openapi: 3.1.0
info:
  title: Fluid Company APIs
  description: >-
    The **Fluid Company APIs** provide a comprehensive set of APIs designed to
    integrate Fluid's powerful

    services into your applications seamlessly. These APIs use Company API
    tokens for authentication and

    provide full access to manage your company's resources including users,
    orders, products, media, and more.


    For APIs that authenticate with User tokens, see the Rep APIs documentation.

    For public SDK APIs, see the Public SDK APIs documentation.
  contact:
    email: support@fluid.app
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  version: '1.0'
security: []
servers:
  - url: https://{company}.fluid.app
    description: Production server with company subdomain
    variables:
      company:
        default: myco
        description: Company subdomain
  - url: http://fluid.lvh.me:{port}
    description: Local development server
    variables:
      port:
        default: '3000'
        description: The port number for local development
components:
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer
  schemas:
    WebhookSchema:
      type: object
      description: A webhook schema definition
      properties:
        id:
          type: integer
          description: The unique identifier for the webhook schema
          example: 1
        event_identifier:
          type: string
          description: The event identifier for this schema
          example: order_created
        version:
          type: string
          description: The semantic version of this schema
          example: 1.0.0
        schema_hash:
          type: string
          description: SHA256 hash of the schema definition
          example: abc123def456
        schema_definition:
          type: object
          description: The JSON schema definition
          example:
            type: object
            properties: {}
        created_at:
          type: string
          format: date-time
          description: The date and time the schema was created
          example: '2021-01-01T00:00:00Z'
        updated_at:
          type: string
          format: date-time
          description: The date and time the schema was last updated
          example: '2021-01-01T00:00:00Z'
      required:
        - id
        - event_identifier
        - version
        - schema_hash
        - schema_definition
        - created_at
        - updated_at
    Meta:
      type: object
      description: Standard response metadata
      properties:
        request_id:
          type: string
          description: Unique identifier for the request
          example: 02368efa-fda5-4c51-a6f4-75e351796526
        timestamp:
          type: string
          format: date-time
          description: ISO 8601 timestamp of when the response was generated
          example: '2025-06-30T16:17:59Z'
      required:
        - request_id
        - timestamp
    MediumSerializer:
      title: MediumSerializer
      type: object
      description: Media resource with user-specific data and associations
      properties:
        id:
          type: integer
        user_id:
          type:
            - integer
            - 'null'
        title:
          type: string
        description:
          type:
            - object
            - 'null'
        stripped:
          type:
            - string
            - 'null'
        media_type:
          type: string
          enum:
            - share
            - update
            - training
            - upload
        media_format:
          type:
            - string
            - 'null'
        image_url:
          type:
            - string
            - 'null'
        video_url:
          type:
            - string
            - 'null'
        pdf_url:
          type:
            - string
            - 'null'
        kind:
          type:
            - string
            - 'null'
        active:
          type: boolean
        visibility:
          type:
            - integer
            - 'null'
        share_link:
          type:
            - string
            - 'null'
        preview_link:
          type:
            - string
            - 'null'
        views:
          type: integer
        leads:
          type: integer
        watch:
          type:
            - object
            - 'null'
        video_status:
          type:
            - string
            - 'null'
        duration:
          type:
            - integer
            - 'null'
        cta_url:
          type:
            - string
            - 'null'
        cta_button_text:
          type:
            - string
            - 'null'
        cta_enabled:
          type: boolean
        cta_action_type:
          type:
            - string
            - 'null'
        video_shopping_enabled:
          type: boolean
        prompts_enabled:
          type: boolean
        ranks:
          type: array
          items:
            type: string
        settings:
          type:
            - object
            - 'null'
        application_theme_template_id:
          type:
            - integer
            - 'null'
        created_at:
          type: string
          format: date-time
        subtitles:
          type:
            - object
            - 'null'
          description: Hash of language ISO codes to subtitle text
          additionalProperties:
            type: string
        countries:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
              iso:
                type: string
              name:
                type: string
        tags:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
              name:
                type: string
        prompts:
          type: array
          description: Only included if media_type is 'share' or 'upload'
          items:
            type: object
        attached_shareables:
          type: array
          items:
            type: object
        comments:
          type: array
          description: >-
            Only included if video_shopping_enabled is true and display_comments
            is true
          items:
            type: object
        label:
          type:
            - object
            - 'null'
          description: Label object from LabelConcern
        display_tag:
          type:
            - string
            - 'null'
          description: Display tag from LabelConcern
      required:
        - id
        - title
        - media_type
        - active
        - views
        - leads
        - cta_enabled
        - video_shopping_enabled
        - prompts_enabled
        - created_at
    UnauthorizedError:
      type: object
      properties:
        message:
          type: string
          example: Invalid credentials
      required:
        - message
    MediaCreate:
      type: object
      properties:
        medium:
          type: object
          properties:
            user_id:
              type: integer
            language:
              type: string
              minLength: 1
            media_type:
              type: string
              minLength: 1
            image_url:
              type: string
              minLength: 1
            video_url:
              type: string
              minLength: 1
            pdf_url:
              type: string
              minLength: 1
            powerpoint_url:
              type: string
              minLength: 1
            title:
              type: string
              minLength: 1
            description:
              type: string
              minLength: 1
            active:
              type: boolean
              not:
                type: 'null'
            compressed_image_url:
              type: string
              minLength: 1
            prompts_enabled:
              type: boolean
              not:
                type: 'null'
            kind:
              type: string
              minLength: 1
            visibility:
              type: string
              minLength: 1
            cta_enabled:
              type: boolean
              not:
                type: 'null'
            cta_action_type:
              type: string
              minLength: 1
            cta_url:
              type: string
              minLength: 1
            cta_button_text:
              type: string
              minLength: 1
            no_index:
              type: boolean
              not:
                type: 'null'
            display_comments:
              type: boolean
              not:
                type: 'null'
            category:
              type: string
              minLength: 1
            display_shop:
              type: boolean
              not:
                type: 'null'
            dam_asset_id:
              type: integer
            dam_asset_code:
              type: string
              minLength: 1
            lead_capture:
              type: boolean
              not:
                type: 'null'
            video_shopping_enabled:
              type: boolean
              not:
                type: 'null'
            application_theme_template_id:
              type: integer
            settings:
              type: object
            label:
              type: object
              properties:
                id:
                  type: integer
                title:
                  type: string
                  minLength: 1
              required: []
            subtitles:
              type: array
              items:
                type: object
                properties:
                  lang:
                    type: string
                    minLength: 1
                  src:
                    type: string
                    minLength: 1
                required:
                  - lang
                  - src
            available_countries:
              type: array
              items:
                type: string
            tags_attributes:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: integer
                  _destroy:
                    type: boolean
                    not:
                      type: 'null'
                  name:
                    type: string
                    minLength: 1
                required: []
            prompts_attributes:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: integer
                  title:
                    type: string
                    minLength: 1
                  content:
                    type: string
                    minLength: 1
                  _destroy:
                    type: boolean
                    not:
                      type: 'null'
                required: []
            attached_shareables_attributes:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: integer
                  attachment_type:
                    type: string
                    minLength: 1
                  attachment_id:
                    type: integer
                  timestamp:
                    type: string
                    minLength: 1
                  _destroy:
                    type: boolean
                    not:
                      type: 'null'
                required: []
          required: []
      required:
        - medium
    MediaUpdate:
      type: object
      properties:
        id:
          type: integer
        medium:
          type: object
          properties:
            user_id:
              type: integer
            media_type:
              type: string
              minLength: 1
            image_url:
              type:
                - 'null'
                - string
            video_url:
              type:
                - 'null'
                - string
            pdf_url:
              type:
                - 'null'
                - string
            powerpoint_url:
              type: string
              minLength: 1
            title:
              type: string
              minLength: 1
            description:
              type:
                - 'null'
                - string
            active:
              type: boolean
              not:
                type: 'null'
            compressed_image_url:
              type: string
              minLength: 1
            prompts_enabled:
              type: boolean
              not:
                type: 'null'
            kind:
              type: string
              minLength: 1
            visibility:
              type: string
              minLength: 1
            cta_enabled:
              type: boolean
              not:
                type: 'null'
            cta_action_type:
              type: string
              minLength: 1
            cta_url:
              type:
                - 'null'
                - string
            cta_button_text:
              type: string
              minLength: 1
            no_index:
              type: boolean
              not:
                type: 'null'
            display_comments:
              type: boolean
              not:
                type: 'null'
            category:
              type: string
              minLength: 1
            display_shop:
              type: boolean
              not:
                type: 'null'
            dam_asset_id:
              type: integer
            dam_asset_code:
              type: string
              minLength: 1
            lead_capture:
              type: boolean
              not:
                type: 'null'
            video_shopping_enabled:
              type: boolean
              not:
                type: 'null'
            application_theme_template_id:
              type: integer
            settings:
              type: object
              properties:
                player:
                  type: object
                  properties:
                    primary_color:
                      type: string
                      minLength: 1
                    button_border_radius:
                      type: string
                      minLength: 1
                    control_bar_height:
                      type: string
                      minLength: 1
                    progress_color:
                      type: string
                      minLength: 1
                    volume_color:
                      type: string
                      minLength: 1
                    show_controls:
                      type: boolean
                      not:
                        type: 'null'
                    autoplay:
                      type: boolean
                      not:
                        type: 'null'
                    loop:
                      type: boolean
                      not:
                        type: 'null'
                    muted:
                      type: boolean
                      not:
                        type: 'null'
                    preload:
                      type: string
                      minLength: 1
                    playback_rates:
                      type: string
                      minLength: 1
                    show_remaining_time:
                      type: boolean
                      not:
                        type: 'null'
                    responsive:
                      type: boolean
                      not:
                        type: 'null'
                    fluid:
                      type: boolean
                      not:
                        type: 'null'
                  required: []
                embed:
                  type: object
                  properties:
                    behavior:
                      type: string
                      minLength: 1
                    responsive:
                      type: boolean
                      not:
                        type: 'null'
                    width:
                      type: string
                      minLength: 1
                    height:
                      type: string
                      minLength: 1
                    show_controls:
                      type: boolean
                      not:
                        type: 'null'
                    autoplay:
                      type: boolean
                      not:
                        type: 'null'
                    loop:
                      type: boolean
                      not:
                        type: 'null'
                  required: []
                cta:
                  type: object
                  properties:
                    enabled:
                      type: boolean
                      not:
                        type: 'null'
                    type:
                      type: string
                      minLength: 1
                    url:
                      type:
                        - 'null'
                        - string
                    button_description:
                      type:
                        - 'null'
                        - string
                    button_text:
                      type: string
                      minLength: 1
                    button_color:
                      type: string
                      minLength: 1
                  required: []
                fair_share:
                  type: object
                  properties:
                    bg_color:
                      type: string
                      minLength: 1
                    rep_name:
                      type: string
                      minLength: 1
                    rep_avatar:
                      type: string
                      minLength: 1
                    message:
                      type: string
                      minLength: 1
                  required: []
                live_chat:
                  type: object
                  properties:
                    enabled:
                      type: boolean
                      not:
                        type: 'null'
                    color:
                      type: string
                      minLength: 1
                    welcome_message:
                      type: string
                      minLength: 1
                  required: []
                thumbnail:
                  type: object
                  properties:
                    show_title:
                      type: boolean
                      not:
                        type: 'null'
                    show_description:
                      type: boolean
                      not:
                        type: 'null'
                  required: []
                seo:
                  type: object
                  properties:
                    title:
                      type: string
                      minLength: 1
                    description:
                      type: string
                      minLength: 1
                    image_url:
                      type: string
                      minLength: 1
                    image_path:
                      type: string
                      minLength: 1
                    block_crawler:
                      type: boolean
                      not:
                        type: 'null'
                  required: []
              required: []
            label:
              type: object
              properties:
                id:
                  type: integer
                title:
                  type: string
                  minLength: 1
              required: []
            subtitles:
              type: array
              items:
                type: object
                properties:
                  lang:
                    type: string
                    minLength: 1
                  src:
                    type: string
                    minLength: 1
                required:
                  - lang
                  - src
            available_countries:
              type: array
              items:
                type: string
            tags_attributes:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: integer
                  _destroy:
                    type: boolean
                    not:
                      type: 'null'
                  name:
                    type: string
                    minLength: 1
                required: []
            prompts_attributes:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: integer
                  title:
                    type: string
                    minLength: 1
                  content:
                    type: string
                    minLength: 1
                  _destroy:
                    type: boolean
                    not:
                      type: 'null'
                required: []
            attached_shareables_attributes:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: integer
                  attachment_type:
                    type: string
                    minLength: 1
                  attachment_id:
                    type: integer
                  timestamp:
                    type: string
                    minLength: 1
                  _destroy:
                    type: boolean
                    not:
                      type: 'null'
                required: []
          required: []
      required:
        - id
        - medium
    index:
      title: index
      required:
        - status
        - data
      type: object
      properties:
        status:
          type: string
        data:
          allOf:
            - $ref: '#/components/schemas/Data'
            - {}
      example:
        status: success
        data:
          products:
            - id: 2260
              slug: dice-product
              category_id: 40
              active: true
              status: active
              title: Dice Product in English
              description: <div>Dice description in English!</div>
              introduction: English introduction
              feature_text: <div>features in English</div>
              stripped: Dice description in English!
              review_count: 0
              sku: Dice123
              upc: null
              hs_code: null
              image_url: https://cdn.filestackcontent.com/tJIUAm0Tlirjoz0B49mL
              compressed_image_url: null
              image_path: null
              external_url: ''
              price: '5.0'
              display_price: $5.00 (USD)
              subscription_price: '0.0'
              currency_code: USD
              tax_category_id: 5364
              public: true
              in_stock: true
              keep_selling: true
              track_quantity: true
              no_index: false
              commission: '10.0'
              affiliate_commission: null
              integration_id: null
              external_id: null
              last_synced_at: null
              category: >-
                {"id":40,"title":"Updated Category
                Title","description":null,"image_url":"","image_path":null,"position":1,"public":false}
              collections: []
              images:
                - id: 2108
                  image_url: >-
                    https://ik.imagekit.io/fluid/s3/DSn06lhwQl6w8CYaL5Uw_DiceImage.jpeg
                  image_path: DSn06lhwQl6w8CYaL5Uw_DiceImage.jpeg
                  position: null
              options: []
              variants:
                - id: 19689
                  is_master: true
                  title: ''
                  image_url: ''
                  buyable: true
                  allow_subscription: true
                  subscription_only: false
                  shipping_included_in_price: false
                  images: []
                  variant_countries:
                    US:
                      id: 134471
                      active: true
                      currency_code: USD
                      price: '5.0'
                      shipping: '1.0'
                      shipping_time: ''
                      subscription_price: '0.0'
                      wholesale: '10.0'
                      wholesale_subscription_price: '10.0'
                      cost_of_goods_sold: '0.0'
                      compare_price: '0.0'
                      display_price: $5.00 (USD)
                      display_subscription_price: $0.00 (USD)
                      display_wholesale: $10.00 (USD)
                      display_wholesale_subscription_price: $10.00 (USD)
                    IN:
                      id: 134469
                      active: true
                      currency_code: INR
                      price: '350.0'
                      shipping: '70.0'
                      shipping_time: ''
                      subscription_price: '0.0'
                      wholesale: '10.0'
                      wholesale_subscription_price: '10.0'
                      cost_of_goods_sold: '0.0'
                      compare_price: '0.0'
                      display_price: ₹350.00 (INR)
                      display_subscription_price: ₹0.00 (INR)
                      display_wholesale: ₹10.00 (INR)
                      display_wholesale_subscription_price: ₹10.00 (INR)
                    NP:
                      id: 134470
                      active: true
                      currency_code: NPR
                      price: '5.0'
                      shipping: '1.0'
                      shipping_time: ''
                      subscription_price: '0.0'
                      wholesale: '10.0'
                      wholesale_subscription_price: '10.0'
                      cost_of_goods_sold: '0.0'
                      compare_price: '0.0'
                      display_price: Rs.5.00 (NPR)
                      display_subscription_price: Rs.0.00 (NPR)
                      display_wholesale: Rs.10.00 (NPR)
                      display_wholesale_subscription_price: Rs.10.00 (NPR)
                    BT:
                      id: 134468
                      active: true
                      currency_code: BTN
                      price: '5.0'
                      shipping: '1.0'
                      shipping_time: ''
                      subscription_price: '0.0'
                      wholesale: '10.0'
                      wholesale_subscription_price: '10.0'
                      cost_of_goods_sold: '0.0'
                      compare_price: '0.0'
                      display_price: Nu.5.00 (BTN)
                      display_subscription_price: Nu.0.00 (BTN)
                      display_wholesale: Nu.10.00 (BTN)
                      display_wholesale_subscription_price: Nu.10.00 (BTN)
                    AF:
                      id: 134467
                      active: true
                      currency_code: AFN
                      price: '6.0'
                      shipping: '1.0'
                      shipping_time: ''
                      subscription_price: '0.0'
                      wholesale: '10.0'
                      wholesale_subscription_price: '10.0'
                      cost_of_goods_sold: '0.0'
                      compare_price: '0.0'
                      display_price: ؋6.00 (AFN)
                      display_subscription_price: ؋0.00 (AFN)
                      display_wholesale: ؋10.00 (AFN)
                      display_wholesale_subscription_price: ؋10.00 (AFN)
    Data:
      title: Data
      required:
        - products
      type: object
      properties:
        products:
          type: array
          items:
            $ref: '#/components/schemas/product'
          description: ''
      example:
        products:
          - id: 2260
            slug: dice-product
            category_id: 40
            active: true
            status: active
            title: Dice Product in English
            description: <div>Dice description in English!</div>
            introduction: English introduction
            feature_text: <div>features in English</div>
            stripped: Dice description in English!
            review_count: 0
            sku: Dice123
            upc: null
            hs_code: null
            image_url: https://cdn.filestackcontent.com/tJIUAm0Tlirjoz0B49mL
            compressed_image_url: null
            image_path: null
            external_url: ''
            price: '5.0'
            display_price: $5.00 (USD)
            subscription_price: '0.0'
            currency_code: USD
            tax_category_id: 5364
            public: true
            in_stock: true
            keep_selling: true
            track_quantity: true
            no_index: false
            commission: '10.0'
            affiliate_commission: null
            integration_id: null
            external_id: null
            last_synced_at: null
            category: >-
              {"id":40,"title":"Updated Category
              Title","description":null,"image_url":"","image_path":null,"position":1,"public":false}
            collections: []
            images:
              - id: 2108
                image_url: >-
                  https://ik.imagekit.io/fluid/s3/DSn06lhwQl6w8CYaL5Uw_DiceImage.jpeg
                image_path: DSn06lhwQl6w8CYaL5Uw_DiceImage.jpeg
                position: null
            options: []
            variants:
              - id: 19689
                is_master: true
                title: ''
                image_url: ''
                buyable: true
                allow_subscription: true
                subscription_only: false
                shipping_included_in_price: false
                images: []
                variant_countries:
                  US:
                    id: 134471
                    active: true
                    currency_code: USD
                    price: '5.0'
                    shipping: '1.0'
                    shipping_time: ''
                    subscription_price: '0.0'
                    wholesale: '10.0'
                    wholesale_subscription_price: '10.0'
                    cost_of_goods_sold: '0.0'
                    compare_price: '0.0'
                    display_price: $5.00 (USD)
                    display_subscription_price: $0.00 (USD)
                    display_wholesale: $10.00 (USD)
                    display_wholesale_subscription_price: $10.00 (USD)
                  IN:
                    id: 134469
                    active: true
                    currency_code: INR
                    price: '350.0'
                    shipping: '70.0'
                    shipping_time: ''
                    subscription_price: '0.0'
                    wholesale: '10.0'
                    wholesale_subscription_price: '10.0'
                    cost_of_goods_sold: '0.0'
                    compare_price: '0.0'
                    display_price: ₹350.00 (INR)
                    display_subscription_price: ₹0.00 (INR)
                    display_wholesale: ₹10.00 (INR)
                    display_wholesale_subscription_price: ₹10.00 (INR)
                  NP:
                    id: 134470
                    active: true
                    currency_code: NPR
                    price: '5.0'
                    shipping: '1.0'
                    shipping_time: ''
                    subscription_price: '0.0'
                    wholesale: '10.0'
                    wholesale_subscription_price: '10.0'
                    cost_of_goods_sold: '0.0'
                    compare_price: '0.0'
                    display_price: Rs.5.00 (NPR)
                    display_subscription_price: Rs.0.00 (NPR)
                    display_wholesale: Rs.10.00 (NPR)
                    display_wholesale_subscription_price: Rs.10.00 (NPR)
                  BT:
                    id: 134468
                    active: true
                    currency_code: BTN
                    price: '5.0'
                    shipping: '1.0'
                    shipping_time: ''
                    subscription_price: '0.0'
                    wholesale: '10.0'
                    wholesale_subscription_price: '10.0'
                    cost_of_goods_sold: '0.0'
                    compare_price: '0.0'
                    display_price: Nu.5.00 (BTN)
                    display_subscription_price: Nu.0.00 (BTN)
                    display_wholesale: Nu.10.00 (BTN)
                    display_wholesale_subscription_price: Nu.10.00 (BTN)
                  AF:
                    id: 134467
                    active: true
                    currency_code: AFN
                    price: '6.0'
                    shipping: '1.0'
                    shipping_time: ''
                    subscription_price: '0.0'
                    wholesale: '10.0'
                    wholesale_subscription_price: '10.0'
                    cost_of_goods_sold: '0.0'
                    compare_price: '0.0'
                    display_price: ؋6.00 (AFN)
                    display_subscription_price: ؋0.00 (AFN)
                    display_wholesale: ؋10.00 (AFN)
                    display_wholesale_subscription_price: ؋10.00 (AFN)
    product:
      title: Product
      required:
        - id
        - slug
        - category_id
        - active
        - status
        - title
        - description
        - introduction
        - feature_text
        - stripped
        - review_count
        - sku
        - upc
        - hs_code
        - image_url
        - compressed_image_url
        - image_path
        - external_url
        - price
        - display_price
        - subscription_price
        - currency_code
        - tax_category_id
        - public
        - in_stock
        - keep_selling
        - track_quantity
        - no_index
        - commission
        - affiliate_commission
        - integration_id
        - external_id
        - last_synced_at
        - category
        - collections
        - images
        - options
        - variants
      type: object
      properties:
        id:
          type: integer
          format: int32
        slug:
          type: string
        category_id:
          type: integer
          format: int32
        active:
          type: boolean
        status:
          type: string
        title:
          type: string
        description:
          type: string
        introduction:
          type: string
        feature_text:
          type: string
        stripped:
          type: string
        review_count:
          type: integer
          format: int32
        sku:
          type: string
        upc:
          type: string
        hs_code:
          type: string
        image_url:
          type: string
        compressed_image_url:
          type: string
        image_path:
          type: string
        external_url:
          type: string
        price:
          type: string
        display_price:
          type: string
        subscription_price:
          type: string
        currency_code:
          type: string
        tax_category_id:
          type: integer
          format: int32
        public:
          type: boolean
        in_stock:
          type: boolean
        keep_selling:
          type: boolean
        track_quantity:
          type: boolean
        no_index:
          type: boolean
        commission:
          type: string
        affiliate_commission:
          type: string
        integration_id:
          type: string
        external_id:
          type: string
        last_synced_at:
          type: string
        category:
          type: string
        collections:
          type: array
          items:
            type: string
          description: ''
        images:
          type: array
          items:
            $ref: '#/components/schemas/Image'
          description: ''
        options:
          type: array
          items:
            type: string
          description: ''
        variants:
          type: array
          items:
            $ref: '#/components/schemas/Variant'
          description: ''
      example:
        id: 2260
        slug: dice-product
        category_id: 40
        active: true
        status: active
        title: Dice Product in English
        description: <div>Dice description in English!</div>
        introduction: English introduction
        feature_text: <div>features in English</div>
        stripped: Dice description in English!
        review_count: 0
        sku: Dice123
        upc: null
        hs_code: null
        image_url: https://cdn.filestackcontent.com/tJIUAm0Tlirjoz0B49mL
        compressed_image_url: null
        image_path: null
        external_url: ''
        price: '5.0'
        display_price: $5.00 (USD)
        subscription_price: '0.0'
        currency_code: USD
        tax_category_id: 5364
        public: true
        in_stock: true
        keep_selling: true
        track_quantity: true
        no_index: false
        commission: '10.0'
        affiliate_commission: null
        integration_id: null
        external_id: null
        last_synced_at: null
        category: >-
          {"id":40,"title":"Updated Category
          Title","description":null,"image_url":"","image_path":null,"position":1,"public":false}
        collections: []
        images:
          - id: 2108
            image_url: >-
              https://ik.imagekit.io/fluid/s3/DSn06lhwQl6w8CYaL5Uw_DiceImage.jpeg
            image_path: DSn06lhwQl6w8CYaL5Uw_DiceImage.jpeg
            position: null
        options: []
        variants:
          - id: 19689
            is_master: true
            title: ''
            image_url: ''
            buyable: true
            allow_subscription: true
            subscription_only: false
            shipping_included_in_price: false
            images: []
            variant_countries:
              US:
                id: 134471
                active: true
                currency_code: USD
                price: '5.0'
                shipping: '1.0'
                shipping_time: ''
                subscription_price: '0.0'
                wholesale: '10.0'
                wholesale_subscription_price: '10.0'
                cost_of_goods_sold: '0.0'
                compare_price: '0.0'
                display_price: $5.00 (USD)
                display_subscription_price: $0.00 (USD)
                display_wholesale: $10.00 (USD)
                display_wholesale_subscription_price: $10.00 (USD)
              IN:
                id: 134469
                active: true
                currency_code: INR
                price: '350.0'
                shipping: '70.0'
                shipping_time: ''
                subscription_price: '0.0'
                wholesale: '10.0'
                wholesale_subscription_price: '10.0'
                cost_of_goods_sold: '0.0'
                compare_price: '0.0'
                display_price: ₹350.00 (INR)
                display_subscription_price: ₹0.00 (INR)
                display_wholesale: ₹10.00 (INR)
                display_wholesale_subscription_price: ₹10.00 (INR)
              NP:
                id: 134470
                active: true
                currency_code: NPR
                price: '5.0'
                shipping: '1.0'
                shipping_time: ''
                subscription_price: '0.0'
                wholesale: '10.0'
                wholesale_subscription_price: '10.0'
                cost_of_goods_sold: '0.0'
                compare_price: '0.0'
                display_price: Rs.5.00 (NPR)
                display_subscription_price: Rs.0.00 (NPR)
                display_wholesale: Rs.10.00 (NPR)
                display_wholesale_subscription_price: Rs.10.00 (NPR)
              BT:
                id: 134468
                active: true
                currency_code: BTN
                price: '5.0'
                shipping: '1.0'
                shipping_time: ''
                subscription_price: '0.0'
                wholesale: '10.0'
                wholesale_subscription_price: '10.0'
                cost_of_goods_sold: '0.0'
                compare_price: '0.0'
                display_price: Nu.5.00 (BTN)
                display_subscription_price: Nu.0.00 (BTN)
                display_wholesale: Nu.10.00 (BTN)
                display_wholesale_subscription_price: Nu.10.00 (BTN)
              AF:
                id: 134467
                active: true
                currency_code: AFN
                price: '6.0'
                shipping: '1.0'
                shipping_time: ''
                subscription_price: '0.0'
                wholesale: '10.0'
                wholesale_subscription_price: '10.0'
                cost_of_goods_sold: '0.0'
                compare_price: '0.0'
                display_price: ؋6.00 (AFN)
                display_subscription_price: ؋0.00 (AFN)
                display_wholesale: ؋10.00 (AFN)
                display_wholesale_subscription_price: ؋10.00 (AFN)
    Image:
      title: Image
      required:
        - id
        - image_url
        - image_path
        - position
      type: object
      properties:
        id:
          type: integer
          format: int32
        image_url:
          type: string
        image_path:
          type: string
        position:
          type: string
      example:
        id: 2108
        image_url: https://ik.imagekit.io/fluid/s3/DSn06lhwQl6w8CYaL5Uw_DiceImage.jpeg
        image_path: DSn06lhwQl6w8CYaL5Uw_DiceImage.jpeg
        position: null
    Variant:
      title: Variant
      required:
        - id
        - is_master
        - title
        - image_url
        - buyable
        - allow_subscription
        - subscription_only
        - shipping_included_in_price
        - images
        - variant_countries
      type: object
      properties:
        id:
          type: integer
          format: int32
        is_master:
          type: boolean
        title:
          type: string
        image_url:
          type: string
        buyable:
          type: boolean
        allow_subscription:
          type: boolean
        subscription_only:
          type: boolean
        shipping_included_in_price:
          type: boolean
        images:
          type: array
          items:
            type: string
          description: ''
        variant_countries:
          allOf:
            - $ref: '#/components/schemas/VariantCountries'
            - {}
      example:
        id: 19689
        is_master: true
        title: ''
        image_url: ''
        buyable: true
        allow_subscription: true
        subscription_only: false
        shipping_included_in_price: false
        images: []
        variant_countries:
          US:
            id: 134471
            active: true
            currency_code: USD
            price: '5.0'
            shipping: '1.0'
            shipping_time: ''
            subscription_price: '0.0'
            wholesale: '10.0'
            wholesale_subscription_price: '10.0'
            cost_of_goods_sold: '0.0'
            compare_price: '0.0'
            display_price: $5.00 (USD)
            display_subscription_price: $0.00 (USD)
            display_wholesale: $10.00 (USD)
            display_wholesale_subscription_price: $10.00 (USD)
          IN:
            id: 134469
            active: true
            currency_code: INR
            price: '350.0'
            shipping: '70.0'
            shipping_time: ''
            subscription_price: '0.0'
            wholesale: '10.0'
            wholesale_subscription_price: '10.0'
            cost_of_goods_sold: '0.0'
            compare_price: '0.0'
            display_price: ₹350.00 (INR)
            display_subscription_price: ₹0.00 (INR)
            display_wholesale: ₹10.00 (INR)
            display_wholesale_subscription_price: ₹10.00 (INR)
          NP:
            id: 134470
            active: true
            currency_code: NPR
            price: '5.0'
            shipping: '1.0'
            shipping_time: ''
            subscription_price: '0.0'
            wholesale: '10.0'
            wholesale_subscription_price: '10.0'
            cost_of_goods_sold: '0.0'
            compare_price: '0.0'
            display_price: Rs.5.00 (NPR)
            display_subscription_price: Rs.0.00 (NPR)
            display_wholesale: Rs.10.00 (NPR)
            display_wholesale_subscription_price: Rs.10.00 (NPR)
          BT:
            id: 134468
            active: true
            currency_code: BTN
            price: '5.0'
            shipping: '1.0'
            shipping_time: ''
            subscription_price: '0.0'
            wholesale: '10.0'
            wholesale_subscription_price: '10.0'
            cost_of_goods_sold: '0.0'
            compare_price: '0.0'
            display_price: Nu.5.00 (BTN)
            display_subscription_price: Nu.0.00 (BTN)
            display_wholesale: Nu.10.00 (BTN)
            display_wholesale_subscription_price: Nu.10.00 (BTN)
          AF:
            id: 134467
            active: true
            currency_code: AFN
            price: '6.0'
            shipping: '1.0'
            shipping_time: ''
            subscription_price: '0.0'
            wholesale: '10.0'
            wholesale_subscription_price: '10.0'
            cost_of_goods_sold: '0.0'
            compare_price: '0.0'
            display_price: ؋6.00 (AFN)
            display_subscription_price: ؋0.00 (AFN)
            display_wholesale: ؋10.00 (AFN)
            display_wholesale_subscription_price: ؋10.00 (AFN)
    VariantCountries:
      title: VariantCountries
      required:
        - US
        - IN
        - NP
        - BT
        - AF
      type: object
      properties:
        US:
          allOf:
            - $ref: '#/components/schemas/US'
            - {}
        IN:
          allOf:
            - $ref: '#/components/schemas/IN'
            - {}
        NP:
          allOf:
            - $ref: '#/components/schemas/NP'
            - {}
        BT:
          allOf:
            - $ref: '#/components/schemas/BT'
            - {}
        AF:
          allOf:
            - $ref: '#/components/schemas/AF'
            - {}
      example:
        US:
          id: 134471
          active: true
          currency_code: USD
          price: '5.0'
          shipping: '1.0'
          shipping_time: ''
          subscription_price: '0.0'
          wholesale: '10.0'
          wholesale_subscription_price: '10.0'
          cost_of_goods_sold: '0.0'
          compare_price: '0.0'
          display_price: $5.00 (USD)
          display_subscription_price: $0.00 (USD)
          display_wholesale: $10.00 (USD)
          display_wholesale_subscription_price: $10.00 (USD)
        IN:
          id: 134469
          active: true
          currency_code: INR
          price: '350.0'
          shipping: '70.0'
          shipping_time: ''
          subscription_price: '0.0'
          wholesale: '10.0'
          wholesale_subscription_price: '10.0'
          cost_of_goods_sold: '0.0'
          compare_price: '0.0'
          display_price: ₹350.00 (INR)
          display_subscription_price: ₹0.00 (INR)
          display_wholesale: ₹10.00 (INR)
          display_wholesale_subscription_price: ₹10.00 (INR)
        NP:
          id: 134470
          active: true
          currency_code: NPR
          price: '5.0'
          shipping: '1.0'
          shipping_time: ''
          subscription_price: '0.0'
          wholesale: '10.0'
          wholesale_subscription_price: '10.0'
          cost_of_goods_sold: '0.0'
          compare_price: '0.0'
          display_price: Rs.5.00 (NPR)
          display_subscription_price: Rs.0.00 (NPR)
          display_wholesale: Rs.10.00 (NPR)
          display_wholesale_subscription_price: Rs.10.00 (NPR)
        BT:
          id: 134468
          active: true
          currency_code: BTN
          price: '5.0'
          shipping: '1.0'
          shipping_time: ''
          subscription_price: '0.0'
          wholesale: '10.0'
          wholesale_subscription_price: '10.0'
          cost_of_goods_sold: '0.0'
          compare_price: '0.0'
          display_price: Nu.5.00 (BTN)
          display_subscription_price: Nu.0.00 (BTN)
          display_wholesale: Nu.10.00 (BTN)
          display_wholesale_subscription_price: Nu.10.00 (BTN)
        AF:
          id: 134467
          active: true
          currency_code: AFN
          price: '6.0'
          shipping: '1.0'
          shipping_time: ''
          subscription_price: '0.0'
          wholesale: '10.0'
          wholesale_subscription_price: '10.0'
          cost_of_goods_sold: '0.0'
          compare_price: '0.0'
          display_price: ؋6.00 (AFN)
          display_subscription_price: ؋0.00 (AFN)
          display_wholesale: ؋10.00 (AFN)
          display_wholesale_subscription_price: ؋10.00 (AFN)
    US:
      title: US
      required:
        - id
        - active
        - currency_code
        - price
        - shipping
        - shipping_time
        - subscription_price
        - wholesale
        - wholesale_subscription_price
        - cost_of_goods_sold
        - compare_price
        - display_price
        - display_subscription_price
        - display_wholesale
        - display_wholesale_subscription_price
      type: object
      properties:
        id:
          type: integer
          format: int32
        active:
          type: boolean
        currency_code:
          type: string
        price:
          type: string
        shipping:
          type: string
        shipping_time:
          type: string
        subscription_price:
          type: string
        wholesale:
          type: string
        wholesale_subscription_price:
          type: string
        cost_of_goods_sold:
          type: string
        compare_price:
          type: string
        display_price:
          type: string
        display_subscription_price:
          type: string
        display_wholesale:
          type: string
        display_wholesale_subscription_price:
          type: string
      example:
        id: 134471
        active: true
        currency_code: USD
        price: '5.0'
        shipping: '1.0'
        shipping_time: ''
        subscription_price: '0.0'
        wholesale: '10.0'
        wholesale_subscription_price: '10.0'
        cost_of_goods_sold: '0.0'
        compare_price: '0.0'
        display_price: $5.00 (USD)
        display_subscription_price: $0.00 (USD)
        display_wholesale: $10.00 (USD)
        display_wholesale_subscription_price: $10.00 (USD)
    IN:
      title: IN
      required:
        - id
        - active
        - currency_code
        - price
        - shipping
        - shipping_time
        - subscription_price
        - wholesale
        - wholesale_subscription_price
        - cost_of_goods_sold
        - compare_price
        - display_price
        - display_subscription_price
        - display_wholesale
        - display_wholesale_subscription_price
      type: object
      properties:
        id:
          type: integer
          format: int32
        active:
          type: boolean
        currency_code:
          type: string
        price:
          type: string
        shipping:
          type: string
        shipping_time:
          type: string
        subscription_price:
          type: string
        wholesale:
          type: string
        wholesale_subscription_price:
          type: string
        cost_of_goods_sold:
          type: string
        compare_price:
          type: string
        display_price:
          type: string
        display_subscription_price:
          type: string
        display_wholesale:
          type: string
        display_wholesale_subscription_price:
          type: string
      example:
        id: 134469
        active: true
        currency_code: INR
        price: '350.0'
        shipping: '70.0'
        shipping_time: ''
        subscription_price: '0.0'
        wholesale: '10.0'
        wholesale_subscription_price: '10.0'
        cost_of_goods_sold: '0.0'
        compare_price: '0.0'
        display_price: ₹350.00 (INR)
        display_subscription_price: ₹0.00 (INR)
        display_wholesale: ₹10.00 (INR)
        display_wholesale_subscription_price: ₹10.00 (INR)
    NP:
      title: NP
      required:
        - id
        - active
        - currency_code
        - price
        - shipping
        - shipping_time
        - subscription_price
        - wholesale
        - wholesale_subscription_price
        - cost_of_goods_sold
        - compare_price
        - display_price
        - display_subscription_price
        - display_wholesale
        - display_wholesale_subscription_price
      type: object
      properties:
        id:
          type: integer
          format: int32
        active:
          type: boolean
        currency_code:
          type: string
        price:
          type: string
        shipping:
          type: string
        shipping_time:
          type: string
        subscription_price:
          type: string
        wholesale:
          type: string
        wholesale_subscription_price:
          type: string
        cost_of_goods_sold:
          type: string
        compare_price:
          type: string
        display_price:
          type: string
        display_subscription_price:
          type: string
        display_wholesale:
          type: string
        display_wholesale_subscription_price:
          type: string
      example:
        id: 134470
        active: true
        currency_code: NPR
        price: '5.0'
        shipping: '1.0'
        shipping_time: ''
        subscription_price: '0.0'
        wholesale: '10.0'
        wholesale_subscription_price: '10.0'
        cost_of_goods_sold: '0.0'
        compare_price: '0.0'
        display_price: Rs.5.00 (NPR)
        display_subscription_price: Rs.0.00 (NPR)
        display_wholesale: Rs.10.00 (NPR)
        display_wholesale_subscription_price: Rs.10.00 (NPR)
    BT:
      title: BT
      required:
        - id
        - active
        - currency_code
        - price
        - shipping
        - shipping_time
        - subscription_price
        - wholesale
        - wholesale_subscription_price
        - cost_of_goods_sold
        - compare_price
        - display_price
        - display_subscription_price
        - display_wholesale
        - display_wholesale_subscription_price
      type: object
      properties:
        id:
          type: integer
          format: int32
        active:
          type: boolean
        currency_code:
          type: string
        price:
          type: string
        shipping:
          type: string
        shipping_time:
          type: string
        subscription_price:
          type: string
        wholesale:
          type: string
        wholesale_subscription_price:
          type: string
        cost_of_goods_sold:
          type: string
        compare_price:
          type: string
        display_price:
          type: string
        display_subscription_price:
          type: string
        display_wholesale:
          type: string
        display_wholesale_subscription_price:
          type: string
      example:
        id: 134468
        active: true
        currency_code: BTN
        price: '5.0'
        shipping: '1.0'
        shipping_time: ''
        subscription_price: '0.0'
        wholesale: '10.0'
        wholesale_subscription_price: '10.0'
        cost_of_goods_sold: '0.0'
        compare_price: '0.0'
        display_price: Nu.5.00 (BTN)
        display_subscription_price: Nu.0.00 (BTN)
        display_wholesale: Nu.10.00 (BTN)
        display_wholesale_subscription_price: Nu.10.00 (BTN)
    AF:
      title: AF
      required:
        - id
        - active
        - currency_code
        - price
        - shipping
        - shipping_time
        - subscription_price
        - wholesale
        - wholesale_subscription_price
        - cost_of_goods_sold
        - compare_price
        - display_price
        - display_subscription_price
        - display_wholesale
        - display_wholesale_subscription_price
      type: object
      properties:
        id:
          type: integer
          format: int32
        active:
          type: boolean
        currency_code:
          type: string
        price:
          type: string
        shipping:
          type: string
        shipping_time:
          type: string
        subscription_price:
          type: string
        wholesale:
          type: string
        wholesale_subscription_price:
          type: string
        cost_of_goods_sold:
          type: string
        compare_price:
          type: string
        display_price:
          type: string
        display_subscription_price:
          type: string
        display_wholesale:
          type: string
        display_wholesale_subscription_price:
          type: string
      example:
        id: 134467
        active: true
        currency_code: AFN
        price: '6.0'
        shipping: '1.0'
        shipping_time: ''
        subscription_price: '0.0'
        wholesale: '10.0'
        wholesale_subscription_price: '10.0'
        cost_of_goods_sold: '0.0'
        compare_price: '0.0'
        display_price: ؋6.00 (AFN)
        display_subscription_price: ؋0.00 (AFN)
        display_wholesale: ؋10.00 (AFN)
        display_wholesale_subscription_price: ؋10.00 (AFN)
    show:
      title: show
      required:
        - status
        - data
      type: object
      properties:
        status:
          type: string
        data:
          allOf:
            - $ref: '#/components/schemas/Data1'
            - {}
      example:
        status: success
        data:
          product:
            id: 2200
            slug: red-card
            category_id: null
            active: true
            status: active
            title: red card
            description: >-
              <div>Description with rich text</div><ul><li>Bullet
              1</li><li>Bullet 2</li></ul><h1>Large Text</h1><div><a
              href="http://fluid.app">link</a></div>
            introduction: null
            feature_text: null
            stripped: |-
              Description with rich text
              • Bullet 1
              • Bullet 2

              Large Text

              link
            review_count: 0
            sku: red card
            upc: null
            hs_code: null
            image_url: https://cdn.filestackcontent.com/tJIUAm0Tlirjoz0B49mL
            compressed_image_url: null
            image_path: null
            external_url: ''
            price: '156.0'
            display_price: $156.00 (USD)
            subscription_price: '0.0'
            currency_code: USD
            tax_category_id: 5364
            public: true
            in_stock: true
            keep_selling: true
            track_quantity: true
            no_index: false
            commission: '10.0'
            affiliate_commission: null
            integration_id: null
            external_id: null
            last_synced_at: null
            category: 'null'
            collections: []
            images:
              - id: 2049
                image_url: >-
                  https://ik.imagekit.io/fluid/s3/FeSn4WD5TacQgqOoR1rL_images+%281%29.jpeg
                image_path: FeSn4WD5TacQgqOoR1rL_images+%281%29.jpeg
                position: null
            options: []
            variants:
              - id: 19513
                is_master: true
                title: ''
                image_url: null
                buyable: true
                allow_subscription: true
                subscription_only: false
                shipping_included_in_price: false
                images: []
                variant_countries:
                  NP:
                    id: 179869
                    active: false
                    currency_code: NPR
                    price: '0.0'
                    shipping: '0.0'
                    shipping_time: null
                    subscription_price: '0.0'
                    wholesale: '0.0'
                    wholesale_subscription_price: '0.0'
                    cost_of_goods_sold: '0.0'
                    compare_price: '0.0'
                    display_price: Rs.0.00 (NPR)
                    display_subscription_price: Rs.0.00 (NPR)
                    display_wholesale: Rs.0.00 (NPR)
                    display_wholesale_subscription_price: Rs.0.00 (NPR)
                  BT:
                    id: 125488
                    active: true
                    currency_code: BTN
                    price: '156.0'
                    shipping: '1.0'
                    shipping_time: ''
                    subscription_price: '0.0'
                    wholesale: '0.0'
                    wholesale_subscription_price: '0.0'
                    cost_of_goods_sold: '0.0'
                    compare_price: '0.0'
                    display_price: Nu.156.00 (BTN)
                    display_subscription_price: Nu.0.00 (BTN)
                    display_wholesale: Nu.0.00 (BTN)
                    display_wholesale_subscription_price: Nu.0.00 (BTN)
                  US:
                    id: 125489
                    active: true
                    currency_code: USD
                    price: '156.0'
                    shipping: '1.0'
                    shipping_time: ''
                    subscription_price: '0.0'
                    wholesale: '0.0'
                    wholesale_subscription_price: '0.0'
                    cost_of_goods_sold: '0.0'
                    compare_price: '0.0'
                    display_price: $156.00 (USD)
                    display_subscription_price: $0.00 (USD)
                    display_wholesale: $0.00 (USD)
                    display_wholesale_subscription_price: $0.00 (USD)
    Data1:
      title: Data1
      required:
        - product
      type: object
      properties:
        product:
          allOf:
            - $ref: '#/components/schemas/Product1'
            - {}
      example:
        product:
          id: 2200
          slug: red-card
          category_id: null
          active: true
          status: active
          title: red card
          description: >-
            <div>Description with rich text</div><ul><li>Bullet 1</li><li>Bullet
            2</li></ul><h1>Large Text</h1><div><a
            href="http://fluid.app">link</a></div>
          introduction: null
          feature_text: null
          stripped: |-
            Description with rich text
            • Bullet 1
            • Bullet 2

            Large Text

            link
          review_count: 0
          sku: red card
          upc: null
          hs_code: null
          image_url: https://cdn.filestackcontent.com/tJIUAm0Tlirjoz0B49mL
          compressed_image_url: null
          image_path: null
          external_url: ''
          price: '156.0'
          display_price: $156.00 (USD)
          subscription_price: '0.0'
          currency_code: USD
          tax_category_id: 5364
          public: true
          in_stock: true
          keep_selling: true
          track_quantity: true
          no_index: false
          commission: '10.0'
          affiliate_commission: null
          integration_id: null
          external_id: null
          last_synced_at: null
          category: 'null'
          collections: []
          images:
            - id: 2049
              image_url: >-
                https://ik.imagekit.io/fluid/s3/FeSn4WD5TacQgqOoR1rL_images+%281%29.jpeg
              image_path: FeSn4WD5TacQgqOoR1rL_images+%281%29.jpeg
              position: null
          options: []
          variants:
            - id: 19513
              is_master: true
              title: ''
              image_url: null
              buyable: true
              allow_subscription: true
              subscription_only: false
              shipping_included_in_price: false
              images: []
              variant_countries:
                NP:
                  id: 179869
                  active: false
                  currency_code: NPR
                  price: '0.0'
                  shipping: '0.0'
                  shipping_time: null
                  subscription_price: '0.0'
                  wholesale: '0.0'
                  wholesale_subscription_price: '0.0'
                  cost_of_goods_sold: '0.0'
                  compare_price: '0.0'
                  display_price: Rs.0.00 (NPR)
                  display_subscription_price: Rs.0.00 (NPR)
                  display_wholesale: Rs.0.00 (NPR)
                  display_wholesale_subscription_price: Rs.0.00 (NPR)
                BT:
                  id: 125488
                  active: true
                  currency_code: BTN
                  price: '156.0'
                  shipping: '1.0'
                  shipping_time: ''
                  subscription_price: '0.0'
                  wholesale: '0.0'
                  wholesale_subscription_price: '0.0'
                  cost_of_goods_sold: '0.0'
                  compare_price: '0.0'
                  display_price: Nu.156.00 (BTN)
                  display_subscription_price: Nu.0.00 (BTN)
                  display_wholesale: Nu.0.00 (BTN)
                  display_wholesale_subscription_price: Nu.0.00 (BTN)
                US:
                  id: 125489
                  active: true
                  currency_code: USD
                  price: '156.0'
                  shipping: '1.0'
                  shipping_time: ''
                  subscription_price: '0.0'
                  wholesale: '0.0'
                  wholesale_subscription_price: '0.0'
                  cost_of_goods_sold: '0.0'
                  compare_price: '0.0'
                  display_price: $156.00 (USD)
                  display_subscription_price: $0.00 (USD)
                  display_wholesale: $0.00 (USD)
                  display_wholesale_subscription_price: $0.00 (USD)
    Product1:
      title: Product1
      required:
        - id
        - slug
        - category_id
        - active
        - status
        - title
        - description
        - introduction
        - feature_text
        - stripped
        - review_count
        - sku
        - upc
        - hs_code
        - image_url
        - compressed_image_url
        - image_path
        - external_url
        - price
        - display_price
        - subscription_price
        - currency_code
        - tax_category_id
        - public
        - in_stock
        - keep_selling
        - track_quantity
        - no_index
        - commission
        - affiliate_commission
        - integration_id
        - external_id
        - last_synced_at
        - category
        - collections
        - images
        - options
        - variants
      type: object
      properties:
        id:
          type: integer
          format: int32
        slug:
          type: string
        category_id:
          type: string
        active:
          type: boolean
        status:
          type: string
        title:
          type: string
        description:
          type: string
        introduction:
          type: string
        feature_text:
          type: string
        stripped:
          type: string
        review_count:
          type: integer
          format: int32
        sku:
          type: string
        upc:
          type: string
        hs_code:
          type: string
        image_url:
          type: string
        compressed_image_url:
          type: string
        image_path:
          type: string
        external_url:
          type: string
        price:
          type: string
        display_price:
          type: string
        subscription_price:
          type: string
        currency_code:
          type: string
        tax_category_id:
          type: integer
          format: int32
        public:
          type: boolean
        in_stock:
          type: boolean
        keep_selling:
          type: boolean
        track_quantity:
          type: boolean
        no_index:
          type: boolean
        commission:
          type: string
        affiliate_commission:
          type: string
        integration_id:
          type: string
        external_id:
          type: string
        last_synced_at:
          type: string
        category:
          type: string
        collections:
          type: array
          items:
            type: string
          description: ''
        images:
          type: array
          items:
            $ref: '#/components/schemas/Image'
          description: ''
        options:
          type: array
          items:
            type: string
          description: ''
        variants:
          type: array
          items:
            $ref: '#/components/schemas/Variant1'
          description: ''
      example:
        id: 2200
        slug: red-card
        category_id: null
        active: true
        status: active
        title: red card
        description: >-
          <div>Description with rich text</div><ul><li>Bullet 1</li><li>Bullet
          2</li></ul><h1>Large Text</h1><div><a
          href="http://fluid.app">link</a></div>
        introduction: null
        feature_text: null
        stripped: |-
          Description with rich text
          • Bullet 1
          • Bullet 2

          Large Text

          link
        review_count: 0
        sku: red card
        upc: null
        hs_code: null
        image_url: https://cdn.filestackcontent.com/tJIUAm0Tlirjoz0B49mL
        compressed_image_url: null
        image_path: null
        external_url: ''
        price: '156.0'
        display_price: $156.00 (USD)
        subscription_price: '0.0'
        currency_code: USD
        tax_category_id: 5364
        public: true
        in_stock: true
        keep_selling: true
        track_quantity: true
        no_index: false
        commission: '10.0'
        affiliate_commission: null
        integration_id: null
        external_id: null
        last_synced_at: null
        category: 'null'
        collections: []
        images:
          - id: 2049
            image_url: >-
              https://ik.imagekit.io/fluid/s3/FeSn4WD5TacQgqOoR1rL_images+%281%29.jpeg
            image_path: FeSn4WD5TacQgqOoR1rL_images+%281%29.jpeg
            position: null
        options: []
        variants:
          - id: 19513
            is_master: true
            title: ''
            image_url: null
            buyable: true
            allow_subscription: true
            subscription_only: false
            shipping_included_in_price: false
            images: []
            variant_countries:
              NP:
                id: 179869
                active: false
                currency_code: NPR
                price: '0.0'
                shipping: '0.0'
                shipping_time: null
                subscription_price: '0.0'
                wholesale: '0.0'
                wholesale_subscription_price: '0.0'
                cost_of_goods_sold: '0.0'
                compare_price: '0.0'
                display_price: Rs.0.00 (NPR)
                display_subscription_price: Rs.0.00 (NPR)
                display_wholesale: Rs.0.00 (NPR)
                display_wholesale_subscription_price: Rs.0.00 (NPR)
              BT:
                id: 125488
                active: true
                currency_code: BTN
                price: '156.0'
                shipping: '1.0'
                shipping_time: ''
                subscription_price: '0.0'
                wholesale: '0.0'
                wholesale_subscription_price: '0.0'
                cost_of_goods_sold: '0.0'
                compare_price: '0.0'
                display_price: Nu.156.00 (BTN)
                display_subscription_price: Nu.0.00 (BTN)
                display_wholesale: Nu.0.00 (BTN)
                display_wholesale_subscription_price: Nu.0.00 (BTN)
              US:
                id: 125489
                active: true
                currency_code: USD
                price: '156.0'
                shipping: '1.0'
                shipping_time: ''
                subscription_price: '0.0'
                wholesale: '0.0'
                wholesale_subscription_price: '0.0'
                cost_of_goods_sold: '0.0'
                compare_price: '0.0'
                display_price: $156.00 (USD)
                display_subscription_price: $0.00 (USD)
                display_wholesale: $0.00 (USD)
                display_wholesale_subscription_price: $0.00 (USD)
    Variant1:
      title: Variant1
      required:
        - id
        - is_master
        - title
        - image_url
        - buyable
        - allow_subscription
        - subscription_only
        - shipping_included_in_price
        - images
        - variant_countries
      type: object
      properties:
        id:
          type: integer
          format: int32
        is_master:
          type: boolean
        title:
          type: string
        image_url:
          type: string
        buyable:
          type: boolean
        allow_subscription:
          type: boolean
        subscription_only:
          type: boolean
        shipping_included_in_price:
          type: boolean
        images:
          type: array
          items:
            type: string
          description: ''
        variant_countries:
          allOf:
            - $ref: '#/components/schemas/VariantCountries1'
            - {}
      example:
        id: 19513
        is_master: true
        title: ''
        image_url: null
        buyable: true
        allow_subscription: true
        subscription_only: false
        shipping_included_in_price: false
        images: []
        variant_countries:
          NP:
            id: 179869
            active: false
            currency_code: NPR
            price: '0.0'
            shipping: '0.0'
            shipping_time: null
            subscription_price: '0.0'
            wholesale: '0.0'
            wholesale_subscription_price: '0.0'
            cost_of_goods_sold: '0.0'
            compare_price: '0.0'
            display_price: Rs.0.00 (NPR)
            display_subscription_price: Rs.0.00 (NPR)
            display_wholesale: Rs.0.00 (NPR)
            display_wholesale_subscription_price: Rs.0.00 (NPR)
          BT:
            id: 125488
            active: true
            currency_code: BTN
            price: '156.0'
            shipping: '1.0'
            shipping_time: ''
            subscription_price: '0.0'
            wholesale: '0.0'
            wholesale_subscription_price: '0.0'
            cost_of_goods_sold: '0.0'
            compare_price: '0.0'
            display_price: Nu.156.00 (BTN)
            display_subscription_price: Nu.0.00 (BTN)
            display_wholesale: Nu.0.00 (BTN)
            display_wholesale_subscription_price: Nu.0.00 (BTN)
          US:
            id: 125489
            active: true
            currency_code: USD
            price: '156.0'
            shipping: '1.0'
            shipping_time: ''
            subscription_price: '0.0'
            wholesale: '0.0'
            wholesale_subscription_price: '0.0'
            cost_of_goods_sold: '0.0'
            compare_price: '0.0'
            display_price: $156.00 (USD)
            display_subscription_price: $0.00 (USD)
            display_wholesale: $0.00 (USD)
            display_wholesale_subscription_price: $0.00 (USD)
    VariantCountries1:
      title: VariantCountries1
      required:
        - NP
        - BT
        - US
      type: object
      properties:
        NP:
          allOf:
            - $ref: '#/components/schemas/NP1'
            - {}
        BT:
          allOf:
            - $ref: '#/components/schemas/BT'
            - {}
        US:
          allOf:
            - $ref: '#/components/schemas/US'
            - {}
      example:
        NP:
          id: 179869
          active: false
          currency_code: NPR
          price: '0.0'
          shipping: '0.0'
          shipping_time: null
          subscription_price: '0.0'
          wholesale: '0.0'
          wholesale_subscription_price: '0.0'
          cost_of_goods_sold: '0.0'
          compare_price: '0.0'
          display_price: Rs.0.00 (NPR)
          display_subscription_price: Rs.0.00 (NPR)
          display_wholesale: Rs.0.00 (NPR)
          display_wholesale_subscription_price: Rs.0.00 (NPR)
        BT:
          id: 125488
          active: true
          currency_code: BTN
          price: '156.0'
          shipping: '1.0'
          shipping_time: ''
          subscription_price: '0.0'
          wholesale: '0.0'
          wholesale_subscription_price: '0.0'
          cost_of_goods_sold: '0.0'
          compare_price: '0.0'
          display_price: Nu.156.00 (BTN)
          display_subscription_price: Nu.0.00 (BTN)
          display_wholesale: Nu.0.00 (BTN)
          display_wholesale_subscription_price: Nu.0.00 (BTN)
        US:
          id: 125489
          active: true
          currency_code: USD
          price: '156.0'
          shipping: '1.0'
          shipping_time: ''
          subscription_price: '0.0'
          wholesale: '0.0'
          wholesale_subscription_price: '0.0'
          cost_of_goods_sold: '0.0'
          compare_price: '0.0'
          display_price: $156.00 (USD)
          display_subscription_price: $0.00 (USD)
          display_wholesale: $0.00 (USD)
          display_wholesale_subscription_price: $0.00 (USD)
    NP1:
      title: NP1
      required:
        - id
        - active
        - currency_code
        - price
        - shipping
        - shipping_time
        - subscription_price
        - wholesale
        - wholesale_subscription_price
        - cost_of_goods_sold
        - compare_price
        - display_price
        - display_subscription_price
        - display_wholesale
        - display_wholesale_subscription_price
      type: object
      properties:
        id:
          type: integer
          format: int32
        active:
          type: boolean
        currency_code:
          type: string
        price:
          type: string
        shipping:
          type: string
        shipping_time:
          type: string
        subscription_price:
          type: string
        wholesale:
          type: string
        wholesale_subscription_price:
          type: string
        cost_of_goods_sold:
          type: string
        compare_price:
          type: string
        display_price:
          type: string
        display_subscription_price:
          type: string
        display_wholesale:
          type: string
        display_wholesale_subscription_price:
          type: string
      example:
        id: 179869
        active: false
        currency_code: NPR
        price: '0.0'
        shipping: '0.0'
        shipping_time: null
        subscription_price: '0.0'
        wholesale: '0.0'
        wholesale_subscription_price: '0.0'
        cost_of_goods_sold: '0.0'
        compare_price: '0.0'
        display_price: Rs.0.00 (NPR)
        display_subscription_price: Rs.0.00 (NPR)
        display_wholesale: Rs.0.00 (NPR)
        display_wholesale_subscription_price: Rs.0.00 (NPR)
    createrequest:
      title: createrequest
      required:
        - product
      type: object
      properties:
        product:
          allOf:
            - $ref: '#/components/schemas/Product2'
            - {}
      example:
        product:
          sku: PSKU83983
          title: CM Test Product Name
          description: test product description changed
          image_url: https://cdn.testimageurl.product
          country_code: US
          active: true
          price: 99.8
          shipping: 4
    Product2:
      title: Product2
      required:
        - sku
        - title
        - description
        - image_url
        - country_code
        - active
        - price
        - shipping
      type: object
      properties:
        sku:
          type: string
        title:
          type: string
        description:
          type: string
        image_url:
          type: string
        country_code:
          type: string
        active:
          type: boolean
        price:
          type: number
        shipping:
          type: integer
          format: int32
      example:
        sku: PSKU83983
        title: CM Test Product Name
        description: test product description changed
        image_url: https://cdn.testimageurl.product
        country_code: US
        active: true
        price: 99.8
        shipping: 4
    create:
      title: create
      required:
        - status
        - data
      type: object
      properties:
        status:
          type: string
        data:
          allOf:
            - $ref: '#/components/schemas/Data2'
            - {}
      example:
        status: success
        data:
          product:
            id: 7661
            slug: cm-test-product-name-22c87051-2d35-4076-886e-ac3eafc808b6
            category_id: null
            active: false
            status: draft
            title: CM Test Product Name
            description: test product description changed
            introduction: null
            feature_text: null
            stripped: test product description changed
            review_count: 0
            sku: PSKU83983
            upc: null
            hs_code: null
            image_url: https://cdn.filestackcontent.com/tJIUAm0Tlirjoz0B49mL
            compressed_image_url: null
            image_path: null
            external_url: null
            price: '99.8'
            display_price: Rs.99.80 (NPR)
            subscription_price: '0.0'
            currency_code: NPR
            tax_category_id: 5364
            public: true
            in_stock: true
            keep_selling: false
            track_quantity: true
            no_index: false
            commission: '10.0'
            affiliate_commission: null
            integration_id: null
            external_id: null
            last_synced_at: null
            category: 'null'
            collections: []
            images: []
            options: []
            variants:
              - id: 29018
                is_master: true
                title: null
                image_url: null
                buyable: true
                allow_subscription: true
                subscription_only: false
                shipping_included_in_price: false
                images: []
                variant_countries:
                  BT:
                    id: 3247076
                    active: true
                    currency_code: BTN
                    price: '99.8'
                    shipping: '4.0'
                    shipping_time: null
                    subscription_price: '0.0'
                    wholesale: '0.0'
                    wholesale_subscription_price: '0.0'
                    cost_of_goods_sold: '0.0'
                    compare_price: '0.0'
                    display_price: Nu.99.80 (BTN)
                    display_subscription_price: Nu.0.00 (BTN)
                    display_wholesale: Nu.0.00 (BTN)
                    display_wholesale_subscription_price: Nu.0.00 (BTN)
                  IN:
                    id: 3247077
                    active: true
                    currency_code: INR
                    price: '99.8'
                    shipping: '4.0'
                    shipping_time: null
                    subscription_price: '0.0'
                    wholesale: '0.0'
                    wholesale_subscription_price: '0.0'
                    cost_of_goods_sold: '0.0'
                    compare_price: '0.0'
                    display_price: ₹99.80 (INR)
                    display_subscription_price: ₹0.00 (INR)
                    display_wholesale: ₹0.00 (INR)
                    display_wholesale_subscription_price: ₹0.00 (INR)
                  US:
                    id: 3247078
                    active: true
                    currency_code: USD
                    price: '99.8'
                    shipping: '4.0'
                    shipping_time: null
                    subscription_price: '0.0'
                    wholesale: '0.0'
                    wholesale_subscription_price: '0.0'
                    cost_of_goods_sold: '0.0'
                    compare_price: '0.0'
                    display_price: $99.80 (USD)
                    display_subscription_price: $0.00 (USD)
                    display_wholesale: $0.00 (USD)
                    display_wholesale_subscription_price: $0.00 (USD)
                  NP:
                    id: 3247079
                    active: true
                    currency_code: NPR
                    price: '99.8'
                    shipping: '4.0'
                    shipping_time: null
                    subscription_price: '0.0'
                    wholesale: '0.0'
                    wholesale_subscription_price: '0.0'
                    cost_of_goods_sold: '0.0'
                    compare_price: '0.0'
                    display_price: Rs.99.80 (NPR)
                    display_subscription_price: Rs.0.00 (NPR)
                    display_wholesale: Rs.0.00 (NPR)
                    display_wholesale_subscription_price: Rs.0.00 (NPR)
                  AF:
                    id: 3247080
                    active: true
                    currency_code: AFN
                    price: '99.8'
                    shipping: '4.0'
                    shipping_time: null
                    subscription_price: '0.0'
                    wholesale: '0.0'
                    wholesale_subscription_price: '0.0'
                    cost_of_goods_sold: '0.0'
                    compare_price: '0.0'
                    display_price: ؋99.80 (AFN)
                    display_subscription_price: ؋0.00 (AFN)
                    display_wholesale: ؋0.00 (AFN)
                    display_wholesale_subscription_price: ؋0.00 (AFN)
    Data2:
      title: Data2
      required:
        - product
      type: object
      properties:
        product:
          allOf:
            - $ref: '#/components/schemas/Product3'
            - {}
      example:
        product:
          id: 7661
          slug: cm-test-product-name-22c87051-2d35-4076-886e-ac3eafc808b6
          category_id: null
          active: false
          status: draft
          title: CM Test Product Name
          description: test product description changed
          introduction: null
          feature_text: null
          stripped: test product description changed
          review_count: 0
          sku: PSKU83983
          upc: null
          hs_code: null
          image_url: https://cdn.filestackcontent.com/tJIUAm0Tlirjoz0B49mL
          compressed_image_url: null
          image_path: null
          external_url: null
          price: '99.8'
          display_price: Rs.99.80 (NPR)
          subscription_price: '0.0'
          currency_code: NPR
          tax_category_id: 5364
          public: true
          in_stock: true
          keep_selling: false
          track_quantity: true
          no_index: false
          commission: '10.0'
          affiliate_commission: null
          integration_id: null
          external_id: null
          last_synced_at: null
          category: 'null'
          collections: []
          images: []
          options: []
          variants:
            - id: 29018
              is_master: true
              title: null
              image_url: null
              buyable: true
              allow_subscription: true
              subscription_only: false
              shipping_included_in_price: false
              images: []
              variant_countries:
                BT:
                  id: 3247076
                  active: true
                  currency_code: BTN
                  price: '99.8'
                  shipping: '4.0'
                  shipping_time: null
                  subscription_price: '0.0'
                  wholesale: '0.0'
                  wholesale_subscription_price: '0.0'
                  cost_of_goods_sold: '0.0'
                  compare_price: '0.0'
                  display_price: Nu.99.80 (BTN)
                  display_subscription_price: Nu.0.00 (BTN)
                  display_wholesale: Nu.0.00 (BTN)
                  display_wholesale_subscription_price: Nu.0.00 (BTN)
                IN:
                  id: 3247077
                  active: true
                  currency_code: INR
                  price: '99.8'
                  shipping: '4.0'
                  shipping_time: null
                  subscription_price: '0.0'
                  wholesale: '0.0'
                  wholesale_subscription_price: '0.0'
                  cost_of_goods_sold: '0.0'
                  compare_price: '0.0'
                  display_price: ₹99.80 (INR)
                  display_subscription_price: ₹0.00 (INR)
                  display_wholesale: ₹0.00 (INR)
                  display_wholesale_subscription_price: ₹0.00 (INR)
                US:
                  id: 3247078
                  active: true
                  currency_code: USD
                  price: '99.8'
                  shipping: '4.0'
                  shipping_time: null
                  subscription_price: '0.0'
                  wholesale: '0.0'
                  wholesale_subscription_price: '0.0'
                  cost_of_goods_sold: '0.0'
                  compare_price: '0.0'
                  display_price: $99.80 (USD)
                  display_subscription_price: $0.00 (USD)
                  display_wholesale: $0.00 (USD)
                  display_wholesale_subscription_price: $0.00 (USD)
                NP:
                  id: 3247079
                  active: true
                  currency_code: NPR
                  price: '99.8'
                  shipping: '4.0'
                  shipping_time: null
                  subscription_price: '0.0'
                  wholesale: '0.0'
                  wholesale_subscription_price: '0.0'
                  cost_of_goods_sold: '0.0'
                  compare_price: '0.0'
                  display_price: Rs.99.80 (NPR)
                  display_subscription_price: Rs.0.00 (NPR)
                  display_wholesale: Rs.0.00 (NPR)
                  display_wholesale_subscription_price: Rs.0.00 (NPR)
                AF:
                  id: 3247080
                  active: true
                  currency_code: AFN
                  price: '99.8'
                  shipping: '4.0'
                  shipping_time: null
                  subscription_price: '0.0'
                  wholesale: '0.0'
                  wholesale_subscription_price: '0.0'
                  cost_of_goods_sold: '0.0'
                  compare_price: '0.0'
                  display_price: ؋99.80 (AFN)
                  display_subscription_price: ؋0.00 (AFN)
                  display_wholesale: ؋0.00 (AFN)
                  display_wholesale_subscription_price: ؋0.00 (AFN)
    Product3:
      title: Product3
      required:
        - id
        - slug
        - category_id
        - active
        - status
        - title
        - description
        - introduction
        - feature_text
        - stripped
        - review_count
        - sku
        - upc
        - hs_code
        - image_url
        - compressed_image_url
        - image_path
        - external_url
        - price
        - display_price
        - subscription_price
        - currency_code
        - tax_category_id
        - public
        - in_stock
        - keep_selling
        - track_quantity
        - no_index
        - commission
        - affiliate_commission
        - integration_id
        - external_id
        - last_synced_at
        - category
        - collections
        - images
        - options
        - variants
      type: object
      properties:
        id:
          type: integer
          format: int32
        slug:
          type: string
        category_id:
          type: string
        active:
          type: boolean
        status:
          type: string
        title:
          type: string
        description:
          type: string
        introduction:
          type: string
        feature_text:
          type: string
        stripped:
          type: string
        review_count:
          type: integer
          format: int32
        sku:
          type: string
        upc:
          type: string
        hs_code:
          type: string
        image_url:
          type: string
        compressed_image_url:
          type: string
        image_path:
          type: string
        external_url:
          type: string
        price:
          type: string
        display_price:
          type: string
        subscription_price:
          type: string
        currency_code:
          type: string
        tax_category_id:
          type: integer
          format: int32
        public:
          type: boolean
        in_stock:
          type: boolean
        keep_selling:
          type: boolean
        track_quantity:
          type: boolean
        no_index:
          type: boolean
        commission:
          type: string
        affiliate_commission:
          type: string
        integration_id:
          type: string
        external_id:
          type: string
        last_synced_at:
          type: string
        category:
          type: string
        collections:
          type: array
          items:
            type: string
          description: ''
        images:
          type: array
          items:
            type: string
          description: ''
        options:
          type: array
          items:
            type: string
          description: ''
        variants:
          type: array
          items:
            $ref: '#/components/schemas/Variant2'
          description: ''
      example:
        id: 7661
        slug: cm-test-product-name-22c87051-2d35-4076-886e-ac3eafc808b6
        category_id: null
        active: false
        status: draft
        title: CM Test Product Name
        description: test product description changed
        introduction: null
        feature_text: null
        stripped: test product description changed
        review_count: 0
        sku: PSKU83983
        upc: null
        hs_code: null
        image_url: https://cdn.filestackcontent.com/tJIUAm0Tlirjoz0B49mL
        compressed_image_url: null
        image_path: null
        external_url: null
        price: '99.8'
        display_price: Rs.99.80 (NPR)
        subscription_price: '0.0'
        currency_code: NPR
        tax_category_id: 5364
        public: true
        in_stock: true
        keep_selling: false
        track_quantity: true
        no_index: false
        commission: '10.0'
        affiliate_commission: null
        integration_id: null
        external_id: null
        last_synced_at: null
        category: 'null'
        collections: []
        images: []
        options: []
        variants:
          - id: 29018
            is_master: true
            title: null
            image_url: null
            buyable: true
            allow_subscription: true
            subscription_only: false
            shipping_included_in_price: false
            images: []
            variant_countries:
              BT:
                id: 3247076
                active: true
                currency_code: BTN
                price: '99.8'
                shipping: '4.0'
                shipping_time: null
                subscription_price: '0.0'
                wholesale: '0.0'
                wholesale_subscription_price: '0.0'
                cost_of_goods_sold: '0.0'
                compare_price: '0.0'
                display_price: Nu.99.80 (BTN)
                display_subscription_price: Nu.0.00 (BTN)
                display_wholesale: Nu.0.00 (BTN)
                display_wholesale_subscription_price: Nu.0.00 (BTN)
              IN:
                id: 3247077
                active: true
                currency_code: INR
                price: '99.8'
                shipping: '4.0'
                shipping_time: null
                subscription_price: '0.0'
                wholesale: '0.0'
                wholesale_subscription_price: '0.0'
                cost_of_goods_sold: '0.0'
                compare_price: '0.0'
                display_price: ₹99.80 (INR)
                display_subscription_price: ₹0.00 (INR)
                display_wholesale: ₹0.00 (INR)
                display_wholesale_subscription_price: ₹0.00 (INR)
              US:
                id: 3247078
                active: true
                currency_code: USD
                price: '99.8'
                shipping: '4.0'
                shipping_time: null
                subscription_price: '0.0'
                wholesale: '0.0'
                wholesale_subscription_price: '0.0'
                cost_of_goods_sold: '0.0'
                compare_price: '0.0'
                display_price: $99.80 (USD)
                display_subscription_price: $0.00 (USD)
                display_wholesale: $0.00 (USD)
                display_wholesale_subscription_price: $0.00 (USD)
              NP:
                id: 3247079
                active: true
                currency_code: NPR
                price: '99.8'
                shipping: '4.0'
                shipping_time: null
                subscription_price: '0.0'
                wholesale: '0.0'
                wholesale_subscription_price: '0.0'
                cost_of_goods_sold: '0.0'
                compare_price: '0.0'
                display_price: Rs.99.80 (NPR)
                display_subscription_price: Rs.0.00 (NPR)
                display_wholesale: Rs.0.00 (NPR)
                display_wholesale_subscription_price: Rs.0.00 (NPR)
              AF:
                id: 3247080
                active: true
                currency_code: AFN
                price: '99.8'
                shipping: '4.0'
                shipping_time: null
                subscription_price: '0.0'
                wholesale: '0.0'
                wholesale_subscription_price: '0.0'
                cost_of_goods_sold: '0.0'
                compare_price: '0.0'
                display_price: ؋99.80 (AFN)
                display_subscription_price: ؋0.00 (AFN)
                display_wholesale: ؋0.00 (AFN)
                display_wholesale_subscription_price: ؋0.00 (AFN)
    Variant2:
      title: Variant2
      required:
        - id
        - is_master
        - title
        - image_url
        - buyable
        - allow_subscription
        - subscription_only
        - shipping_included_in_price
        - images
        - variant_countries
      type: object
      properties:
        id:
          type: integer
          format: int32
        is_master:
          type: boolean
        title:
          type: string
        image_url:
          type: string
        buyable:
          type: boolean
        allow_subscription:
          type: boolean
        subscription_only:
          type: boolean
        shipping_included_in_price:
          type: boolean
        images:
          type: array
          items:
            type: string
          description: ''
        variant_countries:
          allOf:
            - $ref: '#/components/schemas/VariantCountries2'
            - {}
      example:
        id: 29018
        is_master: true
        title: null
        image_url: null
        buyable: true
        allow_subscription: true
        subscription_only: false
        shipping_included_in_price: false
        images: []
        variant_countries:
          BT:
            id: 3247076
            active: true
            currency_code: BTN
            price: '99.8'
            shipping: '4.0'
            shipping_time: null
            subscription_price: '0.0'
            wholesale: '0.0'
            wholesale_subscription_price: '0.0'
            cost_of_goods_sold: '0.0'
            compare_price: '0.0'
            display_price: Nu.99.80 (BTN)
            display_subscription_price: Nu.0.00 (BTN)
            display_wholesale: Nu.0.00 (BTN)
            display_wholesale_subscription_price: Nu.0.00 (BTN)
          IN:
            id: 3247077
            active: true
            currency_code: INR
            price: '99.8'
            shipping: '4.0'
            shipping_time: null
            subscription_price: '0.0'
            wholesale: '0.0'
            wholesale_subscription_price: '0.0'
            cost_of_goods_sold: '0.0'
            compare_price: '0.0'
            display_price: ₹99.80 (INR)
            display_subscription_price: ₹0.00 (INR)
            display_wholesale: ₹0.00 (INR)
            display_wholesale_subscription_price: ₹0.00 (INR)
          US:
            id: 3247078
            active: true
            currency_code: USD
            price: '99.8'
            shipping: '4.0'
            shipping_time: null
            subscription_price: '0.0'
            wholesale: '0.0'
            wholesale_subscription_price: '0.0'
            cost_of_goods_sold: '0.0'
            compare_price: '0.0'
            display_price: $99.80 (USD)
            display_subscription_price: $0.00 (USD)
            display_wholesale: $0.00 (USD)
            display_wholesale_subscription_price: $0.00 (USD)
          NP:
            id: 3247079
            active: true
            currency_code: NPR
            price: '99.8'
            shipping: '4.0'
            shipping_time: null
            subscription_price: '0.0'
            wholesale: '0.0'
            wholesale_subscription_price: '0.0'
            cost_of_goods_sold: '0.0'
            compare_price: '0.0'
            display_price: Rs.99.80 (NPR)
            display_subscription_price: Rs.0.00 (NPR)
            display_wholesale: Rs.0.00 (NPR)
            display_wholesale_subscription_price: Rs.0.00 (NPR)
          AF:
            id: 3247080
            active: true
            currency_code: AFN
            price: '99.8'
            shipping: '4.0'
            shipping_time: null
            subscription_price: '0.0'
            wholesale: '0.0'
            wholesale_subscription_price: '0.0'
            cost_of_goods_sold: '0.0'
            compare_price: '0.0'
            display_price: ؋99.80 (AFN)
            display_subscription_price: ؋0.00 (AFN)
            display_wholesale: ؋0.00 (AFN)
            display_wholesale_subscription_price: ؋0.00 (AFN)
    VariantCountries2:
      title: VariantCountries2
      required:
        - BT
        - IN
        - US
        - NP
        - AF
      type: object
      properties:
        BT:
          allOf:
            - $ref: '#/components/schemas/BT2'
            - {}
        IN:
          allOf:
            - $ref: '#/components/schemas/IN1'
            - {}
        US:
          allOf:
            - $ref: '#/components/schemas/US2'
            - {}
        NP:
          allOf:
            - $ref: '#/components/schemas/NP1'
            - {}
        AF:
          allOf:
            - $ref: '#/components/schemas/AF1'
            - {}
      example:
        BT:
          id: 3247076
          active: true
          currency_code: BTN
          price: '99.8'
          shipping: '4.0'
          shipping_time: null
          subscription_price: '0.0'
          wholesale: '0.0'
          wholesale_subscription_price: '0.0'
          cost_of_goods_sold: '0.0'
          compare_price: '0.0'
          display_price: Nu.99.80 (BTN)
          display_subscription_price: Nu.0.00 (BTN)
          display_wholesale: Nu.0.00 (BTN)
          display_wholesale_subscription_price: Nu.0.00 (BTN)
        IN:
          id: 3247077
          active: true
          currency_code: INR
          price: '99.8'
          shipping: '4.0'
          shipping_time: null
          subscription_price: '0.0'
          wholesale: '0.0'
          wholesale_subscription_price: '0.0'
          cost_of_goods_sold: '0.0'
          compare_price: '0.0'
          display_price: ₹99.80 (INR)
          display_subscription_price: ₹0.00 (INR)
          display_wholesale: ₹0.00 (INR)
          display_wholesale_subscription_price: ₹0.00 (INR)
        US:
          id: 3247078
          active: true
          currency_code: USD
          price: '99.8'
          shipping: '4.0'
          shipping_time: null
          subscription_price: '0.0'
          wholesale: '0.0'
          wholesale_subscription_price: '0.0'
          cost_of_goods_sold: '0.0'
          compare_price: '0.0'
          display_price: $99.80 (USD)
          display_subscription_price: $0.00 (USD)
          display_wholesale: $0.00 (USD)
          display_wholesale_subscription_price: $0.00 (USD)
        NP:
          id: 3247079
          active: true
          currency_code: NPR
          price: '99.8'
          shipping: '4.0'
          shipping_time: null
          subscription_price: '0.0'
          wholesale: '0.0'
          wholesale_subscription_price: '0.0'
          cost_of_goods_sold: '0.0'
          compare_price: '0.0'
          display_price: Rs.99.80 (NPR)
          display_subscription_price: Rs.0.00 (NPR)
          display_wholesale: Rs.0.00 (NPR)
          display_wholesale_subscription_price: Rs.0.00 (NPR)
        AF:
          id: 3247080
          active: true
          currency_code: AFN
          price: '99.8'
          shipping: '4.0'
          shipping_time: null
          subscription_price: '0.0'
          wholesale: '0.0'
          wholesale_subscription_price: '0.0'
          cost_of_goods_sold: '0.0'
          compare_price: '0.0'
          display_price: ؋99.80 (AFN)
          display_subscription_price: ؋0.00 (AFN)
          display_wholesale: ؋0.00 (AFN)
          display_wholesale_subscription_price: ؋0.00 (AFN)
    BT2:
      title: BT2
      required:
        - id
        - active
        - currency_code
        - price
        - shipping
        - shipping_time
        - subscription_price
        - wholesale
        - wholesale_subscription_price
        - cost_of_goods_sold
        - compare_price
        - display_price
        - display_subscription_price
        - display_wholesale
        - display_wholesale_subscription_price
      type: object
      properties:
        id:
          type: integer
          format: int32
        active:
          type: boolean
        currency_code:
          type: string
        price:
          type: string
        shipping:
          type: string
        shipping_time:
          type: string
        subscription_price:
          type: string
        wholesale:
          type: string
        wholesale_subscription_price:
          type: string
        cost_of_goods_sold:
          type: string
        compare_price:
          type: string
        display_price:
          type: string
        display_subscription_price:
          type: string
        display_wholesale:
          type: string
        display_wholesale_subscription_price:
          type: string
      example:
        id: 3247076
        active: true
        currency_code: BTN
        price: '99.8'
        shipping: '4.0'
        shipping_time: null
        subscription_price: '0.0'
        wholesale: '0.0'
        wholesale_subscription_price: '0.0'
        cost_of_goods_sold: '0.0'
        compare_price: '0.0'
        display_price: Nu.99.80 (BTN)
        display_subscription_price: Nu.0.00 (BTN)
        display_wholesale: Nu.0.00 (BTN)
        display_wholesale_subscription_price: Nu.0.00 (BTN)
    IN1:
      title: IN1
      required:
        - id
        - active
        - currency_code
        - price
        - shipping
        - shipping_time
        - subscription_price
        - wholesale
        - wholesale_subscription_price
        - cost_of_goods_sold
        - compare_price
        - display_price
        - display_subscription_price
        - display_wholesale
        - display_wholesale_subscription_price
      type: object
      properties:
        id:
          type: integer
          format: int32
        active:
          type: boolean
        currency_code:
          type: string
        price:
          type: string
        shipping:
          type: string
        shipping_time:
          type: string
        subscription_price:
          type: string
        wholesale:
          type: string
        wholesale_subscription_price:
          type: string
        cost_of_goods_sold:
          type: string
        compare_price:
          type: string
        display_price:
          type: string
        display_subscription_price:
          type: string
        display_wholesale:
          type: string
        display_wholesale_subscription_price:
          type: string
      example:
        id: 3247077
        active: true
        currency_code: INR
        price: '99.8'
        shipping: '4.0'
        shipping_time: null
        subscription_price: '0.0'
        wholesale: '0.0'
        wholesale_subscription_price: '0.0'
        cost_of_goods_sold: '0.0'
        compare_price: '0.0'
        display_price: ₹99.80 (INR)
        display_subscription_price: ₹0.00 (INR)
        display_wholesale: ₹0.00 (INR)
        display_wholesale_subscription_price: ₹0.00 (INR)
    US2:
      title: US2
      required:
        - id
        - active
        - currency_code
        - price
        - shipping
        - shipping_time
        - subscription_price
        - wholesale
        - wholesale_subscription_price
        - cost_of_goods_sold
        - compare_price
        - display_price
        - display_subscription_price
        - display_wholesale
        - display_wholesale_subscription_price
      type: object
      properties:
        id:
          type: integer
          format: int32
        active:
          type: boolean
        currency_code:
          type: string
        price:
          type: string
        shipping:
          type: string
        shipping_time:
          type: string
        subscription_price:
          type: string
        wholesale:
          type: string
        wholesale_subscription_price:
          type: string
        cost_of_goods_sold:
          type: string
        compare_price:
          type: string
        display_price:
          type: string
        display_subscription_price:
          type: string
        display_wholesale:
          type: string
        display_wholesale_subscription_price:
          type: string
      example:
        id: 3247078
        active: true
        currency_code: USD
        price: '99.8'
        shipping: '4.0'
        shipping_time: null
        subscription_price: '0.0'
        wholesale: '0.0'
        wholesale_subscription_price: '0.0'
        cost_of_goods_sold: '0.0'
        compare_price: '0.0'
        display_price: $99.80 (USD)
        display_subscription_price: $0.00 (USD)
        display_wholesale: $0.00 (USD)
        display_wholesale_subscription_price: $0.00 (USD)
    AF1:
      title: AF1
      required:
        - id
        - active
        - currency_code
        - price
        - shipping
        - shipping_time
        - subscription_price
        - wholesale
        - wholesale_subscription_price
        - cost_of_goods_sold
        - compare_price
        - display_price
        - display_subscription_price
        - display_wholesale
        - display_wholesale_subscription_price
      type: object
      properties:
        id:
          type: integer
          format: int32
        active:
          type: boolean
        currency_code:
          type: string
        price:
          type: string
        shipping:
          type: string
        shipping_time:
          type: string
        subscription_price:
          type: string
        wholesale:
          type: string
        wholesale_subscription_price:
          type: string
        cost_of_goods_sold:
          type: string
        compare_price:
          type: string
        display_price:
          type: string
        display_subscription_price:
          type: string
        display_wholesale:
          type: string
        display_wholesale_subscription_price:
          type: string
      example:
        id: 3247080
        active: true
        currency_code: AFN
        price: '99.8'
        shipping: '4.0'
        shipping_time: null
        subscription_price: '0.0'
        wholesale: '0.0'
        wholesale_subscription_price: '0.0'
        cost_of_goods_sold: '0.0'
        compare_price: '0.0'
        display_price: ؋99.80 (AFN)
        display_subscription_price: ؋0.00 (AFN)
        display_wholesale: ؋0.00 (AFN)
        display_wholesale_subscription_price: ؋0.00 (AFN)
    updaterequest:
      title: updaterequest
      required:
        - product
      type: object
      properties:
        product:
          allOf:
            - $ref: '#/components/schemas/Product2'
            - {}
      example:
        product:
          sku: PSKU83983
          title: Test Product Name
          description: test product description
          image_url: https://cdn.testimageurl.product
          country_code: US
          active: false
          price: 99.8
          shipping: 4
    update:
      title: update
      required:
        - status
        - data
      type: object
      properties:
        status:
          type: string
        data:
          allOf:
            - $ref: '#/components/schemas/Data2'
            - {}
      example:
        status: success
        data:
          product:
            id: 7658
            slug: cm-test-product-name-41130673-d0d4-4895-90f2-d9bdce8d1b91
            category_id: null
            active: false
            status: draft
            title: Test Product Name
            description: test product description
            introduction: null
            feature_text: null
            stripped: test product description
            review_count: 0
            sku: PSKU83983
            upc: null
            hs_code: null
            image_url: https://cdn.filestackcontent.com/tJIUAm0Tlirjoz0B49mL
            compressed_image_url: null
            image_path: null
            external_url: null
            price: '99.8'
            display_price: Rs.99.80 (NPR)
            subscription_price: '0.0'
            currency_code: NPR
            tax_category_id: 5364
            public: true
            in_stock: true
            keep_selling: false
            track_quantity: true
            no_index: false
            commission: '10.0'
            affiliate_commission: null
            integration_id: null
            external_id: null
            last_synced_at: null
            category: 'null'
            collections: []
            images: []
            options: []
            variants:
              - id: 29015
                is_master: true
                title: null
                image_url: null
                buyable: true
                allow_subscription: true
                subscription_only: false
                shipping_included_in_price: false
                images: []
                variant_countries:
                  BT:
                    id: 3247063
                    active: true
                    currency_code: BTN
                    price: '99.8'
                    shipping: '4.0'
                    shipping_time: null
                    subscription_price: '0.0'
                    wholesale: '0.0'
                    wholesale_subscription_price: '0.0'
                    cost_of_goods_sold: '0.0'
                    compare_price: '0.0'
                    display_price: Nu.99.80 (BTN)
                    display_subscription_price: Nu.0.00 (BTN)
                    display_wholesale: Nu.0.00 (BTN)
                    display_wholesale_subscription_price: Nu.0.00 (BTN)
                  IN:
                    id: 3247064
                    active: true
                    currency_code: INR
                    price: '99.8'
                    shipping: '4.0'
                    shipping_time: null
                    subscription_price: '0.0'
                    wholesale: '0.0'
                    wholesale_subscription_price: '0.0'
                    cost_of_goods_sold: '0.0'
                    compare_price: '0.0'
                    display_price: ₹99.80 (INR)
                    display_subscription_price: ₹0.00 (INR)
                    display_wholesale: ₹0.00 (INR)
                    display_wholesale_subscription_price: ₹0.00 (INR)
                  US:
                    id: 3247065
                    active: true
                    currency_code: USD
                    price: '99.8'
                    shipping: '4.0'
                    shipping_time: null
                    subscription_price: '0.0'
                    wholesale: '0.0'
                    wholesale_subscription_price: '0.0'
                    cost_of_goods_sold: '0.0'
                    compare_price: '0.0'
                    display_price: $99.80 (USD)
                    display_subscription_price: $0.00 (USD)
                    display_wholesale: $0.00 (USD)
                    display_wholesale_subscription_price: $0.00 (USD)
                  NP:
                    id: 3247066
                    active: true
                    currency_code: NPR
                    price: '99.8'
                    shipping: '4.0'
                    shipping_time: null
                    subscription_price: '0.0'
                    wholesale: '0.0'
                    wholesale_subscription_price: '0.0'
                    cost_of_goods_sold: '0.0'
                    compare_price: '0.0'
                    display_price: Rs.99.80 (NPR)
                    display_subscription_price: Rs.0.00 (NPR)
                    display_wholesale: Rs.0.00 (NPR)
                    display_wholesale_subscription_price: Rs.0.00 (NPR)
                  AF:
                    id: 3247067
                    active: true
                    currency_code: AFN
                    price: '99.8'
                    shipping: '4.0'
                    shipping_time: null
                    subscription_price: '0.0'
                    wholesale: '0.0'
                    wholesale_subscription_price: '0.0'
                    cost_of_goods_sold: '0.0'
                    compare_price: '0.0'
                    display_price: ؋99.80 (AFN)
                    display_subscription_price: ؋0.00 (AFN)
                    display_wholesale: ؋0.00 (AFN)
                    display_wholesale_subscription_price: ؋0.00 (AFN)
    add_to_collection:
      title: add_to_collection
      required:
        - status
        - data
      type: object
      properties:
        status:
          type: string
        data:
          allOf:
            - $ref: '#/components/schemas/Data4'
            - {}
      example:
        status: success
        data:
          message: product (2200) added to collection (47)
    Data4:
      title: Data4
      required:
        - message
      type: object
      properties:
        message:
          type: string
      example:
        message: product (2200) added to collection (47)
    remove_from_collection:
      title: remove_from_collection
      required:
        - status
        - data
      type: object
      properties:
        status:
          type: string
        data:
          allOf:
            - $ref: '#/components/schemas/Data4'
            - {}
      example:
        status: success
        data:
          message: product (2200) removed from collection (47)
    send_to_top:
      title: send_to_top
      required:
        - status
        - data
      type: object
      properties:
        status:
          type: string
        data:
          allOf:
            - $ref: '#/components/schemas/Data4'
            - {}
      example:
        status: success
        data:
          message: priority set to 30
    dupulicate:
      title: dupulicate
      required:
        - status
        - data
      type: object
      properties:
        status:
          type: string
        data:
          allOf:
            - $ref: '#/components/schemas/Data8'
            - {}
      example:
        status: success
        data:
          product:
            id: 7662
            slug: red-card_-copy-21dbe4e5-317c-4c3b-b766-0d9aff37679e
            category_id: null
            active: false
            status: draft
            title: null
            description: null
            introduction: null
            feature_text: null
            stripped: null
            review_count: 0
            sku: null
            upc: null
            hs_code: null
            image_url: https://cdn.filestackcontent.com/tJIUAm0Tlirjoz0B49mL
            compressed_image_url: null
            image_path: null
            external_url: ''
            price: '0.0'
            display_price: Rs.0.00 (NPR)
            subscription_price: '0.0'
            currency_code: NPR
            tax_category_id: 5364
            public: true
            in_stock: true
            keep_selling: true
            track_quantity: true
            no_index: false
            commission: '10.0'
            affiliate_commission: null
            integration_id: null
            external_id: null
            last_synced_at: null
            category: 'null'
            collections: []
            images:
              - id: 18755
                image_url: >-
                  https://ik.imagekit.io/fluid/s3/FeSn4WD5TacQgqOoR1rL_images+%281%29.jpeg
                image_path: FeSn4WD5TacQgqOoR1rL_images+%281%29.jpeg
                position: 0
            options: []
            variants:
              - id: 29019
                is_master: true
                title: ''
                image_url: null
                buyable: true
                allow_subscription: true
                subscription_only: false
                shipping_included_in_price: false
                images: []
                variant_countries:
                  NP:
                    id: 3247081
                    active: false
                    currency_code: NPR
                    price: '0.0'
                    shipping: '0.0'
                    shipping_time: null
                    subscription_price: '0.0'
                    wholesale: '0.0'
                    wholesale_subscription_price: '0.0'
                    cost_of_goods_sold: '0.0'
                    compare_price: '0.0'
                    display_price: Rs.0.00 (NPR)
                    display_subscription_price: Rs.0.00 (NPR)
                    display_wholesale: Rs.0.00 (NPR)
                    display_wholesale_subscription_price: Rs.0.00 (NPR)
                  BT:
                    id: 3247082
                    active: true
                    currency_code: BTN
                    price: '156.0'
                    shipping: '1.0'
                    shipping_time: ''
                    subscription_price: '0.0'
                    wholesale: '0.0'
                    wholesale_subscription_price: '0.0'
                    cost_of_goods_sold: '0.0'
                    compare_price: '0.0'
                    display_price: Nu.156.00 (BTN)
                    display_subscription_price: Nu.0.00 (BTN)
                    display_wholesale: Nu.0.00 (BTN)
                    display_wholesale_subscription_price: Nu.0.00 (BTN)
                  US:
                    id: 3247083
                    active: true
                    currency_code: USD
                    price: '156.0'
                    shipping: '1.0'
                    shipping_time: ''
                    subscription_price: '0.0'
                    wholesale: '0.0'
                    wholesale_subscription_price: '0.0'
                    cost_of_goods_sold: '0.0'
                    compare_price: '0.0'
                    display_price: $156.00 (USD)
                    display_subscription_price: $0.00 (USD)
                    display_wholesale: $0.00 (USD)
                    display_wholesale_subscription_price: $0.00 (USD)
    Data8:
      title: Data8
      required:
        - product
      type: object
      properties:
        product:
          allOf:
            - $ref: '#/components/schemas/Product6'
            - {}
      example:
        product:
          id: 7662
          slug: red-card_-copy-21dbe4e5-317c-4c3b-b766-0d9aff37679e
          category_id: null
          active: false
          status: draft
          title: null
          description: null
          introduction: null
          feature_text: null
          stripped: null
          review_count: 0
          sku: null
          upc: null
          hs_code: null
          image_url: https://cdn.filestackcontent.com/tJIUAm0Tlirjoz0B49mL
          compressed_image_url: null
          image_path: null
          external_url: ''
          price: '0.0'
          display_price: Rs.0.00 (NPR)
          subscription_price: '0.0'
          currency_code: NPR
          tax_category_id: 5364
          public: true
          in_stock: true
          keep_selling: true
          track_quantity: true
          no_index: false
          commission: '10.0'
          affiliate_commission: null
          integration_id: null
          external_id: null
          last_synced_at: null
          category: 'null'
          collections: []
          images:
            - id: 18755
              image_url: >-
                https://ik.imagekit.io/fluid/s3/FeSn4WD5TacQgqOoR1rL_images+%281%29.jpeg
              image_path: FeSn4WD5TacQgqOoR1rL_images+%281%29.jpeg
              position: 0
          options: []
          variants:
            - id: 29019
              is_master: true
              title: ''
              image_url: null
              buyable: true
              allow_subscription: true
              subscription_only: false
              shipping_included_in_price: false
              images: []
              variant_countries:
                NP:
                  id: 3247081
                  active: false
                  currency_code: NPR
                  price: '0.0'
                  shipping: '0.0'
                  shipping_time: null
                  subscription_price: '0.0'
                  wholesale: '0.0'
                  wholesale_subscription_price: '0.0'
                  cost_of_goods_sold: '0.0'
                  compare_price: '0.0'
                  display_price: Rs.0.00 (NPR)
                  display_subscription_price: Rs.0.00 (NPR)
                  display_wholesale: Rs.0.00 (NPR)
                  display_wholesale_subscription_price: Rs.0.00 (NPR)
                BT:
                  id: 3247082
                  active: true
                  currency_code: BTN
                  price: '156.0'
                  shipping: '1.0'
                  shipping_time: ''
                  subscription_price: '0.0'
                  wholesale: '0.0'
                  wholesale_subscription_price: '0.0'
                  cost_of_goods_sold: '0.0'
                  compare_price: '0.0'
                  display_price: Nu.156.00 (BTN)
                  display_subscription_price: Nu.0.00 (BTN)
                  display_wholesale: Nu.0.00 (BTN)
                  display_wholesale_subscription_price: Nu.0.00 (BTN)
                US:
                  id: 3247083
                  active: true
                  currency_code: USD
                  price: '156.0'
                  shipping: '1.0'
                  shipping_time: ''
                  subscription_price: '0.0'
                  wholesale: '0.0'
                  wholesale_subscription_price: '0.0'
                  cost_of_goods_sold: '0.0'
                  compare_price: '0.0'
                  display_price: $156.00 (USD)
                  display_subscription_price: $0.00 (USD)
                  display_wholesale: $0.00 (USD)
                  display_wholesale_subscription_price: $0.00 (USD)
    Product6:
      title: Product6
      required:
        - id
        - slug
        - category_id
        - active
        - status
        - title
        - description
        - introduction
        - feature_text
        - stripped
        - review_count
        - sku
        - upc
        - hs_code
        - image_url
        - compressed_image_url
        - image_path
        - external_url
        - price
        - display_price
        - subscription_price
        - currency_code
        - tax_category_id
        - public
        - in_stock
        - keep_selling
        - track_quantity
        - no_index
        - commission
        - affiliate_commission
        - integration_id
        - external_id
        - last_synced_at
        - category
        - collections
        - images
        - options
        - variants
      type: object
      properties:
        id:
          type: integer
          format: int32
        slug:
          type: string
        category_id:
          type: string
        active:
          type: boolean
        status:
          type: string
        title:
          type: string
        description:
          type: string
        introduction:
          type: string
        feature_text:
          type: string
        stripped:
          type: string
        review_count:
          type: integer
          format: int32
        sku:
          type: string
        upc:
          type: string
        hs_code:
          type: string
        image_url:
          type: string
        compressed_image_url:
          type: string
        image_path:
          type: string
        external_url:
          type: string
        price:
          type: string
        display_price:
          type: string
        subscription_price:
          type: string
        currency_code:
          type: string
        tax_category_id:
          type: integer
          format: int32
        public:
          type: boolean
        in_stock:
          type: boolean
        keep_selling:
          type: boolean
        track_quantity:
          type: boolean
        no_index:
          type: boolean
        commission:
          type: string
        affiliate_commission:
          type: string
        integration_id:
          type: string
        external_id:
          type: string
        last_synced_at:
          type: string
        category:
          type: string
        collections:
          type: array
          items:
            type: string
          description: ''
        images:
          type: array
          items:
            $ref: '#/components/schemas/Image2'
          description: ''
        options:
          type: array
          items:
            type: string
          description: ''
        variants:
          type: array
          items:
            $ref: '#/components/schemas/Variant1'
          description: ''
      example:
        id: 7662
        slug: red-card_-copy-21dbe4e5-317c-4c3b-b766-0d9aff37679e
        category_id: null
        active: false
        status: draft
        title: null
        description: null
        introduction: null
        feature_text: null
        stripped: null
        review_count: 0
        sku: null
        upc: null
        hs_code: null
        image_url: https://cdn.filestackcontent.com/tJIUAm0Tlirjoz0B49mL
        compressed_image_url: null
        image_path: null
        external_url: ''
        price: '0.0'
        display_price: Rs.0.00 (NPR)
        subscription_price: '0.0'
        currency_code: NPR
        tax_category_id: 5364
        public: true
        in_stock: true
        keep_selling: true
        track_quantity: true
        no_index: false
        commission: '10.0'
        affiliate_commission: null
        integration_id: null
        external_id: null
        last_synced_at: null
        category: 'null'
        collections: []
        images:
          - id: 18755
            image_url: >-
              https://ik.imagekit.io/fluid/s3/FeSn4WD5TacQgqOoR1rL_images+%281%29.jpeg
            image_path: FeSn4WD5TacQgqOoR1rL_images+%281%29.jpeg
            position: 0
        options: []
        variants:
          - id: 29019
            is_master: true
            title: ''
            image_url: null
            buyable: true
            allow_subscription: true
            subscription_only: false
            shipping_included_in_price: false
            images: []
            variant_countries:
              NP:
                id: 3247081
                active: false
                currency_code: NPR
                price: '0.0'
                shipping: '0.0'
                shipping_time: null
                subscription_price: '0.0'
                wholesale: '0.0'
                wholesale_subscription_price: '0.0'
                cost_of_goods_sold: '0.0'
                compare_price: '0.0'
                display_price: Rs.0.00 (NPR)
                display_subscription_price: Rs.0.00 (NPR)
                display_wholesale: Rs.0.00 (NPR)
                display_wholesale_subscription_price: Rs.0.00 (NPR)
              BT:
                id: 3247082
                active: true
                currency_code: BTN
                price: '156.0'
                shipping: '1.0'
                shipping_time: ''
                subscription_price: '0.0'
                wholesale: '0.0'
                wholesale_subscription_price: '0.0'
                cost_of_goods_sold: '0.0'
                compare_price: '0.0'
                display_price: Nu.156.00 (BTN)
                display_subscription_price: Nu.0.00 (BTN)
                display_wholesale: Nu.0.00 (BTN)
                display_wholesale_subscription_price: Nu.0.00 (BTN)
              US:
                id: 3247083
                active: true
                currency_code: USD
                price: '156.0'
                shipping: '1.0'
                shipping_time: ''
                subscription_price: '0.0'
                wholesale: '0.0'
                wholesale_subscription_price: '0.0'
                cost_of_goods_sold: '0.0'
                compare_price: '0.0'
                display_price: $156.00 (USD)
                display_subscription_price: $0.00 (USD)
                display_wholesale: $0.00 (USD)
                display_wholesale_subscription_price: $0.00 (USD)
    Image2:
      title: Image2
      required:
        - id
        - image_url
        - image_path
        - position
      type: object
      properties:
        id:
          type: integer
          format: int32
        image_url:
          type: string
        image_path:
          type: string
        position:
          type: integer
          format: int32
      example:
        id: 18755
        image_url: >-
          https://ik.imagekit.io/fluid/s3/FeSn4WD5TacQgqOoR1rL_images+%281%29.jpeg
        image_path: FeSn4WD5TacQgqOoR1rL_images+%281%29.jpeg
        position: 0
    destroy:
      title: destroy
      required:
        - status
        - data
      type: object
      properties:
        status:
          type: string
        data:
          allOf:
            - $ref: '#/components/schemas/Data4'
            - {}
      example:
        status: success
        data:
          message: product deleted
    index1:
      title: index1
      required:
        - status
        - data
      type: object
      properties:
        status:
          type: string
        data:
          allOf:
            - $ref: '#/components/schemas/Data10'
            - {}
      example:
        status: success
        data:
          collections:
            - id: 47
              title: Test Collection
              slug: test-collection-d33a2aa6-0e4b-4793-99bf-b241993fcabb
              description: null
              image_path: null
              image_url: null
              position: null
              public: true
            - id: 48
              title: Test Collection
              slug: test-collection-64c656e3-ae5b-4fd1-a981-d876e6f28130
              description: null
              image_path: null
              image_url: null
              position: null
              public: true
            - id: 50
              title: Test Collection 4
              slug: test-collection-4
              description: null
              image_path: null
              image_url: ''
              position: null
              public: true
    Data10:
      title: Data10
      required:
        - collections
      type: object
      properties:
        collections:
          type: array
          items:
            $ref: '#/components/schemas/Collection'
          description: ''
      example:
        collections:
          - id: 47
            title: Test Collection
            slug: test-collection-d33a2aa6-0e4b-4793-99bf-b241993fcabb
            description: null
            image_path: null
            image_url: null
            position: null
            public: true
          - id: 48
            title: Test Collection
            slug: test-collection-64c656e3-ae5b-4fd1-a981-d876e6f28130
            description: null
            image_path: null
            image_url: null
            position: null
            public: true
          - id: 50
            title: Test Collection 4
            slug: test-collection-4
            description: null
            image_path: null
            image_url: ''
            position: null
            public: true
    Collection:
      title: Collection
      required:
        - id
        - title
        - slug
        - description
        - image_path
        - image_url
        - position
        - public
      type: object
      properties:
        id:
          type: integer
          format: int32
        title:
          type: string
        slug:
          type: string
        description:
          type: string
        image_path:
          type: string
        image_url:
          type: string
        position:
          type: string
        public:
          type: boolean
      example:
        id: 47
        title: Test Collection
        slug: test-collection-d33a2aa6-0e4b-4793-99bf-b241993fcabb
        description: null
        image_path: null
        image_url: null
        position: null
        public: true
    show1:
      title: show1
      required:
        - status
        - data
      type: object
      properties:
        status:
          type: string
        data:
          allOf:
            - $ref: '#/components/schemas/Data12'
            - {}
      example:
        status: success
        data:
          collection:
            id: 49
            title: Test Collection
            slug: test-collection-3
            description: 'true'
            image_path: ''
            image_url: ''
            position: null
            public: false
    Data12:
      title: Data12
      required:
        - collection
      type: object
      properties:
        collection:
          allOf:
            - $ref: '#/components/schemas/Collection2'
            - {}
      example:
        collection:
          id: 49
          title: Test Collection
          slug: test-collection-3
          description: 'true'
          image_path: ''
          image_url: ''
          position: null
          public: false
    Collection2:
      title: Collection2
      required:
        - id
        - title
        - slug
        - description
        - image_path
        - image_url
        - position
        - public
      type: object
      properties:
        id:
          type: integer
          format: int32
        title:
          type: string
        slug:
          type: string
        description:
          type: string
        image_path:
          type: string
        image_url:
          type: string
        position:
          type: string
        public:
          type: boolean
      example:
        id: 49
        title: Test Collection
        slug: test-collection-3
        description: 'true'
        image_path: ''
        image_url: ''
        position: null
        public: false
    createrequest1:
      title: createrequest1
      required:
        - collection
      type: object
      properties:
        collection:
          allOf:
            - $ref: '#/components/schemas/Collection3'
            - {}
      example:
        collection:
          title: Test Collection FTW
          description: This is a great collection of incredible products!
          image_url: >-
            https://andapresent.com/row/images/0x0/auto/product-collection-banner_0a2rr1lv.jpg?v=1
          image_path: ''
          position: 3
          public: true
    Collection3:
      title: Collection3
      required:
        - title
        - description
        - image_url
        - image_path
        - position
        - public
      type: object
      properties:
        title:
          type: string
        description:
          type: string
        image_url:
          type: string
        image_path:
          type: string
        position:
          type: integer
          format: int32
        public:
          type: boolean
      example:
        title: Test Collection FTW
        description: This is a great collection of incredible products!
        image_url: >-
          https://andapresent.com/row/images/0x0/auto/product-collection-banner_0a2rr1lv.jpg?v=1
        image_path: ''
        position: 3
        public: true
    create1:
      title: create1
      required:
        - status
        - data
      type: object
      properties:
        status:
          type: string
        data:
          allOf:
            - $ref: '#/components/schemas/Data12'
            - {}
      example:
        status: success
        data:
          collection:
            id: 56
            title: Test Collection FTW
            slug: test-collection-ftw
            description: This is a great collection of incredible products!
            image_path: ''
            image_url: >-
              https://andapresent.com/row/images/0x0/auto/product-collection-banner_0a2rr1lv.jpg?v=1
            position: null
            public: false
    updaterequest1:
      title: updaterequest1
      required:
        - collection
      type: object
      properties:
        collection:
          allOf:
            - $ref: '#/components/schemas/Collection3'
            - {}
      example:
        collection:
          title: Test Collection FTW
          description: Collection is now public!
          image_url: ''
          image_path: ''
          position: 1
          public: true
    update1:
      title: update1
      required:
        - status
        - data
      type: object
      properties:
        status:
          type: string
        data:
          allOf:
            - $ref: '#/components/schemas/Data14'
            - {}
      example:
        status: success
        data:
          collection:
            id: 56
            title: Collection is now public!
            slug: test-collection-ftw
            description: This is a great collection of incredible products!
            image_path: ''
            image_url: >-
              https://andapresent.com/row/images/0x0/auto/product-collection-banner_0a2rr1lv.jpg?v=1
            position: 1
            public: true
    Data14:
      title: Data14
      required:
        - collection
      type: object
      properties:
        collection:
          allOf:
            - $ref: '#/components/schemas/Collection6'
            - {}
      example:
        collection:
          id: 56
          title: Collection is now public!
          slug: test-collection-ftw
          description: This is a great collection of incredible products!
          image_path: ''
          image_url: >-
            https://andapresent.com/row/images/0x0/auto/product-collection-banner_0a2rr1lv.jpg?v=1
          position: 1
          public: true
    Collection6:
      title: Collection6
      required:
        - id
        - title
        - slug
        - description
        - image_path
        - image_url
        - position
        - public
      type: object
      properties:
        id:
          type: integer
          format: int32
        title:
          type: string
        slug:
          type: string
        description:
          type: string
        image_path:
          type: string
        image_url:
          type: string
        position:
          type: integer
          format: int32
        public:
          type: boolean
      example:
        id: 56
        title: Collection is now public!
        slug: test-collection-ftw
        description: This is a great collection of incredible products!
        image_path: ''
        image_url: >-
          https://andapresent.com/row/images/0x0/auto/product-collection-banner_0a2rr1lv.jpg?v=1
        position: 1
        public: true
    createrequest2:
      title: createrequest2
      required:
        - warehouse
      type: object
      properties:
        warehouse:
          allOf:
            - $ref: '#/components/schemas/Warehouse'
            - {}
      example:
        warehouse:
          name: Test Warehouse
          active: true
          country_code: us
          address_attrubutes: {}
    Warehouse:
      title: Warehouse
      required:
        - name
        - active
        - country_code
        - address_attrubutes
      type: object
      properties:
        name:
          type: string
        active:
          type: boolean
        country_code:
          type: string
        address_attrubutes:
          type: object
      example:
        name: Test Warehouse
        active: true
        country_code: us
        address_attrubutes: {}
    index5:
      title: index5
      required:
        - status
        - data
      type: object
      properties:
        status:
          type: string
        data:
          allOf:
            - $ref: '#/components/schemas/Data22'
            - {}
      example:
        status: success
        data:
          categories:
            - id: 40
              title: Updated Category Title
              description: null
              public: false
              source_type: product
              image_url: ''
              position: 1
              parent_id: null
              has_children: true
              sub_categories:
                - id: 95
                  title: Test Sub Category
                  description: Another great category. Underneath "tops".
                  public: true
                  source_type: null
                  image_url: ''
                  position: 1
                  parent_id: 40
                  has_children: false
            - id: 96
              title: Another Category
              description: More great products
              public: true
              source_type: null
              image_url: ''
              position: 1
              parent_id: null
              has_children: false
              sub_categories: []
    Data22:
      title: Data22
      required:
        - categories
      type: object
      properties:
        categories:
          type: array
          items:
            $ref: '#/components/schemas/Category'
          description: ''
      example:
        categories:
          - id: 40
            title: Updated Category Title
            description: null
            public: false
            source_type: product
            image_url: ''
            position: 1
            parent_id: null
            has_children: true
            sub_categories:
              - id: 95
                title: Test Sub Category
                description: Another great category. Underneath "tops".
                public: true
                source_type: null
                image_url: ''
                position: 1
                parent_id: 40
                has_children: false
          - id: 96
            title: Another Category
            description: More great products
            public: true
            source_type: null
            image_url: ''
            position: 1
            parent_id: null
            has_children: false
            sub_categories: []
    Category:
      title: Category
      required:
        - id
        - title
        - description
        - public
        - source_type
        - image_url
        - position
        - parent_id
        - has_children
        - sub_categories
      type: object
      properties:
        id:
          type: integer
          format: int32
        title:
          type: string
        description:
          type: string
        public:
          type: boolean
        source_type:
          type: string
        image_url:
          type: string
        position:
          type: integer
          format: int32
        parent_id:
          type: string
        has_children:
          type: boolean
        sub_categories:
          type: array
          items:
            oneOf:
              - allOf:
                  - $ref: '#/components/schemas/SubCategory'
                  - example:
                      id: 95
                      title: Test Sub Category
                      description: Another great category. Underneath "tops".
                      public: true
                      source_type: null
                      image_url: ''
                      position: 1
                      parent_id: 40
                      has_children: false
              - type: string
          description: ''
      example:
        id: 40
        title: Updated Category Title
        description: null
        public: false
        source_type: product
        image_url: ''
        position: 1
        parent_id: null
        has_children: true
        sub_categories:
          - id: 95
            title: Test Sub Category
            description: Another great category. Underneath "tops".
            public: true
            source_type: null
            image_url: ''
            position: 1
            parent_id: 40
            has_children: false
    SubCategory:
      title: SubCategory
      type: object
      properties:
        id:
          type: integer
          format: int32
        title:
          type: string
        description:
          type: string
        public:
          type: boolean
        source_type:
          type: string
        image_url:
          type: string
        position:
          type: integer
          format: int32
        parent_id:
          type: integer
          format: int32
        has_children:
          type: boolean
      example:
        id: 95
        title: Test Sub Category
        description: Another great category. Underneath "tops".
        public: true
        source_type: null
        image_url: ''
        position: 1
        parent_id: 40
        has_children: false
    show3:
      title: show3
      required:
        - status
        - data
      type: object
      properties:
        status:
          type: string
        data:
          allOf:
            - $ref: '#/components/schemas/Data23'
            - {}
      example:
        status: success
        data:
          category:
            id: 40
            title: Updated Category Title
            description: null
            public: false
            source_type: product
            image_url: ''
            position: 1
            parent_id: null
            has_children: true
            sub_categories:
              - id: 95
                title: Test Sub Category
                description: Another great category. Underneath "tops".
                public: true
                source_type: null
                image_url: ''
                position: 1
                parent_id: 40
                has_children: false
              - id: 98
                title: Another Test Sub Category
                description: Another great category. Underneath "tops".
                public: true
                source_type: product
                image_url: ''
                position: 1
                parent_id: 40
                has_children: false
    Data23:
      title: Data23
      required:
        - category
      type: object
      properties:
        category:
          allOf:
            - $ref: '#/components/schemas/Category1'
            - {}
      example:
        category:
          id: 40
          title: Updated Category Title
          description: null
          public: false
          source_type: product
          image_url: ''
          position: 1
          parent_id: null
          has_children: true
          sub_categories:
            - id: 95
              title: Test Sub Category
              description: Another great category. Underneath "tops".
              public: true
              source_type: null
              image_url: ''
              position: 1
              parent_id: 40
              has_children: false
            - id: 98
              title: Another Test Sub Category
              description: Another great category. Underneath "tops".
              public: true
              source_type: product
              image_url: ''
              position: 1
              parent_id: 40
              has_children: false
    Category1:
      title: Category1
      required:
        - id
        - title
        - description
        - public
        - source_type
        - image_url
        - position
        - parent_id
        - has_children
        - sub_categories
      type: object
      properties:
        id:
          type: integer
          format: int32
        title:
          type: string
        description:
          type: string
        public:
          type: boolean
        source_type:
          type: string
        image_url:
          type: string
        position:
          type: integer
          format: int32
        parent_id:
          type: string
        has_children:
          type: boolean
        sub_categories:
          type: array
          items:
            $ref: '#/components/schemas/SubCategory2'
          description: ''
      example:
        id: 40
        title: Updated Category Title
        description: null
        public: false
        source_type: product
        image_url: ''
        position: 1
        parent_id: null
        has_children: true
        sub_categories:
          - id: 95
            title: Test Sub Category
            description: Another great category. Underneath "tops".
            public: true
            source_type: null
            image_url: ''
            position: 1
            parent_id: 40
            has_children: false
          - id: 98
            title: Another Test Sub Category
            description: Another great category. Underneath "tops".
            public: true
            source_type: product
            image_url: ''
            position: 1
            parent_id: 40
            has_children: false
    SubCategory2:
      title: SubCategory2
      required:
        - id
        - title
        - description
        - public
        - source_type
        - image_url
        - position
        - parent_id
        - has_children
      type: object
      properties:
        id:
          type: integer
          format: int32
        title:
          type: string
        description:
          type: string
        public:
          type: boolean
        source_type:
          type: string
        image_url:
          type: string
        position:
          type: integer
          format: int32
        parent_id:
          type: integer
          format: int32
        has_children:
          type: boolean
      example:
        id: 95
        title: Test Sub Category
        description: Another great category. Underneath "tops".
        public: true
        source_type: null
        image_url: ''
        position: 1
        parent_id: 40
        has_children: false
    createrequest3:
      title: createrequest3
      required:
        - category
      type: object
      properties:
        category:
          allOf:
            - $ref: '#/components/schemas/Category2'
            - {}
      example:
        category:
          title: Another Test Sub Category
          description: Another great category. Underneath "tops".
          image_url: ''
          position: 1
          public: true
          parent_id: 40
    Category2:
      title: Category2
      required:
        - title
        - description
        - image_url
        - position
        - public
        - parent_id
      type: object
      properties:
        title:
          type: string
        description:
          type: string
        image_url:
          type: string
        position:
          type: integer
          format: int32
        public:
          type: boolean
        parent_id:
          type: integer
          format: int32
      example:
        title: Another Test Sub Category
        description: Another great category. Underneath "tops".
        image_url: ''
        position: 1
        public: true
        parent_id: 40
    create3:
      title: create3
      required:
        - status
        - data
      type: object
      properties:
        status:
          type: string
        data:
          allOf:
            - $ref: '#/components/schemas/Data24'
            - {}
      example:
        status: success
        data:
          category:
            id: 98
            title: Another Test Sub Category
            description: Another great category. Underneath "tops".
            public: true
            source_type: product
            image_url: ''
            position: 1
            parent_id: 40
            has_children: false
    Data24:
      title: Data24
      required:
        - category
      type: object
      properties:
        category:
          allOf:
            - $ref: '#/components/schemas/Category3'
            - {}
      example:
        category:
          id: 98
          title: Another Test Sub Category
          description: Another great category. Underneath "tops".
          public: true
          source_type: product
          image_url: ''
          position: 1
          parent_id: 40
          has_children: false
    Category3:
      title: Category3
      required:
        - id
        - title
        - description
        - public
        - source_type
        - image_url
        - position
        - parent_id
        - has_children
      type: object
      properties:
        id:
          type: integer
          format: int32
        title:
          type: string
        description:
          type: string
        public:
          type: boolean
        source_type:
          type: string
        image_url:
          type: string
        position:
          type: integer
          format: int32
        parent_id:
          type: integer
          format: int32
        has_children:
          type: boolean
      example:
        id: 98
        title: Another Test Sub Category
        description: Another great category. Underneath "tops".
        public: true
        source_type: product
        image_url: ''
        position: 1
        parent_id: 40
        has_children: false
    updaterequest3:
      title: updaterequest3
      required:
        - category
      type: object
      properties:
        category:
          allOf:
            - $ref: '#/components/schemas/Category4'
            - {}
      example:
        category:
          title: Updated Category Title
          description: your description
          image_url: ''
          position: 10
          public: true
          parent_id: null
    Category4:
      title: Category4
      required:
        - title
        - description
        - image_url
        - position
        - public
        - parent_id
      type: object
      properties:
        title:
          type: string
        description:
          type: string
        image_url:
          type: string
        position:
          type: integer
          format: int32
        public:
          type: boolean
        parent_id:
          type: string
      example:
        title: Updated Category Title
        description: your description
        image_url: ''
        position: 10
        public: true
        parent_id: null
    update3:
      title: update3
      required:
        - status
        - data
      type: object
      properties:
        status:
          type: string
        data:
          allOf:
            - $ref: '#/components/schemas/Data25'
            - {}
      example:
        status: success
        data:
          category:
            id: 40
            title: Updated Category Title
            description: null
            public: false
            source_type: product
            image_url: ''
            position: 1
            parent_id: null
            has_children: true
    Data25:
      title: Data25
      required:
        - category
      type: object
      properties:
        category:
          allOf:
            - $ref: '#/components/schemas/Category5'
            - {}
      example:
        category:
          id: 40
          title: Updated Category Title
          description: null
          public: false
          source_type: product
          image_url: ''
          position: 1
          parent_id: null
          has_children: true
    Category5:
      title: Category5
      required:
        - id
        - title
        - description
        - public
        - source_type
        - image_url
        - position
        - parent_id
        - has_children
      type: object
      properties:
        id:
          type: integer
          format: int32
        title:
          type: string
        description:
          type: string
        public:
          type: boolean
        source_type:
          type: string
        image_url:
          type: string
        position:
          type: integer
          format: int32
        parent_id:
          type: string
        has_children:
          type: boolean
      example:
        id: 40
        title: Updated Category Title
        description: null
        public: false
        source_type: product
        image_url: ''
        position: 1
        parent_id: null
        has_children: true
    updaterequest4:
      title: updaterequest4
      required:
        - event_id
        - date
        - customer_code
        - currency_code
        - country_code
        - ip
        - abandoned
        - amount_total
        - sub_total
        - tax_total
        - shipping_total
        - discount_total
        - cv_total
        - qv_total
        - fulfillment
        - payment_token
        - payment_total
        - repeat_order
        - shipping_options
        - customer
        - sponsor
        - addresses
        - discounts
        - lines
      type: object
      properties:
        event_id:
          type: string
        date:
          type: string
        customer_code:
          type: string
        currency_code:
          type: string
        country_code:
          type: string
        ip:
          type: string
        abandoned:
          type: string
        amount_total:
          type: number
        sub_total:
          type: integer
          format: int32
        tax_total:
          type: number
        shipping_total:
          type: integer
          format: int32
        discount_total:
          type: number
        cv_total:
          type: integer
          format: int32
        qv_total:
          type: integer
          format: int32
        fulfillment:
          type: string
        payment_token:
          type: string
        payment_total:
          type: number
        repeat_order:
          type: boolean
        shipping_options:
          type: array
          items:
            $ref: '#/components/schemas/ShippingOption'
          description: ''
        customer:
          allOf:
            - $ref: '#/components/schemas/Customer'
            - {}
        sponsor:
          allOf:
            - $ref: '#/components/schemas/Sponsor'
            - {}
        addresses:
          allOf:
            - $ref: '#/components/schemas/Addresses'
            - {}
        discounts:
          type: array
          items:
            type: string
          description: ''
        lines:
          type: array
          items:
            $ref: '#/components/schemas/Line'
          description: ''
    ShippingOption:
      title: ShippingOption
      required:
        - code
        - name
        - price
        - delivery_date
        - surcharge
      type: object
      properties:
        code:
          type: string
        name:
          type: string
        price:
          oneOf:
            - type: integer
              format: int32
            - type: number
        delivery_date:
          type: string
        surcharge:
          type: integer
          format: int32
    Customer:
      title: Customer
      required:
        - id
        - first_name
        - last_name
        - email
        - country
        - phone
        - affiliate
      type: object
      properties:
        id:
          type: integer
          format: int32
        first_name:
          type: string
        last_name:
          type: string
        email:
          type: string
        country:
          type: string
        phone:
          type: string
        affiliate:
          type: boolean
      example:
        id: 32
        first_name: Subas
        last_name: Poudel
        email: danphecoder@gmail.com
        country: NP
        phone: ''
        affiliate: false
    Sponsor:
      title: Sponsor
      required:
        - id
        - first_name
        - email
        - phone
        - country
        - active
      type: object
      properties:
        id:
          type: integer
          format: int32
        first_name:
          type: string
        email:
          type: string
        phone:
          type: string
        country:
          type: string
        active:
          type: boolean
      example:
        id: 44
        first_name: Ankeet
        email: ankeet@isawesome.com
        phone: ''
        country: NP
        active: true
    Addresses:
      title: Addresses
      required:
        - ship_to
        - bill_to
      type: object
      properties:
        ship_to:
          allOf:
            - $ref: '#/components/schemas/ShipTo'
            - {}
        bill_to:
          allOf:
            - $ref: '#/components/schemas/BillTo'
            - {}
      example:
        ship_to:
          name: Customer Name
          address1: 1145 S 800 E Ste 110
          address2: line 2
          city: Orem
          state: UT
          postal_code: 84097-7227
          country_code: US
        bill_to:
          name: Customer Name
          address1: 1145 S 800 E Ste 110
          address2: line 2
          city: Orem
          state: UT
          postal_code: 84097-7227
          country_code: US
    ShipTo:
      title: ShipTo
      required:
        - name
        - address1
        - address2
        - city
        - state
        - postal_code
        - country_code
      type: object
      properties:
        name:
          type: string
        address1:
          type: string
        address2:
          type: string
        city:
          type: string
        state:
          type: string
        postal_code:
          type: string
        country_code:
          type: string
      example:
        name: Customer Name
        address1: 1145 S 800 E Ste 110
        address2: line 2
        city: Orem
        state: UT
        postal_code: 84097-7227
        country_code: US
    BillTo:
      title: BillTo
      required:
        - name
        - address1
        - address2
        - city
        - state
        - postal_code
        - country_code
      type: object
      properties:
        name:
          type: string
        address1:
          type: string
        address2:
          type: string
        city:
          type: string
        state:
          type: string
        postal_code:
          type: string
        country_code:
          type: string
      example:
        name: Customer Name
        address1: 1145 S 800 E Ste 110
        address2: line 2
        city: Orem
        state: UT
        postal_code: 84097-7227
        country_code: US
    Line:
      title: Line
      required:
        - quantity
        - external_id
        - variant
      type: object
      properties:
        quantity:
          type: integer
          format: int32
        external_id:
          type: string
        variant:
          allOf:
            - $ref: '#/components/schemas/Variant5'
            - {}
      example:
        quantity: 1
        external_id: '2481'
        variant:
          id: 27265
          options:
            - id: 1
              type: size
              value: large
              presentation: Large
    Variant5:
      title: Variant5
      required:
        - id
        - options
      type: object
      properties:
        id:
          type: integer
          format: int32
        options:
          type: array
          items:
            $ref: '#/components/schemas/Option'
          description: ''
      example:
        id: 27265
        options:
          - id: 1
            type: size
            value: large
            presentation: Large
    Option:
      title: Option
      required:
        - id
        - type
        - value
        - presentation
      type: object
      properties:
        id:
          type: integer
          format: int32
        type:
          type: string
        value:
          type: string
        presentation:
          type: string
      example:
        id: 1
        type: size
        value: large
        presentation: Large
    update4:
      title: update4
      required:
        - cart
      type: object
      properties:
        cart:
          allOf:
            - $ref: '#/components/schemas/Cart'
            - {}
      example:
        cart:
          date: '2023-12-19T09:01:17.190Z'
          customer_code: 7319
          currency_code: USD
          country_code: USA
          ip: 139.5.71.59
          abandoned: null
          source: web
          total: '38.23'
          sub_total: '20.0'
          tax_total: '10.23'
          shipping_total: '0.0'
          enrollment_fee: 0
          discount_total: 0
          cv_total: 0
          fulfillment: fedex-ground
          payment_token: null
          payment_total: '28.0'
          subscription: false
          customer:
            email: null
            external_id: null
          sponsor: {}
          addresses:
            ship_to:
              name: Customer Name
              line1: 1145 S 800 E Ste 110
              line2: line 2
              city: Orem
              region: UT
              postal_code: 84097-7227
              country: US
            bill_to:
              name: Customer Name
              line1: 1145 S 800 E Ste 110
              line2: line 2
              city: Orem
              region: UT
              postal_code: 84097-7227
              country: US
          lines:
            - id: 2481
              images:
                - >-
                  https://ik.imagekit.io/fluid/s3/NjRJdhqcSR2b9QWyWDIz_Man_T-shirt.jpg
              item_id: 8305
              item_code: ''
              title: Man T-shirt
              description: what is this tshirt all about. Is it good or is it bad
              quantity: 1
              amount: 20
              tax_code: PF050621
              subscription: false
              cv: 0
              qv: 0
              tax: '0.0'
              shipping: '0.0'
              prices:
                price: '20.0'
                subscription_price: '10.0'
                wholesale: '0.0'
                wholesale_subscription_price: '0.0'
              stock: 2
              track_stock: true
              variant:
                id: 27265
                display: L
                options:
                  - id: 39
                    type: size
                    value: l
                    presentation: L
          cart_token: HuSmS99wrjLfeehQgYLMjKHG
          cart_id: 6583
    Cart:
      title: Cart
      required:
        - date
        - customer_code
        - currency_code
        - country_code
        - ip
        - abandoned
        - source
        - total
        - sub_total
        - tax_total
        - shipping_total
        - enrollment_fee
        - discount_total
        - cv_total
        - fulfillment
        - payment_token
        - payment_total
        - subscription
        - customer
        - sponsor
        - addresses
        - lines
        - cart_token
        - cart_id
      type: object
      properties:
        date:
          type: string
        customer_code:
          type: integer
          format: int32
        currency_code:
          type: string
        country_code:
          type: string
        ip:
          type: string
        abandoned:
          type: string
        source:
          type: string
        total:
          type: string
        sub_total:
          type: string
        tax_total:
          type: string
        shipping_total:
          type: string
        enrollment_fee:
          type: integer
          format: int32
        discount_total:
          type: integer
          format: int32
        cv_total:
          type: integer
          format: int32
        fulfillment:
          type: string
        payment_token:
          type: string
        payment_total:
          type: string
        subscription:
          type: boolean
        customer:
          allOf:
            - $ref: '#/components/schemas/Customer1'
            - {}
        sponsor:
          type: object
        addresses:
          allOf:
            - $ref: '#/components/schemas/Addresses1'
            - {}
        lines:
          type: array
          items:
            $ref: '#/components/schemas/Line1'
          description: ''
        cart_token:
          type: string
        cart_id:
          type: integer
          format: int32
      example:
        date: '2023-12-19T09:01:17.190Z'
        customer_code: 7319
        currency_code: USD
        country_code: USA
        ip: 139.5.71.59
        abandoned: null
        source: web
        total: '38.23'
        sub_total: '20.0'
        tax_total: '10.23'
        shipping_total: '0.0'
        enrollment_fee: 0
        discount_total: 0
        cv_total: 0
        fulfillment: fedex-ground
        payment_token: null
        payment_total: '28.0'
        subscription: false
        customer:
          email: null
          external_id: null
        sponsor: {}
        addresses:
          ship_to:
            name: Customer Name
            line1: 1145 S 800 E Ste 110
            line2: line 2
            city: Orem
            region: UT
            postal_code: 84097-7227
            country: US
          bill_to:
            name: Customer Name
            line1: 1145 S 800 E Ste 110
            line2: line 2
            city: Orem
            region: UT
            postal_code: 84097-7227
            country: US
        lines:
          - id: 2481
            images:
              - >-
                https://ik.imagekit.io/fluid/s3/NjRJdhqcSR2b9QWyWDIz_Man_T-shirt.jpg
            item_id: 8305
            item_code: ''
            title: Man T-shirt
            description: what is this tshirt all about. Is it good or is it bad
            quantity: 1
            amount: 20
            tax_code: PF050621
            subscription: false
            cv: 0
            qv: 0
            tax: '0.0'
            shipping: '0.0'
            prices:
              price: '20.0'
              subscription_price: '10.0'
              wholesale: '0.0'
              wholesale_subscription_price: '0.0'
            stock: 2
            track_stock: true
            variant:
              id: 27265
              display: L
              options:
                - id: 39
                  type: size
                  value: l
                  presentation: L
        cart_token: HuSmS99wrjLfeehQgYLMjKHG
        cart_id: 6583
    Customer1:
      title: Customer1
      required:
        - email
        - external_id
      type: object
      properties:
        email:
          type: string
        external_id:
          type: string
      example:
        email: null
        external_id: null
    Addresses1:
      title: Addresses1
      required:
        - ship_to
        - bill_to
      type: object
      properties:
        ship_to:
          allOf:
            - $ref: '#/components/schemas/ShipTo1'
            - {}
        bill_to:
          allOf:
            - $ref: '#/components/schemas/BillTo1'
            - {}
      example:
        ship_to:
          name: Customer Name
          line1: 1145 S 800 E Ste 110
          line2: line 2
          city: Orem
          region: UT
          postal_code: 84097-7227
          country: US
        bill_to:
          name: Customer Name
          line1: 1145 S 800 E Ste 110
          line2: line 2
          city: Orem
          region: UT
          postal_code: 84097-7227
          country: US
    ShipTo1:
      title: ShipTo1
      required:
        - name
        - line1
        - line2
        - city
        - region
        - postal_code
        - country
      type: object
      properties:
        name:
          type: string
        line1:
          type: string
        line2:
          type: string
        city:
          type: string
        region:
          type: string
        postal_code:
          type: string
        country:
          type: string
      example:
        name: Customer Name
        line1: 1145 S 800 E Ste 110
        line2: line 2
        city: Orem
        region: UT
        postal_code: 84097-7227
        country: US
    BillTo1:
      title: BillTo1
      required:
        - name
        - line1
        - line2
        - city
        - region
        - postal_code
        - country
      type: object
      properties:
        name:
          type: string
        line1:
          type: string
        line2:
          type: string
        city:
          type: string
        region:
          type: string
        postal_code:
          type: string
        country:
          type: string
      example:
        name: Customer Name
        line1: 1145 S 800 E Ste 110
        line2: line 2
        city: Orem
        region: UT
        postal_code: 84097-7227
        country: US
    Line1:
      title: Line1
      required:
        - id
        - images
        - item_id
        - item_code
        - title
        - description
        - quantity
        - amount
        - tax_code
        - subscription
        - cv
        - qv
        - tax
        - shipping
        - prices
        - stock
        - track_stock
        - variant
      type: object
      properties:
        id:
          type: integer
          format: int32
        images:
          type: array
          items:
            type: string
          description: ''
        item_id:
          type: integer
          format: int32
        item_code:
          type: string
        title:
          type: string
        description:
          type: string
        quantity:
          type: integer
          format: int32
        amount:
          type: integer
          format: int32
        tax_code:
          type: string
        subscription:
          type: boolean
        cv:
          type: integer
          format: int32
        qv:
          type: integer
          format: int32
        tax:
          type: string
        shipping:
          type: string
        prices:
          allOf:
            - $ref: '#/components/schemas/Prices'
            - {}
        stock:
          type: integer
          format: int32
        track_stock:
          type: boolean
        variant:
          allOf:
            - $ref: '#/components/schemas/Variant6'
            - {}
      example:
        id: 2481
        images:
          - https://ik.imagekit.io/fluid/s3/NjRJdhqcSR2b9QWyWDIz_Man_T-shirt.jpg
        item_id: 8305
        item_code: ''
        title: Man T-shirt
        description: what is this tshirt all about. Is it good or is it bad
        quantity: 1
        amount: 20
        tax_code: PF050621
        subscription: false
        cv: 0
        qv: 0
        tax: '0.0'
        shipping: '0.0'
        prices:
          price: '20.0'
          subscription_price: '10.0'
          wholesale: '0.0'
          wholesale_subscription_price: '0.0'
        stock: 2
        track_stock: true
        variant:
          id: 27265
          display: L
          options:
            - id: 39
              type: size
              value: l
              presentation: L
    Prices:
      title: Prices
      required:
        - price
        - subscription_price
        - wholesale
        - wholesale_subscription_price
      type: object
      properties:
        price:
          type: string
        subscription_price:
          type: string
        wholesale:
          type: string
        wholesale_subscription_price:
          type: string
      example:
        price: '20.0'
        subscription_price: '10.0'
        wholesale: '0.0'
        wholesale_subscription_price: '0.0'
    Variant6:
      title: Variant6
      required:
        - id
        - display
        - options
      type: object
      properties:
        id:
          type: integer
          format: int32
        display:
          type: string
        options:
          type: array
          items:
            $ref: '#/components/schemas/Option'
          description: ''
      example:
        id: 27265
        display: L
        options:
          - id: 39
            type: size
            value: l
            presentation: L
    index6:
      title: index6
      required:
        - id
        - external_id
        - username
        - active
        - affiliate
        - user
      type: object
      properties:
        id:
          type: integer
          format: int32
        external_id:
          type: string
        username:
          type: string
        active:
          type: boolean
        affiliate:
          type: object
        user:
          allOf:
            - $ref: '#/components/schemas/User'
            - {}
      example:
        id: 3470
        external_id: null
        username: null
        active: true
        affiliate: {}
        user:
          email: pralishkayastha@gmail.com
          first_name: Yucatán
          last_name: résumé
          avatar: null
          phone: null
          google_id: null
          bio: null
          facebook: null
          instagram: null
          twitter: null
          linkedin: null
          whatsapp: null
          wechat: null
          youtube: null
          zip_code: null
          dob: null
          gender: null
          time_zone: null
          language:
            name: English
            iso: en
          country:
            name: United States
            iso: US
    User:
      title: User
      required:
        - email
        - first_name
        - last_name
        - avatar
        - phone
        - google_id
        - bio
        - facebook
        - instagram
        - twitter
        - linkedin
        - whatsapp
        - wechat
        - youtube
        - zip_code
        - dob
        - gender
        - time_zone
        - language
        - country
      type: object
      properties:
        email:
          type: string
        first_name:
          type: string
        last_name:
          type: string
        avatar:
          type: string
        phone:
          type: string
        google_id:
          type: string
        bio:
          type: string
        facebook:
          type: string
        instagram:
          type: string
        twitter:
          type: string
        linkedin:
          type: string
        whatsapp:
          type: string
        wechat:
          type: string
        youtube:
          type: string
        zip_code:
          type: string
        dob:
          type: string
        gender:
          type: string
        time_zone:
          type: string
        language:
          allOf:
            - $ref: '#/components/schemas/Language'
            - {}
        country:
          oneOf:
            - allOf:
                - oneOf:
                    - type: 'null'
                    - $ref: '#/components/schemas/Country'
                - example:
                    name: United States
                    iso: US
            - type: string
            - type: 'null'
      example:
        email: pralishkayastha@gmail.com
        first_name: Yucatán
        last_name: résumé
        avatar: null
        phone: null
        google_id: null
        bio: null
        facebook: null
        instagram: null
        twitter: null
        linkedin: null
        whatsapp: null
        wechat: null
        youtube: null
        zip_code: null
        dob: null
        gender: null
        time_zone: null
        language:
          name: English
          iso: en
        country:
          name: United States
          iso: US
    Language:
      title: Language
      required:
        - name
        - iso
      type: object
      properties:
        name:
          type: string
        iso:
          type: string
      example:
        name: English
        iso: en
    Country:
      title: Country
      type: object
      properties:
        name:
          type: string
        iso:
          type: string
      example:
        name: United States
        iso: US
    createrequest4:
      title: createrequest4
      required:
        - affiliate
        - username
        - active
        - email
        - first_name
        - last_name
        - avatar
        - phone
        - google_id
        - bio
        - facebook
        - instagram
        - twitter
        - linkedin
        - whatsapp
        - wechat
        - youtube
        - zip_code
        - dob
        - gender
        - time_zone
        - push_notifications
        - email_notifications
        - sms_notifications
        - language_code
        - country_code
      type: object
      properties:
        affiliate:
          allOf:
            - $ref: '#/components/schemas/Affiliate'
            - {}
        username:
          type: string
        active:
          type: boolean
        email:
          type: string
        first_name:
          type: string
        last_name:
          type: string
        password:
          type: string
          description: >-
            Password for the user. This will be assigned if the User does not
            exist yet or if they do not have a password set.
        avatar:
          type: string
        phone:
          type: string
        google_id:
          type: string
        bio:
          type: string
        facebook:
          type: string
        instagram:
          type: string
        twitter:
          type: string
        linkedin:
          type: string
        whatsapp:
          type: string
        wechat:
          type: string
        youtube:
          type: string
        zip_code:
          type: string
        dob:
          type: string
        gender:
          type: string
        time_zone:
          type: string
        push_notifications:
          type: string
        email_notifications:
          type: string
        sms_notifications:
          type: string
        language_code:
          type: string
        country_code:
          type: string
      example:
        affiliate:
          id: null
          external_id: null
          username: sammysample12
          email: null
        username: ''
        active: true
        email: juliete1411232@google.com
        first_name: fussname
        last_name: lassname
        password: ''
        avatar: ''
        phone: ''
        google_id: ''
        bio: ''
        facebook: ''
        instagram: ''
        twitter: ''
        linkedin: ''
        whatsapp: ''
        wechat: ''
        youtube: ''
        zip_code: ''
        dob: ''
        gender: ''
        time_zone: ''
        push_notifications: ''
        email_notifications: ''
        sms_notifications: ''
        language_code: en
        country_code: US
    Affiliate:
      title: Affiliate
      required:
        - id
        - external_id
        - username
        - email
      type: object
      properties:
        id:
          type: string
        external_id:
          type: string
        username:
          type: string
        email:
          type: string
      example:
        id: null
        external_id: null
        username: sammysample12
        email: null
    create4:
      title: create4
      required:
        - id
        - external_id
        - username
        - active
        - affiliate
        - user
      type: object
      properties:
        id:
          type: integer
          format: int32
        external_id:
          type: string
        username:
          type: string
        active:
          type: boolean
        affiliate:
          type: object
        user:
          allOf:
            - $ref: '#/components/schemas/User1'
            - {}
      example:
        id: 3477
        external_id: ''
        username: ''
        active: true
        affiliate: {}
        user:
          email: juliete1411232@google.com
          first_name: fussname
          last_name: lassname
          avatar: ''
          phone: ''
          google_id: ''
          bio: ''
          facebook: ''
          instagram: ''
          twitter: ''
          linkedin: ''
          whatsapp: ''
          wechat: ''
          youtube: ''
          zip_code: ''
          dob: null
          gender: ''
          time_zone: ''
          language:
            name: English
            iso: en
          country:
            name: United States
            iso: US
    User1:
      title: User1
      required:
        - email
        - first_name
        - last_name
        - avatar
        - phone
        - google_id
        - bio
        - facebook
        - instagram
        - twitter
        - linkedin
        - whatsapp
        - wechat
        - youtube
        - zip_code
        - dob
        - gender
        - time_zone
        - language
        - country
      type: object
      properties:
        email:
          type: string
        first_name:
          type: string
        last_name:
          type: string
        avatar:
          type: string
        phone:
          type: string
        google_id:
          type: string
        bio:
          type: string
        facebook:
          type: string
        instagram:
          type: string
        twitter:
          type: string
        linkedin:
          type: string
        whatsapp:
          type: string
        wechat:
          type: string
        youtube:
          type: string
        zip_code:
          type: string
        dob:
          type: string
        gender:
          type: string
        time_zone:
          type: string
        language:
          allOf:
            - $ref: '#/components/schemas/Language'
            - {}
        country:
          allOf:
            - $ref: '#/components/schemas/Country2'
            - {}
      example:
        email: juliete1411232@google.com
        first_name: fussname
        last_name: lassname
        avatar: ''
        phone: ''
        google_id: ''
        bio: ''
        facebook: ''
        instagram: ''
        twitter: ''
        linkedin: ''
        whatsapp: ''
        wechat: ''
        youtube: ''
        zip_code: ''
        dob: null
        gender: ''
        time_zone: ''
        language:
          name: English
          iso: en
        country:
          name: United States
          iso: US
    Country2:
      title: Country2
      required:
        - name
        - iso
      type: object
      properties:
        name:
          type: string
        iso:
          type: string
      example:
        name: United States
        iso: US
    show4:
      title: show4
      required:
        - id
        - external_id
        - username
        - active
        - affiliate
        - user
      type: object
      properties:
        id:
          type: integer
          format: int32
        external_id:
          type: string
        username:
          type: string
        active:
          type: boolean
        affiliate:
          type: object
        user:
          allOf:
            - $ref: '#/components/schemas/User2'
            - {}
      example:
        id: 3470
        external_id: null
        username: null
        active: true
        affiliate: {}
        user:
          email: pralishkayastha@gmail.com
          first_name: Yucatán
          last_name: résumé
          avatar: null
          phone: null
          google_id: null
          bio: null
          facebook: null
          instagram: null
          twitter: null
          linkedin: null
          whatsapp: null
          wechat: null
          youtube: null
          zip_code: null
          dob: null
          gender: null
          time_zone: null
          language:
            name: English
            iso: en
          country:
            name: United States
            iso: US
    User2:
      title: User2
      required:
        - email
        - first_name
        - last_name
        - avatar
        - phone
        - google_id
        - bio
        - facebook
        - instagram
        - twitter
        - linkedin
        - whatsapp
        - wechat
        - youtube
        - zip_code
        - dob
        - gender
        - time_zone
        - language
        - country
      type: object
      properties:
        email:
          type: string
        first_name:
          type: string
        last_name:
          type: string
        avatar:
          type: string
        phone:
          type: string
        google_id:
          type: string
        bio:
          type: string
        facebook:
          type: string
        instagram:
          type: string
        twitter:
          type: string
        linkedin:
          type: string
        whatsapp:
          type: string
        wechat:
          type: string
        youtube:
          type: string
        zip_code:
          type: string
        dob:
          type: string
        gender:
          type: string
        time_zone:
          type: string
        language:
          allOf:
            - $ref: '#/components/schemas/Language'
            - {}
        country:
          allOf:
            - $ref: '#/components/schemas/Country2'
            - {}
      example:
        email: pralishkayastha@gmail.com
        first_name: Yucatán
        last_name: résumé
        avatar: null
        phone: null
        google_id: null
        bio: null
        facebook: null
        instagram: null
        twitter: null
        linkedin: null
        whatsapp: null
        wechat: null
        youtube: null
        zip_code: null
        dob: null
        gender: null
        time_zone: null
        language:
          name: English
          iso: en
        country:
          name: United States
          iso: US
    updaterequest5:
      title: updaterequest5
      required:
        - affiliate
        - first_name
        - last_name
        - avatar
        - phone
        - google_id
        - bio
        - facebook
        - instagram
        - twitter
        - linkedin
        - whatsapp
        - wechat
        - youtube
        - zip_code
        - dob
        - gender
        - time_zone
        - push_notifications
        - email_notifications
        - sms_notifications
      type: object
      properties:
        affiliate:
          allOf:
            - $ref: '#/components/schemas/Affiliate1'
            - {}
        first_name:
          type: string
        last_name:
          type: string
        avatar:
          type: string
        phone:
          type: string
        google_id:
          type: string
        bio:
          type: string
        facebook:
          type: string
        instagram:
          type: string
        twitter:
          type: string
        linkedin:
          type: string
        whatsapp:
          type: string
        wechat:
          type: string
        youtube:
          type: string
        zip_code:
          type: string
        dob:
          type: string
        gender:
          type: string
        time_zone:
          type: string
        push_notifications:
          type: string
        email_notifications:
          type: string
        sms_notifications:
          type: string
      example:
        affiliate:
          id: 3355
          external_id: null
          username: null
          email: null
        first_name: testfirst
        last_name: testlast
        avatar: ''
        phone: '+14844145967'
        google_id: julies.home
        bio: hi im jules
        facebook: jle
        instagram: jules
        twitter: jj
        linkedin: ju
        whatsapp: ul
        wechat: '9865326598'
        youtube: juleshome
        zip_code: '97655'
        dob: '1997-08-08'
        gender: female
        time_zone: CST
        push_notifications: ''
        email_notifications: ''
        sms_notifications: ''
    Affiliate1:
      title: Affiliate1
      required:
        - id
        - external_id
        - username
        - email
      type: object
      properties:
        id:
          type: integer
          format: int32
        external_id:
          type: string
        username:
          type: string
        email:
          type: string
      example:
        id: 3355
        external_id: null
        username: null
        email: null
    update5:
      title: update5
      required:
        - id
        - external_id
        - username
        - active
        - affiliate
        - user
      type: object
      properties:
        id:
          type: integer
          format: int32
        external_id:
          type: string
        username:
          type: string
        active:
          type: boolean
        affiliate:
          allOf:
            - $ref: '#/components/schemas/Affiliate2'
            - {}
        user:
          allOf:
            - $ref: '#/components/schemas/User3'
            - {}
      example:
        id: 3484
        external_id: null
        username: ''
        active: true
        affiliate:
          id: 3355
          email: nitesh@tester.com
        user:
          email: juliete1411232111@google.com
          first_name: testfirst
          last_name: testlast
          avatar: ''
          phone: '+14844145967'
          google_id: julies.home
          bio: hi im jules
          facebook: jle
          instagram: jules
          twitter: jj
          linkedin: ju
          whatsapp: ul
          wechat: '9865326598'
          youtube: juleshome
          zip_code: '97655'
          dob: '1997-08-08'
          gender: female
          time_zone: CST
          language:
            name: English
            iso: en
          country:
            name: United States
            iso: US
    Affiliate2:
      title: Affiliate2
      required:
        - id
        - email
      type: object
      properties:
        id:
          type: integer
          format: int32
        email:
          type: string
      example:
        id: 3355
        email: nitesh@tester.com
    User3:
      title: User3
      required:
        - email
        - first_name
        - last_name
        - avatar
        - phone
        - google_id
        - bio
        - facebook
        - instagram
        - twitter
        - linkedin
        - whatsapp
        - wechat
        - youtube
        - zip_code
        - dob
        - gender
        - time_zone
        - language
        - country
      type: object
      properties:
        email:
          type: string
        first_name:
          type: string
        last_name:
          type: string
        avatar:
          type: string
        phone:
          type: string
        google_id:
          type: string
        bio:
          type: string
        facebook:
          type: string
        instagram:
          type: string
        twitter:
          type: string
        linkedin:
          type: string
        whatsapp:
          type: string
        wechat:
          type: string
        youtube:
          type: string
        zip_code:
          type: string
        dob:
          type: string
        gender:
          type: string
        time_zone:
          type: string
        language:
          allOf:
            - $ref: '#/components/schemas/Language'
            - {}
        country:
          allOf:
            - $ref: '#/components/schemas/Country2'
            - {}
      example:
        email: juliete1411232111@google.com
        first_name: testfirst
        last_name: testlast
        avatar: ''
        phone: '+14844145967'
        google_id: julies.home
        bio: hi im jules
        facebook: jle
        instagram: jules
        twitter: jj
        linkedin: ju
        whatsapp: ul
        wechat: '9865326598'
        youtube: juleshome
        zip_code: '97655'
        dob: '1997-08-08'
        gender: female
        time_zone: CST
        language:
          name: English
          iso: en
        country:
          name: United States
          iso: US
    index7:
      title: index7
      required:
        - id
        - order_number
        - amount
        - shipping
        - tax
        - subtotal
        - first_name
        - last_name
        - email
        - phone
        - tracking
        - cv
        - qv
        - status
        - order_type
        - rating
        - review
        - referrer
        - friendly_status
        - type
        - created_at
        - currency_code
        - currency_symbol
        - display_amount
        - display_subtotal
        - display_tax
        - display_shipping
        - display_refunds
        - display_discount
        - order_thumbnail
        - sale_date
        - recognized_ship_date
        - refundable
        - max_refundable_amount
        - max_refundable_tax
        - max_refundable_shipping
        - max_refundable_product_price
        - ship_to
        - contact
        - items
        - tracking_informations
      type: object
      properties:
        id:
          type: integer
          format: int32
        order_number:
          type: string
        amount:
          type: string
        shipping:
          type: string
        tax:
          type: string
        subtotal:
          type: string
        first_name:
          type: string
        last_name:
          type: string
        email:
          type: string
        phone:
          type: string
        tracking:
          type: string
        cv:
          type: integer
          format: int32
        qv:
          type: integer
          format: int32
        status:
          type: string
        order_type:
          type: string
        rating:
          type: integer
          format: int32
        review:
          type: string
        referrer:
          type: string
        friendly_status:
          type: string
        type:
          type: string
        created_at:
          type: string
        currency_code:
          type: string
        currency_symbol:
          type: string
        display_amount:
          type: string
        display_subtotal:
          type: string
        display_tax:
          type: string
        display_shipping:
          type: string
        display_refunds:
          type: string
        display_discount:
          type: string
        order_thumbnail:
          type: string
        sale_date:
          type: string
        recognized_ship_date:
          type: string
        refundable:
          type: boolean
        max_refundable_amount:
          type: string
        max_refundable_tax:
          type: string
        max_refundable_shipping:
          type: string
        max_refundable_product_price:
          type: string
        display_enrollment_fee:
          type: string
        ship_to:
          allOf:
            - $ref: '#/components/schemas/ShipTo2'
            - {}
        contact:
          allOf:
            - $ref: '#/components/schemas/Contact'
            - {}
        items:
          type: array
          items:
            $ref: '#/components/schemas/Item'
          description: ''
        tracking_informations:
          type: array
          items:
            type: string
          description: ''
    ShipTo2:
      title: ShipTo2
      required:
        - id
        - name
        - address1
        - address2
        - address3
        - city
        - state
        - postal_code
        - country_code
        - country
        - default
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        address1:
          type: string
        address2:
          type: string
        address3:
          type: string
        city:
          type: string
        state:
          type: string
        postal_code:
          type: string
        country_code:
          type: string
        country:
          allOf:
            - $ref: '#/components/schemas/Country6'
            - {}
        default:
          type: boolean
      example:
        id: 980199006
        name: Bishal Nepal
        address1: jhapa
        address2: null
        address3: null
        city: damak
        state: Province 1
        postal_code: mechi
        country_code: null
        country:
          id: 141
          iso_name: NEPAL
          iso: NP
          iso3: NPL
          name: Nepal
          numcode: 524
          active: true
          currency_code: NPR
          currency_symbol: Rs.
          separator: .
          delimiter: ','
          address3: false
          state: true
          passport: false
          itn: false
          tax_rate: 0
          default: false
          created_at: '2022-05-09T05:12:21.806Z'
          updated_at: '2022-05-09T05:12:21.806Z'
          geo_entity_id: 28
        default: false
    Country6:
      title: Country6
      required:
        - id
        - iso_name
        - iso
        - iso3
        - name
        - numcode
        - active
        - currency_code
        - currency_symbol
        - separator
        - delimiter
        - address3
        - state
        - passport
        - itn
        - tax_rate
        - default
        - created_at
        - updated_at
        - geo_entity_id
      type: object
      properties:
        id:
          type: integer
          format: int32
        iso_name:
          type: string
        iso:
          type: string
        iso3:
          type: string
        name:
          type: string
        numcode:
          type: integer
          format: int32
        active:
          type: boolean
        currency_code:
          type: string
        currency_symbol:
          type: string
        separator:
          type: string
        delimiter:
          type: string
        address3:
          type: boolean
        state:
          type: boolean
        passport:
          type: boolean
        itn:
          type: boolean
        tax_rate:
          type: integer
          format: int32
        default:
          type: boolean
        created_at:
          type: string
        updated_at:
          type: string
        geo_entity_id:
          type: integer
          format: int32
      example:
        id: 141
        iso_name: NEPAL
        iso: NP
        iso3: NPL
        name: Nepal
        numcode: 524
        active: true
        currency_code: NPR
        currency_symbol: Rs.
        separator: .
        delimiter: ','
        address3: false
        state: true
        passport: false
        itn: false
        tax_rate: 0
        default: false
        created_at: '2022-05-09T05:12:21.806Z'
        updated_at: '2022-05-09T05:12:21.806Z'
        geo_entity_id: 28
    Contact:
      title: Contact
      required:
        - id
        - token
        - first_name
        - last_name
        - avatar_url
        - status
        - email
        - email2
        - phone
        - phone2
        - phone_id
        - address
        - address2
        - city
        - state
        - postal_code
        - language_id
        - country_id
        - lead_type
        - ip
        - requested_at
        - best_time
        - time_zone
        - reason
        - income
        - hours
        - invest
        - interest
        - full_name
      type: object
      properties:
        id:
          type: integer
          format: int32
        token:
          type: string
        first_name:
          type: string
        last_name:
          type: string
        avatar_url:
          type: string
        status:
          type: string
        email:
          type: string
        email2:
          type: string
        phone:
          type: string
        phone2:
          type: string
        phone_id:
          type: string
        address:
          type: string
        address2:
          type: string
        city:
          type: string
        state:
          type: string
        postal_code:
          type: string
        language_id:
          type: string
        country_id:
          type: string
        lead_type:
          type: string
        ip:
          type: string
        requested_at:
          type: string
        best_time:
          type: string
        time_zone:
          type: string
        reason:
          type: string
        income:
          type: string
        hours:
          type: string
        invest:
          type: string
        interest:
          type: string
        full_name:
          type: string
      example:
        id: 6557
        token: h59g4H8EExXpmNYmhq4woiMh
        first_name: Bishal
        last_name: Nepal
        avatar_url: null
        status: null
        email: bnepal05579887@gmail.com
        email2: null
        phone: null
        phone2: null
        phone_id: null
        address: null
        address2: null
        city: null
        state: null
        postal_code: null
        language_id: null
        country_id: null
        lead_type: null
        ip: null
        requested_at: null
        best_time: null
        time_zone: null
        reason: null
        income: null
        hours: null
        invest: null
        interest: null
        full_name: Bishal Nepal
    Item:
      title: Item
      required:
        - id
        - quantity
        - price
        - ordered_variant
        - sku
        - product
      type: object
      properties:
        id:
          type: integer
          format: int32
        quantity:
          type: integer
          format: int32
        price:
          oneOf:
            - type: integer
              format: int32
            - type: number
        ordered_variant:
          type: string
        sku:
          type: string
        product:
          allOf:
            - $ref: '#/components/schemas/Product8'
            - {}
    Product8:
      title: Product8
      required:
        - id
        - active
        - title
        - description
        - stripped
        - price
        - display_price
        - subscription_price
        - display_subscription_price
        - wholesale_price
        - display_wholesale_price
        - wholesale_subscription_price
        - display_wholesale_subscription_price
        - shipping
        - image
        - image_url
        - sku
        - country_code
        - country_id
        - views
        - leads
        - share_link
        - commission
        - public
        - shopify_id
        - shopify_handle
        - in_stock
        - vendor
        - price_range
        - price_range_formatted
        - unlimited_inventory
        - default_variant
        - currency_symbol
        - currency_code
        - average_rating
        - option_values
        - publish_to_retail_store
        - publish_to_rep_store
        - publish_to_share_tab
        - images
        - countries
        - variants
        - options
        - prompts
        - enroll_products
        - enrolls
      type: object
      properties:
        id:
          type: integer
          format: int32
        active:
          type: boolean
        title:
          type: string
        description:
          allOf:
            - $ref: '#/components/schemas/Description'
            - {}
        stripped:
          type: string
        price:
          type: string
        display_price:
          type: string
        subscription_price:
          type: string
        display_subscription_price:
          type: string
        wholesale_price:
          type: string
        display_wholesale_price:
          type: string
        wholesale_subscription_price:
          type: string
        display_wholesale_subscription_price:
          type: string
        shipping:
          type: string
        image:
          allOf:
            - $ref: '#/components/schemas/Image3'
            - {}
        image_url:
          type: string
        sku:
          type: string
        country_code:
          type: string
        country_id:
          type: string
        views:
          type: integer
          format: int32
        leads:
          type: integer
          format: int32
        share_link:
          type: string
        commission:
          type: string
        public:
          type: boolean
        shopify_id:
          type: string
        shopify_handle:
          type: string
        in_stock:
          type: boolean
        vendor:
          type: string
        price_range:
          type: array
          items:
            type: string
          description: ''
        price_range_formatted:
          type: string
        unlimited_inventory:
          type: boolean
        default_variant:
          oneOf:
            - allOf:
                - oneOf:
                    - type: 'null'
                    - $ref: '#/components/schemas/DefaultVariant'
                - example:
                    id: 19630
                    product_id: 2240
                    shopify_id: null
                    title: ''
                    sku: sketch12
                    position: 12698
                    inventory_policy: none
                    taxable: true
                    inventory_quantity: -84
                    created_at: '2023-02-02T03:48:18.009Z'
                    updated_at: '2023-09-29T04:59:12.098Z'
                    external_id: null
                    variant_country_id: null
                    image_url: null
                    image_path: null
                    is_master: true
                    discarded_at: null
                    price: null
                    weight: ''
                    size: ''
                    physical: true
                    unit_of_weight: lb
                    height: 0
                    width: 0
                    length: 0
                    unit_of_size: ft
                    hs_code: ''
                    country_of_origin: ''
                    customs_information_shipping: false
                    active: true
                    bar_code: ''
                    track_quantity: false
                    keep_selling: true
                    option_attrs: []
                    allow_subscription: true
            - type: string
            - type: 'null'
        currency_symbol:
          type: string
        currency_code:
          type: string
        average_rating:
          type: integer
          format: int32
        option_values:
          type: object
          additionalProperties:
            oneOf:
              - type: object
                additionalProperties:
                  $ref: '#/components/schemas/m39'
                example: {}
              - type: string
              - type: 'null'
        publish_to_retail_store:
          type: boolean
        publish_to_rep_store:
          type: boolean
        publish_to_share_tab:
          type: boolean
        images:
          type: array
          items:
            oneOf:
              - allOf:
                  - $ref: '#/components/schemas/Image4'
                  - example:
                      id: 2089
                      image:
                        mini: >-
                          https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                        detail: >-
                          https://ik.imagekit.io/fluid/s3/tr:n-video_poster/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                        full: >-
                          https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                      image_url: >-
                        https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                      position: null
                      shopify_id: null
              - type: string
          description: ''
        countries:
          type: array
          items:
            $ref: '#/components/schemas/Country7'
          description: ''
        variants:
          type: array
          items:
            $ref: '#/components/schemas/Variant7'
          description: ''
        options:
          type: array
          items:
            oneOf:
              - $ref: '#/components/schemas/Option2'
              - allOf:
                  - $ref: '#/components/schemas/Option21'
                  - example:
                      id: 39
                      title: size
                      position: 28
                      created_at: '2023-01-31T08:42:29.725Z'
                      updated_at: '2023-01-31T08:42:29.725Z'
                      presentation: Size
                      company_id: 980191019
                      external_id: null
          description: ''
        prompts:
          type: array
          items:
            type: string
          description: ''
        enroll_products:
          type: array
          items:
            oneOf:
              - allOf:
                  - $ref: '#/components/schemas/EnrollProduct'
                  - example:
                      id: 19
                      product_id: 2240
                      enroll_id: 2
                      active: true
                      type: membership_product
                      created_at: '2023-02-15T06:40:53.303Z'
                      updated_at: '2023-02-15T06:40:53.303Z'
              - type: string
          description: ''
        enrolls:
          type: array
          items:
            oneOf:
              - allOf:
                  - $ref: '#/components/schemas/Enroll'
                  - example:
                      id: 2
                      integration_id: null
                      fields:
                        dob: Birthdate
                        full_name: Name
                        government_id: Government ID
                      member_fee: 25
                      member_fee_enabled: true
                      company_id: 980191019
                      created_at: '2023-02-01T07:49:12.347Z'
                      updated_at: '2023-02-01T07:54:36.961Z'
                      terms_and_conditions_url: https://www.google.com/
              - type: string
          description: ''
      example:
        id: 2240
        active: true
        title: sketch
        description:
          id: 4836
          name: description
          body: <div>best selling sketch</div>
          record_type: Product
          record_id: 2240
          created_at: '2023-02-02T03:48:16.810Z'
          updated_at: '2023-02-02T03:48:16.810Z'
        stripped: best selling sketch
        price: '12740.0'
        display_price: Rs.12,740.00 (NPR)
        subscription_price: '12740.0'
        display_subscription_price: Rs.12,740.00 (NPR)
        wholesale_price: '0.0'
        display_wholesale_price: Rs.0.00 (NPR)
        wholesale_subscription_price: '0.0'
        display_wholesale_subscription_price: Rs.0.00 (NPR)
        shipping: '5.0'
        image:
          mini: >-
            https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
          detail: >-
            https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
          full: >-
            https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
        image_url: >-
          https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
        sku: sketch
        country_code: ar
        country_id: null
        views: 0
        leads: 0
        share_link: null
        commission: '10.0'
        public: true
        shopify_id: null
        shopify_handle: null
        in_stock: true
        vendor: null
        price_range:
          - Rs.0.00
          - Rs.12,740.00
        price_range_formatted: Rs.0.00 - Rs.12,740.00
        unlimited_inventory: false
        default_variant:
          id: 19630
          product_id: 2240
          shopify_id: null
          title: ''
          sku: sketch12
          position: 12698
          inventory_policy: none
          taxable: true
          inventory_quantity: -84
          created_at: '2023-02-02T03:48:18.009Z'
          updated_at: '2023-09-29T04:59:12.098Z'
          external_id: null
          variant_country_id: null
          image_url: null
          image_path: null
          is_master: true
          discarded_at: null
          price: null
          weight: ''
          size: ''
          physical: true
          unit_of_weight: lb
          height: 0
          width: 0
          length: 0
          unit_of_size: ft
          hs_code: ''
          country_of_origin: ''
          customs_information_shipping: false
          active: true
          bar_code: ''
          track_quantity: false
          keep_selling: true
          option_attrs: []
          allow_subscription: true
        currency_symbol: Rs.
        currency_code: NPR
        average_rating: 0
        option_values: {}
        publish_to_retail_store: true
        publish_to_rep_store: true
        publish_to_share_tab: true
        images:
          - id: 2089
            image:
              mini: >-
                https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
              detail: >-
                https://ik.imagekit.io/fluid/s3/tr:n-video_poster/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
              full: >-
                https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
            image_url: >-
              https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
            position: null
            shopify_id: null
        countries:
          - id: 27
            iso_name: BOTSWANA
            iso: BW
            iso3: BWA
            name: Botswana
            numcode: 72
            active: true
            currency_code: BWP
            currency_symbol: P
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 68
            iso_name: FRANCE
            iso: FR
            iso3: FRA
            name: France
            numcode: 250
            active: true
            currency_code: EUR
            currency_symbol: €
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 214
            iso_name: UNITED STATES
            iso: US
            iso3: USA
            name: United States
            numcode: 840
            active: true
            currency_code: USD
            currency_symbol: $
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 12
            iso_name: AUSTRALIA
            iso: AU
            iso3: AUS
            name: Australia
            numcode: 36
            active: true
            currency_code: AUD
            currency_symbol: $
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 13
            iso_name: AUSTRIA
            iso: AT
            iso3: AUT
            name: Austria
            numcode: 40
            active: true
            currency_code: EUR
            currency_symbol: €
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 14
            iso_name: AZERBAIJAN
            iso: AZ
            iso3: AZE
            name: Azerbaijan
            numcode: 31
            active: true
            currency_code: AZN
            currency_symbol: ₼
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 15
            iso_name: BAHAMAS
            iso: BS
            iso3: BHS
            name: Bahamas
            numcode: 44
            active: true
            currency_code: BSD
            currency_symbol: $
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 16
            iso_name: BAHRAIN
            iso: BH
            iso3: BHR
            name: Bahrain
            numcode: 48
            active: true
            currency_code: BHD
            currency_symbol: د.ب
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 17
            iso_name: BANGLADESH
            iso: BD
            iso3: BGD
            name: Bangladesh
            numcode: 50
            active: true
            currency_code: BDT
            currency_symbol: ৳
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 41
            iso_name: CHINA
            iso: CN
            iso3: CHN
            name: China
            numcode: 156
            active: true
            currency_code: CNY
            currency_symbol: ¥
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 162
            iso_name: POLAND
            iso: PL
            iso3: POL
            name: Poland
            numcode: 616
            active: true
            currency_code: PLN
            currency_symbol: zł
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 163
            iso_name: PORTUGAL
            iso: PT
            iso3: PRT
            name: Portugal
            numcode: 620
            active: true
            currency_code: EUR
            currency_symbol: €
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 168
            iso_name: RUSSIAN FEDERATION
            iso: RU
            iso3: RUS
            name: Russia
            numcode: 643
            active: true
            currency_code: RUB
            currency_symbol: ₽
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 197
            iso_name: TAIWAN, PROVINCE OF CHINA
            iso: TW
            iso3: TWN
            name: Taiwan
            numcode: 158
            active: true
            currency_code: TWD
            currency_symbol: $
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 2
            iso_name: ALBANIA
            iso: AL
            iso3: ALB
            name: Albania
            numcode: 8
            active: true
            currency_code: ALL
            currency_symbol: L
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 3
            iso_name: ALGERIA
            iso: DZ
            iso3: DZA
            name: Algeria
            numcode: 12
            active: true
            currency_code: DZD
            currency_symbol: د.ج
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 74
            iso_name: GERMANY
            iso: DE
            iso3: DEU
            name: Germany
            numcode: 276
            active: true
            currency_code: EUR
            currency_symbol: €
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 141
            iso_name: NEPAL
            iso: NP
            iso3: NPL
            name: Nepal
            numcode: 524
            active: true
            currency_code: NPR
            currency_symbol: Rs.
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 188
            iso_name: SPAIN
            iso: ES
            iso3: ESP
            name: Spain
            numcode: 724
            active: true
            currency_code: EUR
            currency_symbol: €
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 1
            iso_name: AFGHANISTAN
            iso: AF
            iso3: AFG
            name: Afghanistan
            numcode: 4
            active: true
            currency_code: AFN
            currency_symbol: ؋
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 4
            iso_name: AMERICAN SAMOA
            iso: AS
            iso3: ASM
            name: American Samoa
            numcode: 16
            active: true
            currency_code: USD
            currency_symbol: $
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 9
            iso_name: ARGENTINA
            iso: AR
            iso3: ARG
            name: Argentina
            numcode: 32
            active: true
            currency_code: ARS
            currency_symbol: $
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 23
            iso_name: BERMUDA
            iso: BM
            iso3: BMU
            name: Bermuda
            numcode: 60
            active: true
            currency_code: BMD
            currency_symbol: $
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
        variants:
          - id: 19630
            title: ''
            image_url: null
            buyable: true
            option_value_ids: []
            allow_subscription: true
            variant_countries:
              - id: 130789
                price: '9800.0'
                shipping: '500.0'
                tax: '200.0'
                currency_code: ARS
                currency_symbol: $
                display_price: $9,800.00 (ARS)
                country_iso: AR
                subscription_price: '9800.0'
                display_wholesale_price: $0.00 (ARS)
                display_wholesale_subscription_price: $0.00 (ARS)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 9
                  iso: AR
                  iso_name: ARGENTINA
                  iso3: ARG
                  name: Argentina
                  tax_rate: 0
              - id: 130790
                price: '98.0'
                shipping: '5.0'
                tax: '2.0'
                currency_code: AUD
                currency_symbol: $
                display_price: $98.00 (AUD)
                country_iso: AU
                subscription_price: '98.0'
                display_wholesale_price: $0.00 (AUD)
                display_wholesale_subscription_price: $0.00 (AUD)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 12
                  iso: AU
                  iso_name: AUSTRALIA
                  iso3: AUS
                  name: Australia
                  tax_rate: 0
              - id: 130791
                price: '4900.0'
                shipping: '250.0'
                tax: '100.0'
                currency_code: EUR
                currency_symbol: €
                display_price: €4,900.00 (EUR)
                country_iso: AT
                subscription_price: '4900.0'
                display_wholesale_price: €0.00 (EUR)
                display_wholesale_subscription_price: €0.00 (EUR)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 13
                  iso: AT
                  iso_name: AUSTRIA
                  iso3: AUT
                  name: Austria
                  tax_rate: 0
              - id: 130792
                price: '9604.0'
                shipping: '490.0'
                tax: '196.0'
                currency_code: AZN
                currency_symbol: ₼
                display_price: ₼9,604.00 (AZN)
                country_iso: AZ
                subscription_price: '9604.0'
                display_wholesale_price: ₼0.00 (AZN)
                display_wholesale_subscription_price: ₼0.00 (AZN)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 14
                  iso: AZ
                  iso_name: AZERBAIJAN
                  iso3: AZE
                  name: Azerbaijan
                  tax_rate: 0
              - id: 130793
                price: '98.0'
                shipping: '5.0'
                tax: '2.0'
                currency_code: BSD
                currency_symbol: $
                display_price: $98.00 (BSD)
                country_iso: BS
                subscription_price: '98.0'
                display_wholesale_price: $0.00 (BSD)
                display_wholesale_subscription_price: $0.00 (BSD)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 15
                  iso: BS
                  iso_name: BAHAMAS
                  iso3: BHS
                  name: Bahamas
                  tax_rate: 0
              - id: 130794
                price: '98.0'
                shipping: '5.0'
                tax: '2.0'
                currency_code: BHD
                currency_symbol: د.ب
                display_price: د.ب98.000 (BHD)
                country_iso: BH
                subscription_price: '98.0'
                display_wholesale_price: د.ب0.000 (BHD)
                display_wholesale_subscription_price: د.ب0.000 (BHD)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 16
                  iso: BH
                  iso_name: BAHRAIN
                  iso3: BHR
                  name: Bahrain
                  tax_rate: 0
              - id: 130795
                price: '98.0'
                shipping: '5.0'
                tax: '2.0'
                currency_code: BDT
                currency_symbol: ৳
                display_price: ৳98.00 (BDT)
                country_iso: BD
                subscription_price: '98.0'
                display_wholesale_price: ৳0.00 (BDT)
                display_wholesale_subscription_price: ৳0.00 (BDT)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 17
                  iso: BD
                  iso_name: BANGLADESH
                  iso3: BGD
                  name: Bangladesh
                  tax_rate: 0
              - id: 130798
                price: '98.0'
                shipping: '5.0'
                tax: '2.0'
                currency_code: BMD
                currency_symbol: $
                display_price: $98.00 (BMD)
                country_iso: BM
                subscription_price: '98.0'
                display_wholesale_price: $0.00 (BMD)
                display_wholesale_subscription_price: $0.00 (BMD)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 23
                  iso: BM
                  iso_name: BERMUDA
                  iso3: BMU
                  name: Bermuda
                  tax_rate: 0
              - id: 130801
                price: '98.0'
                shipping: '5.0'
                tax: '2.0'
                currency_code: BWP
                currency_symbol: P
                display_price: P98.00 (BWP)
                country_iso: BW
                subscription_price: '98.0'
                display_wholesale_price: P0.00 (BWP)
                display_wholesale_subscription_price: P0.00 (BWP)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 27
                  iso: BW
                  iso_name: BOTSWANA
                  iso3: BWA
                  name: Botswana
                  tax_rate: 0
              - id: 130881
                price: '12740.0'
                shipping: '650.0'
                tax: '260.0'
                currency_code: NPR
                currency_symbol: Rs.
                display_price: Rs.12,740.00 (NPR)
                country_iso: NP
                subscription_price: '12740.0'
                display_wholesale_price: Rs.0.00 (NPR)
                display_wholesale_subscription_price: Rs.0.00 (NPR)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 141
                  iso: NP
                  iso_name: NEPAL
                  iso3: NPL
                  name: Nepal
                  tax_rate: 0
              - id: 130897
                price: '98.0'
                shipping: '5.0'
                tax: '2.0'
                currency_code: EUR
                currency_symbol: €
                display_price: €98.00 (EUR)
                country_iso: PT
                subscription_price: '98.0'
                display_wholesale_price: €0.00 (EUR)
                display_wholesale_subscription_price: €0.00 (EUR)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 163
                  iso: PT
                  iso_name: PORTUGAL
                  iso3: PRT
                  name: Portugal
                  tax_rate: 0
              - id: 130921
                price: '98.0'
                shipping: '5.0'
                tax: '2.0'
                currency_code: TWD
                currency_symbol: $
                display_price: $98.00 (TWD)
                country_iso: TW
                subscription_price: '98.0'
                display_wholesale_price: $0.00 (TWD)
                display_wholesale_subscription_price: $0.00 (TWD)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 197
                  iso: TW
                  iso_name: TAIWAN, PROVINCE OF CHINA
                  iso3: TWN
                  name: Taiwan
                  tax_rate: 0
              - id: 130933
                price: '98.0'
                shipping: '5.0'
                tax: '2.0'
                currency_code: USD
                currency_symbol: $
                display_price: $98.00 (USD)
                country_iso: US
                subscription_price: '98.0'
                display_wholesale_price: $0.00 (USD)
                display_wholesale_subscription_price: $0.00 (USD)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 214
                  iso: US
                  iso_name: UNITED STATES
                  iso3: USA
                  name: United States
                  tax_rate: 0
        options: []
        prompts: []
        enroll_products:
          - id: 19
            product_id: 2240
            enroll_id: 2
            active: true
            type: membership_product
            created_at: '2023-02-15T06:40:53.303Z'
            updated_at: '2023-02-15T06:40:53.303Z'
        enrolls:
          - id: 2
            integration_id: null
            fields:
              dob: Birthdate
              full_name: Name
              government_id: Government ID
            member_fee: 25
            member_fee_enabled: true
            company_id: 980191019
            created_at: '2023-02-01T07:49:12.347Z'
            updated_at: '2023-02-01T07:54:36.961Z'
            terms_and_conditions_url: https://www.google.com/
    Description:
      title: Description
      required:
        - id
        - name
        - body
        - record_type
        - record_id
        - created_at
        - updated_at
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        body:
          type: string
        record_type:
          type: string
        record_id:
          type: integer
          format: int32
        created_at:
          type: string
        updated_at:
          type: string
      example:
        id: 4836
        name: description
        body: <div>best selling sketch</div>
        record_type: Product
        record_id: 2240
        created_at: '2023-02-02T03:48:16.810Z'
        updated_at: '2023-02-02T03:48:16.810Z'
    CatchUpAction:
      title: CatchUpAction
      required:
        - type
        - action_prompt
      type: object
      properties:
        type:
          type: string
        action_prompt:
          type: string
      example:
        type: LinkRedirectionCatchUpAction
        action_prompt: >-
          Craft a short friendly message to a visitor, visiting my site
          constantly and buying products.
    Image3:
      title: Image3
      required:
        - mini
        - detail
        - full
      type: object
      properties:
        mini:
          type: string
        detail:
          type: string
        full:
          type: string
      example:
        mini: >-
          https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
        detail: >-
          https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
        full: >-
          https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
    DefaultVariant:
      title: DefaultVariant
      type: object
      properties:
        id:
          type: integer
          format: int32
        product_id:
          type: integer
          format: int32
        shopify_id:
          type: string
        title:
          type: string
        sku:
          type: string
        position:
          type: integer
          format: int32
        inventory_policy:
          type: string
        taxable:
          type: boolean
        inventory_quantity:
          type: integer
          format: int32
        created_at:
          type: string
        updated_at:
          type: string
        external_id:
          type: string
        variant_country_id:
          type: string
        image_url:
          type: string
        image_path:
          type: string
        is_master:
          type: boolean
        discarded_at:
          type: string
        price:
          type: string
        weight:
          type: string
        size:
          type: string
        physical:
          oneOf:
            - type: boolean
            - type: string
            - type: 'null'
        unit_of_weight:
          type: string
        height:
          oneOf:
            - type: integer
              format: int32
            - type: string
            - type: 'null'
        width:
          oneOf:
            - type: integer
              format: int32
            - type: string
            - type: 'null'
        length:
          oneOf:
            - type: integer
              format: int32
            - type: string
            - type: 'null'
        unit_of_size:
          type: string
        hs_code:
          type: string
        country_of_origin:
          type: string
        customs_information_shipping:
          oneOf:
            - type: boolean
            - type: string
            - type: 'null'
        active:
          type: boolean
        bar_code:
          type: string
        track_quantity:
          oneOf:
            - type: boolean
            - type: string
            - type: 'null'
        keep_selling:
          oneOf:
            - type: boolean
            - type: string
            - type: 'null'
        option_attrs:
          type: array
          items:
            type: string
          description: ''
        allow_subscription:
          type: boolean
      example:
        id: 19630
        product_id: 2240
        shopify_id: null
        title: ''
        sku: sketch12
        position: 12698
        inventory_policy: none
        taxable: true
        inventory_quantity: -84
        created_at: '2023-02-02T03:48:18.009Z'
        updated_at: '2023-09-29T04:59:12.098Z'
        external_id: null
        variant_country_id: null
        image_url: null
        image_path: null
        is_master: true
        discarded_at: null
        price: null
        weight: ''
        size: ''
        physical: true
        unit_of_weight: lb
        height: 0
        width: 0
        length: 0
        unit_of_size: ft
        hs_code: ''
        country_of_origin: ''
        customs_information_shipping: false
        active: true
        bar_code: ''
        track_quantity: false
        keep_selling: true
        option_attrs: []
        allow_subscription: true
    m39:
      title: m39
      required:
        - id
        - option_id
        - title
        - position
        - shopify_id
        - created_at
        - updated_at
        - presentation
      type: object
      properties:
        id:
          type: integer
          format: int32
        option_id:
          type: integer
          format: int32
        title:
          type: string
        position:
          type: integer
          format: int32
        shopify_id:
          type: string
        created_at:
          type: string
        updated_at:
          type: string
        presentation:
          type: string
      example:
        id: 143
        option_id: 39
        title: s
        position: 93
        shopify_id: null
        created_at: '2023-01-31T08:42:29.745Z'
        updated_at: '2023-02-03T10:47:37.138Z'
        presentation: S
    Image4:
      title: Image4
      type: object
      properties:
        id:
          type: integer
          format: int32
        image:
          allOf:
            - $ref: '#/components/schemas/Image3'
            - {}
        image_url:
          type: string
        position:
          type: string
        shopify_id:
          type: string
      example:
        id: 2089
        image:
          mini: >-
            https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
          detail: >-
            https://ik.imagekit.io/fluid/s3/tr:n-video_poster/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
          full: >-
            https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
        image_url: >-
          https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
        position: null
        shopify_id: null
    Country7:
      title: Country7
      required:
        - id
        - iso_name
        - iso
        - iso3
        - name
        - numcode
        - active
        - currency_code
        - currency_symbol
        - separator
        - delimiter
        - address3
        - state
        - passport
        - itn
        - tax_rate
      type: object
      properties:
        id:
          type: integer
          format: int32
        iso_name:
          type: string
        iso:
          type: string
        iso3:
          type: string
        name:
          type: string
        numcode:
          type: integer
          format: int32
        active:
          type: boolean
        currency_code:
          type: string
        currency_symbol:
          type: string
        separator:
          type: string
        delimiter:
          type: string
        address3:
          type: boolean
        state:
          type: boolean
        passport:
          type: boolean
        itn:
          type: boolean
        tax_rate:
          type: integer
          format: int32
      example:
        id: 27
        iso_name: BOTSWANA
        iso: BW
        iso3: BWA
        name: Botswana
        numcode: 72
        active: true
        currency_code: BWP
        currency_symbol: P
        separator: .
        delimiter: ','
        address3: false
        state: true
        passport: false
        itn: false
        tax_rate: 0
    Variant7:
      title: Variant7
      required:
        - id
        - title
        - image_url
        - buyable
        - option_value_ids
        - allow_subscription
        - variant_countries
      type: object
      properties:
        id:
          type: integer
          format: int32
        title:
          type: string
        image_url:
          type: string
        buyable:
          type: boolean
        option_value_ids:
          type: array
          items:
            oneOf:
              - type: string
              - type: integer
                format: int32
          description: ''
        allow_subscription:
          type: boolean
        variant_countries:
          type: array
          items:
            oneOf:
              - allOf:
                  - $ref: '#/components/schemas/VariantCountries5'
                  - example:
                      id: 130789
                      price: '9800.0'
                      shipping: '500.0'
                      tax: '200.0'
                      currency_code: ARS
                      currency_symbol: $
                      display_price: $9,800.00 (ARS)
                      country_iso: AR
                      subscription_price: '9800.0'
                      display_wholesale_price: $0.00 (ARS)
                      display_wholesale_subscription_price: $0.00 (ARS)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 9
                        iso: AR
                        iso_name: ARGENTINA
                        iso3: ARG
                        name: Argentina
                        tax_rate: 0
              - oneOf:
                  - $ref: '#/components/schemas/VariantCountries51'
                  - allOf:
                      - $ref: '#/components/schemas/VariantCountries5'
                      - example:
                          id: 449460
                          price: '10.0'
                          shipping: '1.0'
                          tax: '2.0'
                          currency_code: EUR
                          currency_symbol: €
                          display_price: €10.00 (EUR)
                          country_iso: FR
                          subscription_price: '10.0'
                          display_wholesale_price: €0.00 (EUR)
                          display_wholesale_subscription_price: €0.00 (EUR)
                          wholesale_price: '0.0'
                          wholesale_subscription_price: '0.0'
                          country:
                            id: 68
                            iso: FR
                            iso_name: FRANCE
                            iso3: FRA
                            name: France
                            tax_rate: 0
          description: ''
      example:
        id: 19630
        title: ''
        image_url: null
        buyable: true
        option_value_ids: []
        allow_subscription: true
        variant_countries:
          - id: 130789
            price: '9800.0'
            shipping: '500.0'
            tax: '200.0'
            currency_code: ARS
            currency_symbol: $
            display_price: $9,800.00 (ARS)
            country_iso: AR
            subscription_price: '9800.0'
            display_wholesale_price: $0.00 (ARS)
            display_wholesale_subscription_price: $0.00 (ARS)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 9
              iso: AR
              iso_name: ARGENTINA
              iso3: ARG
              name: Argentina
              tax_rate: 0
          - id: 130790
            price: '98.0'
            shipping: '5.0'
            tax: '2.0'
            currency_code: AUD
            currency_symbol: $
            display_price: $98.00 (AUD)
            country_iso: AU
            subscription_price: '98.0'
            display_wholesale_price: $0.00 (AUD)
            display_wholesale_subscription_price: $0.00 (AUD)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 12
              iso: AU
              iso_name: AUSTRALIA
              iso3: AUS
              name: Australia
              tax_rate: 0
          - id: 130791
            price: '4900.0'
            shipping: '250.0'
            tax: '100.0'
            currency_code: EUR
            currency_symbol: €
            display_price: €4,900.00 (EUR)
            country_iso: AT
            subscription_price: '4900.0'
            display_wholesale_price: €0.00 (EUR)
            display_wholesale_subscription_price: €0.00 (EUR)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 13
              iso: AT
              iso_name: AUSTRIA
              iso3: AUT
              name: Austria
              tax_rate: 0
          - id: 130792
            price: '9604.0'
            shipping: '490.0'
            tax: '196.0'
            currency_code: AZN
            currency_symbol: ₼
            display_price: ₼9,604.00 (AZN)
            country_iso: AZ
            subscription_price: '9604.0'
            display_wholesale_price: ₼0.00 (AZN)
            display_wholesale_subscription_price: ₼0.00 (AZN)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 14
              iso: AZ
              iso_name: AZERBAIJAN
              iso3: AZE
              name: Azerbaijan
              tax_rate: 0
          - id: 130793
            price: '98.0'
            shipping: '5.0'
            tax: '2.0'
            currency_code: BSD
            currency_symbol: $
            display_price: $98.00 (BSD)
            country_iso: BS
            subscription_price: '98.0'
            display_wholesale_price: $0.00 (BSD)
            display_wholesale_subscription_price: $0.00 (BSD)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 15
              iso: BS
              iso_name: BAHAMAS
              iso3: BHS
              name: Bahamas
              tax_rate: 0
          - id: 130794
            price: '98.0'
            shipping: '5.0'
            tax: '2.0'
            currency_code: BHD
            currency_symbol: د.ب
            display_price: د.ب98.000 (BHD)
            country_iso: BH
            subscription_price: '98.0'
            display_wholesale_price: د.ب0.000 (BHD)
            display_wholesale_subscription_price: د.ب0.000 (BHD)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 16
              iso: BH
              iso_name: BAHRAIN
              iso3: BHR
              name: Bahrain
              tax_rate: 0
          - id: 130795
            price: '98.0'
            shipping: '5.0'
            tax: '2.0'
            currency_code: BDT
            currency_symbol: ৳
            display_price: ৳98.00 (BDT)
            country_iso: BD
            subscription_price: '98.0'
            display_wholesale_price: ৳0.00 (BDT)
            display_wholesale_subscription_price: ৳0.00 (BDT)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 17
              iso: BD
              iso_name: BANGLADESH
              iso3: BGD
              name: Bangladesh
              tax_rate: 0
          - id: 130798
            price: '98.0'
            shipping: '5.0'
            tax: '2.0'
            currency_code: BMD
            currency_symbol: $
            display_price: $98.00 (BMD)
            country_iso: BM
            subscription_price: '98.0'
            display_wholesale_price: $0.00 (BMD)
            display_wholesale_subscription_price: $0.00 (BMD)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 23
              iso: BM
              iso_name: BERMUDA
              iso3: BMU
              name: Bermuda
              tax_rate: 0
          - id: 130801
            price: '98.0'
            shipping: '5.0'
            tax: '2.0'
            currency_code: BWP
            currency_symbol: P
            display_price: P98.00 (BWP)
            country_iso: BW
            subscription_price: '98.0'
            display_wholesale_price: P0.00 (BWP)
            display_wholesale_subscription_price: P0.00 (BWP)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 27
              iso: BW
              iso_name: BOTSWANA
              iso3: BWA
              name: Botswana
              tax_rate: 0
          - id: 130881
            price: '12740.0'
            shipping: '650.0'
            tax: '260.0'
            currency_code: NPR
            currency_symbol: Rs.
            display_price: Rs.12,740.00 (NPR)
            country_iso: NP
            subscription_price: '12740.0'
            display_wholesale_price: Rs.0.00 (NPR)
            display_wholesale_subscription_price: Rs.0.00 (NPR)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 141
              iso: NP
              iso_name: NEPAL
              iso3: NPL
              name: Nepal
              tax_rate: 0
          - id: 130897
            price: '98.0'
            shipping: '5.0'
            tax: '2.0'
            currency_code: EUR
            currency_symbol: €
            display_price: €98.00 (EUR)
            country_iso: PT
            subscription_price: '98.0'
            display_wholesale_price: €0.00 (EUR)
            display_wholesale_subscription_price: €0.00 (EUR)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 163
              iso: PT
              iso_name: PORTUGAL
              iso3: PRT
              name: Portugal
              tax_rate: 0
          - id: 130921
            price: '98.0'
            shipping: '5.0'
            tax: '2.0'
            currency_code: TWD
            currency_symbol: $
            display_price: $98.00 (TWD)
            country_iso: TW
            subscription_price: '98.0'
            display_wholesale_price: $0.00 (TWD)
            display_wholesale_subscription_price: $0.00 (TWD)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 197
              iso: TW
              iso_name: TAIWAN, PROVINCE OF CHINA
              iso3: TWN
              name: Taiwan
              tax_rate: 0
          - id: 130933
            price: '98.0'
            shipping: '5.0'
            tax: '2.0'
            currency_code: USD
            currency_symbol: $
            display_price: $98.00 (USD)
            country_iso: US
            subscription_price: '98.0'
            display_wholesale_price: $0.00 (USD)
            display_wholesale_subscription_price: $0.00 (USD)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 214
              iso: US
              iso_name: UNITED STATES
              iso3: USA
              name: United States
              tax_rate: 0
    VariantCountries5:
      title: VariantCountries5
      required:
        - id
        - price
        - shipping
        - tax
        - currency_code
        - currency_symbol
        - display_price
        - country_iso
        - subscription_price
        - display_wholesale_price
        - display_wholesale_subscription_price
        - wholesale_price
        - wholesale_subscription_price
        - country
      type: object
      properties:
        id:
          type: integer
          format: int32
        price:
          type: string
        shipping:
          type: string
        tax:
          type: string
        currency_code:
          type: string
        currency_symbol:
          type: string
        display_price:
          type: string
        country_iso:
          type: string
        subscription_price:
          type: string
        display_wholesale_price:
          type: string
        display_wholesale_subscription_price:
          type: string
        wholesale_price:
          type: string
        wholesale_subscription_price:
          type: string
        country:
          allOf:
            - $ref: '#/components/schemas/Country8'
            - {}
      example:
        id: 130789
        price: '9800.0'
        shipping: '500.0'
        tax: '200.0'
        currency_code: ARS
        currency_symbol: $
        display_price: $9,800.00 (ARS)
        country_iso: AR
        subscription_price: '9800.0'
        display_wholesale_price: $0.00 (ARS)
        display_wholesale_subscription_price: $0.00 (ARS)
        wholesale_price: '0.0'
        wholesale_subscription_price: '0.0'
        country:
          id: 9
          iso: AR
          iso_name: ARGENTINA
          iso3: ARG
          name: Argentina
          tax_rate: 0
    Country8:
      title: Country8
      required:
        - id
        - iso
        - iso_name
        - iso3
        - name
        - tax_rate
      type: object
      properties:
        id:
          type: integer
          format: int32
        iso:
          type: string
        iso_name:
          type: string
        iso3:
          type: string
        name:
          type: string
        tax_rate:
          type: integer
          format: int32
      example:
        id: 9
        iso: AR
        iso_name: ARGENTINA
        iso3: ARG
        name: Argentina
        tax_rate: 0
    VariantCountries51:
      title: VariantCountries51
      type: object
      properties:
        id:
          type: integer
          format: int32
        price:
          type: string
        shipping:
          type: string
        tax:
          type: string
        currency_code:
          type: string
        currency_symbol:
          type: string
        display_price:
          type: string
        country_iso:
          type: string
        subscription_price:
          type: string
        display_wholesale_price:
          type: string
        display_wholesale_subscription_price:
          type: string
        wholesale_price:
          type: string
        wholesale_subscription_price:
          type: string
        country:
          allOf:
            - $ref: '#/components/schemas/Country8'
            - {}
    Option2:
      title: Option2
      type: object
      properties:
        id:
          type: integer
          format: int32
        title:
          type: string
        position:
          type: integer
          format: int32
        created_at:
          type: string
        updated_at:
          type: string
        presentation:
          type: string
        company_id:
          type: integer
          format: int32
        external_id:
          type: string
    Option21:
      title: Option21
      required:
        - id
        - title
        - position
        - created_at
        - updated_at
        - presentation
        - company_id
        - external_id
      type: object
      properties:
        id:
          type: integer
          format: int32
        title:
          type: string
        position:
          type: integer
          format: int32
        created_at:
          type: string
        updated_at:
          type: string
        presentation:
          type: string
        company_id:
          type: integer
          format: int32
        external_id:
          type: string
      example:
        id: 39
        title: size
        position: 28
        created_at: '2023-01-31T08:42:29.725Z'
        updated_at: '2023-01-31T08:42:29.725Z'
        presentation: Size
        company_id: 980191019
        external_id: null
    EnrollProduct:
      title: EnrollProduct
      type: object
      properties:
        id:
          type: integer
          format: int32
        product_id:
          type: integer
          format: int32
        enroll_id:
          type: integer
          format: int32
        active:
          type: boolean
        type:
          type: string
        created_at:
          type: string
        updated_at:
          type: string
      example:
        id: 19
        product_id: 2240
        enroll_id: 2
        active: true
        type: membership_product
        created_at: '2023-02-15T06:40:53.303Z'
        updated_at: '2023-02-15T06:40:53.303Z'
    Enroll:
      title: Enroll
      type: object
      properties:
        id:
          type: integer
          format: int32
        integration_id:
          type: string
        fields:
          allOf:
            - $ref: '#/components/schemas/Fields'
            - {}
        member_fee:
          type: integer
          format: int32
        member_fee_enabled:
          type: boolean
        company_id:
          type: integer
          format: int32
        created_at:
          type: string
        updated_at:
          type: string
        terms_and_conditions_url:
          type: string
      example:
        id: 2
        integration_id: null
        fields:
          dob: Birthdate
          full_name: Name
          government_id: Government ID
        member_fee: 25
        member_fee_enabled: true
        company_id: 980191019
        created_at: '2023-02-01T07:49:12.347Z'
        updated_at: '2023-02-01T07:54:36.961Z'
        terms_and_conditions_url: https://www.google.com/
    Fields:
      title: Fields
      required:
        - dob
        - full_name
        - government_id
      type: object
      properties:
        dob:
          type: string
        full_name:
          type: string
        government_id:
          type: string
      example:
        dob: Birthdate
        full_name: Name
        government_id: Government ID
    createrequest5:
      title: createrequest5
      required:
        - order
      type: object
      properties:
        order:
          allOf:
            - $ref: '#/components/schemas/Order'
            - {}
      example:
        order:
          order_number: K5124124
          customer_email: gavin@hooli.com
          customer_firstname: Gavin
          customer_lastname: Belson
          affiliate:
            email: tingeym2@gmail.com
          ship_to:
            address1: 506 W 1060 N
            city: American Fork
            state: UT
            postal_code: '84003'
          items:
            - sku: ABC1234
              name: SRQ
              image_url: >-
                https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png
              quantity: 2
              unit_price: 99.99
          amount_paid: 218.73
    Order:
      title: Order
      required:
        - order_number
        - customer_email
        - customer_firstname
        - customer_lastname
        - affiliate
        - ship_to
        - items
        - amount_paid
      type: object
      properties:
        order_number:
          type: string
        customer_email:
          type: string
        customer_firstname:
          type: string
        customer_lastname:
          type: string
        affiliate:
          allOf:
            - $ref: '#/components/schemas/Affiliate3'
            - {}
        ship_to:
          allOf:
            - $ref: '#/components/schemas/ShipTo3'
            - {}
        items:
          type: array
          items:
            $ref: '#/components/schemas/Item1'
          description: ''
        amount_paid:
          type: number
      example:
        order_number: K5124124
        customer_email: gavin@hooli.com
        customer_firstname: Gavin
        customer_lastname: Belson
        affiliate:
          email: tingeym2@gmail.com
        ship_to:
          address1: 506 W 1060 N
          city: American Fork
          state: UT
          postal_code: '84003'
        items:
          - sku: ABC1234
            name: SRQ
            image_url: >-
              https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png
            quantity: 2
            unit_price: 99.99
        amount_paid: 218.73
    Affiliate3:
      title: Affiliate3
      required:
        - email
      type: object
      properties:
        email:
          type: string
      example:
        email: tingeym2@gmail.com
    ShipTo3:
      title: ShipTo3
      required:
        - address1
        - city
        - state
        - postal_code
      type: object
      properties:
        address1:
          type: string
        city:
          type: string
        state:
          type: string
        postal_code:
          type: string
      example:
        address1: 506 W 1060 N
        city: American Fork
        state: UT
        postal_code: '84003'
    Item1:
      title: Item1
      required:
        - sku
        - name
        - image_url
        - quantity
        - unit_price
      type: object
      properties:
        sku:
          type: string
        name:
          type: string
        image_url:
          type: string
        quantity:
          type: integer
          format: int32
        unit_price:
          type: number
      example:
        sku: ABC1234
        name: SRQ
        image_url: >-
          https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png
        quantity: 2
        unit_price: 99.99
    create5:
      title: create5
      required:
        - id
        - order_number
        - amount
        - shipping
        - tax
        - subtotal
        - first_name
        - last_name
        - email
        - phone
        - tracking
        - cv
        - qv
        - status
        - order_type
        - rating
        - review
        - referrer
        - friendly_status
        - type
        - created_at
        - currency_code
        - currency_symbol
        - display_amount
        - display_subtotal
        - display_tax
        - display_shipping
        - display_refunds
        - display_discount
        - order_thumbnail
        - sale_date
        - recognized_ship_date
        - refundable
        - max_refundable_amount
        - max_refundable_tax
        - max_refundable_shipping
        - max_refundable_product_price
        - ship_to
        - bill_to
        - contact
        - items
        - tracking_informations
      type: object
      properties:
        id:
          type: integer
          format: int32
        order_number:
          type: string
        amount:
          type: string
        shipping:
          type: string
        tax:
          type: string
        subtotal:
          type: string
        first_name:
          type: string
        last_name:
          type: string
        email:
          type: string
        phone:
          type: string
        tracking:
          type: string
        cv:
          type: integer
          format: int32
        qv:
          type: integer
          format: int32
        status:
          type: string
        order_type:
          type: string
        rating:
          type: integer
          format: int32
        review:
          type: string
        referrer:
          type: string
        friendly_status:
          type: string
        type:
          type: string
        created_at:
          type: string
        currency_code:
          type: string
        currency_symbol:
          type: string
        display_amount:
          type: string
        display_subtotal:
          type: string
        display_tax:
          type: string
        display_shipping:
          type: string
        display_refunds:
          type: string
        display_discount:
          type: string
        order_thumbnail:
          type: string
        sale_date:
          type: string
        recognized_ship_date:
          type: string
        refundable:
          type: boolean
        max_refundable_amount:
          type: string
        max_refundable_tax:
          type: string
        max_refundable_shipping:
          type: string
        max_refundable_product_price:
          type: string
        ship_to:
          allOf:
            - $ref: '#/components/schemas/ShipTo4'
            - {}
        bill_to:
          type: string
        contact:
          allOf:
            - $ref: '#/components/schemas/Contact1'
            - {}
        items:
          type: array
          items:
            $ref: '#/components/schemas/Item2'
          description: ''
        tracking_informations:
          type: array
          items:
            type: string
          description: ''
      example:
        id: 10276
        order_number: K5124124
        amount: '218.73'
        shipping: '0.0'
        tax: '0.0'
        subtotal: '0.0'
        first_name: Gavin
        last_name: Belson
        email: gavin@hooli.com
        phone: null
        tracking: null
        cv: 0
        qv: 0
        status: awaiting_shipment
        order_type: imported
        rating: 1
        review: null
        referrer: Mike Tingey
        friendly_status: paid
        type: null
        created_at: '2023-12-19T11:52:57.474Z'
        currency_code: AFN
        currency_symbol: ؋
        display_amount: ؋218.73 (AFN)
        display_subtotal: ؋0.00 (AFN)
        display_tax: ؋0.00 (AFN)
        display_shipping: ؋0.00 (AFN)
        display_refunds: (0 CV, 0 QV) -؋0.00 (AFN)
        display_discount: ؋0.00 (AFN)
        order_thumbnail: >-
          https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png
        sale_date: '2023-12-19T11:52:57.474Z'
        recognized_ship_date: null
        refundable: false
        max_refundable_amount: '218.73'
        max_refundable_tax: '0.0'
        max_refundable_shipping: '0.0'
        max_refundable_product_price: '0.0'
        ship_to:
          id: 980200545
          name: null
          address1: 506 W 1060 N
          address2: null
          address3: null
          city: American Fork
          state: UT
          postal_code: '84003'
          country_code: null
          country: null
          default: false
        bill_to: null
        contact:
          id: 18105
          token: H8HneojRWb3qhs6mkNsCmAv3
          first_name: Gavin
          last_name: Belson
          avatar_url: null
          status: new
          email: gavin@hooli.com
          email2: null
          phone: null
          phone2: null
          phone_id: null
          address: null
          address2: null
          city: null
          state: null
          postal_code: null
          language_id: null
          country_id: null
          lead_type: null
          ip: null
          requested_at: null
          best_time: null
          time_zone: null
          reason: null
          income: null
          hours: null
          invest: null
          interest: null
          full_name: Gavin Belson
        items:
          - id: 10622
            quantity: 2
            price: 99.99
            ordered_variant: ''
            sku: null
            product:
              id: 6684
              active: false
              title: SRQ
              description:
                id: null
                name: description
                body: null
                record_type: Product
                record_id: 6684
                created_at: null
                updated_at: null
              stripped: ''
              price: '99.99'
              display_price: ؋99.99 (AFN)
              subscription_price: '99.99'
              display_subscription_price: ؋99.99 (AFN)
              wholesale_price: '0.0'
              display_wholesale_price: ؋0.00 (AFN)
              wholesale_subscription_price: '0.0'
              display_wholesale_subscription_price: ؋0.00 (AFN)
              shipping: '0.0'
              image:
                mini: >-
                  https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png
                detail: >-
                  https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png
                full: >-
                  https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png
              image_url: >-
                https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png
              sku: ABC1234
              country_code: us
              country_id: 1
              views: 0
              leads: 0
              share_link: null
              commission: '10.0'
              public: true
              shopify_id: null
              shopify_handle: null
              in_stock: true
              vendor: null
              price_range:
                - $99.99
                - $99.99
              price_range_formatted: $99.99
              unlimited_inventory: false
              default_variant:
                id: 27306
                product_id: 6684
                shopify_id: null
                title: null
                sku: ABC1234
                position: 15756
                inventory_policy: none
                taxable: true
                inventory_quantity: 1
                created_at: '2023-12-19T11:52:57.058Z'
                updated_at: '2023-12-19T11:52:57.058Z'
                external_id: null
                variant_country_id: null
                image_url: null
                image_path: null
                is_master: true
                discarded_at: null
                price: null
                weight: null
                size: null
                physical: true
                unit_of_weight: null
                height: null
                width: null
                length: null
                unit_of_size: null
                hs_code: null
                country_of_origin: null
                customs_information_shipping: true
                active: true
                bar_code: null
                track_quantity: true
                keep_selling: false
                option_attrs: []
                allow_subscription: true
              currency_symbol: ؋
              currency_code: AFN
              average_rating: 0
              option_values: {}
              publish_to_retail_store: true
              publish_to_rep_store: true
              publish_to_share_tab: true
              images: []
              countries:
                - id: 24
                  iso_name: BHUTAN
                  iso: BT
                  iso3: BTN
                  name: Bhutan
                  numcode: 64
                  active: true
                  currency_code: BTN
                  currency_symbol: Nu.
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 39
                  iso_name: CHAD
                  iso: TD
                  iso3: TCD
                  name: Chad
                  numcode: 148
                  active: true
                  currency_code: XAF
                  currency_symbol: CFA
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 92
                  iso_name: INDIA
                  iso: IN
                  iso3: IND
                  name: India
                  numcode: 356
                  active: true
                  currency_code: INR
                  currency_symbol: ₹
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 131
                  iso_name: MICRONESIA, FEDERATED STATES OF
                  iso: FM
                  iso3: FSM
                  name: Micronesia, Federated States of
                  numcode: 583
                  active: true
                  currency_code: USD
                  currency_symbol: $
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 148
                  iso_name: NIGERIA
                  iso: NG
                  iso3: NGA
                  name: Nigeria
                  numcode: 566
                  active: true
                  currency_code: NGN
                  currency_symbol: ₦
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 179
                  iso_name: SENEGAL
                  iso: SN
                  iso3: SEN
                  name: Senegal
                  numcode: 686
                  active: true
                  currency_code: XOF
                  currency_symbol: Fr
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 214
                  iso_name: UNITED STATES
                  iso: US
                  iso3: USA
                  name: United States
                  numcode: 840
                  active: true
                  currency_code: USD
                  currency_symbol: $
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 12
                  iso_name: AUSTRALIA
                  iso: AU
                  iso3: AUS
                  name: Australia
                  numcode: 36
                  active: true
                  currency_code: AUD
                  currency_symbol: $
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 13
                  iso_name: AUSTRIA
                  iso: AT
                  iso3: AUT
                  name: Austria
                  numcode: 40
                  active: true
                  currency_code: EUR
                  currency_symbol: €
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 14
                  iso_name: AZERBAIJAN
                  iso: AZ
                  iso3: AZE
                  name: Azerbaijan
                  numcode: 31
                  active: true
                  currency_code: AZN
                  currency_symbol: ₼
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 15
                  iso_name: BAHAMAS
                  iso: BS
                  iso3: BHS
                  name: Bahamas
                  numcode: 44
                  active: true
                  currency_code: BSD
                  currency_symbol: $
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 16
                  iso_name: BAHRAIN
                  iso: BH
                  iso3: BHR
                  name: Bahrain
                  numcode: 48
                  active: true
                  currency_code: BHD
                  currency_symbol: د.ب
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 205
                  iso_name: TUNISIA
                  iso: TN
                  iso3: TUN
                  name: Tunisia
                  numcode: 788
                  active: true
                  currency_code: TND
                  currency_symbol: د.ت
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 2
                  iso_name: ALBANIA
                  iso: AL
                  iso3: ALB
                  name: Albania
                  numcode: 8
                  active: true
                  currency_code: ALL
                  currency_symbol: L
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 3
                  iso_name: ALGERIA
                  iso: DZ
                  iso3: DZA
                  name: Algeria
                  numcode: 12
                  active: true
                  currency_code: DZD
                  currency_symbol: د.ج
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 5
                  iso_name: ANDORRA
                  iso: AD
                  iso3: AND
                  name: Andorra
                  numcode: 20
                  active: true
                  currency_code: EUR
                  currency_symbol: €
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 6
                  iso_name: ANGOLA
                  iso: AO
                  iso3: AGO
                  name: Angola
                  numcode: 24
                  active: true
                  currency_code: AOA
                  currency_symbol: Kz
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 7
                  iso_name: ANGUILLA
                  iso: AI
                  iso3: AIA
                  name: Anguilla
                  numcode: 660
                  active: true
                  currency_code: XCD
                  currency_symbol: $
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 8
                  iso_name: ANTIGUA AND BARBUDA
                  iso: AG
                  iso3: ATG
                  name: Antigua and Barbuda
                  numcode: 28
                  active: true
                  currency_code: XCD
                  currency_symbol: $
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 74
                  iso_name: GERMANY
                  iso: DE
                  iso3: DEU
                  name: Germany
                  numcode: 276
                  active: true
                  currency_code: EUR
                  currency_symbol: €
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 78
                  iso_name: GREENLAND
                  iso: GL
                  iso3: GRL
                  name: Greenland
                  numcode: 304
                  active: true
                  currency_code: DKK
                  currency_symbol: kr.
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 141
                  iso_name: NEPAL
                  iso: NP
                  iso3: NPL
                  name: Nepal
                  numcode: 524
                  active: true
                  currency_code: NPR
                  currency_symbol: Rs.
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 1
                  iso_name: AFGHANISTAN
                  iso: AF
                  iso3: AFG
                  name: Afghanistan
                  numcode: 4
                  active: true
                  currency_code: AFN
                  currency_symbol: ؋
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 9
                  iso_name: ARGENTINA
                  iso: AR
                  iso3: ARG
                  name: Argentina
                  numcode: 32
                  active: true
                  currency_code: ARS
                  currency_symbol: $
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 35
                  iso_name: CANADA
                  iso: CA
                  iso3: CAN
                  name: Canada
                  numcode: 124
                  active: true
                  currency_code: CAD
                  currency_symbol: $
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 142
                  iso_name: NETHERLANDS
                  iso: NL
                  iso3: NLD
                  name: Netherlands
                  numcode: 528
                  active: true
                  currency_code: EUR
                  currency_symbol: €
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 144
                  iso_name: NEW CALEDONIA
                  iso: NC
                  iso3: NCL
                  name: New Caledonia
                  numcode: 540
                  active: true
                  currency_code: XPF
                  currency_symbol: Fr
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 192
                  iso_name: SVALBARD AND JAN MAYEN
                  iso: SJ
                  iso3: SJM
                  name: Svalbard and Jan Mayen
                  numcode: 744
                  active: true
                  currency_code: NOK
                  currency_symbol: kr
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 224
                  iso_name: YEMEN
                  iso: YE
                  iso3: YEM
                  name: Yemen
                  numcode: 887
                  active: true
                  currency_code: YER
                  currency_symbol: ﷼
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
              variants:
                - id: 27306
                  title: null
                  image_url: null
                  buyable: true
                  option_value_ids: []
                  allow_subscription: true
                  variant_countries:
                    - id: 3147116
                      price: '99.99'
                      shipping: '0.0'
                      tax: '0.0'
                      currency_code: AFN
                      currency_symbol: ؋
                      display_price: ؋99.99 (AFN)
                      country_iso: AF
                      subscription_price: '99.99'
                      display_wholesale_price: ؋0.00 (AFN)
                      display_wholesale_subscription_price: ؋0.00 (AFN)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 1
                        iso: AF
                        iso_name: AFGHANISTAN
                        iso3: AFG
                        name: Afghanistan
                        tax_rate: 0
                    - id: 3147117
                      price: '99.99'
                      shipping: '0.0'
                      tax: '0.0'
                      currency_code: ALL
                      currency_symbol: L
                      display_price: L99.99 (ALL)
                      country_iso: AL
                      subscription_price: '99.99'
                      display_wholesale_price: L0.00 (ALL)
                      display_wholesale_subscription_price: L0.00 (ALL)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 2
                        iso: AL
                        iso_name: ALBANIA
                        iso3: ALB
                        name: Albania
                        tax_rate: 0
                    - id: 3147118
                      price: '99.99'
                      shipping: '0.0'
                      tax: '0.0'
                      currency_code: DZD
                      currency_symbol: د.ج
                      display_price: د.ج99.99 (DZD)
                      country_iso: DZ
                      subscription_price: '99.99'
                      display_wholesale_price: د.ج0.00 (DZD)
                      display_wholesale_subscription_price: د.ج0.00 (DZD)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 3
                        iso: DZ
                        iso_name: ALGERIA
                        iso3: DZA
                        name: Algeria
                        tax_rate: 0
                    - id: 3147119
                      price: '99.99'
                      shipping: '0.0'
                      tax: '0.0'
                      currency_code: EUR
                      currency_symbol: €
                      display_price: €99.99 (EUR)
                      country_iso: AD
                      subscription_price: '99.99'
                      display_wholesale_price: €0.00 (EUR)
                      display_wholesale_subscription_price: €0.00 (EUR)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 5
                        iso: AD
                        iso_name: ANDORRA
                        iso3: AND
                        name: Andorra
                        tax_rate: 0
                    - id: 3147120
                      price: '99.99'
                      shipping: '0.0'
                      tax: '0.0'
                      currency_code: AOA
                      currency_symbol: Kz
                      display_price: Kz99.99 (AOA)
                      country_iso: AO
                      subscription_price: '99.99'
                      display_wholesale_price: Kz0.00 (AOA)
                      display_wholesale_subscription_price: Kz0.00 (AOA)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 6
                        iso: AO
                        iso_name: ANGOLA
                        iso3: AGO
                        name: Angola
                        tax_rate: 0
                    - id: 3147121
                      price: '99.99'
                      shipping: '0.0'
                      tax: '0.0'
                      currency_code: XCD
                      currency_symbol: $
                      display_price: $99.99 (XCD)
                      country_iso: AI
                      subscription_price: '99.99'
                      display_wholesale_price: $0.00 (XCD)
                      display_wholesale_subscription_price: $0.00 (XCD)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 7
                        iso: AI
                        iso_name: ANGUILLA
                        iso3: AIA
                        name: Anguilla
                        tax_rate: 0
                    - id: 3147122
                      price: '99.99'
                      shipping: '0.0'
                      tax: '0.0'
                      currency_code: XCD
                      currency_symbol: $
                      display_price: $99.99 (XCD)
                      country_iso: AG
                      subscription_price: '99.99'
                      display_wholesale_price: $0.00 (XCD)
                      display_wholesale_subscription_price: $0.00 (XCD)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 8
                        iso: AG
                        iso_name: ANTIGUA AND BARBUDA
                        iso3: ATG
                        name: Antigua and Barbuda
                        tax_rate: 0
                    - id: 3147123
                      price: '99.99'
                      shipping: '0.0'
                      tax: '0.0'
                      currency_code: ARS
                      currency_symbol: $
                      display_price: $99.99 (ARS)
                      country_iso: AR
                      subscription_price: '99.99'
                      display_wholesale_price: $0.00 (ARS)
                      display_wholesale_subscription_price: $0.00 (ARS)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 9
                        iso: AR
                        iso_name: ARGENTINA
                        iso3: ARG
                        name: Argentina
                        tax_rate: 0
                    - id: 3147124
                      price: '99.99'
                      shipping: '0.0'
                      tax: '0.0'
                      currency_code: AUD
                      currency_symbol: $
                      display_price: $99.99 (AUD)
                      country_iso: AU
                      subscription_price: '99.99'
                      display_wholesale_price: $0.00 (AUD)
                      display_wholesale_subscription_price: $0.00 (AUD)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 12
                        iso: AU
                        iso_name: AUSTRALIA
                        iso3: AUS
                        name: Australia
                        tax_rate: 0
                    - id: 3147125
                      price: '99.99'
                      shipping: '0.0'
                      tax: '0.0'
                      currency_code: EUR
                      currency_symbol: €
                      display_price: €99.99 (EUR)
                      country_iso: AT
                      subscription_price: '99.99'
                      display_wholesale_price: €0.00 (EUR)
                      display_wholesale_subscription_price: €0.00 (EUR)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 13
                        iso: AT
                        iso_name: AUSTRIA
                        iso3: AUT
                        name: Austria
                        tax_rate: 0
                    - id: 3147126
                      price: '99.99'
                      shipping: '0.0'
                      tax: '0.0'
                      currency_code: AZN
                      currency_symbol: ₼
                      display_price: ₼99.99 (AZN)
                      country_iso: AZ
                      subscription_price: '99.99'
                      display_wholesale_price: ₼0.00 (AZN)
                      display_wholesale_subscription_price: ₼0.00 (AZN)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 14
                        iso: AZ
                        iso_name: AZERBAIJAN
                        iso3: AZE
                        name: Azerbaijan
                        tax_rate: 0
                    - id: 3147127
                      price: '99.99'
                      shipping: '0.0'
                      tax: '0.0'
                      currency_code: BSD
                      currency_symbol: $
                      display_price: $99.99 (BSD)
                      country_iso: BS
                      subscription_price: '99.99'
                      display_wholesale_price: $0.00 (BSD)
                      display_wholesale_subscription_price: $0.00 (BSD)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 15
                        iso: BS
                        iso_name: BAHAMAS
                        iso3: BHS
                        name: Bahamas
                        tax_rate: 0
                    - id: 3147128
                      price: '99.99'
                      shipping: '0.0'
                      tax: '0.0'
                      currency_code: BHD
                      currency_symbol: د.ب
                      display_price: د.ب99.990 (BHD)
                      country_iso: BH
                      subscription_price: '99.99'
                      display_wholesale_price: د.ب0.000 (BHD)
                      display_wholesale_subscription_price: د.ب0.000 (BHD)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 16
                        iso: BH
                        iso_name: BAHRAIN
                        iso3: BHR
                        name: Bahrain
                        tax_rate: 0
                    - id: 3147129
                      price: '99.99'
                      shipping: '0.0'
                      tax: '0.0'
                      currency_code: BTN
                      currency_symbol: Nu.
                      display_price: Nu.99.99 (BTN)
                      country_iso: BT
                      subscription_price: '99.99'
                      display_wholesale_price: Nu.0.00 (BTN)
                      display_wholesale_subscription_price: Nu.0.00 (BTN)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 24
                        iso: BT
                        iso_name: BHUTAN
                        iso3: BTN
                        name: Bhutan
                        tax_rate: 0
                    - id: 3147130
                      price: '99.99'
                      shipping: '0.0'
                      tax: '0.0'
                      currency_code: CAD
                      currency_symbol: $
                      display_price: $99.99 (CAD)
                      country_iso: CA
                      subscription_price: '99.99'
                      display_wholesale_price: $0.00 (CAD)
                      display_wholesale_subscription_price: $0.00 (CAD)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 35
                        iso: CA
                        iso_name: CANADA
                        iso3: CAN
                        name: Canada
                        tax_rate: 0
                    - id: 3147131
                      price: '99.99'
                      shipping: '0.0'
                      tax: '0.0'
                      currency_code: XAF
                      currency_symbol: CFA
                      display_price: CFA100 (XAF)
                      country_iso: TD
                      subscription_price: '99.99'
                      display_wholesale_price: CFA0 (XAF)
                      display_wholesale_subscription_price: CFA0 (XAF)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 39
                        iso: TD
                        iso_name: CHAD
                        iso3: TCD
                        name: Chad
                        tax_rate: 0
                    - id: 3147132
                      price: '99.99'
                      shipping: '0.0'
                      tax: '0.0'
                      currency_code: EUR
                      currency_symbol: €
                      display_price: €99.99 (EUR)
                      country_iso: DE
                      subscription_price: '99.99'
                      display_wholesale_price: €0.00 (EUR)
                      display_wholesale_subscription_price: €0.00 (EUR)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 74
                        iso: DE
                        iso_name: GERMANY
                        iso3: DEU
                        name: Germany
                        tax_rate: 0
                    - id: 3147133
                      price: '99.99'
                      shipping: '0.0'
                      tax: '0.0'
                      currency_code: DKK
                      currency_symbol: kr.
                      display_price: kr.99.99 (DKK)
                      country_iso: GL
                      subscription_price: '99.99'
                      display_wholesale_price: kr.0.00 (DKK)
                      display_wholesale_subscription_price: kr.0.00 (DKK)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 78
                        iso: GL
                        iso_name: GREENLAND
                        iso3: GRL
                        name: Greenland
                        tax_rate: 0
                    - id: 3147134
                      price: '99.99'
                      shipping: '0.0'
                      tax: '0.0'
                      currency_code: INR
                      currency_symbol: ₹
                      display_price: ₹99.99 (INR)
                      country_iso: IN
                      subscription_price: '99.99'
                      display_wholesale_price: ₹0.00 (INR)
                      display_wholesale_subscription_price: ₹0.00 (INR)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 92
                        iso: IN
                        iso_name: INDIA
                        iso3: IND
                        name: India
                        tax_rate: 0
                    - id: 3147135
                      price: '99.99'
                      shipping: '0.0'
                      tax: '0.0'
                      currency_code: USD
                      currency_symbol: $
                      display_price: $99.99 (USD)
                      country_iso: FM
                      subscription_price: '99.99'
                      display_wholesale_price: $0.00 (USD)
                      display_wholesale_subscription_price: $0.00 (USD)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 131
                        iso: FM
                        iso_name: MICRONESIA, FEDERATED STATES OF
                        iso3: FSM
                        name: Micronesia, Federated States of
                        tax_rate: 0
                    - id: 3147136
                      price: '99.99'
                      shipping: '0.0'
                      tax: '0.0'
                      currency_code: NPR
                      currency_symbol: Rs.
                      display_price: Rs.99.99 (NPR)
                      country_iso: NP
                      subscription_price: '99.99'
                      display_wholesale_price: Rs.0.00 (NPR)
                      display_wholesale_subscription_price: Rs.0.00 (NPR)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 141
                        iso: NP
                        iso_name: NEPAL
                        iso3: NPL
                        name: Nepal
                        tax_rate: 0
                    - id: 3147137
                      price: '99.99'
                      shipping: '0.0'
                      tax: '0.0'
                      currency_code: EUR
                      currency_symbol: €
                      display_price: €99.99 (EUR)
                      country_iso: NL
                      subscription_price: '99.99'
                      display_wholesale_price: €0.00 (EUR)
                      display_wholesale_subscription_price: €0.00 (EUR)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 142
                        iso: NL
                        iso_name: NETHERLANDS
                        iso3: NLD
                        name: Netherlands
                        tax_rate: 0
                    - id: 3147138
                      price: '99.99'
                      shipping: '0.0'
                      tax: '0.0'
                      currency_code: XPF
                      currency_symbol: Fr
                      display_price: Fr100 (XPF)
                      country_iso: NC
                      subscription_price: '99.99'
                      display_wholesale_price: Fr0 (XPF)
                      display_wholesale_subscription_price: Fr0 (XPF)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 144
                        iso: NC
                        iso_name: NEW CALEDONIA
                        iso3: NCL
                        name: New Caledonia
                        tax_rate: 0
                    - id: 3147139
                      price: '99.99'
                      shipping: '0.0'
                      tax: '0.0'
                      currency_code: NGN
                      currency_symbol: ₦
                      display_price: ₦99.99 (NGN)
                      country_iso: NG
                      subscription_price: '99.99'
                      display_wholesale_price: ₦0.00 (NGN)
                      display_wholesale_subscription_price: ₦0.00 (NGN)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 148
                        iso: NG
                        iso_name: NIGERIA
                        iso3: NGA
                        name: Nigeria
                        tax_rate: 0
                    - id: 3147140
                      price: '99.99'
                      shipping: '0.0'
                      tax: '0.0'
                      currency_code: XOF
                      currency_symbol: Fr
                      display_price: Fr100 (XOF)
                      country_iso: SN
                      subscription_price: '99.99'
                      display_wholesale_price: Fr0 (XOF)
                      display_wholesale_subscription_price: Fr0 (XOF)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 179
                        iso: SN
                        iso_name: SENEGAL
                        iso3: SEN
                        name: Senegal
                        tax_rate: 0
                    - id: 3147141
                      price: '99.99'
                      shipping: '0.0'
                      tax: '0.0'
                      currency_code: NOK
                      currency_symbol: kr
                      display_price: kr99.99 (NOK)
                      country_iso: SJ
                      subscription_price: '99.99'
                      display_wholesale_price: kr0.00 (NOK)
                      display_wholesale_subscription_price: kr0.00 (NOK)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 192
                        iso: SJ
                        iso_name: SVALBARD AND JAN MAYEN
                        iso3: SJM
                        name: Svalbard and Jan Mayen
                        tax_rate: 0
                    - id: 3147142
                      price: '99.99'
                      shipping: '0.0'
                      tax: '0.0'
                      currency_code: TND
                      currency_symbol: د.ت
                      display_price: د.ت99.990 (TND)
                      country_iso: TN
                      subscription_price: '99.99'
                      display_wholesale_price: د.ت0.000 (TND)
                      display_wholesale_subscription_price: د.ت0.000 (TND)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 205
                        iso: TN
                        iso_name: TUNISIA
                        iso3: TUN
                        name: Tunisia
                        tax_rate: 0
                    - id: 3147143
                      price: '99.99'
                      shipping: '0.0'
                      tax: '0.0'
                      currency_code: USD
                      currency_symbol: $
                      display_price: $99.99 (USD)
                      country_iso: US
                      subscription_price: '99.99'
                      display_wholesale_price: $0.00 (USD)
                      display_wholesale_subscription_price: $0.00 (USD)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 214
                        iso: US
                        iso_name: UNITED STATES
                        iso3: USA
                        name: United States
                        tax_rate: 0
                    - id: 3147144
                      price: '99.99'
                      shipping: '0.0'
                      tax: '0.0'
                      currency_code: YER
                      currency_symbol: ﷼
                      display_price: ﷼99.99 (YER)
                      country_iso: YE
                      subscription_price: '99.99'
                      display_wholesale_price: ﷼0.00 (YER)
                      display_wholesale_subscription_price: ﷼0.00 (YER)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 224
                        iso: YE
                        iso_name: YEMEN
                        iso3: YEM
                        name: Yemen
                        tax_rate: 0
              options: []
              prompts: []
              enroll_products: []
              enrolls: []
        tracking_informations: []
    ShipTo4:
      title: ShipTo4
      required:
        - id
        - name
        - address1
        - address2
        - address3
        - city
        - state
        - postal_code
        - country_code
        - country
        - default
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        address1:
          type: string
        address2:
          type: string
        address3:
          type: string
        city:
          type: string
        state:
          type: string
        postal_code:
          type: string
        country_code:
          type: string
        country:
          type: string
        default:
          type: boolean
      example:
        id: 980200545
        name: null
        address1: 506 W 1060 N
        address2: null
        address3: null
        city: American Fork
        state: UT
        postal_code: '84003'
        country_code: null
        country: null
        default: false
    Contact1:
      title: Contact1
      required:
        - id
        - token
        - first_name
        - last_name
        - avatar_url
        - status
        - email
        - email2
        - phone
        - phone2
        - phone_id
        - address
        - address2
        - city
        - state
        - postal_code
        - language_id
        - country_id
        - lead_type
        - ip
        - requested_at
        - best_time
        - time_zone
        - reason
        - income
        - hours
        - invest
        - interest
        - full_name
      type: object
      properties:
        id:
          type: integer
          format: int32
        token:
          type: string
        first_name:
          type: string
        last_name:
          type: string
        avatar_url:
          type: string
        status:
          type: string
        email:
          type: string
        email2:
          type: string
        phone:
          type: string
        phone2:
          type: string
        phone_id:
          type: string
        address:
          type: string
        address2:
          type: string
        city:
          type: string
        state:
          type: string
        postal_code:
          type: string
        language_id:
          type: string
        country_id:
          type: string
        lead_type:
          type: string
        ip:
          type: string
        requested_at:
          type: string
        best_time:
          type: string
        time_zone:
          type: string
        reason:
          type: string
        income:
          type: string
        hours:
          type: string
        invest:
          type: string
        interest:
          type: string
        full_name:
          type: string
      example:
        id: 18105
        token: H8HneojRWb3qhs6mkNsCmAv3
        first_name: Gavin
        last_name: Belson
        avatar_url: null
        status: new
        email: gavin@hooli.com
        email2: null
        phone: null
        phone2: null
        phone_id: null
        address: null
        address2: null
        city: null
        state: null
        postal_code: null
        language_id: null
        country_id: null
        lead_type: null
        ip: null
        requested_at: null
        best_time: null
        time_zone: null
        reason: null
        income: null
        hours: null
        invest: null
        interest: null
        full_name: Gavin Belson
    Item2:
      title: Item2
      required:
        - id
        - quantity
        - price
        - ordered_variant
        - sku
        - product
      type: object
      properties:
        id:
          type: integer
          format: int32
        quantity:
          type: integer
          format: int32
        price:
          type: number
        ordered_variant:
          type: string
        sku:
          type: string
        product:
          allOf:
            - $ref: '#/components/schemas/Product9'
            - {}
      example:
        id: 10622
        quantity: 2
        price: 99.99
        ordered_variant: ''
        sku: null
        product:
          id: 6684
          active: false
          title: SRQ
          description:
            id: null
            name: description
            body: null
            record_type: Product
            record_id: 6684
            created_at: null
            updated_at: null
          stripped: ''
          price: '99.99'
          display_price: ؋99.99 (AFN)
          subscription_price: '99.99'
          display_subscription_price: ؋99.99 (AFN)
          wholesale_price: '0.0'
          display_wholesale_price: ؋0.00 (AFN)
          wholesale_subscription_price: '0.0'
          display_wholesale_subscription_price: ؋0.00 (AFN)
          shipping: '0.0'
          image:
            mini: >-
              https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png
            detail: >-
              https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png
            full: >-
              https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png
          image_url: >-
            https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png
          sku: ABC1234
          country_code: us
          country_id: 1
          views: 0
          leads: 0
          share_link: null
          commission: '10.0'
          public: true
          shopify_id: null
          shopify_handle: null
          in_stock: true
          vendor: null
          price_range:
            - $99.99
            - $99.99
          price_range_formatted: $99.99
          unlimited_inventory: false
          default_variant:
            id: 27306
            product_id: 6684
            shopify_id: null
            title: null
            sku: ABC1234
            position: 15756
            inventory_policy: none
            taxable: true
            inventory_quantity: 1
            created_at: '2023-12-19T11:52:57.058Z'
            updated_at: '2023-12-19T11:52:57.058Z'
            external_id: null
            variant_country_id: null
            image_url: null
            image_path: null
            is_master: true
            discarded_at: null
            price: null
            weight: null
            size: null
            physical: true
            unit_of_weight: null
            height: null
            width: null
            length: null
            unit_of_size: null
            hs_code: null
            country_of_origin: null
            customs_information_shipping: true
            active: true
            bar_code: null
            track_quantity: true
            keep_selling: false
            option_attrs: []
            allow_subscription: true
          currency_symbol: ؋
          currency_code: AFN
          average_rating: 0
          option_values: {}
          publish_to_retail_store: true
          publish_to_rep_store: true
          publish_to_share_tab: true
          images: []
          countries:
            - id: 24
              iso_name: BHUTAN
              iso: BT
              iso3: BTN
              name: Bhutan
              numcode: 64
              active: true
              currency_code: BTN
              currency_symbol: Nu.
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 39
              iso_name: CHAD
              iso: TD
              iso3: TCD
              name: Chad
              numcode: 148
              active: true
              currency_code: XAF
              currency_symbol: CFA
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 92
              iso_name: INDIA
              iso: IN
              iso3: IND
              name: India
              numcode: 356
              active: true
              currency_code: INR
              currency_symbol: ₹
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 131
              iso_name: MICRONESIA, FEDERATED STATES OF
              iso: FM
              iso3: FSM
              name: Micronesia, Federated States of
              numcode: 583
              active: true
              currency_code: USD
              currency_symbol: $
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 148
              iso_name: NIGERIA
              iso: NG
              iso3: NGA
              name: Nigeria
              numcode: 566
              active: true
              currency_code: NGN
              currency_symbol: ₦
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 179
              iso_name: SENEGAL
              iso: SN
              iso3: SEN
              name: Senegal
              numcode: 686
              active: true
              currency_code: XOF
              currency_symbol: Fr
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 214
              iso_name: UNITED STATES
              iso: US
              iso3: USA
              name: United States
              numcode: 840
              active: true
              currency_code: USD
              currency_symbol: $
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 12
              iso_name: AUSTRALIA
              iso: AU
              iso3: AUS
              name: Australia
              numcode: 36
              active: true
              currency_code: AUD
              currency_symbol: $
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 13
              iso_name: AUSTRIA
              iso: AT
              iso3: AUT
              name: Austria
              numcode: 40
              active: true
              currency_code: EUR
              currency_symbol: €
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 14
              iso_name: AZERBAIJAN
              iso: AZ
              iso3: AZE
              name: Azerbaijan
              numcode: 31
              active: true
              currency_code: AZN
              currency_symbol: ₼
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 15
              iso_name: BAHAMAS
              iso: BS
              iso3: BHS
              name: Bahamas
              numcode: 44
              active: true
              currency_code: BSD
              currency_symbol: $
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 16
              iso_name: BAHRAIN
              iso: BH
              iso3: BHR
              name: Bahrain
              numcode: 48
              active: true
              currency_code: BHD
              currency_symbol: د.ب
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 205
              iso_name: TUNISIA
              iso: TN
              iso3: TUN
              name: Tunisia
              numcode: 788
              active: true
              currency_code: TND
              currency_symbol: د.ت
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 2
              iso_name: ALBANIA
              iso: AL
              iso3: ALB
              name: Albania
              numcode: 8
              active: true
              currency_code: ALL
              currency_symbol: L
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 3
              iso_name: ALGERIA
              iso: DZ
              iso3: DZA
              name: Algeria
              numcode: 12
              active: true
              currency_code: DZD
              currency_symbol: د.ج
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 5
              iso_name: ANDORRA
              iso: AD
              iso3: AND
              name: Andorra
              numcode: 20
              active: true
              currency_code: EUR
              currency_symbol: €
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 6
              iso_name: ANGOLA
              iso: AO
              iso3: AGO
              name: Angola
              numcode: 24
              active: true
              currency_code: AOA
              currency_symbol: Kz
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 7
              iso_name: ANGUILLA
              iso: AI
              iso3: AIA
              name: Anguilla
              numcode: 660
              active: true
              currency_code: XCD
              currency_symbol: $
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 8
              iso_name: ANTIGUA AND BARBUDA
              iso: AG
              iso3: ATG
              name: Antigua and Barbuda
              numcode: 28
              active: true
              currency_code: XCD
              currency_symbol: $
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 74
              iso_name: GERMANY
              iso: DE
              iso3: DEU
              name: Germany
              numcode: 276
              active: true
              currency_code: EUR
              currency_symbol: €
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 78
              iso_name: GREENLAND
              iso: GL
              iso3: GRL
              name: Greenland
              numcode: 304
              active: true
              currency_code: DKK
              currency_symbol: kr.
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 141
              iso_name: NEPAL
              iso: NP
              iso3: NPL
              name: Nepal
              numcode: 524
              active: true
              currency_code: NPR
              currency_symbol: Rs.
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 1
              iso_name: AFGHANISTAN
              iso: AF
              iso3: AFG
              name: Afghanistan
              numcode: 4
              active: true
              currency_code: AFN
              currency_symbol: ؋
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 9
              iso_name: ARGENTINA
              iso: AR
              iso3: ARG
              name: Argentina
              numcode: 32
              active: true
              currency_code: ARS
              currency_symbol: $
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 35
              iso_name: CANADA
              iso: CA
              iso3: CAN
              name: Canada
              numcode: 124
              active: true
              currency_code: CAD
              currency_symbol: $
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 142
              iso_name: NETHERLANDS
              iso: NL
              iso3: NLD
              name: Netherlands
              numcode: 528
              active: true
              currency_code: EUR
              currency_symbol: €
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 144
              iso_name: NEW CALEDONIA
              iso: NC
              iso3: NCL
              name: New Caledonia
              numcode: 540
              active: true
              currency_code: XPF
              currency_symbol: Fr
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 192
              iso_name: SVALBARD AND JAN MAYEN
              iso: SJ
              iso3: SJM
              name: Svalbard and Jan Mayen
              numcode: 744
              active: true
              currency_code: NOK
              currency_symbol: kr
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 224
              iso_name: YEMEN
              iso: YE
              iso3: YEM
              name: Yemen
              numcode: 887
              active: true
              currency_code: YER
              currency_symbol: ﷼
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
          variants:
            - id: 27306
              title: null
              image_url: null
              buyable: true
              option_value_ids: []
              allow_subscription: true
              variant_countries:
                - id: 3147116
                  price: '99.99'
                  shipping: '0.0'
                  tax: '0.0'
                  currency_code: AFN
                  currency_symbol: ؋
                  display_price: ؋99.99 (AFN)
                  country_iso: AF
                  subscription_price: '99.99'
                  display_wholesale_price: ؋0.00 (AFN)
                  display_wholesale_subscription_price: ؋0.00 (AFN)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 1
                    iso: AF
                    iso_name: AFGHANISTAN
                    iso3: AFG
                    name: Afghanistan
                    tax_rate: 0
                - id: 3147117
                  price: '99.99'
                  shipping: '0.0'
                  tax: '0.0'
                  currency_code: ALL
                  currency_symbol: L
                  display_price: L99.99 (ALL)
                  country_iso: AL
                  subscription_price: '99.99'
                  display_wholesale_price: L0.00 (ALL)
                  display_wholesale_subscription_price: L0.00 (ALL)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 2
                    iso: AL
                    iso_name: ALBANIA
                    iso3: ALB
                    name: Albania
                    tax_rate: 0
                - id: 3147118
                  price: '99.99'
                  shipping: '0.0'
                  tax: '0.0'
                  currency_code: DZD
                  currency_symbol: د.ج
                  display_price: د.ج99.99 (DZD)
                  country_iso: DZ
                  subscription_price: '99.99'
                  display_wholesale_price: د.ج0.00 (DZD)
                  display_wholesale_subscription_price: د.ج0.00 (DZD)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 3
                    iso: DZ
                    iso_name: ALGERIA
                    iso3: DZA
                    name: Algeria
                    tax_rate: 0
                - id: 3147119
                  price: '99.99'
                  shipping: '0.0'
                  tax: '0.0'
                  currency_code: EUR
                  currency_symbol: €
                  display_price: €99.99 (EUR)
                  country_iso: AD
                  subscription_price: '99.99'
                  display_wholesale_price: €0.00 (EUR)
                  display_wholesale_subscription_price: €0.00 (EUR)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 5
                    iso: AD
                    iso_name: ANDORRA
                    iso3: AND
                    name: Andorra
                    tax_rate: 0
                - id: 3147120
                  price: '99.99'
                  shipping: '0.0'
                  tax: '0.0'
                  currency_code: AOA
                  currency_symbol: Kz
                  display_price: Kz99.99 (AOA)
                  country_iso: AO
                  subscription_price: '99.99'
                  display_wholesale_price: Kz0.00 (AOA)
                  display_wholesale_subscription_price: Kz0.00 (AOA)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 6
                    iso: AO
                    iso_name: ANGOLA
                    iso3: AGO
                    name: Angola
                    tax_rate: 0
                - id: 3147121
                  price: '99.99'
                  shipping: '0.0'
                  tax: '0.0'
                  currency_code: XCD
                  currency_symbol: $
                  display_price: $99.99 (XCD)
                  country_iso: AI
                  subscription_price: '99.99'
                  display_wholesale_price: $0.00 (XCD)
                  display_wholesale_subscription_price: $0.00 (XCD)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 7
                    iso: AI
                    iso_name: ANGUILLA
                    iso3: AIA
                    name: Anguilla
                    tax_rate: 0
                - id: 3147122
                  price: '99.99'
                  shipping: '0.0'
                  tax: '0.0'
                  currency_code: XCD
                  currency_symbol: $
                  display_price: $99.99 (XCD)
                  country_iso: AG
                  subscription_price: '99.99'
                  display_wholesale_price: $0.00 (XCD)
                  display_wholesale_subscription_price: $0.00 (XCD)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 8
                    iso: AG
                    iso_name: ANTIGUA AND BARBUDA
                    iso3: ATG
                    name: Antigua and Barbuda
                    tax_rate: 0
                - id: 3147123
                  price: '99.99'
                  shipping: '0.0'
                  tax: '0.0'
                  currency_code: ARS
                  currency_symbol: $
                  display_price: $99.99 (ARS)
                  country_iso: AR
                  subscription_price: '99.99'
                  display_wholesale_price: $0.00 (ARS)
                  display_wholesale_subscription_price: $0.00 (ARS)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 9
                    iso: AR
                    iso_name: ARGENTINA
                    iso3: ARG
                    name: Argentina
                    tax_rate: 0
                - id: 3147124
                  price: '99.99'
                  shipping: '0.0'
                  tax: '0.0'
                  currency_code: AUD
                  currency_symbol: $
                  display_price: $99.99 (AUD)
                  country_iso: AU
                  subscription_price: '99.99'
                  display_wholesale_price: $0.00 (AUD)
                  display_wholesale_subscription_price: $0.00 (AUD)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 12
                    iso: AU
                    iso_name: AUSTRALIA
                    iso3: AUS
                    name: Australia
                    tax_rate: 0
                - id: 3147125
                  price: '99.99'
                  shipping: '0.0'
                  tax: '0.0'
                  currency_code: EUR
                  currency_symbol: €
                  display_price: €99.99 (EUR)
                  country_iso: AT
                  subscription_price: '99.99'
                  display_wholesale_price: €0.00 (EUR)
                  display_wholesale_subscription_price: €0.00 (EUR)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 13
                    iso: AT
                    iso_name: AUSTRIA
                    iso3: AUT
                    name: Austria
                    tax_rate: 0
                - id: 3147126
                  price: '99.99'
                  shipping: '0.0'
                  tax: '0.0'
                  currency_code: AZN
                  currency_symbol: ₼
                  display_price: ₼99.99 (AZN)
                  country_iso: AZ
                  subscription_price: '99.99'
                  display_wholesale_price: ₼0.00 (AZN)
                  display_wholesale_subscription_price: ₼0.00 (AZN)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 14
                    iso: AZ
                    iso_name: AZERBAIJAN
                    iso3: AZE
                    name: Azerbaijan
                    tax_rate: 0
                - id: 3147127
                  price: '99.99'
                  shipping: '0.0'
                  tax: '0.0'
                  currency_code: BSD
                  currency_symbol: $
                  display_price: $99.99 (BSD)
                  country_iso: BS
                  subscription_price: '99.99'
                  display_wholesale_price: $0.00 (BSD)
                  display_wholesale_subscription_price: $0.00 (BSD)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 15
                    iso: BS
                    iso_name: BAHAMAS
                    iso3: BHS
                    name: Bahamas
                    tax_rate: 0
                - id: 3147128
                  price: '99.99'
                  shipping: '0.0'
                  tax: '0.0'
                  currency_code: BHD
                  currency_symbol: د.ب
                  display_price: د.ب99.990 (BHD)
                  country_iso: BH
                  subscription_price: '99.99'
                  display_wholesale_price: د.ب0.000 (BHD)
                  display_wholesale_subscription_price: د.ب0.000 (BHD)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 16
                    iso: BH
                    iso_name: BAHRAIN
                    iso3: BHR
                    name: Bahrain
                    tax_rate: 0
                - id: 3147129
                  price: '99.99'
                  shipping: '0.0'
                  tax: '0.0'
                  currency_code: BTN
                  currency_symbol: Nu.
                  display_price: Nu.99.99 (BTN)
                  country_iso: BT
                  subscription_price: '99.99'
                  display_wholesale_price: Nu.0.00 (BTN)
                  display_wholesale_subscription_price: Nu.0.00 (BTN)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 24
                    iso: BT
                    iso_name: BHUTAN
                    iso3: BTN
                    name: Bhutan
                    tax_rate: 0
                - id: 3147130
                  price: '99.99'
                  shipping: '0.0'
                  tax: '0.0'
                  currency_code: CAD
                  currency_symbol: $
                  display_price: $99.99 (CAD)
                  country_iso: CA
                  subscription_price: '99.99'
                  display_wholesale_price: $0.00 (CAD)
                  display_wholesale_subscription_price: $0.00 (CAD)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 35
                    iso: CA
                    iso_name: CANADA
                    iso3: CAN
                    name: Canada
                    tax_rate: 0
                - id: 3147131
                  price: '99.99'
                  shipping: '0.0'
                  tax: '0.0'
                  currency_code: XAF
                  currency_symbol: CFA
                  display_price: CFA100 (XAF)
                  country_iso: TD
                  subscription_price: '99.99'
                  display_wholesale_price: CFA0 (XAF)
                  display_wholesale_subscription_price: CFA0 (XAF)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 39
                    iso: TD
                    iso_name: CHAD
                    iso3: TCD
                    name: Chad
                    tax_rate: 0
                - id: 3147132
                  price: '99.99'
                  shipping: '0.0'
                  tax: '0.0'
                  currency_code: EUR
                  currency_symbol: €
                  display_price: €99.99 (EUR)
                  country_iso: DE
                  subscription_price: '99.99'
                  display_wholesale_price: €0.00 (EUR)
                  display_wholesale_subscription_price: €0.00 (EUR)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 74
                    iso: DE
                    iso_name: GERMANY
                    iso3: DEU
                    name: Germany
                    tax_rate: 0
                - id: 3147133
                  price: '99.99'
                  shipping: '0.0'
                  tax: '0.0'
                  currency_code: DKK
                  currency_symbol: kr.
                  display_price: kr.99.99 (DKK)
                  country_iso: GL
                  subscription_price: '99.99'
                  display_wholesale_price: kr.0.00 (DKK)
                  display_wholesale_subscription_price: kr.0.00 (DKK)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 78
                    iso: GL
                    iso_name: GREENLAND
                    iso3: GRL
                    name: Greenland
                    tax_rate: 0
                - id: 3147134
                  price: '99.99'
                  shipping: '0.0'
                  tax: '0.0'
                  currency_code: INR
                  currency_symbol: ₹
                  display_price: ₹99.99 (INR)
                  country_iso: IN
                  subscription_price: '99.99'
                  display_wholesale_price: ₹0.00 (INR)
                  display_wholesale_subscription_price: ₹0.00 (INR)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 92
                    iso: IN
                    iso_name: INDIA
                    iso3: IND
                    name: India
                    tax_rate: 0
                - id: 3147135
                  price: '99.99'
                  shipping: '0.0'
                  tax: '0.0'
                  currency_code: USD
                  currency_symbol: $
                  display_price: $99.99 (USD)
                  country_iso: FM
                  subscription_price: '99.99'
                  display_wholesale_price: $0.00 (USD)
                  display_wholesale_subscription_price: $0.00 (USD)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 131
                    iso: FM
                    iso_name: MICRONESIA, FEDERATED STATES OF
                    iso3: FSM
                    name: Micronesia, Federated States of
                    tax_rate: 0
                - id: 3147136
                  price: '99.99'
                  shipping: '0.0'
                  tax: '0.0'
                  currency_code: NPR
                  currency_symbol: Rs.
                  display_price: Rs.99.99 (NPR)
                  country_iso: NP
                  subscription_price: '99.99'
                  display_wholesale_price: Rs.0.00 (NPR)
                  display_wholesale_subscription_price: Rs.0.00 (NPR)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 141
                    iso: NP
                    iso_name: NEPAL
                    iso3: NPL
                    name: Nepal
                    tax_rate: 0
                - id: 3147137
                  price: '99.99'
                  shipping: '0.0'
                  tax: '0.0'
                  currency_code: EUR
                  currency_symbol: €
                  display_price: €99.99 (EUR)
                  country_iso: NL
                  subscription_price: '99.99'
                  display_wholesale_price: €0.00 (EUR)
                  display_wholesale_subscription_price: €0.00 (EUR)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 142
                    iso: NL
                    iso_name: NETHERLANDS
                    iso3: NLD
                    name: Netherlands
                    tax_rate: 0
                - id: 3147138
                  price: '99.99'
                  shipping: '0.0'
                  tax: '0.0'
                  currency_code: XPF
                  currency_symbol: Fr
                  display_price: Fr100 (XPF)
                  country_iso: NC
                  subscription_price: '99.99'
                  display_wholesale_price: Fr0 (XPF)
                  display_wholesale_subscription_price: Fr0 (XPF)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 144
                    iso: NC
                    iso_name: NEW CALEDONIA
                    iso3: NCL
                    name: New Caledonia
                    tax_rate: 0
                - id: 3147139
                  price: '99.99'
                  shipping: '0.0'
                  tax: '0.0'
                  currency_code: NGN
                  currency_symbol: ₦
                  display_price: ₦99.99 (NGN)
                  country_iso: NG
                  subscription_price: '99.99'
                  display_wholesale_price: ₦0.00 (NGN)
                  display_wholesale_subscription_price: ₦0.00 (NGN)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 148
                    iso: NG
                    iso_name: NIGERIA
                    iso3: NGA
                    name: Nigeria
                    tax_rate: 0
                - id: 3147140
                  price: '99.99'
                  shipping: '0.0'
                  tax: '0.0'
                  currency_code: XOF
                  currency_symbol: Fr
                  display_price: Fr100 (XOF)
                  country_iso: SN
                  subscription_price: '99.99'
                  display_wholesale_price: Fr0 (XOF)
                  display_wholesale_subscription_price: Fr0 (XOF)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 179
                    iso: SN
                    iso_name: SENEGAL
                    iso3: SEN
                    name: Senegal
                    tax_rate: 0
                - id: 3147141
                  price: '99.99'
                  shipping: '0.0'
                  tax: '0.0'
                  currency_code: NOK
                  currency_symbol: kr
                  display_price: kr99.99 (NOK)
                  country_iso: SJ
                  subscription_price: '99.99'
                  display_wholesale_price: kr0.00 (NOK)
                  display_wholesale_subscription_price: kr0.00 (NOK)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 192
                    iso: SJ
                    iso_name: SVALBARD AND JAN MAYEN
                    iso3: SJM
                    name: Svalbard and Jan Mayen
                    tax_rate: 0
                - id: 3147142
                  price: '99.99'
                  shipping: '0.0'
                  tax: '0.0'
                  currency_code: TND
                  currency_symbol: د.ت
                  display_price: د.ت99.990 (TND)
                  country_iso: TN
                  subscription_price: '99.99'
                  display_wholesale_price: د.ت0.000 (TND)
                  display_wholesale_subscription_price: د.ت0.000 (TND)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 205
                    iso: TN
                    iso_name: TUNISIA
                    iso3: TUN
                    name: Tunisia
                    tax_rate: 0
                - id: 3147143
                  price: '99.99'
                  shipping: '0.0'
                  tax: '0.0'
                  currency_code: USD
                  currency_symbol: $
                  display_price: $99.99 (USD)
                  country_iso: US
                  subscription_price: '99.99'
                  display_wholesale_price: $0.00 (USD)
                  display_wholesale_subscription_price: $0.00 (USD)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 214
                    iso: US
                    iso_name: UNITED STATES
                    iso3: USA
                    name: United States
                    tax_rate: 0
                - id: 3147144
                  price: '99.99'
                  shipping: '0.0'
                  tax: '0.0'
                  currency_code: YER
                  currency_symbol: ﷼
                  display_price: ﷼99.99 (YER)
                  country_iso: YE
                  subscription_price: '99.99'
                  display_wholesale_price: ﷼0.00 (YER)
                  display_wholesale_subscription_price: ﷼0.00 (YER)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 224
                    iso: YE
                    iso_name: YEMEN
                    iso3: YEM
                    name: Yemen
                    tax_rate: 0
          options: []
          prompts: []
          enroll_products: []
          enrolls: []
    Product9:
      title: Product9
      required:
        - id
        - active
        - title
        - description
        - stripped
        - price
        - display_price
        - subscription_price
        - display_subscription_price
        - wholesale_price
        - display_wholesale_price
        - wholesale_subscription_price
        - display_wholesale_subscription_price
        - shipping
        - image
        - image_url
        - sku
        - country_code
        - country_id
        - views
        - leads
        - share_link
        - commission
        - public
        - shopify_id
        - shopify_handle
        - in_stock
        - vendor
        - price_range
        - price_range_formatted
        - unlimited_inventory
        - default_variant
        - currency_symbol
        - currency_code
        - average_rating
        - option_values
        - publish_to_retail_store
        - publish_to_rep_store
        - publish_to_share_tab
        - images
        - countries
        - variants
        - options
        - prompts
        - enroll_products
        - enrolls
      type: object
      properties:
        id:
          type: integer
          format: int32
        active:
          type: boolean
        title:
          type: string
        description:
          allOf:
            - $ref: '#/components/schemas/Description1'
            - {}
        stripped:
          type: string
        price:
          type: string
        display_price:
          type: string
        subscription_price:
          type: string
        display_subscription_price:
          type: string
        wholesale_price:
          type: string
        display_wholesale_price:
          type: string
        wholesale_subscription_price:
          type: string
        display_wholesale_subscription_price:
          type: string
        shipping:
          type: string
        image:
          allOf:
            - $ref: '#/components/schemas/Image3'
            - {}
        image_url:
          type: string
        sku:
          type: string
        country_code:
          type: string
        country_id:
          type: integer
          format: int32
        views:
          type: integer
          format: int32
        leads:
          type: integer
          format: int32
        share_link:
          type: string
        commission:
          type: string
        public:
          type: boolean
        shopify_id:
          type: string
        shopify_handle:
          type: string
        in_stock:
          type: boolean
        vendor:
          type: string
        price_range:
          type: array
          items:
            type: string
          description: ''
        price_range_formatted:
          type: string
        unlimited_inventory:
          type: boolean
        default_variant:
          allOf:
            - $ref: '#/components/schemas/DefaultVariant2'
            - {}
        currency_symbol:
          type: string
        currency_code:
          type: string
        average_rating:
          type: integer
          format: int32
        option_values:
          type: object
        publish_to_retail_store:
          type: boolean
        publish_to_rep_store:
          type: boolean
        publish_to_share_tab:
          type: boolean
        images:
          type: array
          items:
            type: string
          description: ''
        countries:
          type: array
          items:
            $ref: '#/components/schemas/Country7'
          description: ''
        variants:
          type: array
          items:
            $ref: '#/components/schemas/Variant8'
          description: ''
        options:
          type: array
          items:
            type: string
          description: ''
        prompts:
          type: array
          items:
            type: string
          description: ''
        enroll_products:
          type: array
          items:
            type: string
          description: ''
        enrolls:
          type: array
          items:
            type: string
          description: ''
      example:
        id: 6684
        active: false
        title: SRQ
        description:
          id: null
          name: description
          body: null
          record_type: Product
          record_id: 6684
          created_at: null
          updated_at: null
        stripped: ''
        price: '99.99'
        display_price: ؋99.99 (AFN)
        subscription_price: '99.99'
        display_subscription_price: ؋99.99 (AFN)
        wholesale_price: '0.0'
        display_wholesale_price: ؋0.00 (AFN)
        wholesale_subscription_price: '0.0'
        display_wholesale_subscription_price: ؋0.00 (AFN)
        shipping: '0.0'
        image:
          mini: >-
            https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png
          detail: >-
            https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png
          full: >-
            https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png
        image_url: >-
          https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png
        sku: ABC1234
        country_code: us
        country_id: 1
        views: 0
        leads: 0
        share_link: null
        commission: '10.0'
        public: true
        shopify_id: null
        shopify_handle: null
        in_stock: true
        vendor: null
        price_range:
          - $99.99
          - $99.99
        price_range_formatted: $99.99
        unlimited_inventory: false
        default_variant:
          id: 27306
          product_id: 6684
          shopify_id: null
          title: null
          sku: ABC1234
          position: 15756
          inventory_policy: none
          taxable: true
          inventory_quantity: 1
          created_at: '2023-12-19T11:52:57.058Z'
          updated_at: '2023-12-19T11:52:57.058Z'
          external_id: null
          variant_country_id: null
          image_url: null
          image_path: null
          is_master: true
          discarded_at: null
          price: null
          weight: null
          size: null
          physical: true
          unit_of_weight: null
          height: null
          width: null
          length: null
          unit_of_size: null
          hs_code: null
          country_of_origin: null
          customs_information_shipping: true
          active: true
          bar_code: null
          track_quantity: true
          keep_selling: false
          option_attrs: []
          allow_subscription: true
        currency_symbol: ؋
        currency_code: AFN
        average_rating: 0
        option_values: {}
        publish_to_retail_store: true
        publish_to_rep_store: true
        publish_to_share_tab: true
        images: []
        countries:
          - id: 24
            iso_name: BHUTAN
            iso: BT
            iso3: BTN
            name: Bhutan
            numcode: 64
            active: true
            currency_code: BTN
            currency_symbol: Nu.
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 39
            iso_name: CHAD
            iso: TD
            iso3: TCD
            name: Chad
            numcode: 148
            active: true
            currency_code: XAF
            currency_symbol: CFA
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 92
            iso_name: INDIA
            iso: IN
            iso3: IND
            name: India
            numcode: 356
            active: true
            currency_code: INR
            currency_symbol: ₹
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 131
            iso_name: MICRONESIA, FEDERATED STATES OF
            iso: FM
            iso3: FSM
            name: Micronesia, Federated States of
            numcode: 583
            active: true
            currency_code: USD
            currency_symbol: $
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 148
            iso_name: NIGERIA
            iso: NG
            iso3: NGA
            name: Nigeria
            numcode: 566
            active: true
            currency_code: NGN
            currency_symbol: ₦
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 179
            iso_name: SENEGAL
            iso: SN
            iso3: SEN
            name: Senegal
            numcode: 686
            active: true
            currency_code: XOF
            currency_symbol: Fr
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 214
            iso_name: UNITED STATES
            iso: US
            iso3: USA
            name: United States
            numcode: 840
            active: true
            currency_code: USD
            currency_symbol: $
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 12
            iso_name: AUSTRALIA
            iso: AU
            iso3: AUS
            name: Australia
            numcode: 36
            active: true
            currency_code: AUD
            currency_symbol: $
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 13
            iso_name: AUSTRIA
            iso: AT
            iso3: AUT
            name: Austria
            numcode: 40
            active: true
            currency_code: EUR
            currency_symbol: €
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 14
            iso_name: AZERBAIJAN
            iso: AZ
            iso3: AZE
            name: Azerbaijan
            numcode: 31
            active: true
            currency_code: AZN
            currency_symbol: ₼
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 15
            iso_name: BAHAMAS
            iso: BS
            iso3: BHS
            name: Bahamas
            numcode: 44
            active: true
            currency_code: BSD
            currency_symbol: $
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 16
            iso_name: BAHRAIN
            iso: BH
            iso3: BHR
            name: Bahrain
            numcode: 48
            active: true
            currency_code: BHD
            currency_symbol: د.ب
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 205
            iso_name: TUNISIA
            iso: TN
            iso3: TUN
            name: Tunisia
            numcode: 788
            active: true
            currency_code: TND
            currency_symbol: د.ت
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 2
            iso_name: ALBANIA
            iso: AL
            iso3: ALB
            name: Albania
            numcode: 8
            active: true
            currency_code: ALL
            currency_symbol: L
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 3
            iso_name: ALGERIA
            iso: DZ
            iso3: DZA
            name: Algeria
            numcode: 12
            active: true
            currency_code: DZD
            currency_symbol: د.ج
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 5
            iso_name: ANDORRA
            iso: AD
            iso3: AND
            name: Andorra
            numcode: 20
            active: true
            currency_code: EUR
            currency_symbol: €
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 6
            iso_name: ANGOLA
            iso: AO
            iso3: AGO
            name: Angola
            numcode: 24
            active: true
            currency_code: AOA
            currency_symbol: Kz
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 7
            iso_name: ANGUILLA
            iso: AI
            iso3: AIA
            name: Anguilla
            numcode: 660
            active: true
            currency_code: XCD
            currency_symbol: $
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 8
            iso_name: ANTIGUA AND BARBUDA
            iso: AG
            iso3: ATG
            name: Antigua and Barbuda
            numcode: 28
            active: true
            currency_code: XCD
            currency_symbol: $
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 74
            iso_name: GERMANY
            iso: DE
            iso3: DEU
            name: Germany
            numcode: 276
            active: true
            currency_code: EUR
            currency_symbol: €
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 78
            iso_name: GREENLAND
            iso: GL
            iso3: GRL
            name: Greenland
            numcode: 304
            active: true
            currency_code: DKK
            currency_symbol: kr.
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 141
            iso_name: NEPAL
            iso: NP
            iso3: NPL
            name: Nepal
            numcode: 524
            active: true
            currency_code: NPR
            currency_symbol: Rs.
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 1
            iso_name: AFGHANISTAN
            iso: AF
            iso3: AFG
            name: Afghanistan
            numcode: 4
            active: true
            currency_code: AFN
            currency_symbol: ؋
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 9
            iso_name: ARGENTINA
            iso: AR
            iso3: ARG
            name: Argentina
            numcode: 32
            active: true
            currency_code: ARS
            currency_symbol: $
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 35
            iso_name: CANADA
            iso: CA
            iso3: CAN
            name: Canada
            numcode: 124
            active: true
            currency_code: CAD
            currency_symbol: $
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 142
            iso_name: NETHERLANDS
            iso: NL
            iso3: NLD
            name: Netherlands
            numcode: 528
            active: true
            currency_code: EUR
            currency_symbol: €
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 144
            iso_name: NEW CALEDONIA
            iso: NC
            iso3: NCL
            name: New Caledonia
            numcode: 540
            active: true
            currency_code: XPF
            currency_symbol: Fr
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 192
            iso_name: SVALBARD AND JAN MAYEN
            iso: SJ
            iso3: SJM
            name: Svalbard and Jan Mayen
            numcode: 744
            active: true
            currency_code: NOK
            currency_symbol: kr
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 224
            iso_name: YEMEN
            iso: YE
            iso3: YEM
            name: Yemen
            numcode: 887
            active: true
            currency_code: YER
            currency_symbol: ﷼
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
        variants:
          - id: 27306
            title: null
            image_url: null
            buyable: true
            option_value_ids: []
            allow_subscription: true
            variant_countries:
              - id: 3147116
                price: '99.99'
                shipping: '0.0'
                tax: '0.0'
                currency_code: AFN
                currency_symbol: ؋
                display_price: ؋99.99 (AFN)
                country_iso: AF
                subscription_price: '99.99'
                display_wholesale_price: ؋0.00 (AFN)
                display_wholesale_subscription_price: ؋0.00 (AFN)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 1
                  iso: AF
                  iso_name: AFGHANISTAN
                  iso3: AFG
                  name: Afghanistan
                  tax_rate: 0
              - id: 3147117
                price: '99.99'
                shipping: '0.0'
                tax: '0.0'
                currency_code: ALL
                currency_symbol: L
                display_price: L99.99 (ALL)
                country_iso: AL
                subscription_price: '99.99'
                display_wholesale_price: L0.00 (ALL)
                display_wholesale_subscription_price: L0.00 (ALL)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 2
                  iso: AL
                  iso_name: ALBANIA
                  iso3: ALB
                  name: Albania
                  tax_rate: 0
              - id: 3147118
                price: '99.99'
                shipping: '0.0'
                tax: '0.0'
                currency_code: DZD
                currency_symbol: د.ج
                display_price: د.ج99.99 (DZD)
                country_iso: DZ
                subscription_price: '99.99'
                display_wholesale_price: د.ج0.00 (DZD)
                display_wholesale_subscription_price: د.ج0.00 (DZD)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 3
                  iso: DZ
                  iso_name: ALGERIA
                  iso3: DZA
                  name: Algeria
                  tax_rate: 0
              - id: 3147119
                price: '99.99'
                shipping: '0.0'
                tax: '0.0'
                currency_code: EUR
                currency_symbol: €
                display_price: €99.99 (EUR)
                country_iso: AD
                subscription_price: '99.99'
                display_wholesale_price: €0.00 (EUR)
                display_wholesale_subscription_price: €0.00 (EUR)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 5
                  iso: AD
                  iso_name: ANDORRA
                  iso3: AND
                  name: Andorra
                  tax_rate: 0
              - id: 3147120
                price: '99.99'
                shipping: '0.0'
                tax: '0.0'
                currency_code: AOA
                currency_symbol: Kz
                display_price: Kz99.99 (AOA)
                country_iso: AO
                subscription_price: '99.99'
                display_wholesale_price: Kz0.00 (AOA)
                display_wholesale_subscription_price: Kz0.00 (AOA)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 6
                  iso: AO
                  iso_name: ANGOLA
                  iso3: AGO
                  name: Angola
                  tax_rate: 0
              - id: 3147121
                price: '99.99'
                shipping: '0.0'
                tax: '0.0'
                currency_code: XCD
                currency_symbol: $
                display_price: $99.99 (XCD)
                country_iso: AI
                subscription_price: '99.99'
                display_wholesale_price: $0.00 (XCD)
                display_wholesale_subscription_price: $0.00 (XCD)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 7
                  iso: AI
                  iso_name: ANGUILLA
                  iso3: AIA
                  name: Anguilla
                  tax_rate: 0
              - id: 3147122
                price: '99.99'
                shipping: '0.0'
                tax: '0.0'
                currency_code: XCD
                currency_symbol: $
                display_price: $99.99 (XCD)
                country_iso: AG
                subscription_price: '99.99'
                display_wholesale_price: $0.00 (XCD)
                display_wholesale_subscription_price: $0.00 (XCD)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 8
                  iso: AG
                  iso_name: ANTIGUA AND BARBUDA
                  iso3: ATG
                  name: Antigua and Barbuda
                  tax_rate: 0
              - id: 3147123
                price: '99.99'
                shipping: '0.0'
                tax: '0.0'
                currency_code: ARS
                currency_symbol: $
                display_price: $99.99 (ARS)
                country_iso: AR
                subscription_price: '99.99'
                display_wholesale_price: $0.00 (ARS)
                display_wholesale_subscription_price: $0.00 (ARS)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 9
                  iso: AR
                  iso_name: ARGENTINA
                  iso3: ARG
                  name: Argentina
                  tax_rate: 0
              - id: 3147124
                price: '99.99'
                shipping: '0.0'
                tax: '0.0'
                currency_code: AUD
                currency_symbol: $
                display_price: $99.99 (AUD)
                country_iso: AU
                subscription_price: '99.99'
                display_wholesale_price: $0.00 (AUD)
                display_wholesale_subscription_price: $0.00 (AUD)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 12
                  iso: AU
                  iso_name: AUSTRALIA
                  iso3: AUS
                  name: Australia
                  tax_rate: 0
              - id: 3147125
                price: '99.99'
                shipping: '0.0'
                tax: '0.0'
                currency_code: EUR
                currency_symbol: €
                display_price: €99.99 (EUR)
                country_iso: AT
                subscription_price: '99.99'
                display_wholesale_price: €0.00 (EUR)
                display_wholesale_subscription_price: €0.00 (EUR)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 13
                  iso: AT
                  iso_name: AUSTRIA
                  iso3: AUT
                  name: Austria
                  tax_rate: 0
              - id: 3147126
                price: '99.99'
                shipping: '0.0'
                tax: '0.0'
                currency_code: AZN
                currency_symbol: ₼
                display_price: ₼99.99 (AZN)
                country_iso: AZ
                subscription_price: '99.99'
                display_wholesale_price: ₼0.00 (AZN)
                display_wholesale_subscription_price: ₼0.00 (AZN)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 14
                  iso: AZ
                  iso_name: AZERBAIJAN
                  iso3: AZE
                  name: Azerbaijan
                  tax_rate: 0
              - id: 3147127
                price: '99.99'
                shipping: '0.0'
                tax: '0.0'
                currency_code: BSD
                currency_symbol: $
                display_price: $99.99 (BSD)
                country_iso: BS
                subscription_price: '99.99'
                display_wholesale_price: $0.00 (BSD)
                display_wholesale_subscription_price: $0.00 (BSD)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 15
                  iso: BS
                  iso_name: BAHAMAS
                  iso3: BHS
                  name: Bahamas
                  tax_rate: 0
              - id: 3147128
                price: '99.99'
                shipping: '0.0'
                tax: '0.0'
                currency_code: BHD
                currency_symbol: د.ب
                display_price: د.ب99.990 (BHD)
                country_iso: BH
                subscription_price: '99.99'
                display_wholesale_price: د.ب0.000 (BHD)
                display_wholesale_subscription_price: د.ب0.000 (BHD)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 16
                  iso: BH
                  iso_name: BAHRAIN
                  iso3: BHR
                  name: Bahrain
                  tax_rate: 0
              - id: 3147129
                price: '99.99'
                shipping: '0.0'
                tax: '0.0'
                currency_code: BTN
                currency_symbol: Nu.
                display_price: Nu.99.99 (BTN)
                country_iso: BT
                subscription_price: '99.99'
                display_wholesale_price: Nu.0.00 (BTN)
                display_wholesale_subscription_price: Nu.0.00 (BTN)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 24
                  iso: BT
                  iso_name: BHUTAN
                  iso3: BTN
                  name: Bhutan
                  tax_rate: 0
              - id: 3147130
                price: '99.99'
                shipping: '0.0'
                tax: '0.0'
                currency_code: CAD
                currency_symbol: $
                display_price: $99.99 (CAD)
                country_iso: CA
                subscription_price: '99.99'
                display_wholesale_price: $0.00 (CAD)
                display_wholesale_subscription_price: $0.00 (CAD)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 35
                  iso: CA
                  iso_name: CANADA
                  iso3: CAN
                  name: Canada
                  tax_rate: 0
              - id: 3147131
                price: '99.99'
                shipping: '0.0'
                tax: '0.0'
                currency_code: XAF
                currency_symbol: CFA
                display_price: CFA100 (XAF)
                country_iso: TD
                subscription_price: '99.99'
                display_wholesale_price: CFA0 (XAF)
                display_wholesale_subscription_price: CFA0 (XAF)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 39
                  iso: TD
                  iso_name: CHAD
                  iso3: TCD
                  name: Chad
                  tax_rate: 0
              - id: 3147132
                price: '99.99'
                shipping: '0.0'
                tax: '0.0'
                currency_code: EUR
                currency_symbol: €
                display_price: €99.99 (EUR)
                country_iso: DE
                subscription_price: '99.99'
                display_wholesale_price: €0.00 (EUR)
                display_wholesale_subscription_price: €0.00 (EUR)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 74
                  iso: DE
                  iso_name: GERMANY
                  iso3: DEU
                  name: Germany
                  tax_rate: 0
              - id: 3147133
                price: '99.99'
                shipping: '0.0'
                tax: '0.0'
                currency_code: DKK
                currency_symbol: kr.
                display_price: kr.99.99 (DKK)
                country_iso: GL
                subscription_price: '99.99'
                display_wholesale_price: kr.0.00 (DKK)
                display_wholesale_subscription_price: kr.0.00 (DKK)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 78
                  iso: GL
                  iso_name: GREENLAND
                  iso3: GRL
                  name: Greenland
                  tax_rate: 0
              - id: 3147134
                price: '99.99'
                shipping: '0.0'
                tax: '0.0'
                currency_code: INR
                currency_symbol: ₹
                display_price: ₹99.99 (INR)
                country_iso: IN
                subscription_price: '99.99'
                display_wholesale_price: ₹0.00 (INR)
                display_wholesale_subscription_price: ₹0.00 (INR)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 92
                  iso: IN
                  iso_name: INDIA
                  iso3: IND
                  name: India
                  tax_rate: 0
              - id: 3147135
                price: '99.99'
                shipping: '0.0'
                tax: '0.0'
                currency_code: USD
                currency_symbol: $
                display_price: $99.99 (USD)
                country_iso: FM
                subscription_price: '99.99'
                display_wholesale_price: $0.00 (USD)
                display_wholesale_subscription_price: $0.00 (USD)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 131
                  iso: FM
                  iso_name: MICRONESIA, FEDERATED STATES OF
                  iso3: FSM
                  name: Micronesia, Federated States of
                  tax_rate: 0
              - id: 3147136
                price: '99.99'
                shipping: '0.0'
                tax: '0.0'
                currency_code: NPR
                currency_symbol: Rs.
                display_price: Rs.99.99 (NPR)
                country_iso: NP
                subscription_price: '99.99'
                display_wholesale_price: Rs.0.00 (NPR)
                display_wholesale_subscription_price: Rs.0.00 (NPR)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 141
                  iso: NP
                  iso_name: NEPAL
                  iso3: NPL
                  name: Nepal
                  tax_rate: 0
              - id: 3147137
                price: '99.99'
                shipping: '0.0'
                tax: '0.0'
                currency_code: EUR
                currency_symbol: €
                display_price: €99.99 (EUR)
                country_iso: NL
                subscription_price: '99.99'
                display_wholesale_price: €0.00 (EUR)
                display_wholesale_subscription_price: €0.00 (EUR)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 142
                  iso: NL
                  iso_name: NETHERLANDS
                  iso3: NLD
                  name: Netherlands
                  tax_rate: 0
              - id: 3147138
                price: '99.99'
                shipping: '0.0'
                tax: '0.0'
                currency_code: XPF
                currency_symbol: Fr
                display_price: Fr100 (XPF)
                country_iso: NC
                subscription_price: '99.99'
                display_wholesale_price: Fr0 (XPF)
                display_wholesale_subscription_price: Fr0 (XPF)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 144
                  iso: NC
                  iso_name: NEW CALEDONIA
                  iso3: NCL
                  name: New Caledonia
                  tax_rate: 0
              - id: 3147139
                price: '99.99'
                shipping: '0.0'
                tax: '0.0'
                currency_code: NGN
                currency_symbol: ₦
                display_price: ₦99.99 (NGN)
                country_iso: NG
                subscription_price: '99.99'
                display_wholesale_price: ₦0.00 (NGN)
                display_wholesale_subscription_price: ₦0.00 (NGN)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 148
                  iso: NG
                  iso_name: NIGERIA
                  iso3: NGA
                  name: Nigeria
                  tax_rate: 0
              - id: 3147140
                price: '99.99'
                shipping: '0.0'
                tax: '0.0'
                currency_code: XOF
                currency_symbol: Fr
                display_price: Fr100 (XOF)
                country_iso: SN
                subscription_price: '99.99'
                display_wholesale_price: Fr0 (XOF)
                display_wholesale_subscription_price: Fr0 (XOF)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 179
                  iso: SN
                  iso_name: SENEGAL
                  iso3: SEN
                  name: Senegal
                  tax_rate: 0
              - id: 3147141
                price: '99.99'
                shipping: '0.0'
                tax: '0.0'
                currency_code: NOK
                currency_symbol: kr
                display_price: kr99.99 (NOK)
                country_iso: SJ
                subscription_price: '99.99'
                display_wholesale_price: kr0.00 (NOK)
                display_wholesale_subscription_price: kr0.00 (NOK)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 192
                  iso: SJ
                  iso_name: SVALBARD AND JAN MAYEN
                  iso3: SJM
                  name: Svalbard and Jan Mayen
                  tax_rate: 0
              - id: 3147142
                price: '99.99'
                shipping: '0.0'
                tax: '0.0'
                currency_code: TND
                currency_symbol: د.ت
                display_price: د.ت99.990 (TND)
                country_iso: TN
                subscription_price: '99.99'
                display_wholesale_price: د.ت0.000 (TND)
                display_wholesale_subscription_price: د.ت0.000 (TND)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 205
                  iso: TN
                  iso_name: TUNISIA
                  iso3: TUN
                  name: Tunisia
                  tax_rate: 0
              - id: 3147143
                price: '99.99'
                shipping: '0.0'
                tax: '0.0'
                currency_code: USD
                currency_symbol: $
                display_price: $99.99 (USD)
                country_iso: US
                subscription_price: '99.99'
                display_wholesale_price: $0.00 (USD)
                display_wholesale_subscription_price: $0.00 (USD)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 214
                  iso: US
                  iso_name: UNITED STATES
                  iso3: USA
                  name: United States
                  tax_rate: 0
              - id: 3147144
                price: '99.99'
                shipping: '0.0'
                tax: '0.0'
                currency_code: YER
                currency_symbol: ﷼
                display_price: ﷼99.99 (YER)
                country_iso: YE
                subscription_price: '99.99'
                display_wholesale_price: ﷼0.00 (YER)
                display_wholesale_subscription_price: ﷼0.00 (YER)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 224
                  iso: YE
                  iso_name: YEMEN
                  iso3: YEM
                  name: Yemen
                  tax_rate: 0
        options: []
        prompts: []
        enroll_products: []
        enrolls: []
    Description1:
      title: Description1
      required:
        - id
        - name
        - body
        - record_type
        - record_id
        - created_at
        - updated_at
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        body:
          type: string
        record_type:
          type: string
        record_id:
          type: integer
          format: int32
        created_at:
          type: string
        updated_at:
          type: string
      example:
        id: null
        name: description
        body: null
        record_type: Product
        record_id: 6684
        created_at: null
        updated_at: null
    DefaultVariant2:
      title: DefaultVariant2
      required:
        - id
        - product_id
        - shopify_id
        - title
        - sku
        - position
        - inventory_policy
        - taxable
        - inventory_quantity
        - created_at
        - updated_at
        - external_id
        - variant_country_id
        - image_url
        - image_path
        - is_master
        - discarded_at
        - price
        - weight
        - size
        - physical
        - unit_of_weight
        - height
        - width
        - length
        - unit_of_size
        - hs_code
        - country_of_origin
        - customs_information_shipping
        - active
        - bar_code
        - track_quantity
        - keep_selling
        - option_attrs
        - allow_subscription
      type: object
      properties:
        id:
          type: integer
          format: int32
        product_id:
          type: integer
          format: int32
        shopify_id:
          type: string
        title:
          type: string
        sku:
          type: string
        position:
          type: integer
          format: int32
        inventory_policy:
          type: string
        taxable:
          type: boolean
        inventory_quantity:
          type: integer
          format: int32
        created_at:
          type: string
        updated_at:
          type: string
        external_id:
          type: string
        variant_country_id:
          type: string
        image_url:
          type: string
        image_path:
          type: string
        is_master:
          type: boolean
        discarded_at:
          type: string
        price:
          type: string
        weight:
          type: string
        size:
          type: string
        physical:
          type: boolean
        unit_of_weight:
          type: string
        height:
          type: string
        width:
          type: string
        length:
          type: string
        unit_of_size:
          type: string
        hs_code:
          type: string
        country_of_origin:
          type: string
        customs_information_shipping:
          type: boolean
        active:
          type: boolean
        bar_code:
          type: string
        track_quantity:
          type: boolean
        keep_selling:
          type: boolean
        option_attrs:
          type: array
          items:
            type: string
          description: ''
        allow_subscription:
          type: boolean
      example:
        id: 27306
        product_id: 6684
        shopify_id: null
        title: null
        sku: ABC1234
        position: 15756
        inventory_policy: none
        taxable: true
        inventory_quantity: 1
        created_at: '2023-12-19T11:52:57.058Z'
        updated_at: '2023-12-19T11:52:57.058Z'
        external_id: null
        variant_country_id: null
        image_url: null
        image_path: null
        is_master: true
        discarded_at: null
        price: null
        weight: null
        size: null
        physical: true
        unit_of_weight: null
        height: null
        width: null
        length: null
        unit_of_size: null
        hs_code: null
        country_of_origin: null
        customs_information_shipping: true
        active: true
        bar_code: null
        track_quantity: true
        keep_selling: false
        option_attrs: []
        allow_subscription: true
    Variant8:
      title: Variant8
      required:
        - id
        - title
        - image_url
        - buyable
        - option_value_ids
        - allow_subscription
        - variant_countries
      type: object
      properties:
        id:
          type: integer
          format: int32
        title:
          type: string
        image_url:
          type: string
        buyable:
          type: boolean
        option_value_ids:
          type: array
          items:
            type: string
          description: ''
        allow_subscription:
          type: boolean
        variant_countries:
          type: array
          items:
            $ref: '#/components/schemas/VariantCountries5'
          description: ''
      example:
        id: 27306
        title: null
        image_url: null
        buyable: true
        option_value_ids: []
        allow_subscription: true
        variant_countries:
          - id: 3147116
            price: '99.99'
            shipping: '0.0'
            tax: '0.0'
            currency_code: AFN
            currency_symbol: ؋
            display_price: ؋99.99 (AFN)
            country_iso: AF
            subscription_price: '99.99'
            display_wholesale_price: ؋0.00 (AFN)
            display_wholesale_subscription_price: ؋0.00 (AFN)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 1
              iso: AF
              iso_name: AFGHANISTAN
              iso3: AFG
              name: Afghanistan
              tax_rate: 0
          - id: 3147117
            price: '99.99'
            shipping: '0.0'
            tax: '0.0'
            currency_code: ALL
            currency_symbol: L
            display_price: L99.99 (ALL)
            country_iso: AL
            subscription_price: '99.99'
            display_wholesale_price: L0.00 (ALL)
            display_wholesale_subscription_price: L0.00 (ALL)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 2
              iso: AL
              iso_name: ALBANIA
              iso3: ALB
              name: Albania
              tax_rate: 0
          - id: 3147118
            price: '99.99'
            shipping: '0.0'
            tax: '0.0'
            currency_code: DZD
            currency_symbol: د.ج
            display_price: د.ج99.99 (DZD)
            country_iso: DZ
            subscription_price: '99.99'
            display_wholesale_price: د.ج0.00 (DZD)
            display_wholesale_subscription_price: د.ج0.00 (DZD)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 3
              iso: DZ
              iso_name: ALGERIA
              iso3: DZA
              name: Algeria
              tax_rate: 0
          - id: 3147119
            price: '99.99'
            shipping: '0.0'
            tax: '0.0'
            currency_code: EUR
            currency_symbol: €
            display_price: €99.99 (EUR)
            country_iso: AD
            subscription_price: '99.99'
            display_wholesale_price: €0.00 (EUR)
            display_wholesale_subscription_price: €0.00 (EUR)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 5
              iso: AD
              iso_name: ANDORRA
              iso3: AND
              name: Andorra
              tax_rate: 0
          - id: 3147120
            price: '99.99'
            shipping: '0.0'
            tax: '0.0'
            currency_code: AOA
            currency_symbol: Kz
            display_price: Kz99.99 (AOA)
            country_iso: AO
            subscription_price: '99.99'
            display_wholesale_price: Kz0.00 (AOA)
            display_wholesale_subscription_price: Kz0.00 (AOA)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 6
              iso: AO
              iso_name: ANGOLA
              iso3: AGO
              name: Angola
              tax_rate: 0
          - id: 3147121
            price: '99.99'
            shipping: '0.0'
            tax: '0.0'
            currency_code: XCD
            currency_symbol: $
            display_price: $99.99 (XCD)
            country_iso: AI
            subscription_price: '99.99'
            display_wholesale_price: $0.00 (XCD)
            display_wholesale_subscription_price: $0.00 (XCD)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 7
              iso: AI
              iso_name: ANGUILLA
              iso3: AIA
              name: Anguilla
              tax_rate: 0
          - id: 3147122
            price: '99.99'
            shipping: '0.0'
            tax: '0.0'
            currency_code: XCD
            currency_symbol: $
            display_price: $99.99 (XCD)
            country_iso: AG
            subscription_price: '99.99'
            display_wholesale_price: $0.00 (XCD)
            display_wholesale_subscription_price: $0.00 (XCD)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 8
              iso: AG
              iso_name: ANTIGUA AND BARBUDA
              iso3: ATG
              name: Antigua and Barbuda
              tax_rate: 0
          - id: 3147123
            price: '99.99'
            shipping: '0.0'
            tax: '0.0'
            currency_code: ARS
            currency_symbol: $
            display_price: $99.99 (ARS)
            country_iso: AR
            subscription_price: '99.99'
            display_wholesale_price: $0.00 (ARS)
            display_wholesale_subscription_price: $0.00 (ARS)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 9
              iso: AR
              iso_name: ARGENTINA
              iso3: ARG
              name: Argentina
              tax_rate: 0
          - id: 3147124
            price: '99.99'
            shipping: '0.0'
            tax: '0.0'
            currency_code: AUD
            currency_symbol: $
            display_price: $99.99 (AUD)
            country_iso: AU
            subscription_price: '99.99'
            display_wholesale_price: $0.00 (AUD)
            display_wholesale_subscription_price: $0.00 (AUD)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 12
              iso: AU
              iso_name: AUSTRALIA
              iso3: AUS
              name: Australia
              tax_rate: 0
          - id: 3147125
            price: '99.99'
            shipping: '0.0'
            tax: '0.0'
            currency_code: EUR
            currency_symbol: €
            display_price: €99.99 (EUR)
            country_iso: AT
            subscription_price: '99.99'
            display_wholesale_price: €0.00 (EUR)
            display_wholesale_subscription_price: €0.00 (EUR)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 13
              iso: AT
              iso_name: AUSTRIA
              iso3: AUT
              name: Austria
              tax_rate: 0
          - id: 3147126
            price: '99.99'
            shipping: '0.0'
            tax: '0.0'
            currency_code: AZN
            currency_symbol: ₼
            display_price: ₼99.99 (AZN)
            country_iso: AZ
            subscription_price: '99.99'
            display_wholesale_price: ₼0.00 (AZN)
            display_wholesale_subscription_price: ₼0.00 (AZN)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 14
              iso: AZ
              iso_name: AZERBAIJAN
              iso3: AZE
              name: Azerbaijan
              tax_rate: 0
          - id: 3147127
            price: '99.99'
            shipping: '0.0'
            tax: '0.0'
            currency_code: BSD
            currency_symbol: $
            display_price: $99.99 (BSD)
            country_iso: BS
            subscription_price: '99.99'
            display_wholesale_price: $0.00 (BSD)
            display_wholesale_subscription_price: $0.00 (BSD)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 15
              iso: BS
              iso_name: BAHAMAS
              iso3: BHS
              name: Bahamas
              tax_rate: 0
          - id: 3147128
            price: '99.99'
            shipping: '0.0'
            tax: '0.0'
            currency_code: BHD
            currency_symbol: د.ب
            display_price: د.ب99.990 (BHD)
            country_iso: BH
            subscription_price: '99.99'
            display_wholesale_price: د.ب0.000 (BHD)
            display_wholesale_subscription_price: د.ب0.000 (BHD)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 16
              iso: BH
              iso_name: BAHRAIN
              iso3: BHR
              name: Bahrain
              tax_rate: 0
          - id: 3147129
            price: '99.99'
            shipping: '0.0'
            tax: '0.0'
            currency_code: BTN
            currency_symbol: Nu.
            display_price: Nu.99.99 (BTN)
            country_iso: BT
            subscription_price: '99.99'
            display_wholesale_price: Nu.0.00 (BTN)
            display_wholesale_subscription_price: Nu.0.00 (BTN)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 24
              iso: BT
              iso_name: BHUTAN
              iso3: BTN
              name: Bhutan
              tax_rate: 0
          - id: 3147130
            price: '99.99'
            shipping: '0.0'
            tax: '0.0'
            currency_code: CAD
            currency_symbol: $
            display_price: $99.99 (CAD)
            country_iso: CA
            subscription_price: '99.99'
            display_wholesale_price: $0.00 (CAD)
            display_wholesale_subscription_price: $0.00 (CAD)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 35
              iso: CA
              iso_name: CANADA
              iso3: CAN
              name: Canada
              tax_rate: 0
          - id: 3147131
            price: '99.99'
            shipping: '0.0'
            tax: '0.0'
            currency_code: XAF
            currency_symbol: CFA
            display_price: CFA100 (XAF)
            country_iso: TD
            subscription_price: '99.99'
            display_wholesale_price: CFA0 (XAF)
            display_wholesale_subscription_price: CFA0 (XAF)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 39
              iso: TD
              iso_name: CHAD
              iso3: TCD
              name: Chad
              tax_rate: 0
          - id: 3147132
            price: '99.99'
            shipping: '0.0'
            tax: '0.0'
            currency_code: EUR
            currency_symbol: €
            display_price: €99.99 (EUR)
            country_iso: DE
            subscription_price: '99.99'
            display_wholesale_price: €0.00 (EUR)
            display_wholesale_subscription_price: €0.00 (EUR)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 74
              iso: DE
              iso_name: GERMANY
              iso3: DEU
              name: Germany
              tax_rate: 0
          - id: 3147133
            price: '99.99'
            shipping: '0.0'
            tax: '0.0'
            currency_code: DKK
            currency_symbol: kr.
            display_price: kr.99.99 (DKK)
            country_iso: GL
            subscription_price: '99.99'
            display_wholesale_price: kr.0.00 (DKK)
            display_wholesale_subscription_price: kr.0.00 (DKK)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 78
              iso: GL
              iso_name: GREENLAND
              iso3: GRL
              name: Greenland
              tax_rate: 0
          - id: 3147134
            price: '99.99'
            shipping: '0.0'
            tax: '0.0'
            currency_code: INR
            currency_symbol: ₹
            display_price: ₹99.99 (INR)
            country_iso: IN
            subscription_price: '99.99'
            display_wholesale_price: ₹0.00 (INR)
            display_wholesale_subscription_price: ₹0.00 (INR)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 92
              iso: IN
              iso_name: INDIA
              iso3: IND
              name: India
              tax_rate: 0
          - id: 3147135
            price: '99.99'
            shipping: '0.0'
            tax: '0.0'
            currency_code: USD
            currency_symbol: $
            display_price: $99.99 (USD)
            country_iso: FM
            subscription_price: '99.99'
            display_wholesale_price: $0.00 (USD)
            display_wholesale_subscription_price: $0.00 (USD)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 131
              iso: FM
              iso_name: MICRONESIA, FEDERATED STATES OF
              iso3: FSM
              name: Micronesia, Federated States of
              tax_rate: 0
          - id: 3147136
            price: '99.99'
            shipping: '0.0'
            tax: '0.0'
            currency_code: NPR
            currency_symbol: Rs.
            display_price: Rs.99.99 (NPR)
            country_iso: NP
            subscription_price: '99.99'
            display_wholesale_price: Rs.0.00 (NPR)
            display_wholesale_subscription_price: Rs.0.00 (NPR)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 141
              iso: NP
              iso_name: NEPAL
              iso3: NPL
              name: Nepal
              tax_rate: 0
          - id: 3147137
            price: '99.99'
            shipping: '0.0'
            tax: '0.0'
            currency_code: EUR
            currency_symbol: €
            display_price: €99.99 (EUR)
            country_iso: NL
            subscription_price: '99.99'
            display_wholesale_price: €0.00 (EUR)
            display_wholesale_subscription_price: €0.00 (EUR)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 142
              iso: NL
              iso_name: NETHERLANDS
              iso3: NLD
              name: Netherlands
              tax_rate: 0
          - id: 3147138
            price: '99.99'
            shipping: '0.0'
            tax: '0.0'
            currency_code: XPF
            currency_symbol: Fr
            display_price: Fr100 (XPF)
            country_iso: NC
            subscription_price: '99.99'
            display_wholesale_price: Fr0 (XPF)
            display_wholesale_subscription_price: Fr0 (XPF)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 144
              iso: NC
              iso_name: NEW CALEDONIA
              iso3: NCL
              name: New Caledonia
              tax_rate: 0
          - id: 3147139
            price: '99.99'
            shipping: '0.0'
            tax: '0.0'
            currency_code: NGN
            currency_symbol: ₦
            display_price: ₦99.99 (NGN)
            country_iso: NG
            subscription_price: '99.99'
            display_wholesale_price: ₦0.00 (NGN)
            display_wholesale_subscription_price: ₦0.00 (NGN)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 148
              iso: NG
              iso_name: NIGERIA
              iso3: NGA
              name: Nigeria
              tax_rate: 0
          - id: 3147140
            price: '99.99'
            shipping: '0.0'
            tax: '0.0'
            currency_code: XOF
            currency_symbol: Fr
            display_price: Fr100 (XOF)
            country_iso: SN
            subscription_price: '99.99'
            display_wholesale_price: Fr0 (XOF)
            display_wholesale_subscription_price: Fr0 (XOF)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 179
              iso: SN
              iso_name: SENEGAL
              iso3: SEN
              name: Senegal
              tax_rate: 0
          - id: 3147141
            price: '99.99'
            shipping: '0.0'
            tax: '0.0'
            currency_code: NOK
            currency_symbol: kr
            display_price: kr99.99 (NOK)
            country_iso: SJ
            subscription_price: '99.99'
            display_wholesale_price: kr0.00 (NOK)
            display_wholesale_subscription_price: kr0.00 (NOK)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 192
              iso: SJ
              iso_name: SVALBARD AND JAN MAYEN
              iso3: SJM
              name: Svalbard and Jan Mayen
              tax_rate: 0
          - id: 3147142
            price: '99.99'
            shipping: '0.0'
            tax: '0.0'
            currency_code: TND
            currency_symbol: د.ت
            display_price: د.ت99.990 (TND)
            country_iso: TN
            subscription_price: '99.99'
            display_wholesale_price: د.ت0.000 (TND)
            display_wholesale_subscription_price: د.ت0.000 (TND)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 205
              iso: TN
              iso_name: TUNISIA
              iso3: TUN
              name: Tunisia
              tax_rate: 0
          - id: 3147143
            price: '99.99'
            shipping: '0.0'
            tax: '0.0'
            currency_code: USD
            currency_symbol: $
            display_price: $99.99 (USD)
            country_iso: US
            subscription_price: '99.99'
            display_wholesale_price: $0.00 (USD)
            display_wholesale_subscription_price: $0.00 (USD)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 214
              iso: US
              iso_name: UNITED STATES
              iso3: USA
              name: United States
              tax_rate: 0
          - id: 3147144
            price: '99.99'
            shipping: '0.0'
            tax: '0.0'
            currency_code: YER
            currency_symbol: ﷼
            display_price: ﷼99.99 (YER)
            country_iso: YE
            subscription_price: '99.99'
            display_wholesale_price: ﷼0.00 (YER)
            display_wholesale_subscription_price: ﷼0.00 (YER)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 224
              iso: YE
              iso_name: YEMEN
              iso3: YEM
              name: Yemen
              tax_rate: 0
    show6:
      title: show6
      required:
        - id
        - order_number
        - amount
        - shipping
        - tax
        - subtotal
        - first_name
        - last_name
        - email
        - phone
        - tracking
        - cv
        - qv
        - status
        - order_type
        - rating
        - review
        - referrer
        - friendly_status
        - type
        - created_at
        - currency_code
        - currency_symbol
        - display_amount
        - display_subtotal
        - display_tax
        - display_shipping
        - display_refunds
        - display_discount
        - order_thumbnail
        - sale_date
        - recognized_ship_date
        - refundable
        - max_refundable_amount
        - max_refundable_tax
        - max_refundable_shipping
        - max_refundable_product_price
        - display_enrollment_fee
        - ship_to
        - contact
        - items
        - tracking_informations
      type: object
      properties:
        id:
          type: integer
          format: int32
        order_number:
          type: string
        amount:
          type: string
        shipping:
          type: string
        tax:
          type: string
        subtotal:
          type: string
        first_name:
          type: string
        last_name:
          type: string
        email:
          type: string
        phone:
          type: string
        tracking:
          type: string
        cv:
          type: integer
          format: int32
        qv:
          type: integer
          format: int32
        status:
          type: string
        order_type:
          type: string
        rating:
          type: integer
          format: int32
        review:
          type: string
        referrer:
          type: string
        friendly_status:
          type: string
        type:
          type: string
        created_at:
          type: string
        currency_code:
          type: string
        currency_symbol:
          type: string
        display_amount:
          type: string
        display_subtotal:
          type: string
        display_tax:
          type: string
        display_shipping:
          type: string
        display_refunds:
          type: string
        display_discount:
          type: string
        order_thumbnail:
          type: string
        sale_date:
          type: string
        recognized_ship_date:
          type: string
        refundable:
          type: boolean
        max_refundable_amount:
          type: string
        max_refundable_tax:
          type: string
        max_refundable_shipping:
          type: string
        max_refundable_product_price:
          type: string
        display_enrollment_fee:
          type: string
        ship_to:
          allOf:
            - $ref: '#/components/schemas/ShipTo5'
            - {}
        contact:
          allOf:
            - $ref: '#/components/schemas/Contact'
            - {}
        items:
          type: array
          items:
            $ref: '#/components/schemas/Item3'
          description: ''
        tracking_informations:
          type: array
          items:
            type: string
          description: ''
      example:
        id: 8768
        order_number: F32799720937756
        amount: '16900.0'
        shipping: '650.0'
        tax: '260.0'
        subtotal: '12740.0'
        first_name: Bishal
        last_name: Nepal
        email: bnepal05579887@gmail.com
        phone: null
        tracking: null
        cv: 5
        qv: 0
        status: awaiting_shipment
        order_type: purchased
        rating: 0
        review: ''
        referrer: Bishal Nepal
        friendly_status: paid
        type: null
        created_at: '2023-03-15T11:10:53.263Z'
        currency_code: NPR
        currency_symbol: Rs.
        display_amount: Rs.16,900.00 (NPR)
        display_subtotal: Rs.12,740.00 (NPR)
        display_tax: Rs.260.00 (NPR)
        display_shipping: Rs.650.00 (NPR)
        display_refunds: (0 CV, 0 QV) -Rs.0.00 (NPR)
        display_discount: Rs.0.00 (NPR)
        order_thumbnail: >-
          https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
        sale_date: null
        recognized_ship_date: null
        refundable: true
        max_refundable_amount: '16900.0'
        max_refundable_tax: '260.0'
        max_refundable_shipping: '650.0'
        max_refundable_product_price: '12740.0'
        display_enrollment_fee: Rs.3,250.00 (NPR)
        ship_to:
          id: 980199006
          name: Bishal Nepal
          address1: jhapa
          address2: null
          address3: null
          city: damak
          state: Province 1
          postal_code: mechi
          country_code: null
          country:
            id: 141
            iso_name: NEPAL
            iso: NP
            iso3: NPL
            name: Nepal
            numcode: 524
            active: true
            currency_code: NPR
            currency_symbol: Rs.
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
            default: false
            created_at: '2022-05-09T05:12:21.806Z'
            updated_at: '2022-05-09T05:12:21.806Z'
            geo_entity_id: 28
          default: false
        contact:
          id: 6557
          token: h59g4H8EExXpmNYmhq4woiMh
          first_name: Bishal
          last_name: Nepal
          avatar_url: null
          status: null
          email: bnepal05579887@gmail.com
          email2: null
          phone: null
          phone2: null
          phone_id: null
          address: null
          address2: null
          city: null
          state: null
          postal_code: null
          language_id: null
          country_id: null
          lead_type: null
          ip: null
          requested_at: null
          best_time: null
          time_zone: null
          reason: null
          income: null
          hours: null
          invest: null
          interest: null
          full_name: Bishal Nepal
        items:
          - id: 8803
            quantity: 1
            price: 12740
            ordered_variant: ''
            sku: sketch12
            product:
              id: 2240
              active: true
              title: sketch
              description:
                id: 4836
                name: description
                body: <div>best selling sketch</div>
                record_type: Product
                record_id: 2240
                created_at: '2023-02-02T03:48:16.810Z'
                updated_at: '2023-02-02T03:48:16.810Z'
              stripped: best selling sketch
              price: '12740.0'
              display_price: Rs.12,740.00 (NPR)
              subscription_price: '12740.0'
              display_subscription_price: Rs.12,740.00 (NPR)
              wholesale_price: '0.0'
              display_wholesale_price: Rs.0.00 (NPR)
              wholesale_subscription_price: '0.0'
              display_wholesale_subscription_price: Rs.0.00 (NPR)
              shipping: '5.0'
              image:
                mini: >-
                  https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                detail: >-
                  https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                full: >-
                  https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
              image_url: >-
                https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
              sku: sketch
              country_code: ar
              country_id: null
              views: 0
              leads: 0
              share_link: null
              commission: '10.0'
              public: true
              shopify_id: null
              shopify_handle: null
              in_stock: true
              vendor: null
              price_range:
                - Rs.0.00
                - Rs.12,740.00
              price_range_formatted: Rs.0.00 - Rs.12,740.00
              unlimited_inventory: false
              default_variant:
                id: 19630
                product_id: 2240
                shopify_id: null
                title: ''
                sku: sketch12
                position: 12698
                inventory_policy: none
                taxable: true
                inventory_quantity: -84
                created_at: '2023-02-02T03:48:18.009Z'
                updated_at: '2023-09-29T04:59:12.098Z'
                external_id: null
                variant_country_id: null
                image_url: null
                image_path: null
                is_master: true
                discarded_at: null
                price: null
                weight: ''
                size: ''
                physical: true
                unit_of_weight: lb
                height: 0
                width: 0
                length: 0
                unit_of_size: ft
                hs_code: ''
                country_of_origin: ''
                customs_information_shipping: false
                active: true
                bar_code: ''
                track_quantity: false
                keep_selling: true
                option_attrs: []
                allow_subscription: true
              currency_symbol: Rs.
              currency_code: NPR
              average_rating: 0
              option_values: {}
              publish_to_retail_store: true
              publish_to_rep_store: true
              publish_to_share_tab: true
              images:
                - id: 2089
                  image:
                    mini: >-
                      https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                    detail: >-
                      https://ik.imagekit.io/fluid/s3/tr:n-video_poster/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                    full: >-
                      https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                  image_url: >-
                    https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                  position: null
                  shopify_id: null
              countries:
                - id: 27
                  iso_name: BOTSWANA
                  iso: BW
                  iso3: BWA
                  name: Botswana
                  numcode: 72
                  active: true
                  currency_code: BWP
                  currency_symbol: P
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 68
                  iso_name: FRANCE
                  iso: FR
                  iso3: FRA
                  name: France
                  numcode: 250
                  active: true
                  currency_code: EUR
                  currency_symbol: €
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 214
                  iso_name: UNITED STATES
                  iso: US
                  iso3: USA
                  name: United States
                  numcode: 840
                  active: true
                  currency_code: USD
                  currency_symbol: $
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 12
                  iso_name: AUSTRALIA
                  iso: AU
                  iso3: AUS
                  name: Australia
                  numcode: 36
                  active: true
                  currency_code: AUD
                  currency_symbol: $
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 13
                  iso_name: AUSTRIA
                  iso: AT
                  iso3: AUT
                  name: Austria
                  numcode: 40
                  active: true
                  currency_code: EUR
                  currency_symbol: €
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 14
                  iso_name: AZERBAIJAN
                  iso: AZ
                  iso3: AZE
                  name: Azerbaijan
                  numcode: 31
                  active: true
                  currency_code: AZN
                  currency_symbol: ₼
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 15
                  iso_name: BAHAMAS
                  iso: BS
                  iso3: BHS
                  name: Bahamas
                  numcode: 44
                  active: true
                  currency_code: BSD
                  currency_symbol: $
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 16
                  iso_name: BAHRAIN
                  iso: BH
                  iso3: BHR
                  name: Bahrain
                  numcode: 48
                  active: true
                  currency_code: BHD
                  currency_symbol: د.ب
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 17
                  iso_name: BANGLADESH
                  iso: BD
                  iso3: BGD
                  name: Bangladesh
                  numcode: 50
                  active: true
                  currency_code: BDT
                  currency_symbol: ৳
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 41
                  iso_name: CHINA
                  iso: CN
                  iso3: CHN
                  name: China
                  numcode: 156
                  active: true
                  currency_code: CNY
                  currency_symbol: ¥
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 162
                  iso_name: POLAND
                  iso: PL
                  iso3: POL
                  name: Poland
                  numcode: 616
                  active: true
                  currency_code: PLN
                  currency_symbol: zł
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 163
                  iso_name: PORTUGAL
                  iso: PT
                  iso3: PRT
                  name: Portugal
                  numcode: 620
                  active: true
                  currency_code: EUR
                  currency_symbol: €
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 168
                  iso_name: RUSSIAN FEDERATION
                  iso: RU
                  iso3: RUS
                  name: Russia
                  numcode: 643
                  active: true
                  currency_code: RUB
                  currency_symbol: ₽
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 197
                  iso_name: TAIWAN, PROVINCE OF CHINA
                  iso: TW
                  iso3: TWN
                  name: Taiwan
                  numcode: 158
                  active: true
                  currency_code: TWD
                  currency_symbol: $
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 2
                  iso_name: ALBANIA
                  iso: AL
                  iso3: ALB
                  name: Albania
                  numcode: 8
                  active: true
                  currency_code: ALL
                  currency_symbol: L
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 3
                  iso_name: ALGERIA
                  iso: DZ
                  iso3: DZA
                  name: Algeria
                  numcode: 12
                  active: true
                  currency_code: DZD
                  currency_symbol: د.ج
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 74
                  iso_name: GERMANY
                  iso: DE
                  iso3: DEU
                  name: Germany
                  numcode: 276
                  active: true
                  currency_code: EUR
                  currency_symbol: €
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 141
                  iso_name: NEPAL
                  iso: NP
                  iso3: NPL
                  name: Nepal
                  numcode: 524
                  active: true
                  currency_code: NPR
                  currency_symbol: Rs.
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 188
                  iso_name: SPAIN
                  iso: ES
                  iso3: ESP
                  name: Spain
                  numcode: 724
                  active: true
                  currency_code: EUR
                  currency_symbol: €
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 1
                  iso_name: AFGHANISTAN
                  iso: AF
                  iso3: AFG
                  name: Afghanistan
                  numcode: 4
                  active: true
                  currency_code: AFN
                  currency_symbol: ؋
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 4
                  iso_name: AMERICAN SAMOA
                  iso: AS
                  iso3: ASM
                  name: American Samoa
                  numcode: 16
                  active: true
                  currency_code: USD
                  currency_symbol: $
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 9
                  iso_name: ARGENTINA
                  iso: AR
                  iso3: ARG
                  name: Argentina
                  numcode: 32
                  active: true
                  currency_code: ARS
                  currency_symbol: $
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 23
                  iso_name: BERMUDA
                  iso: BM
                  iso3: BMU
                  name: Bermuda
                  numcode: 60
                  active: true
                  currency_code: BMD
                  currency_symbol: $
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
              variants:
                - id: 19630
                  title: ''
                  image_url: null
                  buyable: true
                  option_value_ids: []
                  allow_subscription: true
                  variant_countries:
                    - id: 130789
                      price: '9800.0'
                      shipping: '500.0'
                      tax: '200.0'
                      currency_code: ARS
                      currency_symbol: $
                      display_price: $9,800.00 (ARS)
                      country_iso: AR
                      subscription_price: '9800.0'
                      display_wholesale_price: $0.00 (ARS)
                      display_wholesale_subscription_price: $0.00 (ARS)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 9
                        iso: AR
                        iso_name: ARGENTINA
                        iso3: ARG
                        name: Argentina
                        tax_rate: 0
                    - id: 130790
                      price: '98.0'
                      shipping: '5.0'
                      tax: '2.0'
                      currency_code: AUD
                      currency_symbol: $
                      display_price: $98.00 (AUD)
                      country_iso: AU
                      subscription_price: '98.0'
                      display_wholesale_price: $0.00 (AUD)
                      display_wholesale_subscription_price: $0.00 (AUD)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 12
                        iso: AU
                        iso_name: AUSTRALIA
                        iso3: AUS
                        name: Australia
                        tax_rate: 0
                    - id: 130791
                      price: '4900.0'
                      shipping: '250.0'
                      tax: '100.0'
                      currency_code: EUR
                      currency_symbol: €
                      display_price: €4,900.00 (EUR)
                      country_iso: AT
                      subscription_price: '4900.0'
                      display_wholesale_price: €0.00 (EUR)
                      display_wholesale_subscription_price: €0.00 (EUR)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 13
                        iso: AT
                        iso_name: AUSTRIA
                        iso3: AUT
                        name: Austria
                        tax_rate: 0
                    - id: 130792
                      price: '9604.0'
                      shipping: '490.0'
                      tax: '196.0'
                      currency_code: AZN
                      currency_symbol: ₼
                      display_price: ₼9,604.00 (AZN)
                      country_iso: AZ
                      subscription_price: '9604.0'
                      display_wholesale_price: ₼0.00 (AZN)
                      display_wholesale_subscription_price: ₼0.00 (AZN)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 14
                        iso: AZ
                        iso_name: AZERBAIJAN
                        iso3: AZE
                        name: Azerbaijan
                        tax_rate: 0
                    - id: 130793
                      price: '98.0'
                      shipping: '5.0'
                      tax: '2.0'
                      currency_code: BSD
                      currency_symbol: $
                      display_price: $98.00 (BSD)
                      country_iso: BS
                      subscription_price: '98.0'
                      display_wholesale_price: $0.00 (BSD)
                      display_wholesale_subscription_price: $0.00 (BSD)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 15
                        iso: BS
                        iso_name: BAHAMAS
                        iso3: BHS
                        name: Bahamas
                        tax_rate: 0
                    - id: 130794
                      price: '98.0'
                      shipping: '5.0'
                      tax: '2.0'
                      currency_code: BHD
                      currency_symbol: د.ب
                      display_price: د.ب98.000 (BHD)
                      country_iso: BH
                      subscription_price: '98.0'
                      display_wholesale_price: د.ب0.000 (BHD)
                      display_wholesale_subscription_price: د.ب0.000 (BHD)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 16
                        iso: BH
                        iso_name: BAHRAIN
                        iso3: BHR
                        name: Bahrain
                        tax_rate: 0
                    - id: 130795
                      price: '98.0'
                      shipping: '5.0'
                      tax: '2.0'
                      currency_code: BDT
                      currency_symbol: ৳
                      display_price: ৳98.00 (BDT)
                      country_iso: BD
                      subscription_price: '98.0'
                      display_wholesale_price: ৳0.00 (BDT)
                      display_wholesale_subscription_price: ৳0.00 (BDT)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 17
                        iso: BD
                        iso_name: BANGLADESH
                        iso3: BGD
                        name: Bangladesh
                        tax_rate: 0
                    - id: 130798
                      price: '98.0'
                      shipping: '5.0'
                      tax: '2.0'
                      currency_code: BMD
                      currency_symbol: $
                      display_price: $98.00 (BMD)
                      country_iso: BM
                      subscription_price: '98.0'
                      display_wholesale_price: $0.00 (BMD)
                      display_wholesale_subscription_price: $0.00 (BMD)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 23
                        iso: BM
                        iso_name: BERMUDA
                        iso3: BMU
                        name: Bermuda
                        tax_rate: 0
                    - id: 130801
                      price: '98.0'
                      shipping: '5.0'
                      tax: '2.0'
                      currency_code: BWP
                      currency_symbol: P
                      display_price: P98.00 (BWP)
                      country_iso: BW
                      subscription_price: '98.0'
                      display_wholesale_price: P0.00 (BWP)
                      display_wholesale_subscription_price: P0.00 (BWP)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 27
                        iso: BW
                        iso_name: BOTSWANA
                        iso3: BWA
                        name: Botswana
                        tax_rate: 0
                    - id: 130881
                      price: '12740.0'
                      shipping: '650.0'
                      tax: '260.0'
                      currency_code: NPR
                      currency_symbol: Rs.
                      display_price: Rs.12,740.00 (NPR)
                      country_iso: NP
                      subscription_price: '12740.0'
                      display_wholesale_price: Rs.0.00 (NPR)
                      display_wholesale_subscription_price: Rs.0.00 (NPR)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 141
                        iso: NP
                        iso_name: NEPAL
                        iso3: NPL
                        name: Nepal
                        tax_rate: 0
                    - id: 130897
                      price: '98.0'
                      shipping: '5.0'
                      tax: '2.0'
                      currency_code: EUR
                      currency_symbol: €
                      display_price: €98.00 (EUR)
                      country_iso: PT
                      subscription_price: '98.0'
                      display_wholesale_price: €0.00 (EUR)
                      display_wholesale_subscription_price: €0.00 (EUR)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 163
                        iso: PT
                        iso_name: PORTUGAL
                        iso3: PRT
                        name: Portugal
                        tax_rate: 0
                    - id: 130921
                      price: '98.0'
                      shipping: '5.0'
                      tax: '2.0'
                      currency_code: TWD
                      currency_symbol: $
                      display_price: $98.00 (TWD)
                      country_iso: TW
                      subscription_price: '98.0'
                      display_wholesale_price: $0.00 (TWD)
                      display_wholesale_subscription_price: $0.00 (TWD)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 197
                        iso: TW
                        iso_name: TAIWAN, PROVINCE OF CHINA
                        iso3: TWN
                        name: Taiwan
                        tax_rate: 0
                    - id: 130933
                      price: '98.0'
                      shipping: '5.0'
                      tax: '2.0'
                      currency_code: USD
                      currency_symbol: $
                      display_price: $98.00 (USD)
                      country_iso: US
                      subscription_price: '98.0'
                      display_wholesale_price: $0.00 (USD)
                      display_wholesale_subscription_price: $0.00 (USD)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 214
                        iso: US
                        iso_name: UNITED STATES
                        iso3: USA
                        name: United States
                        tax_rate: 0
              options: []
              prompts: []
              enroll_products:
                - id: 19
                  product_id: 2240
                  enroll_id: 2
                  active: true
                  type: membership_product
                  created_at: '2023-02-15T06:40:53.303Z'
                  updated_at: '2023-02-15T06:40:53.303Z'
              enrolls:
                - id: 2
                  integration_id: null
                  fields:
                    dob: Birthdate
                    full_name: Name
                    government_id: Government ID
                  member_fee: 25
                  member_fee_enabled: true
                  company_id: 980191019
                  created_at: '2023-02-01T07:49:12.347Z'
                  updated_at: '2023-02-01T07:54:36.961Z'
                  terms_and_conditions_url: https://www.google.com/
        tracking_informations: []
    ShipTo5:
      title: ShipTo5
      required:
        - id
        - name
        - address1
        - address2
        - address3
        - city
        - state
        - postal_code
        - country_code
        - country
        - default
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        address1:
          type: string
        address2:
          type: string
        address3:
          type: string
        city:
          type: string
        state:
          type: string
        postal_code:
          type: string
        country_code:
          type: string
        country:
          allOf:
            - $ref: '#/components/schemas/Country6'
            - {}
        default:
          type: boolean
      example:
        id: 980199006
        name: Bishal Nepal
        address1: jhapa
        address2: null
        address3: null
        city: damak
        state: Province 1
        postal_code: mechi
        country_code: null
        country:
          id: 141
          iso_name: NEPAL
          iso: NP
          iso3: NPL
          name: Nepal
          numcode: 524
          active: true
          currency_code: NPR
          currency_symbol: Rs.
          separator: .
          delimiter: ','
          address3: false
          state: true
          passport: false
          itn: false
          tax_rate: 0
          default: false
          created_at: '2022-05-09T05:12:21.806Z'
          updated_at: '2022-05-09T05:12:21.806Z'
          geo_entity_id: 28
        default: false
    Item3:
      title: Item3
      required:
        - id
        - quantity
        - price
        - ordered_variant
        - sku
        - product
      type: object
      properties:
        id:
          type: integer
          format: int32
        quantity:
          type: integer
          format: int32
        price:
          type: integer
          format: int32
        ordered_variant:
          type: string
        sku:
          type: string
        product:
          allOf:
            - $ref: '#/components/schemas/Product10'
            - {}
      example:
        id: 8803
        quantity: 1
        price: 12740
        ordered_variant: ''
        sku: sketch12
        product:
          id: 2240
          active: true
          title: sketch
          description:
            id: 4836
            name: description
            body: <div>best selling sketch</div>
            record_type: Product
            record_id: 2240
            created_at: '2023-02-02T03:48:16.810Z'
            updated_at: '2023-02-02T03:48:16.810Z'
          stripped: best selling sketch
          price: '12740.0'
          display_price: Rs.12,740.00 (NPR)
          subscription_price: '12740.0'
          display_subscription_price: Rs.12,740.00 (NPR)
          wholesale_price: '0.0'
          display_wholesale_price: Rs.0.00 (NPR)
          wholesale_subscription_price: '0.0'
          display_wholesale_subscription_price: Rs.0.00 (NPR)
          shipping: '5.0'
          image:
            mini: >-
              https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
            detail: >-
              https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
            full: >-
              https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
          image_url: >-
            https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
          sku: sketch
          country_code: ar
          country_id: null
          views: 0
          leads: 0
          share_link: null
          commission: '10.0'
          public: true
          shopify_id: null
          shopify_handle: null
          in_stock: true
          vendor: null
          price_range:
            - Rs.0.00
            - Rs.12,740.00
          price_range_formatted: Rs.0.00 - Rs.12,740.00
          unlimited_inventory: false
          default_variant:
            id: 19630
            product_id: 2240
            shopify_id: null
            title: ''
            sku: sketch12
            position: 12698
            inventory_policy: none
            taxable: true
            inventory_quantity: -84
            created_at: '2023-02-02T03:48:18.009Z'
            updated_at: '2023-09-29T04:59:12.098Z'
            external_id: null
            variant_country_id: null
            image_url: null
            image_path: null
            is_master: true
            discarded_at: null
            price: null
            weight: ''
            size: ''
            physical: true
            unit_of_weight: lb
            height: 0
            width: 0
            length: 0
            unit_of_size: ft
            hs_code: ''
            country_of_origin: ''
            customs_information_shipping: false
            active: true
            bar_code: ''
            track_quantity: false
            keep_selling: true
            option_attrs: []
            allow_subscription: true
          currency_symbol: Rs.
          currency_code: NPR
          average_rating: 0
          option_values: {}
          publish_to_retail_store: true
          publish_to_rep_store: true
          publish_to_share_tab: true
          images:
            - id: 2089
              image:
                mini: >-
                  https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                detail: >-
                  https://ik.imagekit.io/fluid/s3/tr:n-video_poster/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                full: >-
                  https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
              image_url: >-
                https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
              position: null
              shopify_id: null
          countries:
            - id: 27
              iso_name: BOTSWANA
              iso: BW
              iso3: BWA
              name: Botswana
              numcode: 72
              active: true
              currency_code: BWP
              currency_symbol: P
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 68
              iso_name: FRANCE
              iso: FR
              iso3: FRA
              name: France
              numcode: 250
              active: true
              currency_code: EUR
              currency_symbol: €
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 214
              iso_name: UNITED STATES
              iso: US
              iso3: USA
              name: United States
              numcode: 840
              active: true
              currency_code: USD
              currency_symbol: $
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 12
              iso_name: AUSTRALIA
              iso: AU
              iso3: AUS
              name: Australia
              numcode: 36
              active: true
              currency_code: AUD
              currency_symbol: $
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 13
              iso_name: AUSTRIA
              iso: AT
              iso3: AUT
              name: Austria
              numcode: 40
              active: true
              currency_code: EUR
              currency_symbol: €
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 14
              iso_name: AZERBAIJAN
              iso: AZ
              iso3: AZE
              name: Azerbaijan
              numcode: 31
              active: true
              currency_code: AZN
              currency_symbol: ₼
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 15
              iso_name: BAHAMAS
              iso: BS
              iso3: BHS
              name: Bahamas
              numcode: 44
              active: true
              currency_code: BSD
              currency_symbol: $
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 16
              iso_name: BAHRAIN
              iso: BH
              iso3: BHR
              name: Bahrain
              numcode: 48
              active: true
              currency_code: BHD
              currency_symbol: د.ب
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 17
              iso_name: BANGLADESH
              iso: BD
              iso3: BGD
              name: Bangladesh
              numcode: 50
              active: true
              currency_code: BDT
              currency_symbol: ৳
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 41
              iso_name: CHINA
              iso: CN
              iso3: CHN
              name: China
              numcode: 156
              active: true
              currency_code: CNY
              currency_symbol: ¥
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 162
              iso_name: POLAND
              iso: PL
              iso3: POL
              name: Poland
              numcode: 616
              active: true
              currency_code: PLN
              currency_symbol: zł
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 163
              iso_name: PORTUGAL
              iso: PT
              iso3: PRT
              name: Portugal
              numcode: 620
              active: true
              currency_code: EUR
              currency_symbol: €
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 168
              iso_name: RUSSIAN FEDERATION
              iso: RU
              iso3: RUS
              name: Russia
              numcode: 643
              active: true
              currency_code: RUB
              currency_symbol: ₽
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 197
              iso_name: TAIWAN, PROVINCE OF CHINA
              iso: TW
              iso3: TWN
              name: Taiwan
              numcode: 158
              active: true
              currency_code: TWD
              currency_symbol: $
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 2
              iso_name: ALBANIA
              iso: AL
              iso3: ALB
              name: Albania
              numcode: 8
              active: true
              currency_code: ALL
              currency_symbol: L
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 3
              iso_name: ALGERIA
              iso: DZ
              iso3: DZA
              name: Algeria
              numcode: 12
              active: true
              currency_code: DZD
              currency_symbol: د.ج
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 74
              iso_name: GERMANY
              iso: DE
              iso3: DEU
              name: Germany
              numcode: 276
              active: true
              currency_code: EUR
              currency_symbol: €
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 141
              iso_name: NEPAL
              iso: NP
              iso3: NPL
              name: Nepal
              numcode: 524
              active: true
              currency_code: NPR
              currency_symbol: Rs.
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 188
              iso_name: SPAIN
              iso: ES
              iso3: ESP
              name: Spain
              numcode: 724
              active: true
              currency_code: EUR
              currency_symbol: €
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 1
              iso_name: AFGHANISTAN
              iso: AF
              iso3: AFG
              name: Afghanistan
              numcode: 4
              active: true
              currency_code: AFN
              currency_symbol: ؋
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 4
              iso_name: AMERICAN SAMOA
              iso: AS
              iso3: ASM
              name: American Samoa
              numcode: 16
              active: true
              currency_code: USD
              currency_symbol: $
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 9
              iso_name: ARGENTINA
              iso: AR
              iso3: ARG
              name: Argentina
              numcode: 32
              active: true
              currency_code: ARS
              currency_symbol: $
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 23
              iso_name: BERMUDA
              iso: BM
              iso3: BMU
              name: Bermuda
              numcode: 60
              active: true
              currency_code: BMD
              currency_symbol: $
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
          variants:
            - id: 19630
              title: ''
              image_url: null
              buyable: true
              option_value_ids: []
              allow_subscription: true
              variant_countries:
                - id: 130789
                  price: '9800.0'
                  shipping: '500.0'
                  tax: '200.0'
                  currency_code: ARS
                  currency_symbol: $
                  display_price: $9,800.00 (ARS)
                  country_iso: AR
                  subscription_price: '9800.0'
                  display_wholesale_price: $0.00 (ARS)
                  display_wholesale_subscription_price: $0.00 (ARS)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 9
                    iso: AR
                    iso_name: ARGENTINA
                    iso3: ARG
                    name: Argentina
                    tax_rate: 0
                - id: 130790
                  price: '98.0'
                  shipping: '5.0'
                  tax: '2.0'
                  currency_code: AUD
                  currency_symbol: $
                  display_price: $98.00 (AUD)
                  country_iso: AU
                  subscription_price: '98.0'
                  display_wholesale_price: $0.00 (AUD)
                  display_wholesale_subscription_price: $0.00 (AUD)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 12
                    iso: AU
                    iso_name: AUSTRALIA
                    iso3: AUS
                    name: Australia
                    tax_rate: 0
                - id: 130791
                  price: '4900.0'
                  shipping: '250.0'
                  tax: '100.0'
                  currency_code: EUR
                  currency_symbol: €
                  display_price: €4,900.00 (EUR)
                  country_iso: AT
                  subscription_price: '4900.0'
                  display_wholesale_price: €0.00 (EUR)
                  display_wholesale_subscription_price: €0.00 (EUR)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 13
                    iso: AT
                    iso_name: AUSTRIA
                    iso3: AUT
                    name: Austria
                    tax_rate: 0
                - id: 130792
                  price: '9604.0'
                  shipping: '490.0'
                  tax: '196.0'
                  currency_code: AZN
                  currency_symbol: ₼
                  display_price: ₼9,604.00 (AZN)
                  country_iso: AZ
                  subscription_price: '9604.0'
                  display_wholesale_price: ₼0.00 (AZN)
                  display_wholesale_subscription_price: ₼0.00 (AZN)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 14
                    iso: AZ
                    iso_name: AZERBAIJAN
                    iso3: AZE
                    name: Azerbaijan
                    tax_rate: 0
                - id: 130793
                  price: '98.0'
                  shipping: '5.0'
                  tax: '2.0'
                  currency_code: BSD
                  currency_symbol: $
                  display_price: $98.00 (BSD)
                  country_iso: BS
                  subscription_price: '98.0'
                  display_wholesale_price: $0.00 (BSD)
                  display_wholesale_subscription_price: $0.00 (BSD)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 15
                    iso: BS
                    iso_name: BAHAMAS
                    iso3: BHS
                    name: Bahamas
                    tax_rate: 0
                - id: 130794
                  price: '98.0'
                  shipping: '5.0'
                  tax: '2.0'
                  currency_code: BHD
                  currency_symbol: د.ب
                  display_price: د.ب98.000 (BHD)
                  country_iso: BH
                  subscription_price: '98.0'
                  display_wholesale_price: د.ب0.000 (BHD)
                  display_wholesale_subscription_price: د.ب0.000 (BHD)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 16
                    iso: BH
                    iso_name: BAHRAIN
                    iso3: BHR
                    name: Bahrain
                    tax_rate: 0
                - id: 130795
                  price: '98.0'
                  shipping: '5.0'
                  tax: '2.0'
                  currency_code: BDT
                  currency_symbol: ৳
                  display_price: ৳98.00 (BDT)
                  country_iso: BD
                  subscription_price: '98.0'
                  display_wholesale_price: ৳0.00 (BDT)
                  display_wholesale_subscription_price: ৳0.00 (BDT)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 17
                    iso: BD
                    iso_name: BANGLADESH
                    iso3: BGD
                    name: Bangladesh
                    tax_rate: 0
                - id: 130798
                  price: '98.0'
                  shipping: '5.0'
                  tax: '2.0'
                  currency_code: BMD
                  currency_symbol: $
                  display_price: $98.00 (BMD)
                  country_iso: BM
                  subscription_price: '98.0'
                  display_wholesale_price: $0.00 (BMD)
                  display_wholesale_subscription_price: $0.00 (BMD)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 23
                    iso: BM
                    iso_name: BERMUDA
                    iso3: BMU
                    name: Bermuda
                    tax_rate: 0
                - id: 130801
                  price: '98.0'
                  shipping: '5.0'
                  tax: '2.0'
                  currency_code: BWP
                  currency_symbol: P
                  display_price: P98.00 (BWP)
                  country_iso: BW
                  subscription_price: '98.0'
                  display_wholesale_price: P0.00 (BWP)
                  display_wholesale_subscription_price: P0.00 (BWP)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 27
                    iso: BW
                    iso_name: BOTSWANA
                    iso3: BWA
                    name: Botswana
                    tax_rate: 0
                - id: 130881
                  price: '12740.0'
                  shipping: '650.0'
                  tax: '260.0'
                  currency_code: NPR
                  currency_symbol: Rs.
                  display_price: Rs.12,740.00 (NPR)
                  country_iso: NP
                  subscription_price: '12740.0'
                  display_wholesale_price: Rs.0.00 (NPR)
                  display_wholesale_subscription_price: Rs.0.00 (NPR)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 141
                    iso: NP
                    iso_name: NEPAL
                    iso3: NPL
                    name: Nepal
                    tax_rate: 0
                - id: 130897
                  price: '98.0'
                  shipping: '5.0'
                  tax: '2.0'
                  currency_code: EUR
                  currency_symbol: €
                  display_price: €98.00 (EUR)
                  country_iso: PT
                  subscription_price: '98.0'
                  display_wholesale_price: €0.00 (EUR)
                  display_wholesale_subscription_price: €0.00 (EUR)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 163
                    iso: PT
                    iso_name: PORTUGAL
                    iso3: PRT
                    name: Portugal
                    tax_rate: 0
                - id: 130921
                  price: '98.0'
                  shipping: '5.0'
                  tax: '2.0'
                  currency_code: TWD
                  currency_symbol: $
                  display_price: $98.00 (TWD)
                  country_iso: TW
                  subscription_price: '98.0'
                  display_wholesale_price: $0.00 (TWD)
                  display_wholesale_subscription_price: $0.00 (TWD)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 197
                    iso: TW
                    iso_name: TAIWAN, PROVINCE OF CHINA
                    iso3: TWN
                    name: Taiwan
                    tax_rate: 0
                - id: 130933
                  price: '98.0'
                  shipping: '5.0'
                  tax: '2.0'
                  currency_code: USD
                  currency_symbol: $
                  display_price: $98.00 (USD)
                  country_iso: US
                  subscription_price: '98.0'
                  display_wholesale_price: $0.00 (USD)
                  display_wholesale_subscription_price: $0.00 (USD)
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 214
                    iso: US
                    iso_name: UNITED STATES
                    iso3: USA
                    name: United States
                    tax_rate: 0
          options: []
          prompts: []
          enroll_products:
            - id: 19
              product_id: 2240
              enroll_id: 2
              active: true
              type: membership_product
              created_at: '2023-02-15T06:40:53.303Z'
              updated_at: '2023-02-15T06:40:53.303Z'
          enrolls:
            - id: 2
              integration_id: null
              fields:
                dob: Birthdate
                full_name: Name
                government_id: Government ID
              member_fee: 25
              member_fee_enabled: true
              company_id: 980191019
              created_at: '2023-02-01T07:49:12.347Z'
              updated_at: '2023-02-01T07:54:36.961Z'
              terms_and_conditions_url: https://www.google.com/
    Product10:
      title: Product10
      required:
        - id
        - active
        - title
        - description
        - stripped
        - price
        - display_price
        - subscription_price
        - display_subscription_price
        - wholesale_price
        - display_wholesale_price
        - wholesale_subscription_price
        - display_wholesale_subscription_price
        - shipping
        - image
        - image_url
        - sku
        - country_code
        - country_id
        - views
        - leads
        - share_link
        - commission
        - public
        - shopify_id
        - shopify_handle
        - in_stock
        - vendor
        - price_range
        - price_range_formatted
        - unlimited_inventory
        - default_variant
        - currency_symbol
        - currency_code
        - average_rating
        - option_values
        - publish_to_retail_store
        - publish_to_rep_store
        - publish_to_share_tab
        - images
        - countries
        - variants
        - options
        - prompts
        - enroll_products
        - enrolls
      type: object
      properties:
        id:
          type: integer
          format: int32
        active:
          type: boolean
        title:
          type: string
        description:
          allOf:
            - $ref: '#/components/schemas/Description'
            - {}
        stripped:
          type: string
        price:
          type: string
        display_price:
          type: string
        subscription_price:
          type: string
        display_subscription_price:
          type: string
        wholesale_price:
          type: string
        display_wholesale_price:
          type: string
        wholesale_subscription_price:
          type: string
        display_wholesale_subscription_price:
          type: string
        shipping:
          type: string
        image:
          allOf:
            - $ref: '#/components/schemas/Image3'
            - {}
        image_url:
          type: string
        sku:
          type: string
        country_code:
          type: string
        country_id:
          type: string
        views:
          type: integer
          format: int32
        leads:
          type: integer
          format: int32
        share_link:
          type: string
        commission:
          type: string
        public:
          type: boolean
        shopify_id:
          type: string
        shopify_handle:
          type: string
        in_stock:
          type: boolean
        vendor:
          type: string
        price_range:
          type: array
          items:
            type: string
          description: ''
        price_range_formatted:
          type: string
        unlimited_inventory:
          type: boolean
        default_variant:
          allOf:
            - $ref: '#/components/schemas/DefaultVariant3'
            - {}
        currency_symbol:
          type: string
        currency_code:
          type: string
        average_rating:
          type: integer
          format: int32
        option_values:
          type: object
        publish_to_retail_store:
          type: boolean
        publish_to_rep_store:
          type: boolean
        publish_to_share_tab:
          type: boolean
        images:
          type: array
          items:
            $ref: '#/components/schemas/Image9'
          description: ''
        countries:
          type: array
          items:
            $ref: '#/components/schemas/Country7'
          description: ''
        variants:
          type: array
          items:
            $ref: '#/components/schemas/Variant9'
          description: ''
        options:
          type: array
          items:
            type: string
          description: ''
        prompts:
          type: array
          items:
            type: string
          description: ''
        enroll_products:
          type: array
          items:
            $ref: '#/components/schemas/EnrollProduct2'
          description: ''
        enrolls:
          type: array
          items:
            $ref: '#/components/schemas/Enroll2'
          description: ''
      example:
        id: 2240
        active: true
        title: sketch
        description:
          id: 4836
          name: description
          body: <div>best selling sketch</div>
          record_type: Product
          record_id: 2240
          created_at: '2023-02-02T03:48:16.810Z'
          updated_at: '2023-02-02T03:48:16.810Z'
        stripped: best selling sketch
        price: '12740.0'
        display_price: Rs.12,740.00 (NPR)
        subscription_price: '12740.0'
        display_subscription_price: Rs.12,740.00 (NPR)
        wholesale_price: '0.0'
        display_wholesale_price: Rs.0.00 (NPR)
        wholesale_subscription_price: '0.0'
        display_wholesale_subscription_price: Rs.0.00 (NPR)
        shipping: '5.0'
        image:
          mini: >-
            https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
          detail: >-
            https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
          full: >-
            https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
        image_url: >-
          https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
        sku: sketch
        country_code: ar
        country_id: null
        views: 0
        leads: 0
        share_link: null
        commission: '10.0'
        public: true
        shopify_id: null
        shopify_handle: null
        in_stock: true
        vendor: null
        price_range:
          - Rs.0.00
          - Rs.12,740.00
        price_range_formatted: Rs.0.00 - Rs.12,740.00
        unlimited_inventory: false
        default_variant:
          id: 19630
          product_id: 2240
          shopify_id: null
          title: ''
          sku: sketch12
          position: 12698
          inventory_policy: none
          taxable: true
          inventory_quantity: -84
          created_at: '2023-02-02T03:48:18.009Z'
          updated_at: '2023-09-29T04:59:12.098Z'
          external_id: null
          variant_country_id: null
          image_url: null
          image_path: null
          is_master: true
          discarded_at: null
          price: null
          weight: ''
          size: ''
          physical: true
          unit_of_weight: lb
          height: 0
          width: 0
          length: 0
          unit_of_size: ft
          hs_code: ''
          country_of_origin: ''
          customs_information_shipping: false
          active: true
          bar_code: ''
          track_quantity: false
          keep_selling: true
          option_attrs: []
          allow_subscription: true
        currency_symbol: Rs.
        currency_code: NPR
        average_rating: 0
        option_values: {}
        publish_to_retail_store: true
        publish_to_rep_store: true
        publish_to_share_tab: true
        images:
          - id: 2089
            image:
              mini: >-
                https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
              detail: >-
                https://ik.imagekit.io/fluid/s3/tr:n-video_poster/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
              full: >-
                https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
            image_url: >-
              https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
            position: null
            shopify_id: null
        countries:
          - id: 27
            iso_name: BOTSWANA
            iso: BW
            iso3: BWA
            name: Botswana
            numcode: 72
            active: true
            currency_code: BWP
            currency_symbol: P
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 68
            iso_name: FRANCE
            iso: FR
            iso3: FRA
            name: France
            numcode: 250
            active: true
            currency_code: EUR
            currency_symbol: €
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 214
            iso_name: UNITED STATES
            iso: US
            iso3: USA
            name: United States
            numcode: 840
            active: true
            currency_code: USD
            currency_symbol: $
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 12
            iso_name: AUSTRALIA
            iso: AU
            iso3: AUS
            name: Australia
            numcode: 36
            active: true
            currency_code: AUD
            currency_symbol: $
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 13
            iso_name: AUSTRIA
            iso: AT
            iso3: AUT
            name: Austria
            numcode: 40
            active: true
            currency_code: EUR
            currency_symbol: €
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 14
            iso_name: AZERBAIJAN
            iso: AZ
            iso3: AZE
            name: Azerbaijan
            numcode: 31
            active: true
            currency_code: AZN
            currency_symbol: ₼
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 15
            iso_name: BAHAMAS
            iso: BS
            iso3: BHS
            name: Bahamas
            numcode: 44
            active: true
            currency_code: BSD
            currency_symbol: $
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 16
            iso_name: BAHRAIN
            iso: BH
            iso3: BHR
            name: Bahrain
            numcode: 48
            active: true
            currency_code: BHD
            currency_symbol: د.ب
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 17
            iso_name: BANGLADESH
            iso: BD
            iso3: BGD
            name: Bangladesh
            numcode: 50
            active: true
            currency_code: BDT
            currency_symbol: ৳
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 41
            iso_name: CHINA
            iso: CN
            iso3: CHN
            name: China
            numcode: 156
            active: true
            currency_code: CNY
            currency_symbol: ¥
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 162
            iso_name: POLAND
            iso: PL
            iso3: POL
            name: Poland
            numcode: 616
            active: true
            currency_code: PLN
            currency_symbol: zł
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 163
            iso_name: PORTUGAL
            iso: PT
            iso3: PRT
            name: Portugal
            numcode: 620
            active: true
            currency_code: EUR
            currency_symbol: €
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 168
            iso_name: RUSSIAN FEDERATION
            iso: RU
            iso3: RUS
            name: Russia
            numcode: 643
            active: true
            currency_code: RUB
            currency_symbol: ₽
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 197
            iso_name: TAIWAN, PROVINCE OF CHINA
            iso: TW
            iso3: TWN
            name: Taiwan
            numcode: 158
            active: true
            currency_code: TWD
            currency_symbol: $
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 2
            iso_name: ALBANIA
            iso: AL
            iso3: ALB
            name: Albania
            numcode: 8
            active: true
            currency_code: ALL
            currency_symbol: L
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 3
            iso_name: ALGERIA
            iso: DZ
            iso3: DZA
            name: Algeria
            numcode: 12
            active: true
            currency_code: DZD
            currency_symbol: د.ج
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 74
            iso_name: GERMANY
            iso: DE
            iso3: DEU
            name: Germany
            numcode: 276
            active: true
            currency_code: EUR
            currency_symbol: €
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 141
            iso_name: NEPAL
            iso: NP
            iso3: NPL
            name: Nepal
            numcode: 524
            active: true
            currency_code: NPR
            currency_symbol: Rs.
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 188
            iso_name: SPAIN
            iso: ES
            iso3: ESP
            name: Spain
            numcode: 724
            active: true
            currency_code: EUR
            currency_symbol: €
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 1
            iso_name: AFGHANISTAN
            iso: AF
            iso3: AFG
            name: Afghanistan
            numcode: 4
            active: true
            currency_code: AFN
            currency_symbol: ؋
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 4
            iso_name: AMERICAN SAMOA
            iso: AS
            iso3: ASM
            name: American Samoa
            numcode: 16
            active: true
            currency_code: USD
            currency_symbol: $
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 9
            iso_name: ARGENTINA
            iso: AR
            iso3: ARG
            name: Argentina
            numcode: 32
            active: true
            currency_code: ARS
            currency_symbol: $
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 23
            iso_name: BERMUDA
            iso: BM
            iso3: BMU
            name: Bermuda
            numcode: 60
            active: true
            currency_code: BMD
            currency_symbol: $
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
        variants:
          - id: 19630
            title: ''
            image_url: null
            buyable: true
            option_value_ids: []
            allow_subscription: true
            variant_countries:
              - id: 130789
                price: '9800.0'
                shipping: '500.0'
                tax: '200.0'
                currency_code: ARS
                currency_symbol: $
                display_price: $9,800.00 (ARS)
                country_iso: AR
                subscription_price: '9800.0'
                display_wholesale_price: $0.00 (ARS)
                display_wholesale_subscription_price: $0.00 (ARS)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 9
                  iso: AR
                  iso_name: ARGENTINA
                  iso3: ARG
                  name: Argentina
                  tax_rate: 0
              - id: 130790
                price: '98.0'
                shipping: '5.0'
                tax: '2.0'
                currency_code: AUD
                currency_symbol: $
                display_price: $98.00 (AUD)
                country_iso: AU
                subscription_price: '98.0'
                display_wholesale_price: $0.00 (AUD)
                display_wholesale_subscription_price: $0.00 (AUD)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 12
                  iso: AU
                  iso_name: AUSTRALIA
                  iso3: AUS
                  name: Australia
                  tax_rate: 0
              - id: 130791
                price: '4900.0'
                shipping: '250.0'
                tax: '100.0'
                currency_code: EUR
                currency_symbol: €
                display_price: €4,900.00 (EUR)
                country_iso: AT
                subscription_price: '4900.0'
                display_wholesale_price: €0.00 (EUR)
                display_wholesale_subscription_price: €0.00 (EUR)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 13
                  iso: AT
                  iso_name: AUSTRIA
                  iso3: AUT
                  name: Austria
                  tax_rate: 0
              - id: 130792
                price: '9604.0'
                shipping: '490.0'
                tax: '196.0'
                currency_code: AZN
                currency_symbol: ₼
                display_price: ₼9,604.00 (AZN)
                country_iso: AZ
                subscription_price: '9604.0'
                display_wholesale_price: ₼0.00 (AZN)
                display_wholesale_subscription_price: ₼0.00 (AZN)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 14
                  iso: AZ
                  iso_name: AZERBAIJAN
                  iso3: AZE
                  name: Azerbaijan
                  tax_rate: 0
              - id: 130793
                price: '98.0'
                shipping: '5.0'
                tax: '2.0'
                currency_code: BSD
                currency_symbol: $
                display_price: $98.00 (BSD)
                country_iso: BS
                subscription_price: '98.0'
                display_wholesale_price: $0.00 (BSD)
                display_wholesale_subscription_price: $0.00 (BSD)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 15
                  iso: BS
                  iso_name: BAHAMAS
                  iso3: BHS
                  name: Bahamas
                  tax_rate: 0
              - id: 130794
                price: '98.0'
                shipping: '5.0'
                tax: '2.0'
                currency_code: BHD
                currency_symbol: د.ب
                display_price: د.ب98.000 (BHD)
                country_iso: BH
                subscription_price: '98.0'
                display_wholesale_price: د.ب0.000 (BHD)
                display_wholesale_subscription_price: د.ب0.000 (BHD)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 16
                  iso: BH
                  iso_name: BAHRAIN
                  iso3: BHR
                  name: Bahrain
                  tax_rate: 0
              - id: 130795
                price: '98.0'
                shipping: '5.0'
                tax: '2.0'
                currency_code: BDT
                currency_symbol: ৳
                display_price: ৳98.00 (BDT)
                country_iso: BD
                subscription_price: '98.0'
                display_wholesale_price: ৳0.00 (BDT)
                display_wholesale_subscription_price: ৳0.00 (BDT)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 17
                  iso: BD
                  iso_name: BANGLADESH
                  iso3: BGD
                  name: Bangladesh
                  tax_rate: 0
              - id: 130798
                price: '98.0'
                shipping: '5.0'
                tax: '2.0'
                currency_code: BMD
                currency_symbol: $
                display_price: $98.00 (BMD)
                country_iso: BM
                subscription_price: '98.0'
                display_wholesale_price: $0.00 (BMD)
                display_wholesale_subscription_price: $0.00 (BMD)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 23
                  iso: BM
                  iso_name: BERMUDA
                  iso3: BMU
                  name: Bermuda
                  tax_rate: 0
              - id: 130801
                price: '98.0'
                shipping: '5.0'
                tax: '2.0'
                currency_code: BWP
                currency_symbol: P
                display_price: P98.00 (BWP)
                country_iso: BW
                subscription_price: '98.0'
                display_wholesale_price: P0.00 (BWP)
                display_wholesale_subscription_price: P0.00 (BWP)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 27
                  iso: BW
                  iso_name: BOTSWANA
                  iso3: BWA
                  name: Botswana
                  tax_rate: 0
              - id: 130881
                price: '12740.0'
                shipping: '650.0'
                tax: '260.0'
                currency_code: NPR
                currency_symbol: Rs.
                display_price: Rs.12,740.00 (NPR)
                country_iso: NP
                subscription_price: '12740.0'
                display_wholesale_price: Rs.0.00 (NPR)
                display_wholesale_subscription_price: Rs.0.00 (NPR)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 141
                  iso: NP
                  iso_name: NEPAL
                  iso3: NPL
                  name: Nepal
                  tax_rate: 0
              - id: 130897
                price: '98.0'
                shipping: '5.0'
                tax: '2.0'
                currency_code: EUR
                currency_symbol: €
                display_price: €98.00 (EUR)
                country_iso: PT
                subscription_price: '98.0'
                display_wholesale_price: €0.00 (EUR)
                display_wholesale_subscription_price: €0.00 (EUR)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 163
                  iso: PT
                  iso_name: PORTUGAL
                  iso3: PRT
                  name: Portugal
                  tax_rate: 0
              - id: 130921
                price: '98.0'
                shipping: '5.0'
                tax: '2.0'
                currency_code: TWD
                currency_symbol: $
                display_price: $98.00 (TWD)
                country_iso: TW
                subscription_price: '98.0'
                display_wholesale_price: $0.00 (TWD)
                display_wholesale_subscription_price: $0.00 (TWD)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 197
                  iso: TW
                  iso_name: TAIWAN, PROVINCE OF CHINA
                  iso3: TWN
                  name: Taiwan
                  tax_rate: 0
              - id: 130933
                price: '98.0'
                shipping: '5.0'
                tax: '2.0'
                currency_code: USD
                currency_symbol: $
                display_price: $98.00 (USD)
                country_iso: US
                subscription_price: '98.0'
                display_wholesale_price: $0.00 (USD)
                display_wholesale_subscription_price: $0.00 (USD)
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 214
                  iso: US
                  iso_name: UNITED STATES
                  iso3: USA
                  name: United States
                  tax_rate: 0
        options: []
        prompts: []
        enroll_products:
          - id: 19
            product_id: 2240
            enroll_id: 2
            active: true
            type: membership_product
            created_at: '2023-02-15T06:40:53.303Z'
            updated_at: '2023-02-15T06:40:53.303Z'
        enrolls:
          - id: 2
            integration_id: null
            fields:
              dob: Birthdate
              full_name: Name
              government_id: Government ID
            member_fee: 25
            member_fee_enabled: true
            company_id: 980191019
            created_at: '2023-02-01T07:49:12.347Z'
            updated_at: '2023-02-01T07:54:36.961Z'
            terms_and_conditions_url: https://www.google.com/
    DefaultVariant3:
      title: DefaultVariant3
      required:
        - id
        - product_id
        - shopify_id
        - title
        - sku
        - position
        - inventory_policy
        - taxable
        - inventory_quantity
        - created_at
        - updated_at
        - external_id
        - variant_country_id
        - image_url
        - image_path
        - is_master
        - discarded_at
        - price
        - weight
        - size
        - physical
        - unit_of_weight
        - height
        - width
        - length
        - unit_of_size
        - hs_code
        - country_of_origin
        - customs_information_shipping
        - active
        - bar_code
        - track_quantity
        - keep_selling
        - option_attrs
        - allow_subscription
      type: object
      properties:
        id:
          type: integer
          format: int32
        product_id:
          type: integer
          format: int32
        shopify_id:
          type: string
        title:
          type: string
        sku:
          type: string
        position:
          type: integer
          format: int32
        inventory_policy:
          type: string
        taxable:
          type: boolean
        inventory_quantity:
          type: integer
          format: int32
        created_at:
          type: string
        updated_at:
          type: string
        external_id:
          type: string
        variant_country_id:
          type: string
        image_url:
          type: string
        image_path:
          type: string
        is_master:
          type: boolean
        discarded_at:
          type: string
        price:
          type: string
        weight:
          type: string
        size:
          type: string
        physical:
          type: boolean
        unit_of_weight:
          type: string
        height:
          type: integer
          format: int32
        width:
          type: integer
          format: int32
        length:
          type: integer
          format: int32
        unit_of_size:
          type: string
        hs_code:
          type: string
        country_of_origin:
          type: string
        customs_information_shipping:
          type: boolean
        active:
          type: boolean
        bar_code:
          type: string
        track_quantity:
          type: boolean
        keep_selling:
          type: boolean
        option_attrs:
          type: array
          items:
            type: string
          description: ''
        allow_subscription:
          type: boolean
      example:
        id: 19630
        product_id: 2240
        shopify_id: null
        title: ''
        sku: sketch12
        position: 12698
        inventory_policy: none
        taxable: true
        inventory_quantity: -84
        created_at: '2023-02-02T03:48:18.009Z'
        updated_at: '2023-09-29T04:59:12.098Z'
        external_id: null
        variant_country_id: null
        image_url: null
        image_path: null
        is_master: true
        discarded_at: null
        price: null
        weight: ''
        size: ''
        physical: true
        unit_of_weight: lb
        height: 0
        width: 0
        length: 0
        unit_of_size: ft
        hs_code: ''
        country_of_origin: ''
        customs_information_shipping: false
        active: true
        bar_code: ''
        track_quantity: false
        keep_selling: true
        option_attrs: []
        allow_subscription: true
    Image9:
      title: Image9
      required:
        - id
        - image
        - image_url
        - position
        - shopify_id
      type: object
      properties:
        id:
          type: integer
          format: int32
        image:
          allOf:
            - $ref: '#/components/schemas/Image3'
            - {}
        image_url:
          type: string
        position:
          type: string
        shopify_id:
          type: string
      example:
        id: 2089
        image:
          mini: >-
            https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
          detail: >-
            https://ik.imagekit.io/fluid/s3/tr:n-video_poster/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
          full: >-
            https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
        image_url: >-
          https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
        position: null
        shopify_id: null
    Variant9:
      title: Variant9
      required:
        - id
        - title
        - image_url
        - buyable
        - option_value_ids
        - allow_subscription
        - variant_countries
      type: object
      properties:
        id:
          type: integer
          format: int32
        title:
          type: string
        image_url:
          type: string
        buyable:
          type: boolean
        option_value_ids:
          type: array
          items:
            type: string
          description: ''
        allow_subscription:
          type: boolean
        variant_countries:
          type: array
          items:
            $ref: '#/components/schemas/VariantCountries5'
          description: ''
      example:
        id: 19630
        title: ''
        image_url: null
        buyable: true
        option_value_ids: []
        allow_subscription: true
        variant_countries:
          - id: 130789
            price: '9800.0'
            shipping: '500.0'
            tax: '200.0'
            currency_code: ARS
            currency_symbol: $
            display_price: $9,800.00 (ARS)
            country_iso: AR
            subscription_price: '9800.0'
            display_wholesale_price: $0.00 (ARS)
            display_wholesale_subscription_price: $0.00 (ARS)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 9
              iso: AR
              iso_name: ARGENTINA
              iso3: ARG
              name: Argentina
              tax_rate: 0
          - id: 130790
            price: '98.0'
            shipping: '5.0'
            tax: '2.0'
            currency_code: AUD
            currency_symbol: $
            display_price: $98.00 (AUD)
            country_iso: AU
            subscription_price: '98.0'
            display_wholesale_price: $0.00 (AUD)
            display_wholesale_subscription_price: $0.00 (AUD)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 12
              iso: AU
              iso_name: AUSTRALIA
              iso3: AUS
              name: Australia
              tax_rate: 0
          - id: 130791
            price: '4900.0'
            shipping: '250.0'
            tax: '100.0'
            currency_code: EUR
            currency_symbol: €
            display_price: €4,900.00 (EUR)
            country_iso: AT
            subscription_price: '4900.0'
            display_wholesale_price: €0.00 (EUR)
            display_wholesale_subscription_price: €0.00 (EUR)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 13
              iso: AT
              iso_name: AUSTRIA
              iso3: AUT
              name: Austria
              tax_rate: 0
          - id: 130792
            price: '9604.0'
            shipping: '490.0'
            tax: '196.0'
            currency_code: AZN
            currency_symbol: ₼
            display_price: ₼9,604.00 (AZN)
            country_iso: AZ
            subscription_price: '9604.0'
            display_wholesale_price: ₼0.00 (AZN)
            display_wholesale_subscription_price: ₼0.00 (AZN)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 14
              iso: AZ
              iso_name: AZERBAIJAN
              iso3: AZE
              name: Azerbaijan
              tax_rate: 0
          - id: 130793
            price: '98.0'
            shipping: '5.0'
            tax: '2.0'
            currency_code: BSD
            currency_symbol: $
            display_price: $98.00 (BSD)
            country_iso: BS
            subscription_price: '98.0'
            display_wholesale_price: $0.00 (BSD)
            display_wholesale_subscription_price: $0.00 (BSD)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 15
              iso: BS
              iso_name: BAHAMAS
              iso3: BHS
              name: Bahamas
              tax_rate: 0
          - id: 130794
            price: '98.0'
            shipping: '5.0'
            tax: '2.0'
            currency_code: BHD
            currency_symbol: د.ب
            display_price: د.ب98.000 (BHD)
            country_iso: BH
            subscription_price: '98.0'
            display_wholesale_price: د.ب0.000 (BHD)
            display_wholesale_subscription_price: د.ب0.000 (BHD)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 16
              iso: BH
              iso_name: BAHRAIN
              iso3: BHR
              name: Bahrain
              tax_rate: 0
          - id: 130795
            price: '98.0'
            shipping: '5.0'
            tax: '2.0'
            currency_code: BDT
            currency_symbol: ৳
            display_price: ৳98.00 (BDT)
            country_iso: BD
            subscription_price: '98.0'
            display_wholesale_price: ৳0.00 (BDT)
            display_wholesale_subscription_price: ৳0.00 (BDT)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 17
              iso: BD
              iso_name: BANGLADESH
              iso3: BGD
              name: Bangladesh
              tax_rate: 0
          - id: 130798
            price: '98.0'
            shipping: '5.0'
            tax: '2.0'
            currency_code: BMD
            currency_symbol: $
            display_price: $98.00 (BMD)
            country_iso: BM
            subscription_price: '98.0'
            display_wholesale_price: $0.00 (BMD)
            display_wholesale_subscription_price: $0.00 (BMD)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 23
              iso: BM
              iso_name: BERMUDA
              iso3: BMU
              name: Bermuda
              tax_rate: 0
          - id: 130801
            price: '98.0'
            shipping: '5.0'
            tax: '2.0'
            currency_code: BWP
            currency_symbol: P
            display_price: P98.00 (BWP)
            country_iso: BW
            subscription_price: '98.0'
            display_wholesale_price: P0.00 (BWP)
            display_wholesale_subscription_price: P0.00 (BWP)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 27
              iso: BW
              iso_name: BOTSWANA
              iso3: BWA
              name: Botswana
              tax_rate: 0
          - id: 130881
            price: '12740.0'
            shipping: '650.0'
            tax: '260.0'
            currency_code: NPR
            currency_symbol: Rs.
            display_price: Rs.12,740.00 (NPR)
            country_iso: NP
            subscription_price: '12740.0'
            display_wholesale_price: Rs.0.00 (NPR)
            display_wholesale_subscription_price: Rs.0.00 (NPR)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 141
              iso: NP
              iso_name: NEPAL
              iso3: NPL
              name: Nepal
              tax_rate: 0
          - id: 130897
            price: '98.0'
            shipping: '5.0'
            tax: '2.0'
            currency_code: EUR
            currency_symbol: €
            display_price: €98.00 (EUR)
            country_iso: PT
            subscription_price: '98.0'
            display_wholesale_price: €0.00 (EUR)
            display_wholesale_subscription_price: €0.00 (EUR)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 163
              iso: PT
              iso_name: PORTUGAL
              iso3: PRT
              name: Portugal
              tax_rate: 0
          - id: 130921
            price: '98.0'
            shipping: '5.0'
            tax: '2.0'
            currency_code: TWD
            currency_symbol: $
            display_price: $98.00 (TWD)
            country_iso: TW
            subscription_price: '98.0'
            display_wholesale_price: $0.00 (TWD)
            display_wholesale_subscription_price: $0.00 (TWD)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 197
              iso: TW
              iso_name: TAIWAN, PROVINCE OF CHINA
              iso3: TWN
              name: Taiwan
              tax_rate: 0
          - id: 130933
            price: '98.0'
            shipping: '5.0'
            tax: '2.0'
            currency_code: USD
            currency_symbol: $
            display_price: $98.00 (USD)
            country_iso: US
            subscription_price: '98.0'
            display_wholesale_price: $0.00 (USD)
            display_wholesale_subscription_price: $0.00 (USD)
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 214
              iso: US
              iso_name: UNITED STATES
              iso3: USA
              name: United States
              tax_rate: 0
    EnrollProduct2:
      title: EnrollProduct2
      required:
        - id
        - product_id
        - enroll_id
        - active
        - type
        - created_at
        - updated_at
      type: object
      properties:
        id:
          type: integer
          format: int32
        product_id:
          type: integer
          format: int32
        enroll_id:
          type: integer
          format: int32
        active:
          type: boolean
        type:
          type: string
        created_at:
          type: string
        updated_at:
          type: string
      example:
        id: 19
        product_id: 2240
        enroll_id: 2
        active: true
        type: membership_product
        created_at: '2023-02-15T06:40:53.303Z'
        updated_at: '2023-02-15T06:40:53.303Z'
    Enroll2:
      title: Enroll2
      required:
        - id
        - integration_id
        - fields
        - member_fee
        - member_fee_enabled
        - company_id
        - created_at
        - updated_at
        - terms_and_conditions_url
      type: object
      properties:
        id:
          type: integer
          format: int32
        integration_id:
          type: string
        fields:
          allOf:
            - $ref: '#/components/schemas/Fields'
            - {}
        member_fee:
          type: integer
          format: int32
        member_fee_enabled:
          type: boolean
        company_id:
          type: integer
          format: int32
        created_at:
          type: string
        updated_at:
          type: string
        terms_and_conditions_url:
          type: string
      example:
        id: 2
        integration_id: null
        fields:
          dob: Birthdate
          full_name: Name
          government_id: Government ID
        member_fee: 25
        member_fee_enabled: true
        company_id: 980191019
        created_at: '2023-02-01T07:49:12.347Z'
        updated_at: '2023-02-01T07:54:36.961Z'
        terms_and_conditions_url: https://www.google.com/
    updaterequest6:
      title: updaterequest6
      required:
        - order
      type: object
      properties:
        order:
          allOf:
            - $ref: '#/components/schemas/Order1'
            - {}
      example:
        order:
          shipped_on: '2021-01-02'
          delivered_on: '2021-04-02'
    Order1:
      title: Order1
      required:
        - shipped_on
        - delivered_on
      type: object
      properties:
        shipped_on:
          type: string
        delivered_on:
          type: string
      example:
        shipped_on: '2021-01-02'
        delivered_on: '2021-04-02'
    update6:
      title: update6
      required:
        - id
        - order_number
        - amount
        - shipping
        - tax
        - subtotal
        - first_name
        - last_name
        - email
        - phone
        - tracking
        - cv
        - qv
        - status
        - order_type
        - rating
        - review
        - referrer
        - friendly_status
        - type
        - created_at
        - currency_code
        - currency_symbol
        - display_amount
        - display_subtotal
        - display_tax
        - display_shipping
        - display_refunds
        - display_discount
        - order_thumbnail
        - sale_date
        - recognized_ship_date
        - refundable
        - max_refundable_amount
        - max_refundable_tax
        - max_refundable_shipping
        - max_refundable_product_price
        - display_enrollment_fee
        - ship_to
        - contact
        - items
        - tracking_informations
      type: object
      properties:
        id:
          type: integer
          format: int32
        order_number:
          type: string
        amount:
          type: string
        shipping:
          type: string
        tax:
          type: string
        subtotal:
          type: string
        first_name:
          type: string
        last_name:
          type: string
        email:
          type: string
        phone:
          type: string
        tracking:
          type: string
        cv:
          type: integer
          format: int32
        qv:
          type: integer
          format: int32
        status:
          type: string
        order_type:
          type: string
        rating:
          type: integer
          format: int32
        review:
          type: string
        referrer:
          type: string
        friendly_status:
          type: string
        type:
          type: string
        created_at:
          type: string
        currency_code:
          type: string
        currency_symbol:
          type: string
        display_amount:
          type: string
        display_subtotal:
          type: string
        display_tax:
          type: string
        display_shipping:
          type: string
        display_refunds:
          type: string
        display_discount:
          type: string
        order_thumbnail:
          type: string
        sale_date:
          type: string
        recognized_ship_date:
          type: string
        refundable:
          type: boolean
        max_refundable_amount:
          type: string
        max_refundable_tax:
          type: string
        max_refundable_shipping:
          type: string
        max_refundable_product_price:
          type: string
        display_enrollment_fee:
          type: string
        ship_to:
          allOf:
            - $ref: '#/components/schemas/ShipTo5'
            - {}
        contact:
          allOf:
            - $ref: '#/components/schemas/Contact'
            - {}
        items:
          type: array
          items:
            $ref: '#/components/schemas/Item3'
          description: ''
        tracking_informations:
          type: array
          items:
            type: string
          description: ''
      example:
        id: 8770
        order_number: F32835649011346
        amount: '16900.0'
        shipping: '650.0'
        tax: '260.0'
        subtotal: '12740.0'
        first_name: Bishal
        last_name: Nepal
        email: bnepal05362914@gmail.com
        phone: null
        tracking: null
        cv: 5
        qv: 0
        status: awaiting_shipment
        order_type: purchased
        rating: 0
        review: >-
          Lorem Ipsum is simply dummy text of the printing and typesetting
          industry. Lorem Ipsum has been the industry's standard dummy text ever
          since the 1500s, when an unknown printer took a galley of type and
          scrambled it to make a type specimen book. It has survived not only
          five centuries, but also the leap into electronic typesetting,
          remaining essentially unchanged.
        referrer: Bishal Nepal
        friendly_status: paid
        type: null
        created_at: '2023-03-15T11:17:58.289Z'
        currency_code: NPR
        currency_symbol: Rs.
        display_amount: Rs.16,900.00 (NPR)
        display_subtotal: Rs.12,740.00 (NPR)
        display_tax: Rs.260.00 (NPR)
        display_shipping: Rs.650.00 (NPR)
        display_refunds: (0 CV, 0 QV) -Rs.0.00 (NPR)
        display_discount: Rs.0.00 (NPR)
        order_thumbnail: >-
          https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
        sale_date: null
        recognized_ship_date: '2021-01-02T00:00:00.000Z'
        refundable: true
        max_refundable_amount: '16900.0'
        max_refundable_tax: '260.0'
        max_refundable_shipping: '650.0'
        max_refundable_product_price: '12740.0'
        display_enrollment_fee: Rs.3,250.00 (NPR)
        ship_to:
          id: 980199006
          name: Bishal Nepal
          address1: jhapa
          address2: null
          address3: null
          city: damak
          state: Province 1
          postal_code: mechi
          country_code: null
          country:
            id: 141
            iso_name: NEPAL
            iso: NP
            iso3: NPL
            name: Nepal
            numcode: 524
            active: true
            currency_code: NPR
            currency_symbol: Rs.
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
            default: false
            created_at: '2022-05-09T05:12:21.806Z'
            updated_at: '2022-05-09T05:12:21.806Z'
            geo_entity_id: 28
          default: false
        contact:
          id: 6559
          token: SGJ8gug1WYDBB4vhNW5DqoMM
          first_name: Bishal
          last_name: Nepal
          avatar_url: null
          status: null
          email: bnepal05362914@gmail.com
          email2: null
          phone: null
          phone2: null
          phone_id: null
          address: null
          address2: null
          city: null
          state: null
          postal_code: null
          language_id: null
          country_id: null
          lead_type: null
          ip: null
          requested_at: null
          best_time: null
          time_zone: null
          reason: null
          income: null
          hours: null
          invest: null
          interest: null
          full_name: Bishal Nepal
        items:
          - id: 8805
            quantity: 1
            price: 12740
            ordered_variant: ''
            sku: sketch12
            product:
              id: 2240
              active: true
              title: sketch
              description:
                id: 4836
                name: description
                body: <div>best selling sketch</div>
                record_type: Product
                record_id: 2240
                created_at: '2023-02-02T03:48:16.810Z'
                updated_at: '2023-02-02T03:48:16.810Z'
              stripped: best selling sketch
              price: '12740.0'
              display_price: Rs.12,740.00 (NPR)
              subscription_price: '12740.0'
              display_subscription_price: Rs.12,740.00 (NPR)
              wholesale_price: '0.0'
              display_wholesale_price: Rs.0.00 (NPR)
              wholesale_subscription_price: '0.0'
              display_wholesale_subscription_price: Rs.0.00 (NPR)
              shipping: '5.0'
              image:
                mini: >-
                  https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                detail: >-
                  https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                full: >-
                  https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
              image_url: >-
                https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
              sku: sketch
              country_code: ar
              country_id: null
              views: 0
              leads: 0
              share_link: null
              commission: '10.0'
              public: true
              shopify_id: null
              shopify_handle: null
              in_stock: true
              vendor: null
              price_range:
                - Rs.0.00
                - Rs.12,740.00
              price_range_formatted: Rs.0.00 - Rs.12,740.00
              unlimited_inventory: false
              default_variant:
                id: 19630
                product_id: 2240
                shopify_id: null
                title: ''
                sku: sketch12
                position: 12698
                inventory_policy: none
                taxable: true
                inventory_quantity: -84
                created_at: '2023-02-02T03:48:18.009Z'
                updated_at: '2023-09-29T04:59:12.098Z'
                external_id: null
                variant_country_id: null
                image_url: null
                image_path: null
                is_master: true
                discarded_at: null
                price: null
                weight: ''
                size: ''
                physical: true
                unit_of_weight: lb
                height: 0
                width: 0
                length: 0
                unit_of_size: ft
                hs_code: ''
                country_of_origin: ''
                customs_information_shipping: false
                active: true
                bar_code: ''
                track_quantity: false
                keep_selling: true
                option_attrs: []
                allow_subscription: true
              currency_symbol: Rs.
              currency_code: NPR
              average_rating: 0
              option_values: {}
              publish_to_retail_store: true
              publish_to_rep_store: true
              publish_to_share_tab: true
              images:
                - id: 2089
                  image:
                    mini: >-
                      https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                    detail: >-
                      https://ik.imagekit.io/fluid/s3/tr:n-video_poster/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                    full: >-
                      https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                  image_url: >-
                    https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                  position: null
                  shopify_id: null
              countries:
                - id: 27
                  iso_name: BOTSWANA
                  iso: BW
                  iso3: BWA
                  name: Botswana
                  numcode: 72
                  active: true
                  currency_code: BWP
                  currency_symbol: P
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 68
                  iso_name: FRANCE
                  iso: FR
                  iso3: FRA
                  name: France
                  numcode: 250
                  active: true
                  currency_code: EUR
                  currency_symbol: €
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 214
                  iso_name: UNITED STATES
                  iso: US
                  iso3: USA
                  name: United States
                  numcode: 840
                  active: true
                  currency_code: USD
                  currency_symbol: $
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 12
                  iso_name: AUSTRALIA
                  iso: AU
                  iso3: AUS
                  name: Australia
                  numcode: 36
                  active: true
                  currency_code: AUD
                  currency_symbol: $
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 13
                  iso_name: AUSTRIA
                  iso: AT
                  iso3: AUT
                  name: Austria
                  numcode: 40
                  active: true
                  currency_code: EUR
                  currency_symbol: €
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 14
                  iso_name: AZERBAIJAN
                  iso: AZ
                  iso3: AZE
                  name: Azerbaijan
                  numcode: 31
                  active: true
                  currency_code: AZN
                  currency_symbol: ₼
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 15
                  iso_name: BAHAMAS
                  iso: BS
                  iso3: BHS
                  name: Bahamas
                  numcode: 44
                  active: true
                  currency_code: BSD
                  currency_symbol: $
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 16
                  iso_name: BAHRAIN
                  iso: BH
                  iso3: BHR
                  name: Bahrain
                  numcode: 48
                  active: true
                  currency_code: BHD
                  currency_symbol: د.ب
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 17
                  iso_name: BANGLADESH
                  iso: BD
                  iso3: BGD
                  name: Bangladesh
                  numcode: 50
                  active: true
                  currency_code: BDT
                  currency_symbol: ৳
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 41
                  iso_name: CHINA
                  iso: CN
                  iso3: CHN
                  name: China
                  numcode: 156
                  active: true
                  currency_code: CNY
                  currency_symbol: ¥
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 162
                  iso_name: POLAND
                  iso: PL
                  iso3: POL
                  name: Poland
                  numcode: 616
                  active: true
                  currency_code: PLN
                  currency_symbol: zł
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 163
                  iso_name: PORTUGAL
                  iso: PT
                  iso3: PRT
                  name: Portugal
                  numcode: 620
                  active: true
                  currency_code: EUR
                  currency_symbol: €
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 168
                  iso_name: RUSSIAN FEDERATION
                  iso: RU
                  iso3: RUS
                  name: Russia
                  numcode: 643
                  active: true
                  currency_code: RUB
                  currency_symbol: ₽
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 197
                  iso_name: TAIWAN, PROVINCE OF CHINA
                  iso: TW
                  iso3: TWN
                  name: Taiwan
                  numcode: 158
                  active: true
                  currency_code: TWD
                  currency_symbol: $
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 2
                  iso_name: ALBANIA
                  iso: AL
                  iso3: ALB
                  name: Albania
                  numcode: 8
                  active: true
                  currency_code: ALL
                  currency_symbol: L
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 3
                  iso_name: ALGERIA
                  iso: DZ
                  iso3: DZA
                  name: Algeria
                  numcode: 12
                  active: true
                  currency_code: DZD
                  currency_symbol: د.ج
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 74
                  iso_name: GERMANY
                  iso: DE
                  iso3: DEU
                  name: Germany
                  numcode: 276
                  active: true
                  currency_code: EUR
                  currency_symbol: €
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 141
                  iso_name: NEPAL
                  iso: NP
                  iso3: NPL
                  name: Nepal
                  numcode: 524
                  active: true
                  currency_code: NPR
                  currency_symbol: Rs.
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 188
                  iso_name: SPAIN
                  iso: ES
                  iso3: ESP
                  name: Spain
                  numcode: 724
                  active: true
                  currency_code: EUR
                  currency_symbol: €
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 1
                  iso_name: AFGHANISTAN
                  iso: AF
                  iso3: AFG
                  name: Afghanistan
                  numcode: 4
                  active: true
                  currency_code: AFN
                  currency_symbol: ؋
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 4
                  iso_name: AMERICAN SAMOA
                  iso: AS
                  iso3: ASM
                  name: American Samoa
                  numcode: 16
                  active: true
                  currency_code: USD
                  currency_symbol: $
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 9
                  iso_name: ARGENTINA
                  iso: AR
                  iso3: ARG
                  name: Argentina
                  numcode: 32
                  active: true
                  currency_code: ARS
                  currency_symbol: $
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 23
                  iso_name: BERMUDA
                  iso: BM
                  iso3: BMU
                  name: Bermuda
                  numcode: 60
                  active: true
                  currency_code: BMD
                  currency_symbol: $
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
              variants:
                - id: 19630
                  title: ''
                  image_url: null
                  buyable: true
                  option_value_ids: []
                  allow_subscription: true
                  variant_countries:
                    - id: 130789
                      price: '9800.0'
                      shipping: '500.0'
                      tax: '200.0'
                      currency_code: ARS
                      currency_symbol: $
                      display_price: $9,800.00 (ARS)
                      country_iso: AR
                      subscription_price: '9800.0'
                      display_wholesale_price: $0.00 (ARS)
                      display_wholesale_subscription_price: $0.00 (ARS)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 9
                        iso: AR
                        iso_name: ARGENTINA
                        iso3: ARG
                        name: Argentina
                        tax_rate: 0
                    - id: 130790
                      price: '98.0'
                      shipping: '5.0'
                      tax: '2.0'
                      currency_code: AUD
                      currency_symbol: $
                      display_price: $98.00 (AUD)
                      country_iso: AU
                      subscription_price: '98.0'
                      display_wholesale_price: $0.00 (AUD)
                      display_wholesale_subscription_price: $0.00 (AUD)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 12
                        iso: AU
                        iso_name: AUSTRALIA
                        iso3: AUS
                        name: Australia
                        tax_rate: 0
                    - id: 130791
                      price: '4900.0'
                      shipping: '250.0'
                      tax: '100.0'
                      currency_code: EUR
                      currency_symbol: €
                      display_price: €4,900.00 (EUR)
                      country_iso: AT
                      subscription_price: '4900.0'
                      display_wholesale_price: €0.00 (EUR)
                      display_wholesale_subscription_price: €0.00 (EUR)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 13
                        iso: AT
                        iso_name: AUSTRIA
                        iso3: AUT
                        name: Austria
                        tax_rate: 0
                    - id: 130792
                      price: '9604.0'
                      shipping: '490.0'
                      tax: '196.0'
                      currency_code: AZN
                      currency_symbol: ₼
                      display_price: ₼9,604.00 (AZN)
                      country_iso: AZ
                      subscription_price: '9604.0'
                      display_wholesale_price: ₼0.00 (AZN)
                      display_wholesale_subscription_price: ₼0.00 (AZN)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 14
                        iso: AZ
                        iso_name: AZERBAIJAN
                        iso3: AZE
                        name: Azerbaijan
                        tax_rate: 0
                    - id: 130793
                      price: '98.0'
                      shipping: '5.0'
                      tax: '2.0'
                      currency_code: BSD
                      currency_symbol: $
                      display_price: $98.00 (BSD)
                      country_iso: BS
                      subscription_price: '98.0'
                      display_wholesale_price: $0.00 (BSD)
                      display_wholesale_subscription_price: $0.00 (BSD)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 15
                        iso: BS
                        iso_name: BAHAMAS
                        iso3: BHS
                        name: Bahamas
                        tax_rate: 0
                    - id: 130794
                      price: '98.0'
                      shipping: '5.0'
                      tax: '2.0'
                      currency_code: BHD
                      currency_symbol: د.ب
                      display_price: د.ب98.000 (BHD)
                      country_iso: BH
                      subscription_price: '98.0'
                      display_wholesale_price: د.ب0.000 (BHD)
                      display_wholesale_subscription_price: د.ب0.000 (BHD)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 16
                        iso: BH
                        iso_name: BAHRAIN
                        iso3: BHR
                        name: Bahrain
                        tax_rate: 0
                    - id: 130795
                      price: '98.0'
                      shipping: '5.0'
                      tax: '2.0'
                      currency_code: BDT
                      currency_symbol: ৳
                      display_price: ৳98.00 (BDT)
                      country_iso: BD
                      subscription_price: '98.0'
                      display_wholesale_price: ৳0.00 (BDT)
                      display_wholesale_subscription_price: ৳0.00 (BDT)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 17
                        iso: BD
                        iso_name: BANGLADESH
                        iso3: BGD
                        name: Bangladesh
                        tax_rate: 0
                    - id: 130798
                      price: '98.0'
                      shipping: '5.0'
                      tax: '2.0'
                      currency_code: BMD
                      currency_symbol: $
                      display_price: $98.00 (BMD)
                      country_iso: BM
                      subscription_price: '98.0'
                      display_wholesale_price: $0.00 (BMD)
                      display_wholesale_subscription_price: $0.00 (BMD)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 23
                        iso: BM
                        iso_name: BERMUDA
                        iso3: BMU
                        name: Bermuda
                        tax_rate: 0
                    - id: 130801
                      price: '98.0'
                      shipping: '5.0'
                      tax: '2.0'
                      currency_code: BWP
                      currency_symbol: P
                      display_price: P98.00 (BWP)
                      country_iso: BW
                      subscription_price: '98.0'
                      display_wholesale_price: P0.00 (BWP)
                      display_wholesale_subscription_price: P0.00 (BWP)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 27
                        iso: BW
                        iso_name: BOTSWANA
                        iso3: BWA
                        name: Botswana
                        tax_rate: 0
                    - id: 130881
                      price: '12740.0'
                      shipping: '650.0'
                      tax: '260.0'
                      currency_code: NPR
                      currency_symbol: Rs.
                      display_price: Rs.12,740.00 (NPR)
                      country_iso: NP
                      subscription_price: '12740.0'
                      display_wholesale_price: Rs.0.00 (NPR)
                      display_wholesale_subscription_price: Rs.0.00 (NPR)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 141
                        iso: NP
                        iso_name: NEPAL
                        iso3: NPL
                        name: Nepal
                        tax_rate: 0
                    - id: 130897
                      price: '98.0'
                      shipping: '5.0'
                      tax: '2.0'
                      currency_code: EUR
                      currency_symbol: €
                      display_price: €98.00 (EUR)
                      country_iso: PT
                      subscription_price: '98.0'
                      display_wholesale_price: €0.00 (EUR)
                      display_wholesale_subscription_price: €0.00 (EUR)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 163
                        iso: PT
                        iso_name: PORTUGAL
                        iso3: PRT
                        name: Portugal
                        tax_rate: 0
                    - id: 130921
                      price: '98.0'
                      shipping: '5.0'
                      tax: '2.0'
                      currency_code: TWD
                      currency_symbol: $
                      display_price: $98.00 (TWD)
                      country_iso: TW
                      subscription_price: '98.0'
                      display_wholesale_price: $0.00 (TWD)
                      display_wholesale_subscription_price: $0.00 (TWD)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 197
                        iso: TW
                        iso_name: TAIWAN, PROVINCE OF CHINA
                        iso3: TWN
                        name: Taiwan
                        tax_rate: 0
                    - id: 130933
                      price: '98.0'
                      shipping: '5.0'
                      tax: '2.0'
                      currency_code: USD
                      currency_symbol: $
                      display_price: $98.00 (USD)
                      country_iso: US
                      subscription_price: '98.0'
                      display_wholesale_price: $0.00 (USD)
                      display_wholesale_subscription_price: $0.00 (USD)
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 214
                        iso: US
                        iso_name: UNITED STATES
                        iso3: USA
                        name: United States
                        tax_rate: 0
              options: []
              prompts: []
              enroll_products:
                - id: 19
                  product_id: 2240
                  enroll_id: 2
                  active: true
                  type: membership_product
                  created_at: '2023-02-15T06:40:53.303Z'
                  updated_at: '2023-02-15T06:40:53.303Z'
              enrolls:
                - id: 2
                  integration_id: null
                  fields:
                    dob: Birthdate
                    full_name: Name
                    government_id: Government ID
                  member_fee: 25
                  member_fee_enabled: true
                  company_id: 980191019
                  created_at: '2023-02-01T07:49:12.347Z'
                  updated_at: '2023-02-01T07:54:36.961Z'
                  terms_and_conditions_url: https://www.google.com/
        tracking_informations: []
    createrequest6:
      title: createrequest6
      required:
        - contact
      type: object
      properties:
        contact:
          allOf:
            - $ref: '#/components/schemas/Contact4'
            - {}
      example:
        contact:
          first_name: contact_first_name
          last_name: contact_last_name
          language_code: en
          country_code: US
          status: cold
          email: contact_email@gmail.com
          email2: contact_email_2@gmail.com
          phone: '+00198338838838'
          phone2: '+0019485858758'
          address: N Main Street
          address2: Apt No. 010
          city: N Main
          state: GA
          postal_code: '3884'
          avatar_url: https://cdn.contact_image_url.com/image.jpg
          lead_type: null
          best_time: null
          time_zone: null
          reason: null
          income: null
          hours: null
          invest: null
          interest: null
          affiliate:
            id: null
            external_id: null
            username: null
            email: tingeym2@gmail.com
    Contact4:
      title: Contact4
      required:
        - first_name
        - last_name
        - language_code
        - country_code
        - status
        - email
        - email2
        - phone
        - phone2
        - address
        - address2
        - city
        - state
        - postal_code
        - avatar_url
        - lead_type
        - best_time
        - time_zone
        - reason
        - income
        - hours
        - invest
        - interest
        - affiliate
      type: object
      properties:
        first_name:
          type: string
        last_name:
          type: string
        language_code:
          type: string
        country_code:
          type: string
        status:
          type: string
        email:
          type: string
        email2:
          type: string
        phone:
          type: string
        phone2:
          type: string
        address:
          type: string
        address2:
          type: string
        city:
          type: string
        state:
          type: string
        postal_code:
          type: string
        avatar_url:
          type: string
        lead_type:
          type: string
        best_time:
          type: string
        time_zone:
          type: string
        reason:
          type: string
        income:
          type: string
        hours:
          type: string
        invest:
          type: string
        interest:
          type: string
        affiliate:
          allOf:
            - $ref: '#/components/schemas/Affiliate4'
            - {}
      example:
        first_name: contact_first_name
        last_name: contact_last_name
        language_code: en
        country_code: US
        status: cold
        email: contact_email@gmail.com
        email2: contact_email_2@gmail.com
        phone: '+00198338838838'
        phone2: '+0019485858758'
        address: N Main Street
        address2: Apt No. 010
        city: N Main
        state: GA
        postal_code: '3884'
        avatar_url: https://cdn.contact_image_url.com/image.jpg
        lead_type: null
        best_time: null
        time_zone: null
        reason: null
        income: null
        hours: null
        invest: null
        interest: null
        affiliate:
          id: null
          external_id: null
          username: null
          email: tingeym2@gmail.com
    Affiliate4:
      title: Affiliate4
      required:
        - id
        - external_id
        - username
        - email
      type: object
      properties:
        id:
          type: string
        external_id:
          type: string
        username:
          type: string
        email:
          type: string
      example:
        id: null
        external_id: null
        username: null
        email: tingeym2@gmail.com
    create6:
      title: create6
      required:
        - id
        - token
        - first_name
        - last_name
        - avatar_url
        - status
        - email
        - email2
        - phone
        - phone2
        - phone_id
        - address
        - address2
        - city
        - state
        - postal_code
        - language_id
        - country_id
        - lead_type
        - ip
        - requested_at
        - best_time
        - time_zone
        - reason
        - income
        - hours
        - invest
        - interest
        - full_name
        - activities
      type: object
      properties:
        id:
          type: integer
          format: int32
        token:
          type: string
        first_name:
          type: string
        last_name:
          type: string
        avatar_url:
          type: string
        status:
          type: string
        email:
          type: string
        email2:
          type: string
        phone:
          type: string
        phone2:
          type: string
        phone_id:
          type: string
        address:
          type: string
        address2:
          type: string
        city:
          type: string
        state:
          type: string
        postal_code:
          type: string
        language_id:
          type: integer
          format: int32
        country_id:
          type: integer
          format: int32
        lead_type:
          type: string
        ip:
          type: string
        requested_at:
          type: string
        best_time:
          type: string
        time_zone:
          type: string
        reason:
          type: string
        income:
          type: string
        hours:
          type: string
        invest:
          type: string
        interest:
          type: string
        full_name:
          type: string
        activities:
          type: array
          items:
            type: string
          description: ''
      example:
        id: 28
        token: jmUbn5Ge7cGykVFL4CCWecnQ
        first_name: Ash
        last_name: Ketchum
        avatar_url: https://cdn.contact_image_url.com/image.jpg
        status: cold
        email: contact_email@gmail.com
        email2: contact_email_2@gmail.com
        phone: '+00198338838838'
        phone2: '+0019485858758'
        phone_id: null
        address: N Main Street
        address2: Apt No. 010
        city: N Main
        state: GA
        postal_code: '3884'
        language_id: 980190962
        country_id: 214
        lead_type: null
        ip: null
        requested_at: null
        best_time: null
        time_zone: null
        reason: null
        income: null
        hours: null
        invest: null
        interest: null
        full_name: Ash Ketchum
        activities: []
    createrequest7:
      title: createrequest7
      required:
        - activity
      type: object
      properties:
        activity:
          allOf:
            - $ref: '#/components/schemas/Activity'
            - {}
      example:
        activity:
          title: hello activity
          description: hello activity description here.
          affiliate:
            id: null
            external_id: sammysample12
            username: null
            email: null
            legacy_number: '150010'
    Activity:
      title: Activity
      required:
        - title
        - description
        - affiliate
      type: object
      properties:
        title:
          type: string
        description:
          type: string
        affiliate:
          allOf:
            - $ref: '#/components/schemas/Affiliate5'
            - {}
      example:
        title: hello activity
        description: hello activity description here.
        affiliate:
          id: null
          external_id: sammysample12
          username: null
          email: null
          legacy_number: '150010'
    Affiliate5:
      title: Affiliate5
      required:
        - id
        - external_id
        - username
        - email
        - legacy_number
      type: object
      properties:
        id:
          type: string
        external_id:
          type: string
        username:
          type: string
        email:
          type: string
        legacy_number:
          type: string
      example:
        id: null
        external_id: sammysample12
        username: null
        email: null
        legacy_number: '150010'
    create7:
      title: create7
      required:
        - id
        - user_id
        - title
        - description
        - read_at
        - created_at
        - relation_type
        - company_id
        - relation
        - contact
        - visitor
      type: object
      properties:
        id:
          type: integer
          format: int32
        user_id:
          type: integer
          format: int32
        title:
          type: string
        description:
          type: string
        read_at:
          type: string
        created_at:
          type: string
        relation_type:
          type: string
        company_id:
          type: integer
          format: int32
        relation:
          type: string
        contact:
          type: string
        visitor:
          type: string
      example:
        id: 17
        user_id: 1
        title: hello world
        description: happy new year.
        read_at: null
        created_at: '2024-01-04T08:06:12.267Z'
        relation_type: null
        company_id: 980190962
        relation: null
        contact: null
        visitor: null
    index8:
      title: index8
      required:
        - id
        - points
        - slug
        - point_type
        - title
        - description
        - created_at
      type: object
      properties:
        id:
          type: integer
          format: int32
        points:
          type: integer
          format: int32
        slug:
          type: string
        point_type:
          type: string
        title:
          type: string
        description:
          type: string
        created_at:
          type: string
      example:
        id: 62
        points: 122
        slug: best
        point_type: fantasy
        title: We rock
        description: We make earning fun
        created_at: '2024-01-04T08:11:23.388Z'
    show7:
      title: show7
      required:
        - id
        - points
        - slug
        - point_type
        - title
        - description
        - created_at
      type: object
      properties:
        id:
          type: integer
          format: int32
        points:
          type: integer
          format: int32
        slug:
          type: string
        point_type:
          type: string
        title:
          type: string
        description:
          type: string
        created_at:
          type: string
      example:
        id: 1
        points: 1
        slug: initial
        point_type: giveaway
        title: Welcome to Fluid's giveaways platform!
        description: >-
          Welcome to Fluid!  Your first point is here just because you signed
          up. Start sharing and see your entries explode!
        created_at: '2023-12-26T04:48:56.940Z'
    createrequest8:
      title: createrequest8
      required:
        - point
      type: object
      properties:
        point:
          allOf:
            - $ref: '#/components/schemas/Point'
            - {}
      example:
        point:
          title: hello point
          points: 5
          point_type: fantasy
          description: hello point description here.
          affiliate:
            id: null
            external_id: null
            username: sammysample12
            email: null
    Point:
      title: Point
      required:
        - title
        - points
        - point_type
        - description
        - affiliate
      type: object
      properties:
        title:
          type: string
        points:
          type: integer
          format: int32
        point_type:
          type: string
        description:
          type: string
        affiliate:
          allOf:
            - $ref: '#/components/schemas/Affiliate'
            - {}
      example:
        title: hello point
        points: 5
        point_type: fantasy
        description: hello point description here.
        affiliate:
          id: null
          external_id: null
          username: sammysample12
          email: null
    create8:
      title: create8
      required:
        - id
        - points
        - slug
        - point_type
        - title
        - description
        - created_at
      type: object
      properties:
        id:
          type: integer
          format: int32
        points:
          type: integer
          format: int32
        slug:
          type: string
        point_type:
          type: string
        title:
          type: string
        description:
          type: string
        created_at:
          type: string
      example:
        id: 63
        points: 5
        slug: imported
        point_type: fantasy
        title: hello point
        description: hello point description here.
        created_at: '2024-01-04T08:18:16.346Z'
    updaterequest7:
      title: updaterequest7
      required:
        - point
      type: object
      properties:
        point:
          allOf:
            - $ref: '#/components/schemas/Point1'
            - {}
      example:
        point:
          title: hello point update
          points: 3
          point_type: giveaway
          description: hello point description updated.
    Point1:
      title: Point1
      required:
        - title
        - points
        - point_type
        - description
      type: object
      properties:
        title:
          type: string
        points:
          type: integer
          format: int32
        point_type:
          type: string
        description:
          type: string
      example:
        title: hello point update
        points: 3
        point_type: giveaway
        description: hello point description updated.
    update7:
      title: update7
      required:
        - id
        - points
        - slug
        - point_type
        - title
        - description
        - created_at
      type: object
      properties:
        id:
          type: integer
          format: int32
        points:
          type: integer
          format: int32
        slug:
          type: string
        point_type:
          type: string
        title:
          type: string
        description:
          type: string
        created_at:
          type: string
      example:
        id: 63
        points: 3
        slug: imported
        point_type: giveaway
        title: hello point update
        description: hello point description updated.
        created_at: '2024-01-04T08:18:16.346Z'
    createrequest9:
      title: createrequest9
      required:
        - tile
      type: object
      properties:
        tile:
          allOf:
            - $ref: '#/components/schemas/Tile'
            - {}
      example:
        tile:
          title: ADSite
          url: https://www.anupamdahal.com.np
          subtitle: Personal Portfolio
          image_url: https://miracleanupam.github.io/favicon.ico
          icon_url: ''
          active: true
          available_countries:
            - us
            - in
            - npl
    Tile:
      title: Tile
      required:
        - title
        - url
        - subtitle
        - image_url
        - icon_url
        - active
        - available_countries
      type: object
      properties:
        title:
          type: string
        url:
          type: string
        subtitle:
          type: string
        image_url:
          type: string
        icon_url:
          type: string
        active:
          type: boolean
        available_countries:
          type: array
          items:
            type: string
          description: ''
      example:
        title: ADSite
        url: https://www.anupamdahal.com.np
        subtitle: Personal Portfolio
        image_url: https://miracleanupam.github.io/favicon.ico
        icon_url: ''
        active: true
        available_countries:
          - us
          - in
          - npl
    updaterequest8:
      title: updaterequest8
      required:
        - tile
      type: object
      properties:
        tile:
          allOf:
            - $ref: '#/components/schemas/Tile1'
            - {}
      example:
        tile:
          title: 'ADSite: Anupam''s Blog'
          active: true
          available_countries: []
    Tile1:
      title: Tile1
      required:
        - title
        - active
        - available_countries
      type: object
      properties:
        title:
          type: string
        active:
          type: boolean
        available_countries:
          type: array
          items:
            type: string
          description: ''
      example:
        title: 'ADSite: Anupam''s Blog'
        active: true
        available_countries: []
    cart_abandoned:
      title: cart_abandoned
      required:
        - id
        - name
        - payload
        - timestamp
        - identifier
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        payload:
          allOf:
            - $ref: '#/components/schemas/Payload'
            - {}
        timestamp:
          type: string
        identifier:
          type: string
      example:
        id: 141
        name: cart_abandoned
        payload:
          cart:
            id: 10
            card: null
            type: regular
            buyer:
              email: null
              token: 6bLgYHCSSGn2mshCPB91ZkuH
              full_name: null
              is_enrolled: false
            email: null
            token: YgSi6Xmn6H92MeW69x6hpYdL
            country:
              id: 214
              iso: US
              itn: false
              iso3: USA
              name: United States
              state: true
              active: true
              default: true
              numcode: 840
              address3: false
              iso_name: UNITED STATES
              passport: false
              tax_rate: 0
              delimiter: ','
              separator: .
              created_at: '2023-12-26T04:48:23.479Z'
              updated_at: '2023-12-26T04:48:23.479Z'
              currency_code: USD
              geo_entity_id: null
              currency_symbol: $
            ship_to: null
            visitor: 6bLgYHCSSGn2mshCPB91ZkuH
            wallets: []
            cv_total: 0
            sub_total: '99.91'
            tax_total: '0.0'
            cart_items:
              - id: 15
                price: '99.91'
                cart_id: 10
                external: true
                quantity: 1
                origin_url: http://fluid.lvh.me:3000/home/shop/sleek-plastic-coat5
                variant_id: 25
                subscription: false
            manual_tax: false
            visitor_id: 3
            fulfillment: ups
            amount_total: '120.74'
            order_number: null
            repeat_order: false
            currency_code: USD
            display_price: $120.74 (USD)
            shipping_total: '20.83'
            currency_symbol: $
            manual_shipping: false
            shipping_options:
              - id: 10
                code: ups
                name: UPS
                price: 14
                cart_id: 10
                surcharge: '6.83'
                created_at: '2023-12-27T11:39:08.018Z'
                updated_at: '2023-12-27T11:39:08.018Z'
                delivery_date: null
              - id: 11
                code: ups-surepost
                name: UPS Surepost
                price: 5
                cart_id: 10
                surcharge: '6.29'
                created_at: '2023-12-27T11:39:08.022Z'
                updated_at: '2023-12-27T11:39:08.022Z'
                delivery_date: null
            webhook_enabled?: true
            applied_discounts:
              amount: '0.0'
              discount_codes: []
            checkout_success_url: ''
            hold_card_thirty_days: false
            company_coupon_or_promo_code: true
        timestamp: '2023-12-28T04:24:11.176Z'
        identifier: cart-170373745110
    Payload:
      title: Payload
      required:
        - cart
      type: object
      properties:
        cart:
          allOf:
            - $ref: '#/components/schemas/Cart1'
            - {}
      example:
        cart:
          id: 10
          card: null
          type: regular
          buyer:
            email: null
            token: 6bLgYHCSSGn2mshCPB91ZkuH
            full_name: null
            is_enrolled: false
          email: null
          token: YgSi6Xmn6H92MeW69x6hpYdL
          country:
            id: 214
            iso: US
            itn: false
            iso3: USA
            name: United States
            state: true
            active: true
            default: true
            numcode: 840
            address3: false
            iso_name: UNITED STATES
            passport: false
            tax_rate: 0
            delimiter: ','
            separator: .
            created_at: '2023-12-26T04:48:23.479Z'
            updated_at: '2023-12-26T04:48:23.479Z'
            currency_code: USD
            geo_entity_id: null
            currency_symbol: $
          ship_to: null
          visitor: 6bLgYHCSSGn2mshCPB91ZkuH
          wallets: []
          cv_total: 0
          sub_total: '99.91'
          tax_total: '0.0'
          cart_items:
            - id: 15
              price: '99.91'
              cart_id: 10
              external: true
              quantity: 1
              origin_url: http://fluid.lvh.me:3000/home/shop/sleek-plastic-coat5
              variant_id: 25
              subscription: false
          manual_tax: false
          visitor_id: 3
          fulfillment: ups
          amount_total: '120.74'
          order_number: null
          repeat_order: false
          currency_code: USD
          display_price: $120.74 (USD)
          shipping_total: '20.83'
          currency_symbol: $
          manual_shipping: false
          shipping_options:
            - id: 10
              code: ups
              name: UPS
              price: 14
              cart_id: 10
              surcharge: '6.83'
              created_at: '2023-12-27T11:39:08.018Z'
              updated_at: '2023-12-27T11:39:08.018Z'
              delivery_date: null
            - id: 11
              code: ups-surepost
              name: UPS Surepost
              price: 5
              cart_id: 10
              surcharge: '6.29'
              created_at: '2023-12-27T11:39:08.022Z'
              updated_at: '2023-12-27T11:39:08.022Z'
              delivery_date: null
          webhook_enabled?: true
          applied_discounts:
            amount: '0.0'
            discount_codes: []
          checkout_success_url: ''
          hold_card_thirty_days: false
          company_coupon_or_promo_code: true
    Cart1:
      title: Cart1
      required:
        - id
        - card
        - type
        - buyer
        - email
        - token
        - country
        - ship_to
        - visitor
        - wallets
        - cv_total
        - sub_total
        - tax_total
        - cart_items
        - manual_tax
        - visitor_id
        - fulfillment
        - amount_total
        - order_number
        - repeat_order
        - currency_code
        - display_price
        - shipping_total
        - currency_symbol
        - manual_shipping
        - shipping_options
        - webhook_enabled?
        - applied_discounts
        - checkout_success_url
        - hold_card_thirty_days
        - company_coupon_or_promo_code
      type: object
      properties:
        id:
          type: integer
          format: int32
        card:
          type: string
        type:
          type: string
        buyer:
          allOf:
            - $ref: '#/components/schemas/Buyer'
            - {}
        email:
          type: string
        token:
          type: string
        country:
          allOf:
            - $ref: '#/components/schemas/Country20'
            - {}
        ship_to:
          type: string
        visitor:
          type: string
        wallets:
          type: array
          items:
            type: string
          description: ''
        cv_total:
          type: integer
          format: int32
        sub_total:
          type: string
        tax_total:
          type: string
        cart_items:
          type: array
          items:
            $ref: '#/components/schemas/CartItem'
          description: ''
        manual_tax:
          type: boolean
        visitor_id:
          type: integer
          format: int32
        fulfillment:
          type: string
        amount_total:
          type: string
        order_number:
          type: string
        repeat_order:
          type: boolean
        currency_code:
          type: string
        display_price:
          type: string
        shipping_total:
          type: string
        currency_symbol:
          type: string
        manual_shipping:
          type: boolean
        shipping_options:
          type: array
          items:
            $ref: '#/components/schemas/ShippingOption1'
          description: ''
        webhook_enabled?:
          type: boolean
        applied_discounts:
          allOf:
            - $ref: '#/components/schemas/AppliedDiscounts'
            - {}
        checkout_success_url:
          type: string
        hold_card_thirty_days:
          type: boolean
        company_coupon_or_promo_code:
          type: boolean
      example:
        id: 10
        card: null
        type: regular
        buyer:
          email: null
          token: 6bLgYHCSSGn2mshCPB91ZkuH
          full_name: null
          is_enrolled: false
        email: null
        token: YgSi6Xmn6H92MeW69x6hpYdL
        country:
          id: 214
          iso: US
          itn: false
          iso3: USA
          name: United States
          state: true
          active: true
          default: true
          numcode: 840
          address3: false
          iso_name: UNITED STATES
          passport: false
          tax_rate: 0
          delimiter: ','
          separator: .
          created_at: '2023-12-26T04:48:23.479Z'
          updated_at: '2023-12-26T04:48:23.479Z'
          currency_code: USD
          geo_entity_id: null
          currency_symbol: $
        ship_to: null
        visitor: 6bLgYHCSSGn2mshCPB91ZkuH
        wallets: []
        cv_total: 0
        sub_total: '99.91'
        tax_total: '0.0'
        cart_items:
          - id: 15
            price: '99.91'
            cart_id: 10
            external: true
            quantity: 1
            origin_url: http://fluid.lvh.me:3000/home/shop/sleek-plastic-coat5
            variant_id: 25
            subscription: false
        manual_tax: false
        visitor_id: 3
        fulfillment: ups
        amount_total: '120.74'
        order_number: null
        repeat_order: false
        currency_code: USD
        display_price: $120.74 (USD)
        shipping_total: '20.83'
        currency_symbol: $
        manual_shipping: false
        shipping_options:
          - id: 10
            code: ups
            name: UPS
            price: 14
            cart_id: 10
            surcharge: '6.83'
            created_at: '2023-12-27T11:39:08.018Z'
            updated_at: '2023-12-27T11:39:08.018Z'
            delivery_date: null
          - id: 11
            code: ups-surepost
            name: UPS Surepost
            price: 5
            cart_id: 10
            surcharge: '6.29'
            created_at: '2023-12-27T11:39:08.022Z'
            updated_at: '2023-12-27T11:39:08.022Z'
            delivery_date: null
        webhook_enabled?: true
        applied_discounts:
          amount: '0.0'
          discount_codes: []
        checkout_success_url: ''
        hold_card_thirty_days: false
        company_coupon_or_promo_code: true
    Buyer:
      title: Buyer
      required:
        - email
        - token
        - full_name
        - is_enrolled
      type: object
      properties:
        email:
          type: string
        token:
          type: string
        full_name:
          type: string
        is_enrolled:
          type: boolean
      example:
        email: null
        token: 6bLgYHCSSGn2mshCPB91ZkuH
        full_name: null
        is_enrolled: false
    Country20:
      title: Country20
      required:
        - id
        - iso
        - itn
        - iso3
        - name
        - state
        - active
        - default
        - numcode
        - address3
        - iso_name
        - passport
        - tax_rate
        - delimiter
        - separator
        - created_at
        - updated_at
        - currency_code
        - geo_entity_id
        - currency_symbol
      type: object
      properties:
        id:
          type: integer
          format: int32
        iso:
          type: string
        itn:
          type: boolean
        iso3:
          type: string
        name:
          type: string
        state:
          type: boolean
        active:
          type: boolean
        default:
          type: boolean
        numcode:
          type: integer
          format: int32
        address3:
          type: boolean
        iso_name:
          type: string
        passport:
          type: boolean
        tax_rate:
          type: integer
          format: int32
        delimiter:
          type: string
        separator:
          type: string
        created_at:
          type: string
        updated_at:
          type: string
        currency_code:
          type: string
        geo_entity_id:
          type: string
        currency_symbol:
          type: string
      example:
        id: 214
        iso: US
        itn: false
        iso3: USA
        name: United States
        state: true
        active: true
        default: true
        numcode: 840
        address3: false
        iso_name: UNITED STATES
        passport: false
        tax_rate: 0
        delimiter: ','
        separator: .
        created_at: '2023-12-26T04:48:23.479Z'
        updated_at: '2023-12-26T04:48:23.479Z'
        currency_code: USD
        geo_entity_id: null
        currency_symbol: $
    CartItem:
      title: CartItem
      required:
        - id
        - price
        - cart_id
        - external
        - quantity
        - origin_url
        - variant_id
        - subscription
      type: object
      properties:
        id:
          type: integer
          format: int32
        price:
          type: string
        cart_id:
          type: integer
          format: int32
        external:
          type: boolean
        quantity:
          type: integer
          format: int32
        origin_url:
          type: string
        variant_id:
          type: integer
          format: int32
        subscription:
          type: boolean
      example:
        id: 15
        price: '99.91'
        cart_id: 10
        external: true
        quantity: 1
        origin_url: http://fluid.lvh.me:3000/home/shop/sleek-plastic-coat5
        variant_id: 25
        subscription: false
    ShippingOption1:
      title: ShippingOption1
      required:
        - id
        - code
        - name
        - price
        - cart_id
        - surcharge
        - created_at
        - updated_at
        - delivery_date
      type: object
      properties:
        id:
          type: integer
          format: int32
        code:
          type: string
        name:
          type: string
        price:
          type: integer
          format: int32
        cart_id:
          type: integer
          format: int32
        surcharge:
          type: string
        created_at:
          type: string
        updated_at:
          type: string
        delivery_date:
          type: string
      example:
        id: 10
        code: ups
        name: UPS
        price: 14
        cart_id: 10
        surcharge: '6.83'
        created_at: '2023-12-27T11:39:08.018Z'
        updated_at: '2023-12-27T11:39:08.018Z'
        delivery_date: null
    AppliedDiscounts:
      title: AppliedDiscounts
      required:
        - amount
        - discount_codes
      type: object
      properties:
        amount:
          type: string
        discount_codes:
          type: array
          items:
            type: string
          description: ''
      example:
        amount: '0.0'
        discount_codes: []
    cart_updated:
      title: cart_updated
      required:
        - id
        - name
        - payload
        - timestamp
        - identifier
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        payload:
          allOf:
            - $ref: '#/components/schemas/Payload'
            - {}
        timestamp:
          type: string
        identifier:
          type: string
      example:
        id: 138
        name: cart_updated
        payload:
          cart:
            id: 10
            card: null
            type: regular
            buyer:
              email: null
              token: 6bLgYHCSSGn2mshCPB91ZkuH
              full_name: null
              is_enrolled: false
            email: null
            token: YgSi6Xmn6H92MeW69x6hpYdL
            country:
              id: 214
              iso: US
              itn: false
              iso3: USA
              name: United States
              state: true
              active: true
              default: true
              numcode: 840
              address3: false
              iso_name: UNITED STATES
              passport: false
              tax_rate: 0
              delimiter: ','
              separator: .
              created_at: '2023-12-26T04:48:23.479Z'
              updated_at: '2023-12-26T04:48:23.479Z'
              currency_code: USD
              geo_entity_id: null
              currency_symbol: $
            ship_to: null
            visitor: 6bLgYHCSSGn2mshCPB91ZkuH
            wallets: []
            cv_total: 0
            sub_total: '99.91'
            tax_total: '0.0'
            cart_items:
              - id: 15
                price: '99.91'
                cart_id: 10
                external: true
                quantity: 1
                origin_url: http://fluid.lvh.me:3000/home/shop/sleek-plastic-coat5
                variant_id: 25
                subscription: false
            manual_tax: false
            visitor_id: 3
            fulfillment: ups
            amount_total: '120.74'
            order_number: null
            repeat_order: false
            currency_code: USD
            display_price: $120.74 (USD)
            shipping_total: '20.83'
            currency_symbol: $
            manual_shipping: false
            shipping_options:
              - id: 10
                code: ups
                name: UPS
                price: 14
                cart_id: 10
                surcharge: '6.83'
                created_at: '2023-12-27T11:39:08.018Z'
                updated_at: '2023-12-27T11:39:08.018Z'
                delivery_date: null
              - id: 11
                code: ups-surepost
                name: UPS Surepost
                price: 5
                cart_id: 10
                surcharge: '6.29'
                created_at: '2023-12-27T11:39:08.022Z'
                updated_at: '2023-12-27T11:39:08.022Z'
                delivery_date: null
            webhook_enabled?: true
            applied_discounts:
              amount: '0.0'
              discount_codes: []
            checkout_success_url: ''
            hold_card_thirty_days: false
            company_coupon_or_promo_code: true
        timestamp: '2023-12-28T04:17:03.561Z'
        identifier: cart-170373702310
    contact_created:
      title: contact_created
      required:
        - id
        - name
        - payload
        - timestamp
        - identifier
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        payload:
          allOf:
            - $ref: '#/components/schemas/Payload2'
            - {}
        timestamp:
          type: string
        identifier:
          type: string
      example:
        id: 143
        name: contact_created
        payload:
          contact:
            id: 25
            ip: null
            city: null
            email: aaram@gmail.com
            hours: null
            phone: null
            state: null
            token: UbeDjowurUaFa5E9qgoaST6h
            email2: null
            income: null
            invest: null
            phone2: null
            reason: null
            status: new
            address: null
            address2: null
            interest: null
            phone_id: null
            best_time: null
            full_name: Rameshwor
            last_name: ''
            lead_type: Popup
            time_zone: null
            activities:
              - id: 15
                title: New Contact from Popup
                read_at: null
                user_id: 5
                company_id: 980190962
                created_at: '2023-12-28T04:18:57.808Z'
                description: POPPY
                relation_type: Contact
            avatar_url: null
            country_id: null
            first_name: Rameshwor
            language_id: null
            postal_code: null
            requested_at: null
        timestamp: '2023-12-28T04:27:39.476Z'
        identifier: contact-170373765925
    Payload2:
      title: Payload2
      required:
        - contact
      type: object
      properties:
        contact:
          allOf:
            - $ref: '#/components/schemas/Contact5'
            - {}
      example:
        contact:
          id: 25
          ip: null
          city: null
          email: aaram@gmail.com
          hours: null
          phone: null
          state: null
          token: UbeDjowurUaFa5E9qgoaST6h
          email2: null
          income: null
          invest: null
          phone2: null
          reason: null
          status: new
          address: null
          address2: null
          interest: null
          phone_id: null
          best_time: null
          full_name: Rameshwor
          last_name: ''
          lead_type: Popup
          time_zone: null
          activities:
            - id: 15
              title: New Contact from Popup
              read_at: null
              user_id: 5
              company_id: 980190962
              created_at: '2023-12-28T04:18:57.808Z'
              description: POPPY
              relation_type: Contact
          avatar_url: null
          country_id: null
          first_name: Rameshwor
          language_id: null
          postal_code: null
          requested_at: null
    Contact5:
      title: Contact5
      required:
        - id
        - ip
        - city
        - email
        - hours
        - phone
        - state
        - token
        - email2
        - income
        - invest
        - phone2
        - reason
        - status
        - address
        - address2
        - interest
        - phone_id
        - best_time
        - full_name
        - last_name
        - lead_type
        - time_zone
        - activities
        - avatar_url
        - country_id
        - first_name
        - language_id
        - postal_code
        - requested_at
      type: object
      properties:
        id:
          type: integer
          format: int32
        ip:
          type: string
        city:
          type: string
        email:
          type: string
        hours:
          type: string
        phone:
          type: string
        state:
          type: string
        token:
          type: string
        email2:
          type: string
        income:
          type: string
        invest:
          type: string
        phone2:
          type: string
        reason:
          type: string
        status:
          type: string
        address:
          type: string
        address2:
          type: string
        interest:
          type: string
        phone_id:
          type: string
        best_time:
          type: string
        full_name:
          type: string
        last_name:
          type: string
        lead_type:
          type: string
        time_zone:
          type: string
        activities:
          type: array
          items:
            $ref: '#/components/schemas/Activity1'
          description: ''
        avatar_url:
          type: string
        country_id:
          type: string
        first_name:
          type: string
        language_id:
          type: string
        postal_code:
          type: string
        requested_at:
          type: string
      example:
        id: 25
        ip: null
        city: null
        email: aaram@gmail.com
        hours: null
        phone: null
        state: null
        token: UbeDjowurUaFa5E9qgoaST6h
        email2: null
        income: null
        invest: null
        phone2: null
        reason: null
        status: new
        address: null
        address2: null
        interest: null
        phone_id: null
        best_time: null
        full_name: Rameshwor
        last_name: ''
        lead_type: Popup
        time_zone: null
        activities:
          - id: 15
            title: New Contact from Popup
            read_at: null
            user_id: 5
            company_id: 980190962
            created_at: '2023-12-28T04:18:57.808Z'
            description: POPPY
            relation_type: Contact
        avatar_url: null
        country_id: null
        first_name: Rameshwor
        language_id: null
        postal_code: null
        requested_at: null
    Activity1:
      title: Activity1
      required:
        - id
        - title
        - read_at
        - user_id
        - company_id
        - created_at
        - description
        - relation_type
      type: object
      properties:
        id:
          type: integer
          format: int32
        title:
          type: string
        read_at:
          type: string
        user_id:
          type: integer
          format: int32
        company_id:
          type: integer
          format: int32
        created_at:
          type: string
        description:
          type: string
        relation_type:
          type: string
      example:
        id: 15
        title: New Contact from Popup
        read_at: null
        user_id: 5
        company_id: 980190962
        created_at: '2023-12-28T04:18:57.808Z'
        description: POPPY
        relation_type: Contact
    contact_updated:
      title: contact_updated
      required:
        - id
        - name
        - payload
        - timestamp
        - identifier
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        payload:
          allOf:
            - $ref: '#/components/schemas/Payload3'
            - {}
        timestamp:
          type: string
        identifier:
          type: string
      example:
        id: 30
        name: contact_updated
        payload:
          contact:
            id: 20
            ip: null
            city: null
            email: amir@danpheit.com
            hours: null
            phone: null
            state: null
            token: qgUpmwfwPpCiVmrQTnw6DZQR
            email2: null
            income: null
            invest: null
            phone2: null
            reason: null
            status: new
            address: null
            address2: null
            interest: null
            phone_id: null
            best_time: null
            full_name: amir@danpheit.com
            last_name: null
            lead_type: null
            time_zone: null
            activities:
              - id: 7
                title: >-
                  A customer with the email address amir@danpheit.com has added
                  items to their cart
                read_at: null
                user_id: 5
                company_id: 980190962
                created_at: '2023-12-26T08:36:49.185Z'
                description: >-
                  Products in the cart:<br><a href =
                  'http://fluid.lvh.me:3000/32c44e/shop/aerodynamic-aluminum-bag9'>Aerodynamic
                  Aluminum </a>
                relation_type: Cart
              - id: 6
                title: >-
                  A customer with the email address amir@danpheit.com has added
                  items to their cart
                read_at: null
                user_id: 5
                company_id: 980190962
                created_at: '2023-12-26T08:36:10.350Z'
                description: >-
                  Products in the cart:<br><a href =
                  'http://fluid.lvh.me:3000/32c44e/shop/aerodynamic-aluminum-bag9'>Aerodynamic
                  Aluminum </a>
                relation_type: Cart
            avatar_url: null
            country_id: null
            first_name: null
            language_id: null
            postal_code: null
            requested_at: null
        timestamp: '2023-12-26T08:39:18.737Z'
        identifier: contact-170357995820
    Payload3:
      title: Payload3
      required:
        - contact
      type: object
      properties:
        contact:
          allOf:
            - $ref: '#/components/schemas/Contact6'
            - {}
      example:
        contact:
          id: 20
          ip: null
          city: null
          email: amir@danpheit.com
          hours: null
          phone: null
          state: null
          token: qgUpmwfwPpCiVmrQTnw6DZQR
          email2: null
          income: null
          invest: null
          phone2: null
          reason: null
          status: new
          address: null
          address2: null
          interest: null
          phone_id: null
          best_time: null
          full_name: amir@danpheit.com
          last_name: null
          lead_type: null
          time_zone: null
          activities:
            - id: 7
              title: >-
                A customer with the email address amir@danpheit.com has added
                items to their cart
              read_at: null
              user_id: 5
              company_id: 980190962
              created_at: '2023-12-26T08:36:49.185Z'
              description: >-
                Products in the cart:<br><a href =
                'http://fluid.lvh.me:3000/32c44e/shop/aerodynamic-aluminum-bag9'>Aerodynamic
                Aluminum </a>
              relation_type: Cart
            - id: 6
              title: >-
                A customer with the email address amir@danpheit.com has added
                items to their cart
              read_at: null
              user_id: 5
              company_id: 980190962
              created_at: '2023-12-26T08:36:10.350Z'
              description: >-
                Products in the cart:<br><a href =
                'http://fluid.lvh.me:3000/32c44e/shop/aerodynamic-aluminum-bag9'>Aerodynamic
                Aluminum </a>
              relation_type: Cart
          avatar_url: null
          country_id: null
          first_name: null
          language_id: null
          postal_code: null
          requested_at: null
    Contact6:
      title: Contact6
      required:
        - id
        - ip
        - city
        - email
        - hours
        - phone
        - state
        - token
        - email2
        - income
        - invest
        - phone2
        - reason
        - status
        - address
        - address2
        - interest
        - phone_id
        - best_time
        - full_name
        - last_name
        - lead_type
        - time_zone
        - activities
        - avatar_url
        - country_id
        - first_name
        - language_id
        - postal_code
        - requested_at
      type: object
      properties:
        id:
          type: integer
          format: int32
        ip:
          type: string
        city:
          type: string
        email:
          type: string
        hours:
          type: string
        phone:
          type: string
        state:
          type: string
        token:
          type: string
        email2:
          type: string
        income:
          type: string
        invest:
          type: string
        phone2:
          type: string
        reason:
          type: string
        status:
          type: string
        address:
          type: string
        address2:
          type: string
        interest:
          type: string
        phone_id:
          type: string
        best_time:
          type: string
        full_name:
          type: string
        last_name:
          type: string
        lead_type:
          type: string
        time_zone:
          type: string
        activities:
          type: array
          items:
            $ref: '#/components/schemas/Activity1'
          description: ''
        avatar_url:
          type: string
        country_id:
          type: string
        first_name:
          type: string
        language_id:
          type: string
        postal_code:
          type: string
        requested_at:
          type: string
      example:
        id: 20
        ip: null
        city: null
        email: amir@danpheit.com
        hours: null
        phone: null
        state: null
        token: qgUpmwfwPpCiVmrQTnw6DZQR
        email2: null
        income: null
        invest: null
        phone2: null
        reason: null
        status: new
        address: null
        address2: null
        interest: null
        phone_id: null
        best_time: null
        full_name: amir@danpheit.com
        last_name: null
        lead_type: null
        time_zone: null
        activities:
          - id: 7
            title: >-
              A customer with the email address amir@danpheit.com has added
              items to their cart
            read_at: null
            user_id: 5
            company_id: 980190962
            created_at: '2023-12-26T08:36:49.185Z'
            description: >-
              Products in the cart:<br><a href =
              'http://fluid.lvh.me:3000/32c44e/shop/aerodynamic-aluminum-bag9'>Aerodynamic
              Aluminum </a>
            relation_type: Cart
          - id: 6
            title: >-
              A customer with the email address amir@danpheit.com has added
              items to their cart
            read_at: null
            user_id: 5
            company_id: 980190962
            created_at: '2023-12-26T08:36:10.350Z'
            description: >-
              Products in the cart:<br><a href =
              'http://fluid.lvh.me:3000/32c44e/shop/aerodynamic-aluminum-bag9'>Aerodynamic
              Aluminum </a>
            relation_type: Cart
        avatar_url: null
        country_id: null
        first_name: null
        language_id: null
        postal_code: null
        requested_at: null
    event_created:
      title: event_created
      required:
        - id
        - name
        - payload
        - timestamp
        - identifier
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        payload:
          allOf:
            - $ref: '#/components/schemas/Payload4'
            - {}
        timestamp:
          type: string
        identifier:
          type: string
      example:
        id: 145
        name: event_created
        payload:
          event:
            id: 1
            end: '2024-01-01T12:20:00.000Z'
            url: www.fluid.app
            alert: true
            color: '#EF1A65'
            start: '2024-01-01T11:50:00.000Z'
            title: Happy New Year
            active: true
            time_zone: '-12'
            description:
              id: 132
              body: <div>Wishing everyone on Fluid a Happy New Year</div>
              name: description
              record_id: 1
              created_at: '2023-12-28T04:35:43.198Z'
              updated_at: '2023-12-28T04:35:43.198Z'
              record_type: Event
        timestamp: '2023-12-28T04:35:43.296Z'
        identifier: event-17037381431
    Payload4:
      title: Payload4
      required:
        - event
      type: object
      properties:
        event:
          allOf:
            - $ref: '#/components/schemas/Event'
            - {}
      example:
        event:
          id: 1
          end: '2024-01-01T12:20:00.000Z'
          url: www.fluid.app
          alert: true
          color: '#EF1A65'
          start: '2024-01-01T11:50:00.000Z'
          title: Happy New Year
          active: true
          time_zone: '-12'
          description:
            id: 132
            body: <div>Wishing everyone on Fluid a Happy New Year</div>
            name: description
            record_id: 1
            created_at: '2023-12-28T04:35:43.198Z'
            updated_at: '2023-12-28T04:35:43.198Z'
            record_type: Event
    Event:
      title: Event
      required:
        - id
        - end
        - url
        - alert
        - color
        - start
        - title
        - active
        - time_zone
        - description
      type: object
      properties:
        id:
          type: integer
          format: int32
        end:
          type: string
        url:
          type: string
        alert:
          type: boolean
        color:
          type: string
        start:
          type: string
        title:
          type: string
        active:
          type: boolean
        time_zone:
          type: string
        description:
          allOf:
            - $ref: '#/components/schemas/Description'
            - {}
      example:
        id: 1
        end: '2024-01-01T12:20:00.000Z'
        url: www.fluid.app
        alert: true
        color: '#EF1A65'
        start: '2024-01-01T11:50:00.000Z'
        title: Happy New Year
        active: true
        time_zone: '-12'
        description:
          id: 132
          body: <div>Wishing everyone on Fluid a Happy New Year</div>
          name: description
          record_id: 1
          created_at: '2023-12-28T04:35:43.198Z'
          updated_at: '2023-12-28T04:35:43.198Z'
          record_type: Event
    event_deleted:
      title: event_deleted
      required:
        - id
        - name
        - payload
        - timestamp
        - identifier
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        payload:
          allOf:
            - $ref: '#/components/schemas/Payload4'
            - {}
        timestamp:
          type: string
        identifier:
          type: string
      example:
        id: 149
        name: event_deleted
        payload:
          event:
            id: 1
            end: '2024-01-01T12:20:00.000Z'
            url: www.fluid.app
            alert: true
            color: '#EF1A65'
            start: '2024-01-01T11:50:00.000Z'
            title: Happy New Year
            active: true
            time_zone: '-12'
            description:
              id: 132
              body: <div>Wishing everyone on Fluid a Happy New Year</div>
              name: description
              record_id: 1
              created_at: '2023-12-28T04:35:43.198Z'
              updated_at: '2023-12-28T04:35:43.198Z'
              record_type: Event
        timestamp: '2023-12-28T04:39:54.989Z'
        identifier: event-17037383941
    event_updated:
      title: event_updated
      required:
        - id
        - name
        - payload
        - timestamp
        - identifier
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        payload:
          allOf:
            - $ref: '#/components/schemas/Payload4'
            - {}
        timestamp:
          type: string
        identifier:
          type: string
      example:
        id: 147
        name: event_updated
        payload:
          event:
            id: 1
            end: '2024-01-01T12:20:00.000Z'
            url: www.fluid.app
            alert: true
            color: '#EF1A65'
            start: '2024-01-01T11:50:00.000Z'
            title: Happy New Year
            active: true
            time_zone: '-12'
            description:
              id: 132
              body: <div>Wishing everyone on Fluid a Happy New Year</div>
              name: description
              record_id: 1
              created_at: '2023-12-28T04:35:43.198Z'
              updated_at: '2023-12-28T04:35:43.198Z'
              record_type: Event
        timestamp: '2023-12-28T04:36:57.434Z'
        identifier: event-17037382171
    order_cancelled:
      title: order_cancelled
      required:
        - id
        - name
        - payload
        - timestamp
        - identifier
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        payload:
          allOf:
            - $ref: '#/components/schemas/Payload7'
            - {}
        timestamp:
          type: string
        identifier:
          type: string
      example:
        id: 112
        name: order_cancelled
        payload:
          order:
            cv: 97
            id: 52
            qv: 0
            tax: '0.0'
            type: null
            email: ram@gmail.com
            items:
              - id: 2
                sku: QDPF7N2XOR
                price: 17.32
                product:
                  id: 113
                  sku: QDPF7N2XOR
                  image:
                    full: >-
                      https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                    mini: >-
                      https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                    detail: >-
                      https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                  leads: 0
                  price: '17.32'
                  title: Aerodynamic Aluminum aaa
                  views: 0
                  active: true
                  images: []
                  public: true
                  vendor: null
                  enrolls: []
                  options: []
                  prompts: []
                  in_stock: true
                  shipping: '0.03'
                  stripped: Optimized clear-thinking access
                  variants:
                    - id: 113
                      title: Default Variant
                      buyable: true
                      image_url: null
                      option_value_ids: []
                      variant_countries:
                        - id: 686
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 214
                            iso: US
                            iso3: USA
                            name: United States
                            iso_name: UNITED STATES
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: US
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 687
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 65
                            iso: FO
                            iso3: FRO
                            name: Faroe Islands
                            iso_name: FAROE ISLANDS
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: FO
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 688
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 92
                            iso: IN
                            iso3: IND
                            name: India
                            iso_name: INDIA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: IN
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 689
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 146
                            iso: NI
                            iso3: NIC
                            name: Nicaragua
                            iso_name: NICARAGUA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: NI
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 690
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 172
                            iso: LC
                            iso3: LCA
                            name: Saint Lucia
                            iso_name: SAINT LUCIA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: LC
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 691
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 66
                            iso: FJ
                            iso3: FJI
                            name: Fiji
                            iso_name: FIJI
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: FJ
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 692
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 93
                            iso: ID
                            iso3: IDN
                            name: Indonesia
                            iso_name: INDONESIA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: ID
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 693
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 147
                            iso: NE
                            iso3: NER
                            name: Niger
                            iso_name: NIGER
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: NE
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 694
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 67
                            iso: FI
                            iso3: FIN
                            name: Finland
                            iso_name: FINLAND
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: FI
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 695
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 148
                            iso: NG
                            iso3: NGA
                            name: Nigeria
                            iso_name: NIGERIA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: NG
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                      allow_subscription: true
                  countries:
                    - id: 214
                      iso: US
                      itn: false
                      iso3: USA
                      name: United States
                      state: true
                      active: true
                      numcode: 840
                      address3: false
                      iso_name: UNITED STATES
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: USD
                      currency_symbol: $
                    - id: 65
                      iso: FO
                      itn: false
                      iso3: FRO
                      name: Faroe Islands
                      state: true
                      active: true
                      numcode: 234
                      address3: false
                      iso_name: FAROE ISLANDS
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: DKK
                      currency_symbol: kr.
                    - id: 92
                      iso: IN
                      itn: false
                      iso3: IND
                      name: India
                      state: true
                      active: true
                      numcode: 356
                      address3: false
                      iso_name: INDIA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: INR
                      currency_symbol: ₹
                    - id: 146
                      iso: NI
                      itn: false
                      iso3: NIC
                      name: Nicaragua
                      state: true
                      active: true
                      numcode: 558
                      address3: false
                      iso_name: NICARAGUA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: NIO
                      currency_symbol: C$
                    - id: 172
                      iso: LC
                      itn: false
                      iso3: LCA
                      name: Saint Lucia
                      state: true
                      active: true
                      numcode: 662
                      address3: false
                      iso_name: SAINT LUCIA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: XCD
                      currency_symbol: $
                    - id: 66
                      iso: FJ
                      itn: false
                      iso3: FJI
                      name: Fiji
                      state: true
                      active: true
                      numcode: 242
                      address3: false
                      iso_name: FIJI
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: FJD
                      currency_symbol: $
                    - id: 93
                      iso: ID
                      itn: false
                      iso3: IDN
                      name: Indonesia
                      state: true
                      active: true
                      numcode: 360
                      address3: false
                      iso_name: INDONESIA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: IDR
                      currency_symbol: Rp
                    - id: 147
                      iso: NE
                      itn: false
                      iso3: NER
                      name: Niger
                      state: true
                      active: true
                      numcode: 562
                      address3: false
                      iso_name: NIGER
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: XOF
                      currency_symbol: Fr
                    - id: 67
                      iso: FI
                      itn: false
                      iso3: FIN
                      name: Finland
                      state: true
                      active: true
                      numcode: 246
                      address3: false
                      iso_name: FINLAND
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 148
                      iso: NG
                      itn: false
                      iso3: NGA
                      name: Nigeria
                      state: true
                      active: true
                      numcode: 566
                      address3: false
                      iso_name: NIGERIA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: NGN
                      currency_symbol: ₦
                    - id: 174
                      iso: VC
                      itn: false
                      iso3: VCT
                      name: Saint Vincent and the Grenadines
                      state: true
                      active: true
                      numcode: 670
                      address3: false
                      iso_name: SAINT VINCENT AND THE GRENADINES
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: XCD
                      currency_symbol: $
                    - id: 68
                      iso: FR
                      itn: false
                      iso3: FRA
                      name: France
                      state: true
                      active: true
                      numcode: 250
                      address3: false
                      iso_name: FRANCE
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 94
                      iso: IR
                      itn: false
                      iso3: IRN
                      name: Iran, Islamic Republic of
                      state: true
                      active: true
                      numcode: 364
                      address3: false
                      iso_name: IRAN, ISLAMIC REPUBLIC OF
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: IRR
                      currency_symbol: ﷼
                    - id: 149
                      iso: NU
                      itn: false
                      iso3: NIU
                      name: Niue
                      state: true
                      active: true
                      numcode: 570
                      address3: false
                      iso_name: NIUE
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: NZD
                      currency_symbol: $
                    - id: 175
                      iso: WS
                      itn: false
                      iso3: WSM
                      name: Samoa
                      state: true
                      active: true
                      numcode: 882
                      address3: false
                      iso_name: SAMOA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: WST
                      currency_symbol: T
                    - id: 69
                      iso: GF
                      itn: false
                      iso3: GUF
                      name: French Guiana
                      state: true
                      active: true
                      numcode: 254
                      address3: false
                      iso_name: FRENCH GUIANA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 95
                      iso: IQ
                      itn: false
                      iso3: IRQ
                      name: Iraq
                      state: true
                      active: true
                      numcode: 368
                      address3: false
                      iso_name: IRAQ
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: IQD
                      currency_symbol: ع.د
                    - id: 176
                      iso: SM
                      itn: false
                      iso3: SMR
                      name: San Marino
                      state: true
                      active: true
                      numcode: 674
                      address3: false
                      iso_name: SAN MARINO
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 96
                      iso: IE
                      itn: false
                      iso3: IRL
                      name: Ireland
                      state: true
                      active: true
                      numcode: 372
                      address3: false
                      iso_name: IRELAND
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 177
                      iso: ST
                      itn: false
                      iso3: STP
                      name: Sao Tome and Principe
                      state: true
                      active: true
                      numcode: 678
                      address3: false
                      iso_name: SAO TOME AND PRINCIPE
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: STD
                      currency_symbol: Db
                    - id: 39
                      iso: TD
                      itn: false
                      iso3: TCD
                      name: Chad
                      state: true
                      active: true
                      numcode: 148
                      address3: false
                      iso_name: CHAD
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: XAF
                      currency_symbol: CFA
                    - id: 173
                      iso: PM
                      itn: false
                      iso3: SPM
                      name: Saint Pierre and Miquelon
                      state: true
                      active: true
                      numcode: 666
                      address3: false
                      iso_name: SAINT PIERRE AND MIQUELON
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                  image_url: >-
                    https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                  commission: '10.0'
                  country_id: null
                  share_link: null
                  shopify_id: null
                  description:
                    id: 122
                    body: <div>Optimized clear-thinking access</div>
                    name: description
                    record_id: 113
                    created_at: '2023-12-26T04:49:52.800Z'
                    updated_at: '2023-12-26T06:37:59.551Z'
                    record_type: Product
                  price_range:
                    - $17.32
                    - $17.32
                  country_code: td
                  currency_code: USD
                  display_price: $17.32 (USD)
                  option_values: {}
                  average_rating: 0
                  shopify_handle: null
                  currency_symbol: $
                  default_variant:
                    id: 113
                    sku: QDPF7N2XOR
                    size: 4cm
                    price: null
                    title: Default Variant
                    width: null
                    active: true
                    height: null
                    length: null
                    weight: 10 kg
                    hs_code: null
                    taxable: true
                    bar_code: null
                    physical: null
                    position: 1
                    image_url: null
                    is_master: true
                    created_at: '2023-12-26T04:49:52.811Z'
                    image_path: null
                    product_id: 113
                    shopify_id: null
                    updated_at: '2023-12-26T08:32:24.878Z'
                    external_id: null
                    discarded_at: null
                    keep_selling: false
                    option_attrs: []
                    unit_of_size: null
                    track_quantity: true
                    unit_of_weight: null
                    inventory_policy: none
                    country_of_origin: null
                    allow_subscription: true
                    inventory_quantity: 100
                    variant_country_id: null
                    customs_information_shipping: null
                  enroll_products: []
                  wholesale_price: '0.0'
                  subscription_price: '17.32'
                  unlimited_inventory: false
                  publish_to_rep_store: true
                  publish_to_share_tab: true
                  price_range_formatted: $17.32
                  display_wholesale_price: $0.00 (USD)
                  publish_to_retail_store: true
                  display_subscription_price: $17.32 (USD)
                  wholesale_subscription_price: '0.0'
                  display_wholesale_subscription_price: $0.00 (USD)
                quantity: 1
                ordered_variant: ''
            phone: null
            amount: '13.32'
            rating: 5
            review: null
            status: awaiting_shipment
            contact:
              id: 17
              ip: null
              city: null
              email: ram@gmail.com
              hours: null
              phone: null
              state: null
              token: bqy3h61S3bBFSR8QUzocghn4
              email2: null
              income: null
              invest: null
              phone2: null
              reason: null
              status: new
              address: null
              address2: null
              interest: null
              phone_id: null
              best_time: null
              full_name: Ram Khanka
              last_name: Khanka
              lead_type: null
              time_zone: null
              avatar_url: null
              country_id: null
              first_name: Ram
              language_id: null
              postal_code: null
              requested_at: null
            ship_to:
              id: 980190965
              city: x
              name: Ram Khanka
              state: Alaska
              country:
                id: 214
                iso: US
                itn: false
                iso3: USA
                name: United States
                state: true
                active: true
                default: true
                numcode: 840
                address3: false
                iso_name: UNITED STATES
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                created_at: '2023-12-26T04:48:23.479Z'
                updated_at: '2023-12-26T04:48:23.479Z'
                currency_code: USD
                geo_entity_id: null
                currency_symbol: $
              default: false
              address1: a
              address2: b
              address3: null
              postal_code: '11111'
              country_code: null
            referrer: null
            shipping: '0.0'
            subtotal: '17.32'
            tracking: null
            last_name: Khanka
            sale_date: '2023-12-26T00:00:00.000Z'
            created_at: '2023-12-26T08:28:26.141Z'
            first_name: Rama
            order_type: purchased
            refundable: true
            display_tax: $0.00 (USD)
            order_number: F17227665844
            currency_code: USD
            display_amount: $13.32 (USD)
            currency_symbol: $
            display_refunds: (3 CV, 0 QV) -$4.00 (USD)
            friendly_status: paid
            order_thumbnail: >-
              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
            display_discount: $0.00 (USD)
            display_shipping: $0.00 (USD)
            display_subtotal: $17.32 (USD)
            max_refundable_tax: '0.0'
            recognized_ship_date: null
            max_refundable_amount: '13.32'
            tracking_informations: []
            max_refundable_shipping: '0.0'
            max_refundable_product_price: '13.32'
        timestamp: '2023-12-27T12:37:52.385Z'
        identifier: order-170368067252
    Payload7:
      title: Payload7
      required:
        - order
      type: object
      properties:
        order:
          allOf:
            - $ref: '#/components/schemas/Order2'
            - {}
      example:
        order:
          cv: 97
          id: 52
          qv: 0
          tax: '0.0'
          type: null
          email: ram@gmail.com
          items:
            - id: 2
              sku: QDPF7N2XOR
              price: 17.32
              product:
                id: 113
                sku: QDPF7N2XOR
                image:
                  full: >-
                    https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                  mini: >-
                    https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                  detail: >-
                    https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                leads: 0
                price: '17.32'
                title: Aerodynamic Aluminum aaa
                views: 0
                active: true
                images: []
                public: true
                vendor: null
                enrolls: []
                options: []
                prompts: []
                in_stock: true
                shipping: '0.03'
                stripped: Optimized clear-thinking access
                variants:
                  - id: 113
                    title: Default Variant
                    buyable: true
                    image_url: null
                    option_value_ids: []
                    variant_countries:
                      - id: 686
                        tax: '0.0'
                        price: '17.32'
                        country:
                          id: 214
                          iso: US
                          iso3: USA
                          name: United States
                          iso_name: UNITED STATES
                          tax_rate: 0
                        shipping: '0.0'
                        country_iso: US
                        currency_code: USD
                        display_price: $17.32 (USD)
                        currency_symbol: $
                        wholesale_price: '0.0'
                        subscription_price: '17.32'
                        display_wholesale_price: $0.00 (USD)
                        wholesale_subscription_price: '0.0'
                        display_wholesale_subscription_price: $0.00 (USD)
                      - id: 687
                        tax: '0.0'
                        price: '17.32'
                        country:
                          id: 65
                          iso: FO
                          iso3: FRO
                          name: Faroe Islands
                          iso_name: FAROE ISLANDS
                          tax_rate: 0
                        shipping: '0.0'
                        country_iso: FO
                        currency_code: USD
                        display_price: $17.32 (USD)
                        currency_symbol: $
                        wholesale_price: '0.0'
                        subscription_price: '17.32'
                        display_wholesale_price: $0.00 (USD)
                        wholesale_subscription_price: '0.0'
                        display_wholesale_subscription_price: $0.00 (USD)
                      - id: 688
                        tax: '0.0'
                        price: '17.32'
                        country:
                          id: 92
                          iso: IN
                          iso3: IND
                          name: India
                          iso_name: INDIA
                          tax_rate: 0
                        shipping: '0.0'
                        country_iso: IN
                        currency_code: USD
                        display_price: $17.32 (USD)
                        currency_symbol: $
                        wholesale_price: '0.0'
                        subscription_price: '17.32'
                        display_wholesale_price: $0.00 (USD)
                        wholesale_subscription_price: '0.0'
                        display_wholesale_subscription_price: $0.00 (USD)
                      - id: 689
                        tax: '0.0'
                        price: '17.32'
                        country:
                          id: 146
                          iso: NI
                          iso3: NIC
                          name: Nicaragua
                          iso_name: NICARAGUA
                          tax_rate: 0
                        shipping: '0.0'
                        country_iso: NI
                        currency_code: USD
                        display_price: $17.32 (USD)
                        currency_symbol: $
                        wholesale_price: '0.0'
                        subscription_price: '17.32'
                        display_wholesale_price: $0.00 (USD)
                        wholesale_subscription_price: '0.0'
                        display_wholesale_subscription_price: $0.00 (USD)
                      - id: 690
                        tax: '0.0'
                        price: '17.32'
                        country:
                          id: 172
                          iso: LC
                          iso3: LCA
                          name: Saint Lucia
                          iso_name: SAINT LUCIA
                          tax_rate: 0
                        shipping: '0.0'
                        country_iso: LC
                        currency_code: USD
                        display_price: $17.32 (USD)
                        currency_symbol: $
                        wholesale_price: '0.0'
                        subscription_price: '17.32'
                        display_wholesale_price: $0.00 (USD)
                        wholesale_subscription_price: '0.0'
                        display_wholesale_subscription_price: $0.00 (USD)
                      - id: 691
                        tax: '0.0'
                        price: '17.32'
                        country:
                          id: 66
                          iso: FJ
                          iso3: FJI
                          name: Fiji
                          iso_name: FIJI
                          tax_rate: 0
                        shipping: '0.0'
                        country_iso: FJ
                        currency_code: USD
                        display_price: $17.32 (USD)
                        currency_symbol: $
                        wholesale_price: '0.0'
                        subscription_price: '17.32'
                        display_wholesale_price: $0.00 (USD)
                        wholesale_subscription_price: '0.0'
                        display_wholesale_subscription_price: $0.00 (USD)
                      - id: 692
                        tax: '0.0'
                        price: '17.32'
                        country:
                          id: 93
                          iso: ID
                          iso3: IDN
                          name: Indonesia
                          iso_name: INDONESIA
                          tax_rate: 0
                        shipping: '0.0'
                        country_iso: ID
                        currency_code: USD
                        display_price: $17.32 (USD)
                        currency_symbol: $
                        wholesale_price: '0.0'
                        subscription_price: '17.32'
                        display_wholesale_price: $0.00 (USD)
                        wholesale_subscription_price: '0.0'
                        display_wholesale_subscription_price: $0.00 (USD)
                      - id: 693
                        tax: '0.0'
                        price: '17.32'
                        country:
                          id: 147
                          iso: NE
                          iso3: NER
                          name: Niger
                          iso_name: NIGER
                          tax_rate: 0
                        shipping: '0.0'
                        country_iso: NE
                        currency_code: USD
                        display_price: $17.32 (USD)
                        currency_symbol: $
                        wholesale_price: '0.0'
                        subscription_price: '17.32'
                        display_wholesale_price: $0.00 (USD)
                        wholesale_subscription_price: '0.0'
                        display_wholesale_subscription_price: $0.00 (USD)
                      - id: 694
                        tax: '0.0'
                        price: '17.32'
                        country:
                          id: 67
                          iso: FI
                          iso3: FIN
                          name: Finland
                          iso_name: FINLAND
                          tax_rate: 0
                        shipping: '0.0'
                        country_iso: FI
                        currency_code: USD
                        display_price: $17.32 (USD)
                        currency_symbol: $
                        wholesale_price: '0.0'
                        subscription_price: '17.32'
                        display_wholesale_price: $0.00 (USD)
                        wholesale_subscription_price: '0.0'
                        display_wholesale_subscription_price: $0.00 (USD)
                      - id: 695
                        tax: '0.0'
                        price: '17.32'
                        country:
                          id: 148
                          iso: NG
                          iso3: NGA
                          name: Nigeria
                          iso_name: NIGERIA
                          tax_rate: 0
                        shipping: '0.0'
                        country_iso: NG
                        currency_code: USD
                        display_price: $17.32 (USD)
                        currency_symbol: $
                        wholesale_price: '0.0'
                        subscription_price: '17.32'
                        display_wholesale_price: $0.00 (USD)
                        wholesale_subscription_price: '0.0'
                        display_wholesale_subscription_price: $0.00 (USD)
                    allow_subscription: true
                countries:
                  - id: 214
                    iso: US
                    itn: false
                    iso3: USA
                    name: United States
                    state: true
                    active: true
                    numcode: 840
                    address3: false
                    iso_name: UNITED STATES
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: USD
                    currency_symbol: $
                  - id: 65
                    iso: FO
                    itn: false
                    iso3: FRO
                    name: Faroe Islands
                    state: true
                    active: true
                    numcode: 234
                    address3: false
                    iso_name: FAROE ISLANDS
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: DKK
                    currency_symbol: kr.
                  - id: 92
                    iso: IN
                    itn: false
                    iso3: IND
                    name: India
                    state: true
                    active: true
                    numcode: 356
                    address3: false
                    iso_name: INDIA
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: INR
                    currency_symbol: ₹
                  - id: 146
                    iso: NI
                    itn: false
                    iso3: NIC
                    name: Nicaragua
                    state: true
                    active: true
                    numcode: 558
                    address3: false
                    iso_name: NICARAGUA
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: NIO
                    currency_symbol: C$
                  - id: 172
                    iso: LC
                    itn: false
                    iso3: LCA
                    name: Saint Lucia
                    state: true
                    active: true
                    numcode: 662
                    address3: false
                    iso_name: SAINT LUCIA
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: XCD
                    currency_symbol: $
                  - id: 66
                    iso: FJ
                    itn: false
                    iso3: FJI
                    name: Fiji
                    state: true
                    active: true
                    numcode: 242
                    address3: false
                    iso_name: FIJI
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: FJD
                    currency_symbol: $
                  - id: 93
                    iso: ID
                    itn: false
                    iso3: IDN
                    name: Indonesia
                    state: true
                    active: true
                    numcode: 360
                    address3: false
                    iso_name: INDONESIA
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: IDR
                    currency_symbol: Rp
                  - id: 147
                    iso: NE
                    itn: false
                    iso3: NER
                    name: Niger
                    state: true
                    active: true
                    numcode: 562
                    address3: false
                    iso_name: NIGER
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: XOF
                    currency_symbol: Fr
                  - id: 67
                    iso: FI
                    itn: false
                    iso3: FIN
                    name: Finland
                    state: true
                    active: true
                    numcode: 246
                    address3: false
                    iso_name: FINLAND
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: EUR
                    currency_symbol: €
                  - id: 148
                    iso: NG
                    itn: false
                    iso3: NGA
                    name: Nigeria
                    state: true
                    active: true
                    numcode: 566
                    address3: false
                    iso_name: NIGERIA
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: NGN
                    currency_symbol: ₦
                  - id: 174
                    iso: VC
                    itn: false
                    iso3: VCT
                    name: Saint Vincent and the Grenadines
                    state: true
                    active: true
                    numcode: 670
                    address3: false
                    iso_name: SAINT VINCENT AND THE GRENADINES
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: XCD
                    currency_symbol: $
                  - id: 68
                    iso: FR
                    itn: false
                    iso3: FRA
                    name: France
                    state: true
                    active: true
                    numcode: 250
                    address3: false
                    iso_name: FRANCE
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: EUR
                    currency_symbol: €
                  - id: 94
                    iso: IR
                    itn: false
                    iso3: IRN
                    name: Iran, Islamic Republic of
                    state: true
                    active: true
                    numcode: 364
                    address3: false
                    iso_name: IRAN, ISLAMIC REPUBLIC OF
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: IRR
                    currency_symbol: ﷼
                  - id: 149
                    iso: NU
                    itn: false
                    iso3: NIU
                    name: Niue
                    state: true
                    active: true
                    numcode: 570
                    address3: false
                    iso_name: NIUE
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: NZD
                    currency_symbol: $
                  - id: 175
                    iso: WS
                    itn: false
                    iso3: WSM
                    name: Samoa
                    state: true
                    active: true
                    numcode: 882
                    address3: false
                    iso_name: SAMOA
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: WST
                    currency_symbol: T
                  - id: 69
                    iso: GF
                    itn: false
                    iso3: GUF
                    name: French Guiana
                    state: true
                    active: true
                    numcode: 254
                    address3: false
                    iso_name: FRENCH GUIANA
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: EUR
                    currency_symbol: €
                  - id: 95
                    iso: IQ
                    itn: false
                    iso3: IRQ
                    name: Iraq
                    state: true
                    active: true
                    numcode: 368
                    address3: false
                    iso_name: IRAQ
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: IQD
                    currency_symbol: ع.د
                  - id: 176
                    iso: SM
                    itn: false
                    iso3: SMR
                    name: San Marino
                    state: true
                    active: true
                    numcode: 674
                    address3: false
                    iso_name: SAN MARINO
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: EUR
                    currency_symbol: €
                  - id: 96
                    iso: IE
                    itn: false
                    iso3: IRL
                    name: Ireland
                    state: true
                    active: true
                    numcode: 372
                    address3: false
                    iso_name: IRELAND
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: EUR
                    currency_symbol: €
                  - id: 177
                    iso: ST
                    itn: false
                    iso3: STP
                    name: Sao Tome and Principe
                    state: true
                    active: true
                    numcode: 678
                    address3: false
                    iso_name: SAO TOME AND PRINCIPE
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: STD
                    currency_symbol: Db
                  - id: 39
                    iso: TD
                    itn: false
                    iso3: TCD
                    name: Chad
                    state: true
                    active: true
                    numcode: 148
                    address3: false
                    iso_name: CHAD
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: XAF
                    currency_symbol: CFA
                  - id: 173
                    iso: PM
                    itn: false
                    iso3: SPM
                    name: Saint Pierre and Miquelon
                    state: true
                    active: true
                    numcode: 666
                    address3: false
                    iso_name: SAINT PIERRE AND MIQUELON
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: EUR
                    currency_symbol: €
                image_url: >-
                  https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                commission: '10.0'
                country_id: null
                share_link: null
                shopify_id: null
                description:
                  id: 122
                  body: <div>Optimized clear-thinking access</div>
                  name: description
                  record_id: 113
                  created_at: '2023-12-26T04:49:52.800Z'
                  updated_at: '2023-12-26T06:37:59.551Z'
                  record_type: Product
                price_range:
                  - $17.32
                  - $17.32
                country_code: td
                currency_code: USD
                display_price: $17.32 (USD)
                option_values: {}
                average_rating: 0
                shopify_handle: null
                currency_symbol: $
                default_variant:
                  id: 113
                  sku: QDPF7N2XOR
                  size: 4cm
                  price: null
                  title: Default Variant
                  width: null
                  active: true
                  height: null
                  length: null
                  weight: 10 kg
                  hs_code: null
                  taxable: true
                  bar_code: null
                  physical: null
                  position: 1
                  image_url: null
                  is_master: true
                  created_at: '2023-12-26T04:49:52.811Z'
                  image_path: null
                  product_id: 113
                  shopify_id: null
                  updated_at: '2023-12-26T08:32:24.878Z'
                  external_id: null
                  discarded_at: null
                  keep_selling: false
                  option_attrs: []
                  unit_of_size: null
                  track_quantity: true
                  unit_of_weight: null
                  inventory_policy: none
                  country_of_origin: null
                  allow_subscription: true
                  inventory_quantity: 100
                  variant_country_id: null
                  customs_information_shipping: null
                enroll_products: []
                wholesale_price: '0.0'
                subscription_price: '17.32'
                unlimited_inventory: false
                publish_to_rep_store: true
                publish_to_share_tab: true
                price_range_formatted: $17.32
                display_wholesale_price: $0.00 (USD)
                publish_to_retail_store: true
                display_subscription_price: $17.32 (USD)
                wholesale_subscription_price: '0.0'
                display_wholesale_subscription_price: $0.00 (USD)
              quantity: 1
              ordered_variant: ''
          phone: null
          amount: '13.32'
          rating: 5
          review: null
          status: awaiting_shipment
          contact:
            id: 17
            ip: null
            city: null
            email: ram@gmail.com
            hours: null
            phone: null
            state: null
            token: bqy3h61S3bBFSR8QUzocghn4
            email2: null
            income: null
            invest: null
            phone2: null
            reason: null
            status: new
            address: null
            address2: null
            interest: null
            phone_id: null
            best_time: null
            full_name: Ram Khanka
            last_name: Khanka
            lead_type: null
            time_zone: null
            avatar_url: null
            country_id: null
            first_name: Ram
            language_id: null
            postal_code: null
            requested_at: null
          ship_to:
            id: 980190965
            city: x
            name: Ram Khanka
            state: Alaska
            country:
              id: 214
              iso: US
              itn: false
              iso3: USA
              name: United States
              state: true
              active: true
              default: true
              numcode: 840
              address3: false
              iso_name: UNITED STATES
              passport: false
              tax_rate: 0
              delimiter: ','
              separator: .
              created_at: '2023-12-26T04:48:23.479Z'
              updated_at: '2023-12-26T04:48:23.479Z'
              currency_code: USD
              geo_entity_id: null
              currency_symbol: $
            default: false
            address1: a
            address2: b
            address3: null
            postal_code: '11111'
            country_code: null
          referrer: null
          shipping: '0.0'
          subtotal: '17.32'
          tracking: null
          last_name: Khanka
          sale_date: '2023-12-26T00:00:00.000Z'
          created_at: '2023-12-26T08:28:26.141Z'
          first_name: Rama
          order_type: purchased
          refundable: true
          display_tax: $0.00 (USD)
          order_number: F17227665844
          currency_code: USD
          display_amount: $13.32 (USD)
          currency_symbol: $
          display_refunds: (3 CV, 0 QV) -$4.00 (USD)
          friendly_status: paid
          order_thumbnail: >-
            https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
          display_discount: $0.00 (USD)
          display_shipping: $0.00 (USD)
          display_subtotal: $17.32 (USD)
          max_refundable_tax: '0.0'
          recognized_ship_date: null
          max_refundable_amount: '13.32'
          tracking_informations: []
          max_refundable_shipping: '0.0'
          max_refundable_product_price: '13.32'
    Order2:
      title: Order2
      required:
        - cv
        - id
        - qv
        - tax
        - type
        - email
        - items
        - phone
        - amount
        - rating
        - review
        - status
        - contact
        - ship_to
        - referrer
        - shipping
        - subtotal
        - tracking
        - last_name
        - sale_date
        - created_at
        - first_name
        - order_type
        - refundable
        - display_tax
        - order_number
        - currency_code
        - display_amount
        - currency_symbol
        - display_refunds
        - friendly_status
        - order_thumbnail
        - display_discount
        - display_shipping
        - display_subtotal
        - max_refundable_tax
        - recognized_ship_date
        - max_refundable_amount
        - tracking_informations
        - max_refundable_shipping
        - max_refundable_product_price
      type: object
      properties:
        cv:
          type: integer
          format: int32
        id:
          type: integer
          format: int32
        qv:
          type: integer
          format: int32
        tax:
          type: string
        type:
          type: string
        email:
          type: string
        items:
          type: array
          items:
            $ref: '#/components/schemas/Item5'
          description: ''
        phone:
          type: string
        amount:
          type: string
        rating:
          type: integer
          format: int32
        review:
          type: string
        status:
          type: string
        contact:
          allOf:
            - $ref: '#/components/schemas/Contact1'
            - {}
        ship_to:
          allOf:
            - $ref: '#/components/schemas/ShipTo7'
            - {}
        referrer:
          type: string
        shipping:
          type: string
        subtotal:
          type: string
        tracking:
          type: string
        last_name:
          type: string
        sale_date:
          type: string
        created_at:
          type: string
        first_name:
          type: string
        order_type:
          type: string
        refundable:
          type: boolean
        display_tax:
          type: string
        order_number:
          type: string
        currency_code:
          type: string
        display_amount:
          type: string
        currency_symbol:
          type: string
        display_refunds:
          type: string
        friendly_status:
          type: string
        order_thumbnail:
          type: string
        display_discount:
          type: string
        display_shipping:
          type: string
        display_subtotal:
          type: string
        max_refundable_tax:
          type: string
        recognized_ship_date:
          type: string
        max_refundable_amount:
          type: string
        tracking_informations:
          type: array
          items:
            type: string
          description: ''
        max_refundable_shipping:
          type: string
        max_refundable_product_price:
          type: string
      example:
        cv: 97
        id: 52
        qv: 0
        tax: '0.0'
        type: null
        email: ram@gmail.com
        items:
          - id: 2
            sku: QDPF7N2XOR
            price: 17.32
            product:
              id: 113
              sku: QDPF7N2XOR
              image:
                full: >-
                  https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                mini: >-
                  https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                detail: >-
                  https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
              leads: 0
              price: '17.32'
              title: Aerodynamic Aluminum aaa
              views: 0
              active: true
              images: []
              public: true
              vendor: null
              enrolls: []
              options: []
              prompts: []
              in_stock: true
              shipping: '0.03'
              stripped: Optimized clear-thinking access
              variants:
                - id: 113
                  title: Default Variant
                  buyable: true
                  image_url: null
                  option_value_ids: []
                  variant_countries:
                    - id: 686
                      tax: '0.0'
                      price: '17.32'
                      country:
                        id: 214
                        iso: US
                        iso3: USA
                        name: United States
                        iso_name: UNITED STATES
                        tax_rate: 0
                      shipping: '0.0'
                      country_iso: US
                      currency_code: USD
                      display_price: $17.32 (USD)
                      currency_symbol: $
                      wholesale_price: '0.0'
                      subscription_price: '17.32'
                      display_wholesale_price: $0.00 (USD)
                      wholesale_subscription_price: '0.0'
                      display_wholesale_subscription_price: $0.00 (USD)
                    - id: 687
                      tax: '0.0'
                      price: '17.32'
                      country:
                        id: 65
                        iso: FO
                        iso3: FRO
                        name: Faroe Islands
                        iso_name: FAROE ISLANDS
                        tax_rate: 0
                      shipping: '0.0'
                      country_iso: FO
                      currency_code: USD
                      display_price: $17.32 (USD)
                      currency_symbol: $
                      wholesale_price: '0.0'
                      subscription_price: '17.32'
                      display_wholesale_price: $0.00 (USD)
                      wholesale_subscription_price: '0.0'
                      display_wholesale_subscription_price: $0.00 (USD)
                    - id: 688
                      tax: '0.0'
                      price: '17.32'
                      country:
                        id: 92
                        iso: IN
                        iso3: IND
                        name: India
                        iso_name: INDIA
                        tax_rate: 0
                      shipping: '0.0'
                      country_iso: IN
                      currency_code: USD
                      display_price: $17.32 (USD)
                      currency_symbol: $
                      wholesale_price: '0.0'
                      subscription_price: '17.32'
                      display_wholesale_price: $0.00 (USD)
                      wholesale_subscription_price: '0.0'
                      display_wholesale_subscription_price: $0.00 (USD)
                    - id: 689
                      tax: '0.0'
                      price: '17.32'
                      country:
                        id: 146
                        iso: NI
                        iso3: NIC
                        name: Nicaragua
                        iso_name: NICARAGUA
                        tax_rate: 0
                      shipping: '0.0'
                      country_iso: NI
                      currency_code: USD
                      display_price: $17.32 (USD)
                      currency_symbol: $
                      wholesale_price: '0.0'
                      subscription_price: '17.32'
                      display_wholesale_price: $0.00 (USD)
                      wholesale_subscription_price: '0.0'
                      display_wholesale_subscription_price: $0.00 (USD)
                    - id: 690
                      tax: '0.0'
                      price: '17.32'
                      country:
                        id: 172
                        iso: LC
                        iso3: LCA
                        name: Saint Lucia
                        iso_name: SAINT LUCIA
                        tax_rate: 0
                      shipping: '0.0'
                      country_iso: LC
                      currency_code: USD
                      display_price: $17.32 (USD)
                      currency_symbol: $
                      wholesale_price: '0.0'
                      subscription_price: '17.32'
                      display_wholesale_price: $0.00 (USD)
                      wholesale_subscription_price: '0.0'
                      display_wholesale_subscription_price: $0.00 (USD)
                    - id: 691
                      tax: '0.0'
                      price: '17.32'
                      country:
                        id: 66
                        iso: FJ
                        iso3: FJI
                        name: Fiji
                        iso_name: FIJI
                        tax_rate: 0
                      shipping: '0.0'
                      country_iso: FJ
                      currency_code: USD
                      display_price: $17.32 (USD)
                      currency_symbol: $
                      wholesale_price: '0.0'
                      subscription_price: '17.32'
                      display_wholesale_price: $0.00 (USD)
                      wholesale_subscription_price: '0.0'
                      display_wholesale_subscription_price: $0.00 (USD)
                    - id: 692
                      tax: '0.0'
                      price: '17.32'
                      country:
                        id: 93
                        iso: ID
                        iso3: IDN
                        name: Indonesia
                        iso_name: INDONESIA
                        tax_rate: 0
                      shipping: '0.0'
                      country_iso: ID
                      currency_code: USD
                      display_price: $17.32 (USD)
                      currency_symbol: $
                      wholesale_price: '0.0'
                      subscription_price: '17.32'
                      display_wholesale_price: $0.00 (USD)
                      wholesale_subscription_price: '0.0'
                      display_wholesale_subscription_price: $0.00 (USD)
                    - id: 693
                      tax: '0.0'
                      price: '17.32'
                      country:
                        id: 147
                        iso: NE
                        iso3: NER
                        name: Niger
                        iso_name: NIGER
                        tax_rate: 0
                      shipping: '0.0'
                      country_iso: NE
                      currency_code: USD
                      display_price: $17.32 (USD)
                      currency_symbol: $
                      wholesale_price: '0.0'
                      subscription_price: '17.32'
                      display_wholesale_price: $0.00 (USD)
                      wholesale_subscription_price: '0.0'
                      display_wholesale_subscription_price: $0.00 (USD)
                    - id: 694
                      tax: '0.0'
                      price: '17.32'
                      country:
                        id: 67
                        iso: FI
                        iso3: FIN
                        name: Finland
                        iso_name: FINLAND
                        tax_rate: 0
                      shipping: '0.0'
                      country_iso: FI
                      currency_code: USD
                      display_price: $17.32 (USD)
                      currency_symbol: $
                      wholesale_price: '0.0'
                      subscription_price: '17.32'
                      display_wholesale_price: $0.00 (USD)
                      wholesale_subscription_price: '0.0'
                      display_wholesale_subscription_price: $0.00 (USD)
                    - id: 695
                      tax: '0.0'
                      price: '17.32'
                      country:
                        id: 148
                        iso: NG
                        iso3: NGA
                        name: Nigeria
                        iso_name: NIGERIA
                        tax_rate: 0
                      shipping: '0.0'
                      country_iso: NG
                      currency_code: USD
                      display_price: $17.32 (USD)
                      currency_symbol: $
                      wholesale_price: '0.0'
                      subscription_price: '17.32'
                      display_wholesale_price: $0.00 (USD)
                      wholesale_subscription_price: '0.0'
                      display_wholesale_subscription_price: $0.00 (USD)
                  allow_subscription: true
              countries:
                - id: 214
                  iso: US
                  itn: false
                  iso3: USA
                  name: United States
                  state: true
                  active: true
                  numcode: 840
                  address3: false
                  iso_name: UNITED STATES
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: USD
                  currency_symbol: $
                - id: 65
                  iso: FO
                  itn: false
                  iso3: FRO
                  name: Faroe Islands
                  state: true
                  active: true
                  numcode: 234
                  address3: false
                  iso_name: FAROE ISLANDS
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: DKK
                  currency_symbol: kr.
                - id: 92
                  iso: IN
                  itn: false
                  iso3: IND
                  name: India
                  state: true
                  active: true
                  numcode: 356
                  address3: false
                  iso_name: INDIA
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: INR
                  currency_symbol: ₹
                - id: 146
                  iso: NI
                  itn: false
                  iso3: NIC
                  name: Nicaragua
                  state: true
                  active: true
                  numcode: 558
                  address3: false
                  iso_name: NICARAGUA
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: NIO
                  currency_symbol: C$
                - id: 172
                  iso: LC
                  itn: false
                  iso3: LCA
                  name: Saint Lucia
                  state: true
                  active: true
                  numcode: 662
                  address3: false
                  iso_name: SAINT LUCIA
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: XCD
                  currency_symbol: $
                - id: 66
                  iso: FJ
                  itn: false
                  iso3: FJI
                  name: Fiji
                  state: true
                  active: true
                  numcode: 242
                  address3: false
                  iso_name: FIJI
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: FJD
                  currency_symbol: $
                - id: 93
                  iso: ID
                  itn: false
                  iso3: IDN
                  name: Indonesia
                  state: true
                  active: true
                  numcode: 360
                  address3: false
                  iso_name: INDONESIA
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: IDR
                  currency_symbol: Rp
                - id: 147
                  iso: NE
                  itn: false
                  iso3: NER
                  name: Niger
                  state: true
                  active: true
                  numcode: 562
                  address3: false
                  iso_name: NIGER
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: XOF
                  currency_symbol: Fr
                - id: 67
                  iso: FI
                  itn: false
                  iso3: FIN
                  name: Finland
                  state: true
                  active: true
                  numcode: 246
                  address3: false
                  iso_name: FINLAND
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: EUR
                  currency_symbol: €
                - id: 148
                  iso: NG
                  itn: false
                  iso3: NGA
                  name: Nigeria
                  state: true
                  active: true
                  numcode: 566
                  address3: false
                  iso_name: NIGERIA
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: NGN
                  currency_symbol: ₦
                - id: 174
                  iso: VC
                  itn: false
                  iso3: VCT
                  name: Saint Vincent and the Grenadines
                  state: true
                  active: true
                  numcode: 670
                  address3: false
                  iso_name: SAINT VINCENT AND THE GRENADINES
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: XCD
                  currency_symbol: $
                - id: 68
                  iso: FR
                  itn: false
                  iso3: FRA
                  name: France
                  state: true
                  active: true
                  numcode: 250
                  address3: false
                  iso_name: FRANCE
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: EUR
                  currency_symbol: €
                - id: 94
                  iso: IR
                  itn: false
                  iso3: IRN
                  name: Iran, Islamic Republic of
                  state: true
                  active: true
                  numcode: 364
                  address3: false
                  iso_name: IRAN, ISLAMIC REPUBLIC OF
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: IRR
                  currency_symbol: ﷼
                - id: 149
                  iso: NU
                  itn: false
                  iso3: NIU
                  name: Niue
                  state: true
                  active: true
                  numcode: 570
                  address3: false
                  iso_name: NIUE
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: NZD
                  currency_symbol: $
                - id: 175
                  iso: WS
                  itn: false
                  iso3: WSM
                  name: Samoa
                  state: true
                  active: true
                  numcode: 882
                  address3: false
                  iso_name: SAMOA
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: WST
                  currency_symbol: T
                - id: 69
                  iso: GF
                  itn: false
                  iso3: GUF
                  name: French Guiana
                  state: true
                  active: true
                  numcode: 254
                  address3: false
                  iso_name: FRENCH GUIANA
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: EUR
                  currency_symbol: €
                - id: 95
                  iso: IQ
                  itn: false
                  iso3: IRQ
                  name: Iraq
                  state: true
                  active: true
                  numcode: 368
                  address3: false
                  iso_name: IRAQ
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: IQD
                  currency_symbol: ع.د
                - id: 176
                  iso: SM
                  itn: false
                  iso3: SMR
                  name: San Marino
                  state: true
                  active: true
                  numcode: 674
                  address3: false
                  iso_name: SAN MARINO
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: EUR
                  currency_symbol: €
                - id: 96
                  iso: IE
                  itn: false
                  iso3: IRL
                  name: Ireland
                  state: true
                  active: true
                  numcode: 372
                  address3: false
                  iso_name: IRELAND
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: EUR
                  currency_symbol: €
                - id: 177
                  iso: ST
                  itn: false
                  iso3: STP
                  name: Sao Tome and Principe
                  state: true
                  active: true
                  numcode: 678
                  address3: false
                  iso_name: SAO TOME AND PRINCIPE
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: STD
                  currency_symbol: Db
                - id: 39
                  iso: TD
                  itn: false
                  iso3: TCD
                  name: Chad
                  state: true
                  active: true
                  numcode: 148
                  address3: false
                  iso_name: CHAD
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: XAF
                  currency_symbol: CFA
                - id: 173
                  iso: PM
                  itn: false
                  iso3: SPM
                  name: Saint Pierre and Miquelon
                  state: true
                  active: true
                  numcode: 666
                  address3: false
                  iso_name: SAINT PIERRE AND MIQUELON
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: EUR
                  currency_symbol: €
              image_url: >-
                https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
              commission: '10.0'
              country_id: null
              share_link: null
              shopify_id: null
              description:
                id: 122
                body: <div>Optimized clear-thinking access</div>
                name: description
                record_id: 113
                created_at: '2023-12-26T04:49:52.800Z'
                updated_at: '2023-12-26T06:37:59.551Z'
                record_type: Product
              price_range:
                - $17.32
                - $17.32
              country_code: td
              currency_code: USD
              display_price: $17.32 (USD)
              option_values: {}
              average_rating: 0
              shopify_handle: null
              currency_symbol: $
              default_variant:
                id: 113
                sku: QDPF7N2XOR
                size: 4cm
                price: null
                title: Default Variant
                width: null
                active: true
                height: null
                length: null
                weight: 10 kg
                hs_code: null
                taxable: true
                bar_code: null
                physical: null
                position: 1
                image_url: null
                is_master: true
                created_at: '2023-12-26T04:49:52.811Z'
                image_path: null
                product_id: 113
                shopify_id: null
                updated_at: '2023-12-26T08:32:24.878Z'
                external_id: null
                discarded_at: null
                keep_selling: false
                option_attrs: []
                unit_of_size: null
                track_quantity: true
                unit_of_weight: null
                inventory_policy: none
                country_of_origin: null
                allow_subscription: true
                inventory_quantity: 100
                variant_country_id: null
                customs_information_shipping: null
              enroll_products: []
              wholesale_price: '0.0'
              subscription_price: '17.32'
              unlimited_inventory: false
              publish_to_rep_store: true
              publish_to_share_tab: true
              price_range_formatted: $17.32
              display_wholesale_price: $0.00 (USD)
              publish_to_retail_store: true
              display_subscription_price: $17.32 (USD)
              wholesale_subscription_price: '0.0'
              display_wholesale_subscription_price: $0.00 (USD)
            quantity: 1
            ordered_variant: ''
        phone: null
        amount: '13.32'
        rating: 5
        review: null
        status: awaiting_shipment
        contact:
          id: 17
          ip: null
          city: null
          email: ram@gmail.com
          hours: null
          phone: null
          state: null
          token: bqy3h61S3bBFSR8QUzocghn4
          email2: null
          income: null
          invest: null
          phone2: null
          reason: null
          status: new
          address: null
          address2: null
          interest: null
          phone_id: null
          best_time: null
          full_name: Ram Khanka
          last_name: Khanka
          lead_type: null
          time_zone: null
          avatar_url: null
          country_id: null
          first_name: Ram
          language_id: null
          postal_code: null
          requested_at: null
        ship_to:
          id: 980190965
          city: x
          name: Ram Khanka
          state: Alaska
          country:
            id: 214
            iso: US
            itn: false
            iso3: USA
            name: United States
            state: true
            active: true
            default: true
            numcode: 840
            address3: false
            iso_name: UNITED STATES
            passport: false
            tax_rate: 0
            delimiter: ','
            separator: .
            created_at: '2023-12-26T04:48:23.479Z'
            updated_at: '2023-12-26T04:48:23.479Z'
            currency_code: USD
            geo_entity_id: null
            currency_symbol: $
          default: false
          address1: a
          address2: b
          address3: null
          postal_code: '11111'
          country_code: null
        referrer: null
        shipping: '0.0'
        subtotal: '17.32'
        tracking: null
        last_name: Khanka
        sale_date: '2023-12-26T00:00:00.000Z'
        created_at: '2023-12-26T08:28:26.141Z'
        first_name: Rama
        order_type: purchased
        refundable: true
        display_tax: $0.00 (USD)
        order_number: F17227665844
        currency_code: USD
        display_amount: $13.32 (USD)
        currency_symbol: $
        display_refunds: (3 CV, 0 QV) -$4.00 (USD)
        friendly_status: paid
        order_thumbnail: >-
          https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
        display_discount: $0.00 (USD)
        display_shipping: $0.00 (USD)
        display_subtotal: $17.32 (USD)
        max_refundable_tax: '0.0'
        recognized_ship_date: null
        max_refundable_amount: '13.32'
        tracking_informations: []
        max_refundable_shipping: '0.0'
        max_refundable_product_price: '13.32'
    Item5:
      title: Item5
      required:
        - id
        - sku
        - price
        - product
        - quantity
        - ordered_variant
      type: object
      properties:
        id:
          type: integer
          format: int32
        sku:
          type: string
        price:
          type: number
        product:
          allOf:
            - $ref: '#/components/schemas/Product12'
            - {}
        quantity:
          type: integer
          format: int32
        ordered_variant:
          type: string
      example:
        id: 2
        sku: QDPF7N2XOR
        price: 17.32
        product:
          id: 113
          sku: QDPF7N2XOR
          image:
            full: >-
              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
            mini: >-
              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
            detail: >-
              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
          leads: 0
          price: '17.32'
          title: Aerodynamic Aluminum aaa
          views: 0
          active: true
          images: []
          public: true
          vendor: null
          enrolls: []
          options: []
          prompts: []
          in_stock: true
          shipping: '0.03'
          stripped: Optimized clear-thinking access
          variants:
            - id: 113
              title: Default Variant
              buyable: true
              image_url: null
              option_value_ids: []
              variant_countries:
                - id: 686
                  tax: '0.0'
                  price: '17.32'
                  country:
                    id: 214
                    iso: US
                    iso3: USA
                    name: United States
                    iso_name: UNITED STATES
                    tax_rate: 0
                  shipping: '0.0'
                  country_iso: US
                  currency_code: USD
                  display_price: $17.32 (USD)
                  currency_symbol: $
                  wholesale_price: '0.0'
                  subscription_price: '17.32'
                  display_wholesale_price: $0.00 (USD)
                  wholesale_subscription_price: '0.0'
                  display_wholesale_subscription_price: $0.00 (USD)
                - id: 687
                  tax: '0.0'
                  price: '17.32'
                  country:
                    id: 65
                    iso: FO
                    iso3: FRO
                    name: Faroe Islands
                    iso_name: FAROE ISLANDS
                    tax_rate: 0
                  shipping: '0.0'
                  country_iso: FO
                  currency_code: USD
                  display_price: $17.32 (USD)
                  currency_symbol: $
                  wholesale_price: '0.0'
                  subscription_price: '17.32'
                  display_wholesale_price: $0.00 (USD)
                  wholesale_subscription_price: '0.0'
                  display_wholesale_subscription_price: $0.00 (USD)
                - id: 688
                  tax: '0.0'
                  price: '17.32'
                  country:
                    id: 92
                    iso: IN
                    iso3: IND
                    name: India
                    iso_name: INDIA
                    tax_rate: 0
                  shipping: '0.0'
                  country_iso: IN
                  currency_code: USD
                  display_price: $17.32 (USD)
                  currency_symbol: $
                  wholesale_price: '0.0'
                  subscription_price: '17.32'
                  display_wholesale_price: $0.00 (USD)
                  wholesale_subscription_price: '0.0'
                  display_wholesale_subscription_price: $0.00 (USD)
                - id: 689
                  tax: '0.0'
                  price: '17.32'
                  country:
                    id: 146
                    iso: NI
                    iso3: NIC
                    name: Nicaragua
                    iso_name: NICARAGUA
                    tax_rate: 0
                  shipping: '0.0'
                  country_iso: NI
                  currency_code: USD
                  display_price: $17.32 (USD)
                  currency_symbol: $
                  wholesale_price: '0.0'
                  subscription_price: '17.32'
                  display_wholesale_price: $0.00 (USD)
                  wholesale_subscription_price: '0.0'
                  display_wholesale_subscription_price: $0.00 (USD)
                - id: 690
                  tax: '0.0'
                  price: '17.32'
                  country:
                    id: 172
                    iso: LC
                    iso3: LCA
                    name: Saint Lucia
                    iso_name: SAINT LUCIA
                    tax_rate: 0
                  shipping: '0.0'
                  country_iso: LC
                  currency_code: USD
                  display_price: $17.32 (USD)
                  currency_symbol: $
                  wholesale_price: '0.0'
                  subscription_price: '17.32'
                  display_wholesale_price: $0.00 (USD)
                  wholesale_subscription_price: '0.0'
                  display_wholesale_subscription_price: $0.00 (USD)
                - id: 691
                  tax: '0.0'
                  price: '17.32'
                  country:
                    id: 66
                    iso: FJ
                    iso3: FJI
                    name: Fiji
                    iso_name: FIJI
                    tax_rate: 0
                  shipping: '0.0'
                  country_iso: FJ
                  currency_code: USD
                  display_price: $17.32 (USD)
                  currency_symbol: $
                  wholesale_price: '0.0'
                  subscription_price: '17.32'
                  display_wholesale_price: $0.00 (USD)
                  wholesale_subscription_price: '0.0'
                  display_wholesale_subscription_price: $0.00 (USD)
                - id: 692
                  tax: '0.0'
                  price: '17.32'
                  country:
                    id: 93
                    iso: ID
                    iso3: IDN
                    name: Indonesia
                    iso_name: INDONESIA
                    tax_rate: 0
                  shipping: '0.0'
                  country_iso: ID
                  currency_code: USD
                  display_price: $17.32 (USD)
                  currency_symbol: $
                  wholesale_price: '0.0'
                  subscription_price: '17.32'
                  display_wholesale_price: $0.00 (USD)
                  wholesale_subscription_price: '0.0'
                  display_wholesale_subscription_price: $0.00 (USD)
                - id: 693
                  tax: '0.0'
                  price: '17.32'
                  country:
                    id: 147
                    iso: NE
                    iso3: NER
                    name: Niger
                    iso_name: NIGER
                    tax_rate: 0
                  shipping: '0.0'
                  country_iso: NE
                  currency_code: USD
                  display_price: $17.32 (USD)
                  currency_symbol: $
                  wholesale_price: '0.0'
                  subscription_price: '17.32'
                  display_wholesale_price: $0.00 (USD)
                  wholesale_subscription_price: '0.0'
                  display_wholesale_subscription_price: $0.00 (USD)
                - id: 694
                  tax: '0.0'
                  price: '17.32'
                  country:
                    id: 67
                    iso: FI
                    iso3: FIN
                    name: Finland
                    iso_name: FINLAND
                    tax_rate: 0
                  shipping: '0.0'
                  country_iso: FI
                  currency_code: USD
                  display_price: $17.32 (USD)
                  currency_symbol: $
                  wholesale_price: '0.0'
                  subscription_price: '17.32'
                  display_wholesale_price: $0.00 (USD)
                  wholesale_subscription_price: '0.0'
                  display_wholesale_subscription_price: $0.00 (USD)
                - id: 695
                  tax: '0.0'
                  price: '17.32'
                  country:
                    id: 148
                    iso: NG
                    iso3: NGA
                    name: Nigeria
                    iso_name: NIGERIA
                    tax_rate: 0
                  shipping: '0.0'
                  country_iso: NG
                  currency_code: USD
                  display_price: $17.32 (USD)
                  currency_symbol: $
                  wholesale_price: '0.0'
                  subscription_price: '17.32'
                  display_wholesale_price: $0.00 (USD)
                  wholesale_subscription_price: '0.0'
                  display_wholesale_subscription_price: $0.00 (USD)
              allow_subscription: true
          countries:
            - id: 214
              iso: US
              itn: false
              iso3: USA
              name: United States
              state: true
              active: true
              numcode: 840
              address3: false
              iso_name: UNITED STATES
              passport: false
              tax_rate: 0
              delimiter: ','
              separator: .
              currency_code: USD
              currency_symbol: $
            - id: 65
              iso: FO
              itn: false
              iso3: FRO
              name: Faroe Islands
              state: true
              active: true
              numcode: 234
              address3: false
              iso_name: FAROE ISLANDS
              passport: false
              tax_rate: 0
              delimiter: ','
              separator: .
              currency_code: DKK
              currency_symbol: kr.
            - id: 92
              iso: IN
              itn: false
              iso3: IND
              name: India
              state: true
              active: true
              numcode: 356
              address3: false
              iso_name: INDIA
              passport: false
              tax_rate: 0
              delimiter: ','
              separator: .
              currency_code: INR
              currency_symbol: ₹
            - id: 146
              iso: NI
              itn: false
              iso3: NIC
              name: Nicaragua
              state: true
              active: true
              numcode: 558
              address3: false
              iso_name: NICARAGUA
              passport: false
              tax_rate: 0
              delimiter: ','
              separator: .
              currency_code: NIO
              currency_symbol: C$
            - id: 172
              iso: LC
              itn: false
              iso3: LCA
              name: Saint Lucia
              state: true
              active: true
              numcode: 662
              address3: false
              iso_name: SAINT LUCIA
              passport: false
              tax_rate: 0
              delimiter: ','
              separator: .
              currency_code: XCD
              currency_symbol: $
            - id: 66
              iso: FJ
              itn: false
              iso3: FJI
              name: Fiji
              state: true
              active: true
              numcode: 242
              address3: false
              iso_name: FIJI
              passport: false
              tax_rate: 0
              delimiter: ','
              separator: .
              currency_code: FJD
              currency_symbol: $
            - id: 93
              iso: ID
              itn: false
              iso3: IDN
              name: Indonesia
              state: true
              active: true
              numcode: 360
              address3: false
              iso_name: INDONESIA
              passport: false
              tax_rate: 0
              delimiter: ','
              separator: .
              currency_code: IDR
              currency_symbol: Rp
            - id: 147
              iso: NE
              itn: false
              iso3: NER
              name: Niger
              state: true
              active: true
              numcode: 562
              address3: false
              iso_name: NIGER
              passport: false
              tax_rate: 0
              delimiter: ','
              separator: .
              currency_code: XOF
              currency_symbol: Fr
            - id: 67
              iso: FI
              itn: false
              iso3: FIN
              name: Finland
              state: true
              active: true
              numcode: 246
              address3: false
              iso_name: FINLAND
              passport: false
              tax_rate: 0
              delimiter: ','
              separator: .
              currency_code: EUR
              currency_symbol: €
            - id: 148
              iso: NG
              itn: false
              iso3: NGA
              name: Nigeria
              state: true
              active: true
              numcode: 566
              address3: false
              iso_name: NIGERIA
              passport: false
              tax_rate: 0
              delimiter: ','
              separator: .
              currency_code: NGN
              currency_symbol: ₦
            - id: 174
              iso: VC
              itn: false
              iso3: VCT
              name: Saint Vincent and the Grenadines
              state: true
              active: true
              numcode: 670
              address3: false
              iso_name: SAINT VINCENT AND THE GRENADINES
              passport: false
              tax_rate: 0
              delimiter: ','
              separator: .
              currency_code: XCD
              currency_symbol: $
            - id: 68
              iso: FR
              itn: false
              iso3: FRA
              name: France
              state: true
              active: true
              numcode: 250
              address3: false
              iso_name: FRANCE
              passport: false
              tax_rate: 0
              delimiter: ','
              separator: .
              currency_code: EUR
              currency_symbol: €
            - id: 94
              iso: IR
              itn: false
              iso3: IRN
              name: Iran, Islamic Republic of
              state: true
              active: true
              numcode: 364
              address3: false
              iso_name: IRAN, ISLAMIC REPUBLIC OF
              passport: false
              tax_rate: 0
              delimiter: ','
              separator: .
              currency_code: IRR
              currency_symbol: ﷼
            - id: 149
              iso: NU
              itn: false
              iso3: NIU
              name: Niue
              state: true
              active: true
              numcode: 570
              address3: false
              iso_name: NIUE
              passport: false
              tax_rate: 0
              delimiter: ','
              separator: .
              currency_code: NZD
              currency_symbol: $
            - id: 175
              iso: WS
              itn: false
              iso3: WSM
              name: Samoa
              state: true
              active: true
              numcode: 882
              address3: false
              iso_name: SAMOA
              passport: false
              tax_rate: 0
              delimiter: ','
              separator: .
              currency_code: WST
              currency_symbol: T
            - id: 69
              iso: GF
              itn: false
              iso3: GUF
              name: French Guiana
              state: true
              active: true
              numcode: 254
              address3: false
              iso_name: FRENCH GUIANA
              passport: false
              tax_rate: 0
              delimiter: ','
              separator: .
              currency_code: EUR
              currency_symbol: €
            - id: 95
              iso: IQ
              itn: false
              iso3: IRQ
              name: Iraq
              state: true
              active: true
              numcode: 368
              address3: false
              iso_name: IRAQ
              passport: false
              tax_rate: 0
              delimiter: ','
              separator: .
              currency_code: IQD
              currency_symbol: ع.د
            - id: 176
              iso: SM
              itn: false
              iso3: SMR
              name: San Marino
              state: true
              active: true
              numcode: 674
              address3: false
              iso_name: SAN MARINO
              passport: false
              tax_rate: 0
              delimiter: ','
              separator: .
              currency_code: EUR
              currency_symbol: €
            - id: 96
              iso: IE
              itn: false
              iso3: IRL
              name: Ireland
              state: true
              active: true
              numcode: 372
              address3: false
              iso_name: IRELAND
              passport: false
              tax_rate: 0
              delimiter: ','
              separator: .
              currency_code: EUR
              currency_symbol: €
            - id: 177
              iso: ST
              itn: false
              iso3: STP
              name: Sao Tome and Principe
              state: true
              active: true
              numcode: 678
              address3: false
              iso_name: SAO TOME AND PRINCIPE
              passport: false
              tax_rate: 0
              delimiter: ','
              separator: .
              currency_code: STD
              currency_symbol: Db
            - id: 39
              iso: TD
              itn: false
              iso3: TCD
              name: Chad
              state: true
              active: true
              numcode: 148
              address3: false
              iso_name: CHAD
              passport: false
              tax_rate: 0
              delimiter: ','
              separator: .
              currency_code: XAF
              currency_symbol: CFA
            - id: 173
              iso: PM
              itn: false
              iso3: SPM
              name: Saint Pierre and Miquelon
              state: true
              active: true
              numcode: 666
              address3: false
              iso_name: SAINT PIERRE AND MIQUELON
              passport: false
              tax_rate: 0
              delimiter: ','
              separator: .
              currency_code: EUR
              currency_symbol: €
          image_url: >-
            https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
          commission: '10.0'
          country_id: null
          share_link: null
          shopify_id: null
          description:
            id: 122
            body: <div>Optimized clear-thinking access</div>
            name: description
            record_id: 113
            created_at: '2023-12-26T04:49:52.800Z'
            updated_at: '2023-12-26T06:37:59.551Z'
            record_type: Product
          price_range:
            - $17.32
            - $17.32
          country_code: td
          currency_code: USD
          display_price: $17.32 (USD)
          option_values: {}
          average_rating: 0
          shopify_handle: null
          currency_symbol: $
          default_variant:
            id: 113
            sku: QDPF7N2XOR
            size: 4cm
            price: null
            title: Default Variant
            width: null
            active: true
            height: null
            length: null
            weight: 10 kg
            hs_code: null
            taxable: true
            bar_code: null
            physical: null
            position: 1
            image_url: null
            is_master: true
            created_at: '2023-12-26T04:49:52.811Z'
            image_path: null
            product_id: 113
            shopify_id: null
            updated_at: '2023-12-26T08:32:24.878Z'
            external_id: null
            discarded_at: null
            keep_selling: false
            option_attrs: []
            unit_of_size: null
            track_quantity: true
            unit_of_weight: null
            inventory_policy: none
            country_of_origin: null
            allow_subscription: true
            inventory_quantity: 100
            variant_country_id: null
            customs_information_shipping: null
          enroll_products: []
          wholesale_price: '0.0'
          subscription_price: '17.32'
          unlimited_inventory: false
          publish_to_rep_store: true
          publish_to_share_tab: true
          price_range_formatted: $17.32
          display_wholesale_price: $0.00 (USD)
          publish_to_retail_store: true
          display_subscription_price: $17.32 (USD)
          wholesale_subscription_price: '0.0'
          display_wholesale_subscription_price: $0.00 (USD)
        quantity: 1
        ordered_variant: ''
    Product12:
      title: Product12
      required:
        - id
        - sku
        - image
        - leads
        - price
        - title
        - views
        - active
        - images
        - public
        - vendor
        - enrolls
        - options
        - prompts
        - in_stock
        - shipping
        - stripped
        - variants
        - countries
        - image_url
        - commission
        - country_id
        - share_link
        - shopify_id
        - description
        - price_range
        - country_code
        - currency_code
        - display_price
        - option_values
        - average_rating
        - shopify_handle
        - currency_symbol
        - default_variant
        - enroll_products
        - wholesale_price
        - subscription_price
        - unlimited_inventory
        - publish_to_rep_store
        - publish_to_share_tab
        - price_range_formatted
        - display_wholesale_price
        - publish_to_retail_store
        - display_subscription_price
        - wholesale_subscription_price
        - display_wholesale_subscription_price
      type: object
      properties:
        id:
          type: integer
          format: int32
        sku:
          type: string
        image:
          allOf:
            - $ref: '#/components/schemas/Image3'
            - {}
        leads:
          type: integer
          format: int32
        price:
          type: string
        title:
          type: string
        views:
          type: integer
          format: int32
        active:
          type: boolean
        images:
          type: array
          items:
            type: string
          description: ''
        public:
          type: boolean
        vendor:
          type: string
        enrolls:
          type: array
          items:
            type: string
          description: ''
        options:
          type: array
          items:
            type: string
          description: ''
        prompts:
          type: array
          items:
            type: string
          description: ''
        in_stock:
          type: boolean
        shipping:
          type: string
        stripped:
          type: string
        variants:
          type: array
          items:
            $ref: '#/components/schemas/Variant9'
          description: ''
        countries:
          type: array
          items:
            $ref: '#/components/schemas/Country7'
          description: ''
        image_url:
          type: string
        commission:
          type: string
        country_id:
          type: string
        share_link:
          type: string
        shopify_id:
          type: string
        description:
          allOf:
            - $ref: '#/components/schemas/Description'
            - {}
        price_range:
          type: array
          items:
            type: string
          description: ''
        country_code:
          type: string
        currency_code:
          type: string
        display_price:
          type: string
        option_values:
          type: object
        average_rating:
          type: integer
          format: int32
        shopify_handle:
          type: string
        currency_symbol:
          type: string
        default_variant:
          allOf:
            - $ref: '#/components/schemas/DefaultVariant5'
            - {}
        enroll_products:
          type: array
          items:
            type: string
          description: ''
        wholesale_price:
          type: string
        subscription_price:
          type: string
        unlimited_inventory:
          type: boolean
        publish_to_rep_store:
          type: boolean
        publish_to_share_tab:
          type: boolean
        price_range_formatted:
          type: string
        display_wholesale_price:
          type: string
        publish_to_retail_store:
          type: boolean
        display_subscription_price:
          type: string
        wholesale_subscription_price:
          type: string
        display_wholesale_subscription_price:
          type: string
      example:
        id: 113
        sku: QDPF7N2XOR
        image:
          full: >-
            https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
          mini: >-
            https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
          detail: >-
            https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
        leads: 0
        price: '17.32'
        title: Aerodynamic Aluminum aaa
        views: 0
        active: true
        images: []
        public: true
        vendor: null
        enrolls: []
        options: []
        prompts: []
        in_stock: true
        shipping: '0.03'
        stripped: Optimized clear-thinking access
        variants:
          - id: 113
            title: Default Variant
            buyable: true
            image_url: null
            option_value_ids: []
            variant_countries:
              - id: 686
                tax: '0.0'
                price: '17.32'
                country:
                  id: 214
                  iso: US
                  iso3: USA
                  name: United States
                  iso_name: UNITED STATES
                  tax_rate: 0
                shipping: '0.0'
                country_iso: US
                currency_code: USD
                display_price: $17.32 (USD)
                currency_symbol: $
                wholesale_price: '0.0'
                subscription_price: '17.32'
                display_wholesale_price: $0.00 (USD)
                wholesale_subscription_price: '0.0'
                display_wholesale_subscription_price: $0.00 (USD)
              - id: 687
                tax: '0.0'
                price: '17.32'
                country:
                  id: 65
                  iso: FO
                  iso3: FRO
                  name: Faroe Islands
                  iso_name: FAROE ISLANDS
                  tax_rate: 0
                shipping: '0.0'
                country_iso: FO
                currency_code: USD
                display_price: $17.32 (USD)
                currency_symbol: $
                wholesale_price: '0.0'
                subscription_price: '17.32'
                display_wholesale_price: $0.00 (USD)
                wholesale_subscription_price: '0.0'
                display_wholesale_subscription_price: $0.00 (USD)
              - id: 688
                tax: '0.0'
                price: '17.32'
                country:
                  id: 92
                  iso: IN
                  iso3: IND
                  name: India
                  iso_name: INDIA
                  tax_rate: 0
                shipping: '0.0'
                country_iso: IN
                currency_code: USD
                display_price: $17.32 (USD)
                currency_symbol: $
                wholesale_price: '0.0'
                subscription_price: '17.32'
                display_wholesale_price: $0.00 (USD)
                wholesale_subscription_price: '0.0'
                display_wholesale_subscription_price: $0.00 (USD)
              - id: 689
                tax: '0.0'
                price: '17.32'
                country:
                  id: 146
                  iso: NI
                  iso3: NIC
                  name: Nicaragua
                  iso_name: NICARAGUA
                  tax_rate: 0
                shipping: '0.0'
                country_iso: NI
                currency_code: USD
                display_price: $17.32 (USD)
                currency_symbol: $
                wholesale_price: '0.0'
                subscription_price: '17.32'
                display_wholesale_price: $0.00 (USD)
                wholesale_subscription_price: '0.0'
                display_wholesale_subscription_price: $0.00 (USD)
              - id: 690
                tax: '0.0'
                price: '17.32'
                country:
                  id: 172
                  iso: LC
                  iso3: LCA
                  name: Saint Lucia
                  iso_name: SAINT LUCIA
                  tax_rate: 0
                shipping: '0.0'
                country_iso: LC
                currency_code: USD
                display_price: $17.32 (USD)
                currency_symbol: $
                wholesale_price: '0.0'
                subscription_price: '17.32'
                display_wholesale_price: $0.00 (USD)
                wholesale_subscription_price: '0.0'
                display_wholesale_subscription_price: $0.00 (USD)
              - id: 691
                tax: '0.0'
                price: '17.32'
                country:
                  id: 66
                  iso: FJ
                  iso3: FJI
                  name: Fiji
                  iso_name: FIJI
                  tax_rate: 0
                shipping: '0.0'
                country_iso: FJ
                currency_code: USD
                display_price: $17.32 (USD)
                currency_symbol: $
                wholesale_price: '0.0'
                subscription_price: '17.32'
                display_wholesale_price: $0.00 (USD)
                wholesale_subscription_price: '0.0'
                display_wholesale_subscription_price: $0.00 (USD)
              - id: 692
                tax: '0.0'
                price: '17.32'
                country:
                  id: 93
                  iso: ID
                  iso3: IDN
                  name: Indonesia
                  iso_name: INDONESIA
                  tax_rate: 0
                shipping: '0.0'
                country_iso: ID
                currency_code: USD
                display_price: $17.32 (USD)
                currency_symbol: $
                wholesale_price: '0.0'
                subscription_price: '17.32'
                display_wholesale_price: $0.00 (USD)
                wholesale_subscription_price: '0.0'
                display_wholesale_subscription_price: $0.00 (USD)
              - id: 693
                tax: '0.0'
                price: '17.32'
                country:
                  id: 147
                  iso: NE
                  iso3: NER
                  name: Niger
                  iso_name: NIGER
                  tax_rate: 0
                shipping: '0.0'
                country_iso: NE
                currency_code: USD
                display_price: $17.32 (USD)
                currency_symbol: $
                wholesale_price: '0.0'
                subscription_price: '17.32'
                display_wholesale_price: $0.00 (USD)
                wholesale_subscription_price: '0.0'
                display_wholesale_subscription_price: $0.00 (USD)
              - id: 694
                tax: '0.0'
                price: '17.32'
                country:
                  id: 67
                  iso: FI
                  iso3: FIN
                  name: Finland
                  iso_name: FINLAND
                  tax_rate: 0
                shipping: '0.0'
                country_iso: FI
                currency_code: USD
                display_price: $17.32 (USD)
                currency_symbol: $
                wholesale_price: '0.0'
                subscription_price: '17.32'
                display_wholesale_price: $0.00 (USD)
                wholesale_subscription_price: '0.0'
                display_wholesale_subscription_price: $0.00 (USD)
              - id: 695
                tax: '0.0'
                price: '17.32'
                country:
                  id: 148
                  iso: NG
                  iso3: NGA
                  name: Nigeria
                  iso_name: NIGERIA
                  tax_rate: 0
                shipping: '0.0'
                country_iso: NG
                currency_code: USD
                display_price: $17.32 (USD)
                currency_symbol: $
                wholesale_price: '0.0'
                subscription_price: '17.32'
                display_wholesale_price: $0.00 (USD)
                wholesale_subscription_price: '0.0'
                display_wholesale_subscription_price: $0.00 (USD)
            allow_subscription: true
        countries:
          - id: 214
            iso: US
            itn: false
            iso3: USA
            name: United States
            state: true
            active: true
            numcode: 840
            address3: false
            iso_name: UNITED STATES
            passport: false
            tax_rate: 0
            delimiter: ','
            separator: .
            currency_code: USD
            currency_symbol: $
          - id: 65
            iso: FO
            itn: false
            iso3: FRO
            name: Faroe Islands
            state: true
            active: true
            numcode: 234
            address3: false
            iso_name: FAROE ISLANDS
            passport: false
            tax_rate: 0
            delimiter: ','
            separator: .
            currency_code: DKK
            currency_symbol: kr.
          - id: 92
            iso: IN
            itn: false
            iso3: IND
            name: India
            state: true
            active: true
            numcode: 356
            address3: false
            iso_name: INDIA
            passport: false
            tax_rate: 0
            delimiter: ','
            separator: .
            currency_code: INR
            currency_symbol: ₹
          - id: 146
            iso: NI
            itn: false
            iso3: NIC
            name: Nicaragua
            state: true
            active: true
            numcode: 558
            address3: false
            iso_name: NICARAGUA
            passport: false
            tax_rate: 0
            delimiter: ','
            separator: .
            currency_code: NIO
            currency_symbol: C$
          - id: 172
            iso: LC
            itn: false
            iso3: LCA
            name: Saint Lucia
            state: true
            active: true
            numcode: 662
            address3: false
            iso_name: SAINT LUCIA
            passport: false
            tax_rate: 0
            delimiter: ','
            separator: .
            currency_code: XCD
            currency_symbol: $
          - id: 66
            iso: FJ
            itn: false
            iso3: FJI
            name: Fiji
            state: true
            active: true
            numcode: 242
            address3: false
            iso_name: FIJI
            passport: false
            tax_rate: 0
            delimiter: ','
            separator: .
            currency_code: FJD
            currency_symbol: $
          - id: 93
            iso: ID
            itn: false
            iso3: IDN
            name: Indonesia
            state: true
            active: true
            numcode: 360
            address3: false
            iso_name: INDONESIA
            passport: false
            tax_rate: 0
            delimiter: ','
            separator: .
            currency_code: IDR
            currency_symbol: Rp
          - id: 147
            iso: NE
            itn: false
            iso3: NER
            name: Niger
            state: true
            active: true
            numcode: 562
            address3: false
            iso_name: NIGER
            passport: false
            tax_rate: 0
            delimiter: ','
            separator: .
            currency_code: XOF
            currency_symbol: Fr
          - id: 67
            iso: FI
            itn: false
            iso3: FIN
            name: Finland
            state: true
            active: true
            numcode: 246
            address3: false
            iso_name: FINLAND
            passport: false
            tax_rate: 0
            delimiter: ','
            separator: .
            currency_code: EUR
            currency_symbol: €
          - id: 148
            iso: NG
            itn: false
            iso3: NGA
            name: Nigeria
            state: true
            active: true
            numcode: 566
            address3: false
            iso_name: NIGERIA
            passport: false
            tax_rate: 0
            delimiter: ','
            separator: .
            currency_code: NGN
            currency_symbol: ₦
          - id: 174
            iso: VC
            itn: false
            iso3: VCT
            name: Saint Vincent and the Grenadines
            state: true
            active: true
            numcode: 670
            address3: false
            iso_name: SAINT VINCENT AND THE GRENADINES
            passport: false
            tax_rate: 0
            delimiter: ','
            separator: .
            currency_code: XCD
            currency_symbol: $
          - id: 68
            iso: FR
            itn: false
            iso3: FRA
            name: France
            state: true
            active: true
            numcode: 250
            address3: false
            iso_name: FRANCE
            passport: false
            tax_rate: 0
            delimiter: ','
            separator: .
            currency_code: EUR
            currency_symbol: €
          - id: 94
            iso: IR
            itn: false
            iso3: IRN
            name: Iran, Islamic Republic of
            state: true
            active: true
            numcode: 364
            address3: false
            iso_name: IRAN, ISLAMIC REPUBLIC OF
            passport: false
            tax_rate: 0
            delimiter: ','
            separator: .
            currency_code: IRR
            currency_symbol: ﷼
          - id: 149
            iso: NU
            itn: false
            iso3: NIU
            name: Niue
            state: true
            active: true
            numcode: 570
            address3: false
            iso_name: NIUE
            passport: false
            tax_rate: 0
            delimiter: ','
            separator: .
            currency_code: NZD
            currency_symbol: $
          - id: 175
            iso: WS
            itn: false
            iso3: WSM
            name: Samoa
            state: true
            active: true
            numcode: 882
            address3: false
            iso_name: SAMOA
            passport: false
            tax_rate: 0
            delimiter: ','
            separator: .
            currency_code: WST
            currency_symbol: T
          - id: 69
            iso: GF
            itn: false
            iso3: GUF
            name: French Guiana
            state: true
            active: true
            numcode: 254
            address3: false
            iso_name: FRENCH GUIANA
            passport: false
            tax_rate: 0
            delimiter: ','
            separator: .
            currency_code: EUR
            currency_symbol: €
          - id: 95
            iso: IQ
            itn: false
            iso3: IRQ
            name: Iraq
            state: true
            active: true
            numcode: 368
            address3: false
            iso_name: IRAQ
            passport: false
            tax_rate: 0
            delimiter: ','
            separator: .
            currency_code: IQD
            currency_symbol: ع.د
          - id: 176
            iso: SM
            itn: false
            iso3: SMR
            name: San Marino
            state: true
            active: true
            numcode: 674
            address3: false
            iso_name: SAN MARINO
            passport: false
            tax_rate: 0
            delimiter: ','
            separator: .
            currency_code: EUR
            currency_symbol: €
          - id: 96
            iso: IE
            itn: false
            iso3: IRL
            name: Ireland
            state: true
            active: true
            numcode: 372
            address3: false
            iso_name: IRELAND
            passport: false
            tax_rate: 0
            delimiter: ','
            separator: .
            currency_code: EUR
            currency_symbol: €
          - id: 177
            iso: ST
            itn: false
            iso3: STP
            name: Sao Tome and Principe
            state: true
            active: true
            numcode: 678
            address3: false
            iso_name: SAO TOME AND PRINCIPE
            passport: false
            tax_rate: 0
            delimiter: ','
            separator: .
            currency_code: STD
            currency_symbol: Db
          - id: 39
            iso: TD
            itn: false
            iso3: TCD
            name: Chad
            state: true
            active: true
            numcode: 148
            address3: false
            iso_name: CHAD
            passport: false
            tax_rate: 0
            delimiter: ','
            separator: .
            currency_code: XAF
            currency_symbol: CFA
          - id: 173
            iso: PM
            itn: false
            iso3: SPM
            name: Saint Pierre and Miquelon
            state: true
            active: true
            numcode: 666
            address3: false
            iso_name: SAINT PIERRE AND MIQUELON
            passport: false
            tax_rate: 0
            delimiter: ','
            separator: .
            currency_code: EUR
            currency_symbol: €
        image_url: >-
          https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
        commission: '10.0'
        country_id: null
        share_link: null
        shopify_id: null
        description:
          id: 122
          body: <div>Optimized clear-thinking access</div>
          name: description
          record_id: 113
          created_at: '2023-12-26T04:49:52.800Z'
          updated_at: '2023-12-26T06:37:59.551Z'
          record_type: Product
        price_range:
          - $17.32
          - $17.32
        country_code: td
        currency_code: USD
        display_price: $17.32 (USD)
        option_values: {}
        average_rating: 0
        shopify_handle: null
        currency_symbol: $
        default_variant:
          id: 113
          sku: QDPF7N2XOR
          size: 4cm
          price: null
          title: Default Variant
          width: null
          active: true
          height: null
          length: null
          weight: 10 kg
          hs_code: null
          taxable: true
          bar_code: null
          physical: null
          position: 1
          image_url: null
          is_master: true
          created_at: '2023-12-26T04:49:52.811Z'
          image_path: null
          product_id: 113
          shopify_id: null
          updated_at: '2023-12-26T08:32:24.878Z'
          external_id: null
          discarded_at: null
          keep_selling: false
          option_attrs: []
          unit_of_size: null
          track_quantity: true
          unit_of_weight: null
          inventory_policy: none
          country_of_origin: null
          allow_subscription: true
          inventory_quantity: 100
          variant_country_id: null
          customs_information_shipping: null
        enroll_products: []
        wholesale_price: '0.0'
        subscription_price: '17.32'
        unlimited_inventory: false
        publish_to_rep_store: true
        publish_to_share_tab: true
        price_range_formatted: $17.32
        display_wholesale_price: $0.00 (USD)
        publish_to_retail_store: true
        display_subscription_price: $17.32 (USD)
        wholesale_subscription_price: '0.0'
        display_wholesale_subscription_price: $0.00 (USD)
    DefaultVariant5:
      title: DefaultVariant5
      required:
        - id
        - sku
        - size
        - price
        - title
        - width
        - active
        - height
        - length
        - weight
        - hs_code
        - taxable
        - bar_code
        - physical
        - position
        - image_url
        - is_master
        - created_at
        - image_path
        - product_id
        - shopify_id
        - updated_at
        - external_id
        - discarded_at
        - keep_selling
        - option_attrs
        - unit_of_size
        - track_quantity
        - unit_of_weight
        - inventory_policy
        - country_of_origin
        - allow_subscription
        - inventory_quantity
        - variant_country_id
        - customs_information_shipping
      type: object
      properties:
        id:
          type: integer
          format: int32
        sku:
          type: string
        size:
          type: string
        price:
          type: string
        title:
          type: string
        width:
          type: string
        active:
          type: boolean
        height:
          type: string
        length:
          type: string
        weight:
          type: string
        hs_code:
          type: string
        taxable:
          type: boolean
        bar_code:
          type: string
        physical:
          type: string
        position:
          type: integer
          format: int32
        image_url:
          type: string
        is_master:
          type: boolean
        created_at:
          type: string
        image_path:
          type: string
        product_id:
          type: integer
          format: int32
        shopify_id:
          type: string
        updated_at:
          type: string
        external_id:
          type: string
        discarded_at:
          type: string
        keep_selling:
          type: boolean
        option_attrs:
          type: array
          items:
            type: string
          description: ''
        unit_of_size:
          type: string
        track_quantity:
          type: boolean
        unit_of_weight:
          type: string
        inventory_policy:
          type: string
        country_of_origin:
          type: string
        allow_subscription:
          type: boolean
        inventory_quantity:
          type: integer
          format: int32
        variant_country_id:
          type: string
        customs_information_shipping:
          type: string
      example:
        id: 113
        sku: QDPF7N2XOR
        size: 4cm
        price: null
        title: Default Variant
        width: null
        active: true
        height: null
        length: null
        weight: 10 kg
        hs_code: null
        taxable: true
        bar_code: null
        physical: null
        position: 1
        image_url: null
        is_master: true
        created_at: '2023-12-26T04:49:52.811Z'
        image_path: null
        product_id: 113
        shopify_id: null
        updated_at: '2023-12-26T08:32:24.878Z'
        external_id: null
        discarded_at: null
        keep_selling: false
        option_attrs: []
        unit_of_size: null
        track_quantity: true
        unit_of_weight: null
        inventory_policy: none
        country_of_origin: null
        allow_subscription: true
        inventory_quantity: 100
        variant_country_id: null
        customs_information_shipping: null
    ShipTo7:
      title: ShipTo7
      required:
        - id
        - city
        - name
        - state
        - country
        - default
        - address1
        - address2
        - address3
        - postal_code
        - country_code
      type: object
      properties:
        id:
          type: integer
          format: int32
        city:
          type: string
        name:
          type: string
        state:
          type: string
        country:
          allOf:
            - $ref: '#/components/schemas/Country20'
            - {}
        default:
          type: boolean
        address1:
          type: string
        address2:
          type: string
        address3:
          type: string
        postal_code:
          type: string
        country_code:
          type: string
      example:
        id: 980190965
        city: x
        name: Ram Khanka
        state: Alaska
        country:
          id: 214
          iso: US
          itn: false
          iso3: USA
          name: United States
          state: true
          active: true
          default: true
          numcode: 840
          address3: false
          iso_name: UNITED STATES
          passport: false
          tax_rate: 0
          delimiter: ','
          separator: .
          created_at: '2023-12-26T04:48:23.479Z'
          updated_at: '2023-12-26T04:48:23.479Z'
          currency_code: USD
          geo_entity_id: null
          currency_symbol: $
        default: false
        address1: a
        address2: b
        address3: null
        postal_code: '11111'
        country_code: null
    order_completed:
      title: order_completed
      required:
        - id
        - name
        - payload
        - timestamp
        - identifier
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        payload:
          allOf:
            - $ref: '#/components/schemas/Payload7'
            - {}
        timestamp:
          type: string
        identifier:
          type: string
      example:
        id: 114
        name: order_completed
        payload:
          order:
            cv: 97
            id: 52
            qv: 0
            tax: '0.0'
            type: null
            email: ram@gmail.com
            items:
              - id: 2
                sku: QDPF7N2XOR
                price: 17.32
                product:
                  id: 113
                  sku: QDPF7N2XOR
                  image:
                    full: >-
                      https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                    mini: >-
                      https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                    detail: >-
                      https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                  leads: 0
                  price: '17.32'
                  title: Aerodynamic Aluminum aaa
                  views: 0
                  active: true
                  images: []
                  public: true
                  vendor: null
                  enrolls: []
                  options: []
                  prompts: []
                  in_stock: true
                  shipping: '0.03'
                  stripped: Optimized clear-thinking access
                  variants:
                    - id: 113
                      title: Default Variant
                      buyable: true
                      image_url: null
                      option_value_ids: []
                      variant_countries:
                        - id: 686
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 214
                            iso: US
                            iso3: USA
                            name: United States
                            iso_name: UNITED STATES
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: US
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 687
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 65
                            iso: FO
                            iso3: FRO
                            name: Faroe Islands
                            iso_name: FAROE ISLANDS
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: FO
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 688
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 92
                            iso: IN
                            iso3: IND
                            name: India
                            iso_name: INDIA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: IN
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 689
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 146
                            iso: NI
                            iso3: NIC
                            name: Nicaragua
                            iso_name: NICARAGUA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: NI
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 690
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 172
                            iso: LC
                            iso3: LCA
                            name: Saint Lucia
                            iso_name: SAINT LUCIA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: LC
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 691
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 66
                            iso: FJ
                            iso3: FJI
                            name: Fiji
                            iso_name: FIJI
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: FJ
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 692
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 93
                            iso: ID
                            iso3: IDN
                            name: Indonesia
                            iso_name: INDONESIA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: ID
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 693
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 147
                            iso: NE
                            iso3: NER
                            name: Niger
                            iso_name: NIGER
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: NE
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 694
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 67
                            iso: FI
                            iso3: FIN
                            name: Finland
                            iso_name: FINLAND
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: FI
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 695
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 148
                            iso: NG
                            iso3: NGA
                            name: Nigeria
                            iso_name: NIGERIA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: NG
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                      allow_subscription: true
                  countries:
                    - id: 214
                      iso: US
                      itn: false
                      iso3: USA
                      name: United States
                      state: true
                      active: true
                      numcode: 840
                      address3: false
                      iso_name: UNITED STATES
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: USD
                      currency_symbol: $
                    - id: 65
                      iso: FO
                      itn: false
                      iso3: FRO
                      name: Faroe Islands
                      state: true
                      active: true
                      numcode: 234
                      address3: false
                      iso_name: FAROE ISLANDS
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: DKK
                      currency_symbol: kr.
                    - id: 92
                      iso: IN
                      itn: false
                      iso3: IND
                      name: India
                      state: true
                      active: true
                      numcode: 356
                      address3: false
                      iso_name: INDIA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: INR
                      currency_symbol: ₹
                    - id: 146
                      iso: NI
                      itn: false
                      iso3: NIC
                      name: Nicaragua
                      state: true
                      active: true
                      numcode: 558
                      address3: false
                      iso_name: NICARAGUA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: NIO
                      currency_symbol: C$
                    - id: 172
                      iso: LC
                      itn: false
                      iso3: LCA
                      name: Saint Lucia
                      state: true
                      active: true
                      numcode: 662
                      address3: false
                      iso_name: SAINT LUCIA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: XCD
                      currency_symbol: $
                    - id: 66
                      iso: FJ
                      itn: false
                      iso3: FJI
                      name: Fiji
                      state: true
                      active: true
                      numcode: 242
                      address3: false
                      iso_name: FIJI
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: FJD
                      currency_symbol: $
                    - id: 93
                      iso: ID
                      itn: false
                      iso3: IDN
                      name: Indonesia
                      state: true
                      active: true
                      numcode: 360
                      address3: false
                      iso_name: INDONESIA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: IDR
                      currency_symbol: Rp
                    - id: 147
                      iso: NE
                      itn: false
                      iso3: NER
                      name: Niger
                      state: true
                      active: true
                      numcode: 562
                      address3: false
                      iso_name: NIGER
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: XOF
                      currency_symbol: Fr
                    - id: 67
                      iso: FI
                      itn: false
                      iso3: FIN
                      name: Finland
                      state: true
                      active: true
                      numcode: 246
                      address3: false
                      iso_name: FINLAND
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 148
                      iso: NG
                      itn: false
                      iso3: NGA
                      name: Nigeria
                      state: true
                      active: true
                      numcode: 566
                      address3: false
                      iso_name: NIGERIA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: NGN
                      currency_symbol: ₦
                    - id: 174
                      iso: VC
                      itn: false
                      iso3: VCT
                      name: Saint Vincent and the Grenadines
                      state: true
                      active: true
                      numcode: 670
                      address3: false
                      iso_name: SAINT VINCENT AND THE GRENADINES
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: XCD
                      currency_symbol: $
                    - id: 68
                      iso: FR
                      itn: false
                      iso3: FRA
                      name: France
                      state: true
                      active: true
                      numcode: 250
                      address3: false
                      iso_name: FRANCE
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 94
                      iso: IR
                      itn: false
                      iso3: IRN
                      name: Iran, Islamic Republic of
                      state: true
                      active: true
                      numcode: 364
                      address3: false
                      iso_name: IRAN, ISLAMIC REPUBLIC OF
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: IRR
                      currency_symbol: ﷼
                    - id: 149
                      iso: NU
                      itn: false
                      iso3: NIU
                      name: Niue
                      state: true
                      active: true
                      numcode: 570
                      address3: false
                      iso_name: NIUE
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: NZD
                      currency_symbol: $
                    - id: 175
                      iso: WS
                      itn: false
                      iso3: WSM
                      name: Samoa
                      state: true
                      active: true
                      numcode: 882
                      address3: false
                      iso_name: SAMOA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: WST
                      currency_symbol: T
                    - id: 69
                      iso: GF
                      itn: false
                      iso3: GUF
                      name: French Guiana
                      state: true
                      active: true
                      numcode: 254
                      address3: false
                      iso_name: FRENCH GUIANA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 95
                      iso: IQ
                      itn: false
                      iso3: IRQ
                      name: Iraq
                      state: true
                      active: true
                      numcode: 368
                      address3: false
                      iso_name: IRAQ
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: IQD
                      currency_symbol: ع.د
                    - id: 176
                      iso: SM
                      itn: false
                      iso3: SMR
                      name: San Marino
                      state: true
                      active: true
                      numcode: 674
                      address3: false
                      iso_name: SAN MARINO
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 96
                      iso: IE
                      itn: false
                      iso3: IRL
                      name: Ireland
                      state: true
                      active: true
                      numcode: 372
                      address3: false
                      iso_name: IRELAND
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 177
                      iso: ST
                      itn: false
                      iso3: STP
                      name: Sao Tome and Principe
                      state: true
                      active: true
                      numcode: 678
                      address3: false
                      iso_name: SAO TOME AND PRINCIPE
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: STD
                      currency_symbol: Db
                    - id: 39
                      iso: TD
                      itn: false
                      iso3: TCD
                      name: Chad
                      state: true
                      active: true
                      numcode: 148
                      address3: false
                      iso_name: CHAD
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: XAF
                      currency_symbol: CFA
                    - id: 173
                      iso: PM
                      itn: false
                      iso3: SPM
                      name: Saint Pierre and Miquelon
                      state: true
                      active: true
                      numcode: 666
                      address3: false
                      iso_name: SAINT PIERRE AND MIQUELON
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                  image_url: >-
                    https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                  commission: '10.0'
                  country_id: null
                  share_link: null
                  shopify_id: null
                  description:
                    id: 122
                    body: <div>Optimized clear-thinking access</div>
                    name: description
                    record_id: 113
                    created_at: '2023-12-26T04:49:52.800Z'
                    updated_at: '2023-12-26T06:37:59.551Z'
                    record_type: Product
                  price_range:
                    - $17.32
                    - $17.32
                  country_code: td
                  currency_code: USD
                  display_price: $17.32 (USD)
                  option_values: {}
                  average_rating: 0
                  shopify_handle: null
                  currency_symbol: $
                  default_variant:
                    id: 113
                    sku: QDPF7N2XOR
                    size: 4cm
                    price: null
                    title: Default Variant
                    width: null
                    active: true
                    height: null
                    length: null
                    weight: 10 kg
                    hs_code: null
                    taxable: true
                    bar_code: null
                    physical: null
                    position: 1
                    image_url: null
                    is_master: true
                    created_at: '2023-12-26T04:49:52.811Z'
                    image_path: null
                    product_id: 113
                    shopify_id: null
                    updated_at: '2023-12-26T08:32:24.878Z'
                    external_id: null
                    discarded_at: null
                    keep_selling: false
                    option_attrs: []
                    unit_of_size: null
                    track_quantity: true
                    unit_of_weight: null
                    inventory_policy: none
                    country_of_origin: null
                    allow_subscription: true
                    inventory_quantity: 100
                    variant_country_id: null
                    customs_information_shipping: null
                  enroll_products: []
                  wholesale_price: '0.0'
                  subscription_price: '17.32'
                  unlimited_inventory: false
                  publish_to_rep_store: true
                  publish_to_share_tab: true
                  price_range_formatted: $17.32
                  display_wholesale_price: $0.00 (USD)
                  publish_to_retail_store: true
                  display_subscription_price: $17.32 (USD)
                  wholesale_subscription_price: '0.0'
                  display_wholesale_subscription_price: $0.00 (USD)
                quantity: 1
                ordered_variant: ''
            phone: null
            amount: '13.32'
            rating: 4
            review: null
            status: awaiting_shipment
            contact:
              id: 17
              ip: null
              city: null
              email: ram@gmail.com
              hours: null
              phone: null
              state: null
              token: bqy3h61S3bBFSR8QUzocghn4
              email2: null
              income: null
              invest: null
              phone2: null
              reason: null
              status: new
              address: null
              address2: null
              interest: null
              phone_id: null
              best_time: null
              full_name: Ram Khanka
              last_name: Khanka
              lead_type: null
              time_zone: null
              avatar_url: null
              country_id: null
              first_name: Ram
              language_id: null
              postal_code: null
              requested_at: null
            ship_to:
              id: 980190965
              city: x
              name: Ram Khanka
              state: Alaska
              country:
                id: 214
                iso: US
                itn: false
                iso3: USA
                name: United States
                state: true
                active: true
                default: true
                numcode: 840
                address3: false
                iso_name: UNITED STATES
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                created_at: '2023-12-26T04:48:23.479Z'
                updated_at: '2023-12-26T04:48:23.479Z'
                currency_code: USD
                geo_entity_id: null
                currency_symbol: $
              default: false
              address1: a
              address2: b
              address3: null
              postal_code: '11111'
              country_code: null
            referrer: null
            shipping: '0.0'
            subtotal: '17.32'
            tracking: null
            last_name: Khanka
            sale_date: '2023-12-26T00:00:00.000Z'
            created_at: '2023-12-26T08:28:26.141Z'
            first_name: Rama
            order_type: purchased
            refundable: true
            display_tax: $0.00 (USD)
            order_number: F17227665844
            currency_code: USD
            display_amount: $13.32 (USD)
            currency_symbol: $
            display_refunds: (3 CV, 0 QV) -$4.00 (USD)
            friendly_status: paid
            order_thumbnail: >-
              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
            display_discount: $0.00 (USD)
            display_shipping: $0.00 (USD)
            display_subtotal: $17.32 (USD)
            max_refundable_tax: '0.0'
            recognized_ship_date: null
            max_refundable_amount: '13.32'
            tracking_informations: []
            max_refundable_shipping: '0.0'
            max_refundable_product_price: '13.32'
        timestamp: '2023-12-27T12:39:26.144Z'
        identifier: order-170368076652
    order_updated:
      title: order_updated
      required:
        - id
        - name
        - payload
        - timestamp
        - identifier
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        payload:
          allOf:
            - $ref: '#/components/schemas/Payload7'
            - {}
        timestamp:
          type: string
        identifier:
          type: string
      example:
        id: 31
        name: order_updated
        payload:
          order:
            cv: 0
            id: 52
            qv: 0
            tax: '0.0'
            type: null
            email: ram@gmail.com
            items:
              - id: 2
                sku: QDPF7N2XOR
                price: 17.32
                product:
                  id: 113
                  sku: QDPF7N2XOR
                  image:
                    full: >-
                      https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                    mini: >-
                      https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                    detail: >-
                      https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                  leads: 0
                  price: '17.32'
                  title: 'Aerodynamic Aluminum '
                  views: 0
                  active: true
                  images: []
                  public: true
                  vendor: null
                  enrolls: []
                  options: []
                  prompts: []
                  in_stock: true
                  shipping: '0.03'
                  stripped: Optimized clear-thinking access
                  variants:
                    - id: 113
                      title: Default Variant
                      buyable: true
                      image_url: null
                      option_value_ids: []
                      variant_countries:
                        - id: 686
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 214
                            iso: US
                            iso3: USA
                            name: United States
                            iso_name: UNITED STATES
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: US
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 687
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 65
                            iso: FO
                            iso3: FRO
                            name: Faroe Islands
                            iso_name: FAROE ISLANDS
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: FO
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 688
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 92
                            iso: IN
                            iso3: IND
                            name: India
                            iso_name: INDIA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: IN
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 689
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 146
                            iso: NI
                            iso3: NIC
                            name: Nicaragua
                            iso_name: NICARAGUA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: NI
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 690
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 172
                            iso: LC
                            iso3: LCA
                            name: Saint Lucia
                            iso_name: SAINT LUCIA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: LC
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 691
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 66
                            iso: FJ
                            iso3: FJI
                            name: Fiji
                            iso_name: FIJI
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: FJ
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 692
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 93
                            iso: ID
                            iso3: IDN
                            name: Indonesia
                            iso_name: INDONESIA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: ID
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 693
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 147
                            iso: NE
                            iso3: NER
                            name: Niger
                            iso_name: NIGER
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: NE
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 694
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 67
                            iso: FI
                            iso3: FIN
                            name: Finland
                            iso_name: FINLAND
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: FI
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 695
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 148
                            iso: NG
                            iso3: NGA
                            name: Nigeria
                            iso_name: NIGERIA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: NG
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                      allow_subscription: true
                  countries:
                    - id: 214
                      iso: US
                      itn: false
                      iso3: USA
                      name: United States
                      state: true
                      active: true
                      numcode: 840
                      address3: false
                      iso_name: UNITED STATES
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: USD
                      currency_symbol: $
                    - id: 65
                      iso: FO
                      itn: false
                      iso3: FRO
                      name: Faroe Islands
                      state: true
                      active: true
                      numcode: 234
                      address3: false
                      iso_name: FAROE ISLANDS
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: DKK
                      currency_symbol: kr.
                    - id: 92
                      iso: IN
                      itn: false
                      iso3: IND
                      name: India
                      state: true
                      active: true
                      numcode: 356
                      address3: false
                      iso_name: INDIA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: INR
                      currency_symbol: ₹
                    - id: 146
                      iso: NI
                      itn: false
                      iso3: NIC
                      name: Nicaragua
                      state: true
                      active: true
                      numcode: 558
                      address3: false
                      iso_name: NICARAGUA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: NIO
                      currency_symbol: C$
                    - id: 172
                      iso: LC
                      itn: false
                      iso3: LCA
                      name: Saint Lucia
                      state: true
                      active: true
                      numcode: 662
                      address3: false
                      iso_name: SAINT LUCIA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: XCD
                      currency_symbol: $
                    - id: 66
                      iso: FJ
                      itn: false
                      iso3: FJI
                      name: Fiji
                      state: true
                      active: true
                      numcode: 242
                      address3: false
                      iso_name: FIJI
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: FJD
                      currency_symbol: $
                    - id: 93
                      iso: ID
                      itn: false
                      iso3: IDN
                      name: Indonesia
                      state: true
                      active: true
                      numcode: 360
                      address3: false
                      iso_name: INDONESIA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: IDR
                      currency_symbol: Rp
                    - id: 147
                      iso: NE
                      itn: false
                      iso3: NER
                      name: Niger
                      state: true
                      active: true
                      numcode: 562
                      address3: false
                      iso_name: NIGER
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: XOF
                      currency_symbol: Fr
                    - id: 67
                      iso: FI
                      itn: false
                      iso3: FIN
                      name: Finland
                      state: true
                      active: true
                      numcode: 246
                      address3: false
                      iso_name: FINLAND
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 148
                      iso: NG
                      itn: false
                      iso3: NGA
                      name: Nigeria
                      state: true
                      active: true
                      numcode: 566
                      address3: false
                      iso_name: NIGERIA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: NGN
                      currency_symbol: ₦
                    - id: 174
                      iso: VC
                      itn: false
                      iso3: VCT
                      name: Saint Vincent and the Grenadines
                      state: true
                      active: true
                      numcode: 670
                      address3: false
                      iso_name: SAINT VINCENT AND THE GRENADINES
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: XCD
                      currency_symbol: $
                    - id: 68
                      iso: FR
                      itn: false
                      iso3: FRA
                      name: France
                      state: true
                      active: true
                      numcode: 250
                      address3: false
                      iso_name: FRANCE
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 94
                      iso: IR
                      itn: false
                      iso3: IRN
                      name: Iran, Islamic Republic of
                      state: true
                      active: true
                      numcode: 364
                      address3: false
                      iso_name: IRAN, ISLAMIC REPUBLIC OF
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: IRR
                      currency_symbol: ﷼
                    - id: 149
                      iso: NU
                      itn: false
                      iso3: NIU
                      name: Niue
                      state: true
                      active: true
                      numcode: 570
                      address3: false
                      iso_name: NIUE
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: NZD
                      currency_symbol: $
                    - id: 175
                      iso: WS
                      itn: false
                      iso3: WSM
                      name: Samoa
                      state: true
                      active: true
                      numcode: 882
                      address3: false
                      iso_name: SAMOA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: WST
                      currency_symbol: T
                    - id: 69
                      iso: GF
                      itn: false
                      iso3: GUF
                      name: French Guiana
                      state: true
                      active: true
                      numcode: 254
                      address3: false
                      iso_name: FRENCH GUIANA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 95
                      iso: IQ
                      itn: false
                      iso3: IRQ
                      name: Iraq
                      state: true
                      active: true
                      numcode: 368
                      address3: false
                      iso_name: IRAQ
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: IQD
                      currency_symbol: ع.د
                    - id: 176
                      iso: SM
                      itn: false
                      iso3: SMR
                      name: San Marino
                      state: true
                      active: true
                      numcode: 674
                      address3: false
                      iso_name: SAN MARINO
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 96
                      iso: IE
                      itn: false
                      iso3: IRL
                      name: Ireland
                      state: true
                      active: true
                      numcode: 372
                      address3: false
                      iso_name: IRELAND
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 177
                      iso: ST
                      itn: false
                      iso3: STP
                      name: Sao Tome and Principe
                      state: true
                      active: true
                      numcode: 678
                      address3: false
                      iso_name: SAO TOME AND PRINCIPE
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: STD
                      currency_symbol: Db
                    - id: 39
                      iso: TD
                      itn: false
                      iso3: TCD
                      name: Chad
                      state: true
                      active: true
                      numcode: 148
                      address3: false
                      iso_name: CHAD
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: XAF
                      currency_symbol: CFA
                    - id: 173
                      iso: PM
                      itn: false
                      iso3: SPM
                      name: Saint Pierre and Miquelon
                      state: true
                      active: true
                      numcode: 666
                      address3: false
                      iso_name: SAINT PIERRE AND MIQUELON
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                  image_url: >-
                    https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                  commission: '10.0'
                  country_id: null
                  share_link: null
                  shopify_id: null
                  description:
                    id: 122
                    body: <div>Optimized clear-thinking access</div>
                    name: description
                    record_id: 113
                    created_at: '2023-12-26T04:49:52.800Z'
                    updated_at: '2023-12-26T06:37:59.551Z'
                    record_type: Product
                  price_range:
                    - $17.32
                    - $17.32
                  country_code: td
                  currency_code: USD
                  display_price: $17.32 (USD)
                  option_values: {}
                  average_rating: 0
                  shopify_handle: null
                  currency_symbol: $
                  default_variant:
                    id: 113
                    sku: QDPF7N2XOR
                    size: 4cm
                    price: null
                    title: Default Variant
                    width: null
                    active: true
                    height: null
                    length: null
                    weight: 10 kg
                    hs_code: null
                    taxable: true
                    bar_code: null
                    physical: null
                    position: 1
                    image_url: null
                    is_master: true
                    created_at: '2023-12-26T04:49:52.811Z'
                    image_path: null
                    product_id: 113
                    shopify_id: null
                    updated_at: '2023-12-26T08:32:24.878Z'
                    external_id: null
                    discarded_at: null
                    keep_selling: false
                    option_attrs: []
                    unit_of_size: null
                    track_quantity: true
                    unit_of_weight: null
                    inventory_policy: none
                    country_of_origin: null
                    allow_subscription: true
                    inventory_quantity: 100
                    variant_country_id: null
                    customs_information_shipping: null
                  enroll_products: []
                  wholesale_price: '0.0'
                  subscription_price: '17.32'
                  unlimited_inventory: false
                  publish_to_rep_store: true
                  publish_to_share_tab: true
                  price_range_formatted: $17.32
                  display_wholesale_price: $0.00 (USD)
                  publish_to_retail_store: true
                  display_subscription_price: $17.32 (USD)
                  wholesale_subscription_price: '0.0'
                  display_wholesale_subscription_price: $0.00 (USD)
                quantity: 1
                ordered_variant: ''
            phone: null
            amount: '17.32'
            rating: 3
            review: null
            status: awaiting_shipment
            contact:
              id: 17
              ip: null
              city: null
              email: ram@gmail.com
              hours: null
              phone: null
              state: null
              token: bqy3h61S3bBFSR8QUzocghn4
              email2: null
              income: null
              invest: null
              phone2: null
              reason: null
              status: new
              address: null
              address2: null
              interest: null
              phone_id: null
              best_time: null
              full_name: Ram Khanka
              last_name: Khanka
              lead_type: null
              time_zone: null
              avatar_url: null
              country_id: null
              first_name: Ram
              language_id: null
              postal_code: null
              requested_at: null
            ship_to:
              id: 980190965
              city: x
              name: Ram Khanka
              state: Alaska
              country:
                id: 214
                iso: US
                itn: false
                iso3: USA
                name: United States
                state: true
                active: true
                default: true
                numcode: 840
                address3: false
                iso_name: UNITED STATES
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                created_at: '2023-12-26T04:48:23.479Z'
                updated_at: '2023-12-26T04:48:23.479Z'
                currency_code: USD
                geo_entity_id: null
                currency_symbol: $
              default: false
              address1: a
              address2: b
              address3: null
              postal_code: '11111'
              country_code: null
            referrer: null
            shipping: '0.0'
            subtotal: '17.32'
            tracking: null
            last_name: Khanka
            sale_date: '2023-12-26T00:00:00.000Z'
            created_at: '2023-12-26T08:28:26.141Z'
            first_name: Rama
            order_type: purchased
            refundable: true
            display_tax: $0.00 (USD)
            order_number: F17227665844
            currency_code: USD
            display_amount: $17.32 (USD)
            currency_symbol: $
            display_refunds: (0 CV, 0 QV) -$0.00 (USD)
            friendly_status: paid
            order_thumbnail: >-
              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
            display_discount: $0.00 (USD)
            display_shipping: $0.00 (USD)
            display_subtotal: $17.32 (USD)
            max_refundable_tax: '0.0'
            recognized_ship_date: null
            max_refundable_amount: '17.32'
            tracking_informations: []
            max_refundable_shipping: '0.0'
            max_refundable_product_price: '17.32'
        timestamp: '2023-12-26T08:40:36.551Z'
        identifier: order-170358003652
    order_shipped:
      title: order_shipped
      required:
        - id
        - name
        - payload
        - timestamp
        - identifier
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        payload:
          allOf:
            - $ref: '#/components/schemas/Payload7'
            - {}
        timestamp:
          type: string
        identifier:
          type: string
      example:
        id: 111
        name: order_shipped
        payload:
          order:
            cv: 97
            id: 52
            qv: 0
            tax: '0.0'
            type: null
            email: ram@gmail.com
            items:
              - id: 2
                sku: QDPF7N2XOR
                price: 17.32
                product:
                  id: 113
                  sku: QDPF7N2XOR
                  image:
                    full: >-
                      https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                    mini: >-
                      https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                    detail: >-
                      https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                  leads: 0
                  price: '17.32'
                  title: Aerodynamic Aluminum aaa
                  views: 0
                  active: true
                  images: []
                  public: true
                  vendor: null
                  enrolls: []
                  options: []
                  prompts: []
                  in_stock: true
                  shipping: '0.03'
                  stripped: Optimized clear-thinking access
                  variants:
                    - id: 113
                      title: Default Variant
                      buyable: true
                      image_url: null
                      option_value_ids: []
                      variant_countries:
                        - id: 686
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 214
                            iso: US
                            iso3: USA
                            name: United States
                            iso_name: UNITED STATES
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: US
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 687
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 65
                            iso: FO
                            iso3: FRO
                            name: Faroe Islands
                            iso_name: FAROE ISLANDS
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: FO
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 688
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 92
                            iso: IN
                            iso3: IND
                            name: India
                            iso_name: INDIA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: IN
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 689
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 146
                            iso: NI
                            iso3: NIC
                            name: Nicaragua
                            iso_name: NICARAGUA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: NI
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 690
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 172
                            iso: LC
                            iso3: LCA
                            name: Saint Lucia
                            iso_name: SAINT LUCIA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: LC
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 691
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 66
                            iso: FJ
                            iso3: FJI
                            name: Fiji
                            iso_name: FIJI
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: FJ
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 692
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 93
                            iso: ID
                            iso3: IDN
                            name: Indonesia
                            iso_name: INDONESIA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: ID
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 693
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 147
                            iso: NE
                            iso3: NER
                            name: Niger
                            iso_name: NIGER
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: NE
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 694
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 67
                            iso: FI
                            iso3: FIN
                            name: Finland
                            iso_name: FINLAND
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: FI
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 695
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 148
                            iso: NG
                            iso3: NGA
                            name: Nigeria
                            iso_name: NIGERIA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: NG
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                      allow_subscription: true
                  countries:
                    - id: 214
                      iso: US
                      itn: false
                      iso3: USA
                      name: United States
                      state: true
                      active: true
                      numcode: 840
                      address3: false
                      iso_name: UNITED STATES
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: USD
                      currency_symbol: $
                    - id: 65
                      iso: FO
                      itn: false
                      iso3: FRO
                      name: Faroe Islands
                      state: true
                      active: true
                      numcode: 234
                      address3: false
                      iso_name: FAROE ISLANDS
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: DKK
                      currency_symbol: kr.
                    - id: 92
                      iso: IN
                      itn: false
                      iso3: IND
                      name: India
                      state: true
                      active: true
                      numcode: 356
                      address3: false
                      iso_name: INDIA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: INR
                      currency_symbol: ₹
                    - id: 146
                      iso: NI
                      itn: false
                      iso3: NIC
                      name: Nicaragua
                      state: true
                      active: true
                      numcode: 558
                      address3: false
                      iso_name: NICARAGUA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: NIO
                      currency_symbol: C$
                    - id: 172
                      iso: LC
                      itn: false
                      iso3: LCA
                      name: Saint Lucia
                      state: true
                      active: true
                      numcode: 662
                      address3: false
                      iso_name: SAINT LUCIA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: XCD
                      currency_symbol: $
                    - id: 66
                      iso: FJ
                      itn: false
                      iso3: FJI
                      name: Fiji
                      state: true
                      active: true
                      numcode: 242
                      address3: false
                      iso_name: FIJI
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: FJD
                      currency_symbol: $
                    - id: 93
                      iso: ID
                      itn: false
                      iso3: IDN
                      name: Indonesia
                      state: true
                      active: true
                      numcode: 360
                      address3: false
                      iso_name: INDONESIA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: IDR
                      currency_symbol: Rp
                    - id: 147
                      iso: NE
                      itn: false
                      iso3: NER
                      name: Niger
                      state: true
                      active: true
                      numcode: 562
                      address3: false
                      iso_name: NIGER
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: XOF
                      currency_symbol: Fr
                    - id: 67
                      iso: FI
                      itn: false
                      iso3: FIN
                      name: Finland
                      state: true
                      active: true
                      numcode: 246
                      address3: false
                      iso_name: FINLAND
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 148
                      iso: NG
                      itn: false
                      iso3: NGA
                      name: Nigeria
                      state: true
                      active: true
                      numcode: 566
                      address3: false
                      iso_name: NIGERIA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: NGN
                      currency_symbol: ₦
                    - id: 174
                      iso: VC
                      itn: false
                      iso3: VCT
                      name: Saint Vincent and the Grenadines
                      state: true
                      active: true
                      numcode: 670
                      address3: false
                      iso_name: SAINT VINCENT AND THE GRENADINES
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: XCD
                      currency_symbol: $
                    - id: 68
                      iso: FR
                      itn: false
                      iso3: FRA
                      name: France
                      state: true
                      active: true
                      numcode: 250
                      address3: false
                      iso_name: FRANCE
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 94
                      iso: IR
                      itn: false
                      iso3: IRN
                      name: Iran, Islamic Republic of
                      state: true
                      active: true
                      numcode: 364
                      address3: false
                      iso_name: IRAN, ISLAMIC REPUBLIC OF
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: IRR
                      currency_symbol: ﷼
                    - id: 149
                      iso: NU
                      itn: false
                      iso3: NIU
                      name: Niue
                      state: true
                      active: true
                      numcode: 570
                      address3: false
                      iso_name: NIUE
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: NZD
                      currency_symbol: $
                    - id: 175
                      iso: WS
                      itn: false
                      iso3: WSM
                      name: Samoa
                      state: true
                      active: true
                      numcode: 882
                      address3: false
                      iso_name: SAMOA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: WST
                      currency_symbol: T
                    - id: 69
                      iso: GF
                      itn: false
                      iso3: GUF
                      name: French Guiana
                      state: true
                      active: true
                      numcode: 254
                      address3: false
                      iso_name: FRENCH GUIANA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 95
                      iso: IQ
                      itn: false
                      iso3: IRQ
                      name: Iraq
                      state: true
                      active: true
                      numcode: 368
                      address3: false
                      iso_name: IRAQ
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: IQD
                      currency_symbol: ع.د
                    - id: 176
                      iso: SM
                      itn: false
                      iso3: SMR
                      name: San Marino
                      state: true
                      active: true
                      numcode: 674
                      address3: false
                      iso_name: SAN MARINO
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 96
                      iso: IE
                      itn: false
                      iso3: IRL
                      name: Ireland
                      state: true
                      active: true
                      numcode: 372
                      address3: false
                      iso_name: IRELAND
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 177
                      iso: ST
                      itn: false
                      iso3: STP
                      name: Sao Tome and Principe
                      state: true
                      active: true
                      numcode: 678
                      address3: false
                      iso_name: SAO TOME AND PRINCIPE
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: STD
                      currency_symbol: Db
                    - id: 39
                      iso: TD
                      itn: false
                      iso3: TCD
                      name: Chad
                      state: true
                      active: true
                      numcode: 148
                      address3: false
                      iso_name: CHAD
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: XAF
                      currency_symbol: CFA
                    - id: 173
                      iso: PM
                      itn: false
                      iso3: SPM
                      name: Saint Pierre and Miquelon
                      state: true
                      active: true
                      numcode: 666
                      address3: false
                      iso_name: SAINT PIERRE AND MIQUELON
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                  image_url: >-
                    https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                  commission: '10.0'
                  country_id: null
                  share_link: null
                  shopify_id: null
                  description:
                    id: 122
                    body: <div>Optimized clear-thinking access</div>
                    name: description
                    record_id: 113
                    created_at: '2023-12-26T04:49:52.800Z'
                    updated_at: '2023-12-26T06:37:59.551Z'
                    record_type: Product
                  price_range:
                    - $17.32
                    - $17.32
                  country_code: td
                  currency_code: USD
                  display_price: $17.32 (USD)
                  option_values: {}
                  average_rating: 0
                  shopify_handle: null
                  currency_symbol: $
                  default_variant:
                    id: 113
                    sku: QDPF7N2XOR
                    size: 4cm
                    price: null
                    title: Default Variant
                    width: null
                    active: true
                    height: null
                    length: null
                    weight: 10 kg
                    hs_code: null
                    taxable: true
                    bar_code: null
                    physical: null
                    position: 1
                    image_url: null
                    is_master: true
                    created_at: '2023-12-26T04:49:52.811Z'
                    image_path: null
                    product_id: 113
                    shopify_id: null
                    updated_at: '2023-12-26T08:32:24.878Z'
                    external_id: null
                    discarded_at: null
                    keep_selling: false
                    option_attrs: []
                    unit_of_size: null
                    track_quantity: true
                    unit_of_weight: null
                    inventory_policy: none
                    country_of_origin: null
                    allow_subscription: true
                    inventory_quantity: 100
                    variant_country_id: null
                    customs_information_shipping: null
                  enroll_products: []
                  wholesale_price: '0.0'
                  subscription_price: '17.32'
                  unlimited_inventory: false
                  publish_to_rep_store: true
                  publish_to_share_tab: true
                  price_range_formatted: $17.32
                  display_wholesale_price: $0.00 (USD)
                  publish_to_retail_store: true
                  display_subscription_price: $17.32 (USD)
                  wholesale_subscription_price: '0.0'
                  display_wholesale_subscription_price: $0.00 (USD)
                quantity: 1
                ordered_variant: ''
            phone: null
            amount: '13.32'
            rating: 2
            review: null
            status: awaiting_shipment
            contact:
              id: 17
              ip: null
              city: null
              email: ram@gmail.com
              hours: null
              phone: null
              state: null
              token: bqy3h61S3bBFSR8QUzocghn4
              email2: null
              income: null
              invest: null
              phone2: null
              reason: null
              status: new
              address: null
              address2: null
              interest: null
              phone_id: null
              best_time: null
              full_name: Ram Khanka
              last_name: Khanka
              lead_type: null
              time_zone: null
              avatar_url: null
              country_id: null
              first_name: Ram
              language_id: null
              postal_code: null
              requested_at: null
            ship_to:
              id: 980190965
              city: x
              name: Ram Khanka
              state: Alaska
              country:
                id: 214
                iso: US
                itn: false
                iso3: USA
                name: United States
                state: true
                active: true
                default: true
                numcode: 840
                address3: false
                iso_name: UNITED STATES
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                created_at: '2023-12-26T04:48:23.479Z'
                updated_at: '2023-12-26T04:48:23.479Z'
                currency_code: USD
                geo_entity_id: null
                currency_symbol: $
              default: false
              address1: a
              address2: b
              address3: null
              postal_code: '11111'
              country_code: null
            referrer: null
            shipping: '0.0'
            subtotal: '17.32'
            tracking: null
            last_name: Khanka
            sale_date: '2023-12-26T00:00:00.000Z'
            created_at: '2023-12-26T08:28:26.141Z'
            first_name: Rama
            order_type: purchased
            refundable: true
            display_tax: $0.00 (USD)
            order_number: F17227665844
            currency_code: USD
            display_amount: $13.32 (USD)
            currency_symbol: $
            display_refunds: (3 CV, 0 QV) -$4.00 (USD)
            friendly_status: paid
            order_thumbnail: >-
              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
            display_discount: $0.00 (USD)
            display_shipping: $0.00 (USD)
            display_subtotal: $17.32 (USD)
            max_refundable_tax: '0.0'
            recognized_ship_date: null
            max_refundable_amount: '13.32'
            tracking_informations: []
            max_refundable_shipping: '0.0'
            max_refundable_product_price: '13.32'
        timestamp: '2023-12-27T12:37:34.409Z'
        identifier: order-170368065452
    order_refunded:
      title: order_refunded
      required:
        - id
        - name
        - payload
        - timestamp
        - identifier
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        payload:
          allOf:
            - $ref: '#/components/schemas/Payload7'
            - {}
        timestamp:
          type: string
        identifier:
          type: string
      example:
        id: 113
        name: order_refunded
        payload:
          order:
            cv: 97
            id: 52
            qv: 0
            tax: '0.0'
            type: null
            email: ram@gmail.com
            items:
              - id: 2
                sku: QDPF7N2XOR
                price: 17.32
                product:
                  id: 113
                  sku: QDPF7N2XOR
                  image:
                    full: >-
                      https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                    mini: >-
                      https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                    detail: >-
                      https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                  leads: 0
                  price: '17.32'
                  title: Aerodynamic Aluminum aaa
                  views: 0
                  active: true
                  images: []
                  public: true
                  vendor: null
                  enrolls: []
                  options: []
                  prompts: []
                  in_stock: true
                  shipping: '0.03'
                  stripped: Optimized clear-thinking access
                  variants:
                    - id: 113
                      title: Default Variant
                      buyable: true
                      image_url: null
                      option_value_ids: []
                      variant_countries:
                        - id: 686
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 214
                            iso: US
                            iso3: USA
                            name: United States
                            iso_name: UNITED STATES
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: US
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 687
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 65
                            iso: FO
                            iso3: FRO
                            name: Faroe Islands
                            iso_name: FAROE ISLANDS
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: FO
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 688
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 92
                            iso: IN
                            iso3: IND
                            name: India
                            iso_name: INDIA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: IN
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 689
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 146
                            iso: NI
                            iso3: NIC
                            name: Nicaragua
                            iso_name: NICARAGUA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: NI
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 690
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 172
                            iso: LC
                            iso3: LCA
                            name: Saint Lucia
                            iso_name: SAINT LUCIA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: LC
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 691
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 66
                            iso: FJ
                            iso3: FJI
                            name: Fiji
                            iso_name: FIJI
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: FJ
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 692
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 93
                            iso: ID
                            iso3: IDN
                            name: Indonesia
                            iso_name: INDONESIA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: ID
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 693
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 147
                            iso: NE
                            iso3: NER
                            name: Niger
                            iso_name: NIGER
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: NE
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 694
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 67
                            iso: FI
                            iso3: FIN
                            name: Finland
                            iso_name: FINLAND
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: FI
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 695
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 148
                            iso: NG
                            iso3: NGA
                            name: Nigeria
                            iso_name: NIGERIA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: NG
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                      allow_subscription: true
                  countries:
                    - id: 214
                      iso: US
                      itn: false
                      iso3: USA
                      name: United States
                      state: true
                      active: true
                      numcode: 840
                      address3: false
                      iso_name: UNITED STATES
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: USD
                      currency_symbol: $
                    - id: 65
                      iso: FO
                      itn: false
                      iso3: FRO
                      name: Faroe Islands
                      state: true
                      active: true
                      numcode: 234
                      address3: false
                      iso_name: FAROE ISLANDS
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: DKK
                      currency_symbol: kr.
                    - id: 92
                      iso: IN
                      itn: false
                      iso3: IND
                      name: India
                      state: true
                      active: true
                      numcode: 356
                      address3: false
                      iso_name: INDIA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: INR
                      currency_symbol: ₹
                    - id: 146
                      iso: NI
                      itn: false
                      iso3: NIC
                      name: Nicaragua
                      state: true
                      active: true
                      numcode: 558
                      address3: false
                      iso_name: NICARAGUA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: NIO
                      currency_symbol: C$
                    - id: 172
                      iso: LC
                      itn: false
                      iso3: LCA
                      name: Saint Lucia
                      state: true
                      active: true
                      numcode: 662
                      address3: false
                      iso_name: SAINT LUCIA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: XCD
                      currency_symbol: $
                    - id: 66
                      iso: FJ
                      itn: false
                      iso3: FJI
                      name: Fiji
                      state: true
                      active: true
                      numcode: 242
                      address3: false
                      iso_name: FIJI
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: FJD
                      currency_symbol: $
                    - id: 93
                      iso: ID
                      itn: false
                      iso3: IDN
                      name: Indonesia
                      state: true
                      active: true
                      numcode: 360
                      address3: false
                      iso_name: INDONESIA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: IDR
                      currency_symbol: Rp
                    - id: 147
                      iso: NE
                      itn: false
                      iso3: NER
                      name: Niger
                      state: true
                      active: true
                      numcode: 562
                      address3: false
                      iso_name: NIGER
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: XOF
                      currency_symbol: Fr
                    - id: 67
                      iso: FI
                      itn: false
                      iso3: FIN
                      name: Finland
                      state: true
                      active: true
                      numcode: 246
                      address3: false
                      iso_name: FINLAND
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 148
                      iso: NG
                      itn: false
                      iso3: NGA
                      name: Nigeria
                      state: true
                      active: true
                      numcode: 566
                      address3: false
                      iso_name: NIGERIA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: NGN
                      currency_symbol: ₦
                    - id: 174
                      iso: VC
                      itn: false
                      iso3: VCT
                      name: Saint Vincent and the Grenadines
                      state: true
                      active: true
                      numcode: 670
                      address3: false
                      iso_name: SAINT VINCENT AND THE GRENADINES
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: XCD
                      currency_symbol: $
                    - id: 68
                      iso: FR
                      itn: false
                      iso3: FRA
                      name: France
                      state: true
                      active: true
                      numcode: 250
                      address3: false
                      iso_name: FRANCE
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 94
                      iso: IR
                      itn: false
                      iso3: IRN
                      name: Iran, Islamic Republic of
                      state: true
                      active: true
                      numcode: 364
                      address3: false
                      iso_name: IRAN, ISLAMIC REPUBLIC OF
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: IRR
                      currency_symbol: ﷼
                    - id: 149
                      iso: NU
                      itn: false
                      iso3: NIU
                      name: Niue
                      state: true
                      active: true
                      numcode: 570
                      address3: false
                      iso_name: NIUE
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: NZD
                      currency_symbol: $
                    - id: 175
                      iso: WS
                      itn: false
                      iso3: WSM
                      name: Samoa
                      state: true
                      active: true
                      numcode: 882
                      address3: false
                      iso_name: SAMOA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: WST
                      currency_symbol: T
                    - id: 69
                      iso: GF
                      itn: false
                      iso3: GUF
                      name: French Guiana
                      state: true
                      active: true
                      numcode: 254
                      address3: false
                      iso_name: FRENCH GUIANA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 95
                      iso: IQ
                      itn: false
                      iso3: IRQ
                      name: Iraq
                      state: true
                      active: true
                      numcode: 368
                      address3: false
                      iso_name: IRAQ
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: IQD
                      currency_symbol: ع.د
                    - id: 176
                      iso: SM
                      itn: false
                      iso3: SMR
                      name: San Marino
                      state: true
                      active: true
                      numcode: 674
                      address3: false
                      iso_name: SAN MARINO
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 96
                      iso: IE
                      itn: false
                      iso3: IRL
                      name: Ireland
                      state: true
                      active: true
                      numcode: 372
                      address3: false
                      iso_name: IRELAND
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 177
                      iso: ST
                      itn: false
                      iso3: STP
                      name: Sao Tome and Principe
                      state: true
                      active: true
                      numcode: 678
                      address3: false
                      iso_name: SAO TOME AND PRINCIPE
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: STD
                      currency_symbol: Db
                    - id: 39
                      iso: TD
                      itn: false
                      iso3: TCD
                      name: Chad
                      state: true
                      active: true
                      numcode: 148
                      address3: false
                      iso_name: CHAD
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: XAF
                      currency_symbol: CFA
                    - id: 173
                      iso: PM
                      itn: false
                      iso3: SPM
                      name: Saint Pierre and Miquelon
                      state: true
                      active: true
                      numcode: 666
                      address3: false
                      iso_name: SAINT PIERRE AND MIQUELON
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                  image_url: >-
                    https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                  commission: '10.0'
                  country_id: null
                  share_link: null
                  shopify_id: null
                  description:
                    id: 122
                    body: <div>Optimized clear-thinking access</div>
                    name: description
                    record_id: 113
                    created_at: '2023-12-26T04:49:52.800Z'
                    updated_at: '2023-12-26T06:37:59.551Z'
                    record_type: Product
                  price_range:
                    - $17.32
                    - $17.32
                  country_code: td
                  currency_code: USD
                  display_price: $17.32 (USD)
                  option_values: {}
                  average_rating: 0
                  shopify_handle: null
                  currency_symbol: $
                  default_variant:
                    id: 113
                    sku: QDPF7N2XOR
                    size: 4cm
                    price: null
                    title: Default Variant
                    width: null
                    active: true
                    height: null
                    length: null
                    weight: 10 kg
                    hs_code: null
                    taxable: true
                    bar_code: null
                    physical: null
                    position: 1
                    image_url: null
                    is_master: true
                    created_at: '2023-12-26T04:49:52.811Z'
                    image_path: null
                    product_id: 113
                    shopify_id: null
                    updated_at: '2023-12-26T08:32:24.878Z'
                    external_id: null
                    discarded_at: null
                    keep_selling: false
                    option_attrs: []
                    unit_of_size: null
                    track_quantity: true
                    unit_of_weight: null
                    inventory_policy: none
                    country_of_origin: null
                    allow_subscription: true
                    inventory_quantity: 100
                    variant_country_id: null
                    customs_information_shipping: null
                  enroll_products: []
                  wholesale_price: '0.0'
                  subscription_price: '17.32'
                  unlimited_inventory: false
                  publish_to_rep_store: true
                  publish_to_share_tab: true
                  price_range_formatted: $17.32
                  display_wholesale_price: $0.00 (USD)
                  publish_to_retail_store: true
                  display_subscription_price: $17.32 (USD)
                  wholesale_subscription_price: '0.0'
                  display_wholesale_subscription_price: $0.00 (USD)
                quantity: 1
                ordered_variant: ''
            phone: null
            amount: '13.32'
            rating: 4
            review: null
            status: awaiting_shipment
            contact:
              id: 17
              ip: null
              city: null
              email: ram@gmail.com
              hours: null
              phone: null
              state: null
              token: bqy3h61S3bBFSR8QUzocghn4
              email2: null
              income: null
              invest: null
              phone2: null
              reason: null
              status: new
              address: null
              address2: null
              interest: null
              phone_id: null
              best_time: null
              full_name: Ram Khanka
              last_name: Khanka
              lead_type: null
              time_zone: null
              avatar_url: null
              country_id: null
              first_name: Ram
              language_id: null
              postal_code: null
              requested_at: null
            ship_to:
              id: 980190965
              city: x
              name: Ram Khanka
              state: Alaska
              country:
                id: 214
                iso: US
                itn: false
                iso3: USA
                name: United States
                state: true
                active: true
                default: true
                numcode: 840
                address3: false
                iso_name: UNITED STATES
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                created_at: '2023-12-26T04:48:23.479Z'
                updated_at: '2023-12-26T04:48:23.479Z'
                currency_code: USD
                geo_entity_id: null
                currency_symbol: $
              default: false
              address1: a
              address2: b
              address3: null
              postal_code: '11111'
              country_code: null
            referrer: null
            shipping: '0.0'
            subtotal: '17.32'
            tracking: null
            last_name: Khanka
            sale_date: '2023-12-26T00:00:00.000Z'
            created_at: '2023-12-26T08:28:26.141Z'
            first_name: Rama
            order_type: purchased
            refundable: true
            display_tax: $0.00 (USD)
            order_number: F17227665844
            currency_code: USD
            display_amount: $13.32 (USD)
            currency_symbol: $
            display_refunds: (3 CV, 0 QV) -$4.00 (USD)
            friendly_status: paid
            order_thumbnail: >-
              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
            display_discount: $0.00 (USD)
            display_shipping: $0.00 (USD)
            display_subtotal: $17.32 (USD)
            max_refundable_tax: '0.0'
            recognized_ship_date: null
            max_refundable_amount: '13.32'
            tracking_informations: []
            max_refundable_shipping: '0.0'
            max_refundable_product_price: '13.32'
        timestamp: '2023-12-27T12:38:13.187Z'
        identifier: order-170368069352
    popup_submitted:
      title: popup_submitted
      required:
        - id
        - name
        - payload
        - timestamp
        - identifier
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        payload:
          allOf:
            - $ref: '#/components/schemas/Payload12'
            - {}
        timestamp:
          type: string
        identifier:
          type: string
      example:
        id: 140
        name: popup_submitted
        payload:
          popup:
            id: 1
            event: timer
            title: POPPY
            active: true
            global: false
            header: null
            seconds: 1
            image_url: ''
            followable: null
            popup_type: modal
            description:
              id: 130
              body: <div>THIS IS A POPUP</div>
              name: description
              record_id: 1
              created_at: '2023-12-28T04:10:22.836Z'
              updated_at: '2023-12-28T04:10:22.836Z'
              record_type: Popup
        timestamp: '2023-12-28T04:19:58.261Z'
        identifier: popup-17037371981
    Payload12:
      title: Payload12
      required:
        - popup
      type: object
      properties:
        popup:
          allOf:
            - $ref: '#/components/schemas/Popup'
            - {}
      example:
        popup:
          id: 1
          event: timer
          title: POPPY
          active: true
          global: false
          header: null
          seconds: 1
          image_url: ''
          followable: null
          popup_type: modal
          description:
            id: 130
            body: <div>THIS IS A POPUP</div>
            name: description
            record_id: 1
            created_at: '2023-12-28T04:10:22.836Z'
            updated_at: '2023-12-28T04:10:22.836Z'
            record_type: Popup
    Popup:
      title: Popup
      required:
        - id
        - event
        - title
        - active
        - global
        - header
        - seconds
        - image_url
        - followable
        - popup_type
        - description
      type: object
      properties:
        id:
          type: integer
          format: int32
        event:
          type: string
        title:
          type: string
        active:
          type: boolean
        global:
          type: boolean
        header:
          type: string
        seconds:
          type: integer
          format: int32
        image_url:
          type: string
        followable:
          type: string
        popup_type:
          type: string
        description:
          allOf:
            - $ref: '#/components/schemas/Description'
            - {}
      example:
        id: 1
        event: timer
        title: POPPY
        active: true
        global: false
        header: null
        seconds: 1
        image_url: ''
        followable: null
        popup_type: modal
        description:
          id: 130
          body: <div>THIS IS A POPUP</div>
          name: description
          record_id: 1
          created_at: '2023-12-28T04:10:22.836Z'
          updated_at: '2023-12-28T04:10:22.836Z'
          record_type: Popup
    CustomCatchUps:
      title: CustonCatchUp
      required:
        - type
        - title
        - description
        - affiliate_id
        - actions
      type: object
      properties:
        type:
          type: string
        title:
          type: string
        header:
          type: string
        affiliate_id:
          type: integer
          format: int32
        actions:
          allOf:
            - $ref: '#/components/schemas/CatchUpAction'
            - {}
      example:
        type: custom_catch_up
        title: Talk to your favorite visitor.
        description: >-
          This visitor has routing through your mysite and purchasing products
          constantly. Say Hi.
        affiliate_id: 1
        actions:
          type: SendSmsCatchUpAction
          action_prompt: >-
            Craft a short friendly message to a visitor, visiting my site
            constantly and buying products.
        contact_id: 22
    product_created:
      title: product_created
      required:
        - id
        - name
        - payload
        - timestamp
        - identifier
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        payload:
          allOf:
            - $ref: '#/components/schemas/Payload13'
            - {}
        timestamp:
          type: string
        identifier:
          type: string
      example:
        id: 165
        name: product_created
        payload:
          product:
            id: 115
            sku: HTPGX14SE7
            image:
              full: >-
                https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
              mini: >-
                https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
              detail: >-
                https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
            leads: 0
            price: null
            title: Awesome Copper Computer45
            views: 0
            active: false
            images: []
            public: true
            vendor: null
            enrolls: []
            options: []
            prompts: []
            in_stock: true
            shipping: '4.7'
            stripped: Reactive intermediate moderator
            variants:
              - id: 115
                title: Default Variant
                buyable: true
                image_url: null
                option_value_ids: []
                variant_countries:
                  - id: 706
                    tax: '0.0'
                    price: '22.27'
                    country:
                      id: 214
                      iso: US
                      iso3: USA
                      name: United States
                      iso_name: UNITED STATES
                      tax_rate: 0
                    shipping: '0.0'
                    country_iso: US
                    currency_code: USD
                    display_price: $22.27 (USD)
                    currency_symbol: $
                    wholesale_price: '0.0'
                    subscription_price: '22.27'
                    display_wholesale_price: $0.00 (USD)
                    wholesale_subscription_price: '0.0'
                    display_wholesale_subscription_price: $0.00 (USD)
                  - id: 707
                    tax: '0.0'
                    price: '22.27'
                    country:
                      id: 65
                      iso: FO
                      iso3: FRO
                      name: Faroe Islands
                      iso_name: FAROE ISLANDS
                      tax_rate: 0
                    shipping: '0.0'
                    country_iso: FO
                    currency_code: USD
                    display_price: $22.27 (USD)
                    currency_symbol: $
                    wholesale_price: '0.0'
                    subscription_price: '22.27'
                    display_wholesale_price: $0.00 (USD)
                    wholesale_subscription_price: '0.0'
                    display_wholesale_subscription_price: $0.00 (USD)
                  - id: 708
                    tax: '0.0'
                    price: '22.27'
                    country:
                      id: 92
                      iso: IN
                      iso3: IND
                      name: India
                      iso_name: INDIA
                      tax_rate: 0
                    shipping: '0.0'
                    country_iso: IN
                    currency_code: USD
                    display_price: $22.27 (USD)
                    currency_symbol: $
                    wholesale_price: '0.0'
                    subscription_price: '22.27'
                    display_wholesale_price: $0.00 (USD)
                    wholesale_subscription_price: '0.0'
                    display_wholesale_subscription_price: $0.00 (USD)
                  - id: 709
                    tax: '0.0'
                    price: '22.27'
                    country:
                      id: 146
                      iso: NI
                      iso3: NIC
                      name: Nicaragua
                      iso_name: NICARAGUA
                      tax_rate: 0
                    shipping: '0.0'
                    country_iso: NI
                    currency_code: USD
                    display_price: $22.27 (USD)
                    currency_symbol: $
                    wholesale_price: '0.0'
                    subscription_price: '22.27'
                    display_wholesale_price: $0.00 (USD)
                    wholesale_subscription_price: '0.0'
                    display_wholesale_subscription_price: $0.00 (USD)
                  - id: 710
                    tax: '0.0'
                    price: '22.27'
                    country:
                      id: 172
                      iso: LC
                      iso3: LCA
                      name: Saint Lucia
                      iso_name: SAINT LUCIA
                      tax_rate: 0
                    shipping: '0.0'
                    country_iso: LC
                    currency_code: USD
                    display_price: $22.27 (USD)
                    currency_symbol: $
                    wholesale_price: '0.0'
                    subscription_price: '22.27'
                    display_wholesale_price: $0.00 (USD)
                    wholesale_subscription_price: '0.0'
                    display_wholesale_subscription_price: $0.00 (USD)
                  - id: 711
                    tax: '0.0'
                    price: '22.27'
                    country:
                      id: 66
                      iso: FJ
                      iso3: FJI
                      name: Fiji
                      iso_name: FIJI
                      tax_rate: 0
                    shipping: '0.0'
                    country_iso: FJ
                    currency_code: USD
                    display_price: $22.27 (USD)
                    currency_symbol: $
                    wholesale_price: '0.0'
                    subscription_price: '22.27'
                    display_wholesale_price: $0.00 (USD)
                    wholesale_subscription_price: '0.0'
                    display_wholesale_subscription_price: $0.00 (USD)
                  - id: 712
                    tax: '0.0'
                    price: '22.27'
                    country:
                      id: 93
                      iso: ID
                      iso3: IDN
                      name: Indonesia
                      iso_name: INDONESIA
                      tax_rate: 0
                    shipping: '0.0'
                    country_iso: ID
                    currency_code: USD
                    display_price: $22.27 (USD)
                    currency_symbol: $
                    wholesale_price: '0.0'
                    subscription_price: '22.27'
                    display_wholesale_price: $0.00 (USD)
                    wholesale_subscription_price: '0.0'
                    display_wholesale_subscription_price: $0.00 (USD)
                  - id: 713
                    tax: '0.0'
                    price: '22.27'
                    country:
                      id: 147
                      iso: NE
                      iso3: NER
                      name: Niger
                      iso_name: NIGER
                      tax_rate: 0
                    shipping: '0.0'
                    country_iso: NE
                    currency_code: USD
                    display_price: $22.27 (USD)
                    currency_symbol: $
                    wholesale_price: '0.0'
                    subscription_price: '22.27'
                    display_wholesale_price: $0.00 (USD)
                    wholesale_subscription_price: '0.0'
                    display_wholesale_subscription_price: $0.00 (USD)
                  - id: 714
                    tax: '0.0'
                    price: '22.27'
                    country:
                      id: 67
                      iso: FI
                      iso3: FIN
                      name: Finland
                      iso_name: FINLAND
                      tax_rate: 0
                    shipping: '0.0'
                    country_iso: FI
                    currency_code: USD
                    display_price: $22.27 (USD)
                    currency_symbol: $
                    wholesale_price: '0.0'
                    subscription_price: '22.27'
                    display_wholesale_price: $0.00 (USD)
                    wholesale_subscription_price: '0.0'
                    display_wholesale_subscription_price: $0.00 (USD)
                allow_subscription: true
            countries:
              - id: 214
                iso: US
                itn: false
                iso3: USA
                name: United States
                state: true
                active: true
                numcode: 840
                address3: false
                iso_name: UNITED STATES
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: USD
                currency_symbol: $
            image_url: >-
              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
            commission: '10.0'
            country_id: null
            share_link: null
            shopify_id: null
            description:
              id: 124
              body: Reactive intermediate moderator
              name: description
              record_id: 115
              created_at: '2023-12-26T04:49:52.800Z'
              updated_at: '2023-12-26T04:49:52.800Z'
              record_type: Product
            price_range:
              - $22.27
              - $22.27
            country_code: us
            currency_code: USD
            display_price: ''
            option_values: null
            average_rating: 0
            shopify_handle: null
            currency_symbol: $
            default_variant:
              id: 115
              sku: HTPGX14SE7
              size: 2 cm
              price: null
              title: Default Variant
              width: null
              active: true
              height: null
              length: null
              weight: 20 kg
              hs_code: null
              taxable: true
              bar_code: null
              physical: null
              position: 1
              image_url: null
              is_master: true
              created_at: '2023-12-26T04:49:52.811Z'
              image_path: null
              product_id: 115
              shopify_id: null
              updated_at: '2023-12-26T04:49:52.811Z'
              external_id: null
              discarded_at: null
              keep_selling: false
              option_attrs: []
              unit_of_size: null
              track_quantity: true
              unit_of_weight: null
              inventory_policy: none
              country_of_origin: null
              allow_subscription: true
              inventory_quantity: 1
              variant_country_id: null
              customs_information_shipping: null
            enroll_products: []
            wholesale_price: null
            subscription_price: null
            unlimited_inventory: false
            publish_to_rep_store: true
            publish_to_share_tab: true
            price_range_formatted: $22.27
            display_wholesale_price: ''
            publish_to_retail_store: true
            display_subscription_price: null
            wholesale_subscription_price: null
            display_wholesale_subscription_price: null
        timestamp: '2023-12-28T06:55:37.833Z'
        identifier: product-1703746537115
    Payload13:
      title: Payload13
      required:
        - product
      type: object
      properties:
        product:
          allOf:
            - $ref: '#/components/schemas/Product17'
            - {}
      example:
        product:
          id: 115
          sku: HTPGX14SE7
          image:
            full: >-
              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
            mini: >-
              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
            detail: >-
              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
          leads: 0
          price: null
          title: Awesome Copper Computer45
          views: 0
          active: false
          images: []
          public: true
          vendor: null
          enrolls: []
          options: []
          prompts: []
          in_stock: true
          shipping: '4.7'
          stripped: Reactive intermediate moderator
          variants:
            - id: 115
              title: Default Variant
              buyable: true
              image_url: null
              option_value_ids: []
              variant_countries:
                - id: 706
                  tax: '0.0'
                  price: '22.27'
                  country:
                    id: 214
                    iso: US
                    iso3: USA
                    name: United States
                    iso_name: UNITED STATES
                    tax_rate: 0
                  shipping: '0.0'
                  country_iso: US
                  currency_code: USD
                  display_price: $22.27 (USD)
                  currency_symbol: $
                  wholesale_price: '0.0'
                  subscription_price: '22.27'
                  display_wholesale_price: $0.00 (USD)
                  wholesale_subscription_price: '0.0'
                  display_wholesale_subscription_price: $0.00 (USD)
                - id: 707
                  tax: '0.0'
                  price: '22.27'
                  country:
                    id: 65
                    iso: FO
                    iso3: FRO
                    name: Faroe Islands
                    iso_name: FAROE ISLANDS
                    tax_rate: 0
                  shipping: '0.0'
                  country_iso: FO
                  currency_code: USD
                  display_price: $22.27 (USD)
                  currency_symbol: $
                  wholesale_price: '0.0'
                  subscription_price: '22.27'
                  display_wholesale_price: $0.00 (USD)
                  wholesale_subscription_price: '0.0'
                  display_wholesale_subscription_price: $0.00 (USD)
                - id: 708
                  tax: '0.0'
                  price: '22.27'
                  country:
                    id: 92
                    iso: IN
                    iso3: IND
                    name: India
                    iso_name: INDIA
                    tax_rate: 0
                  shipping: '0.0'
                  country_iso: IN
                  currency_code: USD
                  display_price: $22.27 (USD)
                  currency_symbol: $
                  wholesale_price: '0.0'
                  subscription_price: '22.27'
                  display_wholesale_price: $0.00 (USD)
                  wholesale_subscription_price: '0.0'
                  display_wholesale_subscription_price: $0.00 (USD)
                - id: 709
                  tax: '0.0'
                  price: '22.27'
                  country:
                    id: 146
                    iso: NI
                    iso3: NIC
                    name: Nicaragua
                    iso_name: NICARAGUA
                    tax_rate: 0
                  shipping: '0.0'
                  country_iso: NI
                  currency_code: USD
                  display_price: $22.27 (USD)
                  currency_symbol: $
                  wholesale_price: '0.0'
                  subscription_price: '22.27'
                  display_wholesale_price: $0.00 (USD)
                  wholesale_subscription_price: '0.0'
                  display_wholesale_subscription_price: $0.00 (USD)
                - id: 710
                  tax: '0.0'
                  price: '22.27'
                  country:
                    id: 172
                    iso: LC
                    iso3: LCA
                    name: Saint Lucia
                    iso_name: SAINT LUCIA
                    tax_rate: 0
                  shipping: '0.0'
                  country_iso: LC
                  currency_code: USD
                  display_price: $22.27 (USD)
                  currency_symbol: $
                  wholesale_price: '0.0'
                  subscription_price: '22.27'
                  display_wholesale_price: $0.00 (USD)
                  wholesale_subscription_price: '0.0'
                  display_wholesale_subscription_price: $0.00 (USD)
                - id: 711
                  tax: '0.0'
                  price: '22.27'
                  country:
                    id: 66
                    iso: FJ
                    iso3: FJI
                    name: Fiji
                    iso_name: FIJI
                    tax_rate: 0
                  shipping: '0.0'
                  country_iso: FJ
                  currency_code: USD
                  display_price: $22.27 (USD)
                  currency_symbol: $
                  wholesale_price: '0.0'
                  subscription_price: '22.27'
                  display_wholesale_price: $0.00 (USD)
                  wholesale_subscription_price: '0.0'
                  display_wholesale_subscription_price: $0.00 (USD)
                - id: 712
                  tax: '0.0'
                  price: '22.27'
                  country:
                    id: 93
                    iso: ID
                    iso3: IDN
                    name: Indonesia
                    iso_name: INDONESIA
                    tax_rate: 0
                  shipping: '0.0'
                  country_iso: ID
                  currency_code: USD
                  display_price: $22.27 (USD)
                  currency_symbol: $
                  wholesale_price: '0.0'
                  subscription_price: '22.27'
                  display_wholesale_price: $0.00 (USD)
                  wholesale_subscription_price: '0.0'
                  display_wholesale_subscription_price: $0.00 (USD)
                - id: 713
                  tax: '0.0'
                  price: '22.27'
                  country:
                    id: 147
                    iso: NE
                    iso3: NER
                    name: Niger
                    iso_name: NIGER
                    tax_rate: 0
                  shipping: '0.0'
                  country_iso: NE
                  currency_code: USD
                  display_price: $22.27 (USD)
                  currency_symbol: $
                  wholesale_price: '0.0'
                  subscription_price: '22.27'
                  display_wholesale_price: $0.00 (USD)
                  wholesale_subscription_price: '0.0'
                  display_wholesale_subscription_price: $0.00 (USD)
                - id: 714
                  tax: '0.0'
                  price: '22.27'
                  country:
                    id: 67
                    iso: FI
                    iso3: FIN
                    name: Finland
                    iso_name: FINLAND
                    tax_rate: 0
                  shipping: '0.0'
                  country_iso: FI
                  currency_code: USD
                  display_price: $22.27 (USD)
                  currency_symbol: $
                  wholesale_price: '0.0'
                  subscription_price: '22.27'
                  display_wholesale_price: $0.00 (USD)
                  wholesale_subscription_price: '0.0'
                  display_wholesale_subscription_price: $0.00 (USD)
              allow_subscription: true
          countries:
            - id: 214
              iso: US
              itn: false
              iso3: USA
              name: United States
              state: true
              active: true
              numcode: 840
              address3: false
              iso_name: UNITED STATES
              passport: false
              tax_rate: 0
              delimiter: ','
              separator: .
              currency_code: USD
              currency_symbol: $
          image_url: >-
            https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
          commission: '10.0'
          country_id: null
          share_link: null
          shopify_id: null
          description:
            id: 124
            body: Reactive intermediate moderator
            name: description
            record_id: 115
            created_at: '2023-12-26T04:49:52.800Z'
            updated_at: '2023-12-26T04:49:52.800Z'
            record_type: Product
          price_range:
            - $22.27
            - $22.27
          country_code: us
          currency_code: USD
          display_price: ''
          option_values: null
          average_rating: 0
          shopify_handle: null
          currency_symbol: $
          default_variant:
            id: 115
            sku: HTPGX14SE7
            size: 2 cm
            price: null
            title: Default Variant
            width: null
            active: true
            height: null
            length: null
            weight: 20 kg
            hs_code: null
            taxable: true
            bar_code: null
            physical: null
            position: 1
            image_url: null
            is_master: true
            created_at: '2023-12-26T04:49:52.811Z'
            image_path: null
            product_id: 115
            shopify_id: null
            updated_at: '2023-12-26T04:49:52.811Z'
            external_id: null
            discarded_at: null
            keep_selling: false
            option_attrs: []
            unit_of_size: null
            track_quantity: true
            unit_of_weight: null
            inventory_policy: none
            country_of_origin: null
            allow_subscription: true
            inventory_quantity: 1
            variant_country_id: null
            customs_information_shipping: null
          enroll_products: []
          wholesale_price: null
          subscription_price: null
          unlimited_inventory: false
          publish_to_rep_store: true
          publish_to_share_tab: true
          price_range_formatted: $22.27
          display_wholesale_price: ''
          publish_to_retail_store: true
          display_subscription_price: null
          wholesale_subscription_price: null
          display_wholesale_subscription_price: null
    Product17:
      title: Product17
      required:
        - id
        - sku
        - image
        - leads
        - price
        - title
        - views
        - active
        - images
        - public
        - vendor
        - enrolls
        - options
        - prompts
        - in_stock
        - shipping
        - stripped
        - variants
        - countries
        - image_url
        - commission
        - country_id
        - share_link
        - shopify_id
        - description
        - price_range
        - country_code
        - currency_code
        - display_price
        - option_values
        - average_rating
        - shopify_handle
        - currency_symbol
        - default_variant
        - enroll_products
        - wholesale_price
        - subscription_price
        - unlimited_inventory
        - publish_to_rep_store
        - publish_to_share_tab
        - price_range_formatted
        - display_wholesale_price
        - publish_to_retail_store
        - display_subscription_price
        - wholesale_subscription_price
        - display_wholesale_subscription_price
      type: object
      properties:
        id:
          type: integer
          format: int32
        sku:
          type: string
        image:
          allOf:
            - $ref: '#/components/schemas/Image3'
            - {}
        leads:
          type: integer
          format: int32
        price:
          type: string
        title:
          type: string
        views:
          type: integer
          format: int32
        active:
          type: boolean
        images:
          type: array
          items:
            type: string
          description: ''
        public:
          type: boolean
        vendor:
          type: string
        enrolls:
          type: array
          items:
            type: string
          description: ''
        options:
          type: array
          items:
            type: string
          description: ''
        prompts:
          type: array
          items:
            type: string
          description: ''
        in_stock:
          type: boolean
        shipping:
          type: string
        stripped:
          type: string
        variants:
          type: array
          items:
            $ref: '#/components/schemas/Variant9'
          description: ''
        countries:
          type: array
          items:
            $ref: '#/components/schemas/Country7'
          description: ''
        image_url:
          type: string
        commission:
          type: string
        country_id:
          type: string
        share_link:
          type: string
        shopify_id:
          type: string
        description:
          allOf:
            - $ref: '#/components/schemas/Description'
            - {}
        price_range:
          type: array
          items:
            type: string
          description: ''
        country_code:
          type: string
        currency_code:
          type: string
        display_price:
          type: string
        option_values:
          type: string
        average_rating:
          type: integer
          format: int32
        shopify_handle:
          type: string
        currency_symbol:
          type: string
        default_variant:
          allOf:
            - $ref: '#/components/schemas/DefaultVariant5'
            - {}
        enroll_products:
          type: array
          items:
            type: string
          description: ''
        wholesale_price:
          type: string
        subscription_price:
          type: string
        unlimited_inventory:
          type: boolean
        publish_to_rep_store:
          type: boolean
        publish_to_share_tab:
          type: boolean
        price_range_formatted:
          type: string
        display_wholesale_price:
          type: string
        publish_to_retail_store:
          type: boolean
        display_subscription_price:
          type: string
        wholesale_subscription_price:
          type: string
        display_wholesale_subscription_price:
          type: string
      example:
        id: 115
        sku: HTPGX14SE7
        image:
          full: >-
            https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
          mini: >-
            https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
          detail: >-
            https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
        leads: 0
        price: null
        title: Awesome Copper Computer45
        views: 0
        active: false
        images: []
        public: true
        vendor: null
        enrolls: []
        options: []
        prompts: []
        in_stock: true
        shipping: '4.7'
        stripped: Reactive intermediate moderator
        variants:
          - id: 115
            title: Default Variant
            buyable: true
            image_url: null
            option_value_ids: []
            variant_countries:
              - id: 706
                tax: '0.0'
                price: '22.27'
                country:
                  id: 214
                  iso: US
                  iso3: USA
                  name: United States
                  iso_name: UNITED STATES
                  tax_rate: 0
                shipping: '0.0'
                country_iso: US
                currency_code: USD
                display_price: $22.27 (USD)
                currency_symbol: $
                wholesale_price: '0.0'
                subscription_price: '22.27'
                display_wholesale_price: $0.00 (USD)
                wholesale_subscription_price: '0.0'
                display_wholesale_subscription_price: $0.00 (USD)
              - id: 707
                tax: '0.0'
                price: '22.27'
                country:
                  id: 65
                  iso: FO
                  iso3: FRO
                  name: Faroe Islands
                  iso_name: FAROE ISLANDS
                  tax_rate: 0
                shipping: '0.0'
                country_iso: FO
                currency_code: USD
                display_price: $22.27 (USD)
                currency_symbol: $
                wholesale_price: '0.0'
                subscription_price: '22.27'
                display_wholesale_price: $0.00 (USD)
                wholesale_subscription_price: '0.0'
                display_wholesale_subscription_price: $0.00 (USD)
              - id: 708
                tax: '0.0'
                price: '22.27'
                country:
                  id: 92
                  iso: IN
                  iso3: IND
                  name: India
                  iso_name: INDIA
                  tax_rate: 0
                shipping: '0.0'
                country_iso: IN
                currency_code: USD
                display_price: $22.27 (USD)
                currency_symbol: $
                wholesale_price: '0.0'
                subscription_price: '22.27'
                display_wholesale_price: $0.00 (USD)
                wholesale_subscription_price: '0.0'
                display_wholesale_subscription_price: $0.00 (USD)
              - id: 709
                tax: '0.0'
                price: '22.27'
                country:
                  id: 146
                  iso: NI
                  iso3: NIC
                  name: Nicaragua
                  iso_name: NICARAGUA
                  tax_rate: 0
                shipping: '0.0'
                country_iso: NI
                currency_code: USD
                display_price: $22.27 (USD)
                currency_symbol: $
                wholesale_price: '0.0'
                subscription_price: '22.27'
                display_wholesale_price: $0.00 (USD)
                wholesale_subscription_price: '0.0'
                display_wholesale_subscription_price: $0.00 (USD)
              - id: 710
                tax: '0.0'
                price: '22.27'
                country:
                  id: 172
                  iso: LC
                  iso3: LCA
                  name: Saint Lucia
                  iso_name: SAINT LUCIA
                  tax_rate: 0
                shipping: '0.0'
                country_iso: LC
                currency_code: USD
                display_price: $22.27 (USD)
                currency_symbol: $
                wholesale_price: '0.0'
                subscription_price: '22.27'
                display_wholesale_price: $0.00 (USD)
                wholesale_subscription_price: '0.0'
                display_wholesale_subscription_price: $0.00 (USD)
              - id: 711
                tax: '0.0'
                price: '22.27'
                country:
                  id: 66
                  iso: FJ
                  iso3: FJI
                  name: Fiji
                  iso_name: FIJI
                  tax_rate: 0
                shipping: '0.0'
                country_iso: FJ
                currency_code: USD
                display_price: $22.27 (USD)
                currency_symbol: $
                wholesale_price: '0.0'
                subscription_price: '22.27'
                display_wholesale_price: $0.00 (USD)
                wholesale_subscription_price: '0.0'
                display_wholesale_subscription_price: $0.00 (USD)
              - id: 712
                tax: '0.0'
                price: '22.27'
                country:
                  id: 93
                  iso: ID
                  iso3: IDN
                  name: Indonesia
                  iso_name: INDONESIA
                  tax_rate: 0
                shipping: '0.0'
                country_iso: ID
                currency_code: USD
                display_price: $22.27 (USD)
                currency_symbol: $
                wholesale_price: '0.0'
                subscription_price: '22.27'
                display_wholesale_price: $0.00 (USD)
                wholesale_subscription_price: '0.0'
                display_wholesale_subscription_price: $0.00 (USD)
              - id: 713
                tax: '0.0'
                price: '22.27'
                country:
                  id: 147
                  iso: NE
                  iso3: NER
                  name: Niger
                  iso_name: NIGER
                  tax_rate: 0
                shipping: '0.0'
                country_iso: NE
                currency_code: USD
                display_price: $22.27 (USD)
                currency_symbol: $
                wholesale_price: '0.0'
                subscription_price: '22.27'
                display_wholesale_price: $0.00 (USD)
                wholesale_subscription_price: '0.0'
                display_wholesale_subscription_price: $0.00 (USD)
              - id: 714
                tax: '0.0'
                price: '22.27'
                country:
                  id: 67
                  iso: FI
                  iso3: FIN
                  name: Finland
                  iso_name: FINLAND
                  tax_rate: 0
                shipping: '0.0'
                country_iso: FI
                currency_code: USD
                display_price: $22.27 (USD)
                currency_symbol: $
                wholesale_price: '0.0'
                subscription_price: '22.27'
                display_wholesale_price: $0.00 (USD)
                wholesale_subscription_price: '0.0'
                display_wholesale_subscription_price: $0.00 (USD)
            allow_subscription: true
        countries:
          - id: 214
            iso: US
            itn: false
            iso3: USA
            name: United States
            state: true
            active: true
            numcode: 840
            address3: false
            iso_name: UNITED STATES
            passport: false
            tax_rate: 0
            delimiter: ','
            separator: .
            currency_code: USD
            currency_symbol: $
        image_url: >-
          https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
        commission: '10.0'
        country_id: null
        share_link: null
        shopify_id: null
        description:
          id: 124
          body: Reactive intermediate moderator
          name: description
          record_id: 115
          created_at: '2023-12-26T04:49:52.800Z'
          updated_at: '2023-12-26T04:49:52.800Z'
          record_type: Product
        price_range:
          - $22.27
          - $22.27
        country_code: us
        currency_code: USD
        display_price: ''
        option_values: null
        average_rating: 0
        shopify_handle: null
        currency_symbol: $
        default_variant:
          id: 115
          sku: HTPGX14SE7
          size: 2 cm
          price: null
          title: Default Variant
          width: null
          active: true
          height: null
          length: null
          weight: 20 kg
          hs_code: null
          taxable: true
          bar_code: null
          physical: null
          position: 1
          image_url: null
          is_master: true
          created_at: '2023-12-26T04:49:52.811Z'
          image_path: null
          product_id: 115
          shopify_id: null
          updated_at: '2023-12-26T04:49:52.811Z'
          external_id: null
          discarded_at: null
          keep_selling: false
          option_attrs: []
          unit_of_size: null
          track_quantity: true
          unit_of_weight: null
          inventory_policy: none
          country_of_origin: null
          allow_subscription: true
          inventory_quantity: 1
          variant_country_id: null
          customs_information_shipping: null
        enroll_products: []
        wholesale_price: null
        subscription_price: null
        unlimited_inventory: false
        publish_to_rep_store: true
        publish_to_share_tab: true
        price_range_formatted: $22.27
        display_wholesale_price: ''
        publish_to_retail_store: true
        display_subscription_price: null
        wholesale_subscription_price: null
        display_wholesale_subscription_price: null
    product_updated:
      title: product_updated
      required:
        - id
        - name
        - payload
        - timestamp
        - identifier
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        payload:
          allOf:
            - $ref: '#/components/schemas/Payload13'
            - {}
        timestamp:
          type: string
        identifier:
          type: string
      example:
        id: 29
        name: product_updated
        payload:
          product:
            id: 113
            sku: QDPF7N2XOR
            image:
              full: >-
                https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
              mini: >-
                https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
              detail: >-
                https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
            leads: 0
            price: null
            title: 'Aerodynamic Aluminum '
            views: 0
            active: true
            images: []
            public: true
            vendor: null
            enrolls: []
            options: []
            prompts: []
            in_stock: true
            shipping: '0.03'
            stripped: Optimized clear-thinking access
            variants:
              - id: 113
                title: Default Variant
                buyable: true
                image_url: null
                option_value_ids: []
                variant_countries:
                  - id: 686
                    tax: '0.0'
                    price: '17.32'
                    country:
                      id: 214
                      iso: US
                      iso3: USA
                      name: United States
                      iso_name: UNITED STATES
                      tax_rate: 0
                    shipping: '0.0'
                    country_iso: US
                    currency_code: USD
                    display_price: $17.32 (USD)
                    currency_symbol: $
                    wholesale_price: '0.0'
                    subscription_price: '17.32'
                    display_wholesale_price: $0.00 (USD)
                    wholesale_subscription_price: '0.0'
                    display_wholesale_subscription_price: $0.00 (USD)
                  - id: 687
                    tax: '0.0'
                    price: '17.32'
                    country:
                      id: 65
                      iso: FO
                      iso3: FRO
                      name: Faroe Islands
                      iso_name: FAROE ISLANDS
                      tax_rate: 0
                    shipping: '0.0'
                    country_iso: FO
                    currency_code: USD
                    display_price: $17.32 (USD)
                    currency_symbol: $
                    wholesale_price: '0.0'
                    subscription_price: '17.32'
                    display_wholesale_price: $0.00 (USD)
                    wholesale_subscription_price: '0.0'
                    display_wholesale_subscription_price: $0.00 (USD)
                  - id: 688
                    tax: '0.0'
                    price: '17.32'
                    country:
                      id: 92
                      iso: IN
                      iso3: IND
                      name: India
                      iso_name: INDIA
                      tax_rate: 0
                    shipping: '0.0'
                    country_iso: IN
                    currency_code: USD
                    display_price: $17.32 (USD)
                    currency_symbol: $
                    wholesale_price: '0.0'
                    subscription_price: '17.32'
                    display_wholesale_price: $0.00 (USD)
                    wholesale_subscription_price: '0.0'
                    display_wholesale_subscription_price: $0.00 (USD)
                  - id: 689
                    tax: '0.0'
                    price: '17.32'
                    country:
                      id: 146
                      iso: NI
                      iso3: NIC
                      name: Nicaragua
                      iso_name: NICARAGUA
                      tax_rate: 0
                    shipping: '0.0'
                    country_iso: NI
                    currency_code: USD
                    display_price: $17.32 (USD)
                    currency_symbol: $
                    wholesale_price: '0.0'
                    subscription_price: '17.32'
                    display_wholesale_price: $0.00 (USD)
                    wholesale_subscription_price: '0.0'
                    display_wholesale_subscription_price: $0.00 (USD)
                  - id: 690
                    tax: '0.0'
                    price: '17.32'
                    country:
                      id: 172
                      iso: LC
                      iso3: LCA
                      name: Saint Lucia
                      iso_name: SAINT LUCIA
                      tax_rate: 0
                    shipping: '0.0'
                    country_iso: LC
                    currency_code: USD
                    display_price: $17.32 (USD)
                    currency_symbol: $
                    wholesale_price: '0.0'
                    subscription_price: '17.32'
                    display_wholesale_price: $0.00 (USD)
                    wholesale_subscription_price: '0.0'
                    display_wholesale_subscription_price: $0.00 (USD)
                  - id: 691
                    tax: '0.0'
                    price: '17.32'
                    country:
                      id: 66
                      iso: FJ
                      iso3: FJI
                      name: Fiji
                      iso_name: FIJI
                      tax_rate: 0
                    shipping: '0.0'
                    country_iso: FJ
                    currency_code: USD
                    display_price: $17.32 (USD)
                    currency_symbol: $
                    wholesale_price: '0.0'
                    subscription_price: '17.32'
                    display_wholesale_price: $0.00 (USD)
                    wholesale_subscription_price: '0.0'
                    display_wholesale_subscription_price: $0.00 (USD)
                  - id: 692
                    tax: '0.0'
                    price: '17.32'
                    country:
                      id: 93
                      iso: ID
                      iso3: IDN
                      name: Indonesia
                      iso_name: INDONESIA
                      tax_rate: 0
                    shipping: '0.0'
                    country_iso: ID
                    currency_code: USD
                    display_price: $17.32 (USD)
                    currency_symbol: $
                    wholesale_price: '0.0'
                    subscription_price: '17.32'
                    display_wholesale_price: $0.00 (USD)
                    wholesale_subscription_price: '0.0'
                    display_wholesale_subscription_price: $0.00 (USD)
                  - id: 693
                    tax: '0.0'
                    price: '17.32'
                    country:
                      id: 147
                      iso: NE
                      iso3: NER
                      name: Niger
                      iso_name: NIGER
                      tax_rate: 0
                    shipping: '0.0'
                    country_iso: NE
                    currency_code: USD
                    display_price: $17.32 (USD)
                    currency_symbol: $
                    wholesale_price: '0.0'
                    subscription_price: '17.32'
                    display_wholesale_price: $0.00 (USD)
                    wholesale_subscription_price: '0.0'
                    display_wholesale_subscription_price: $0.00 (USD)
                  - id: 694
                    tax: '0.0'
                    price: '17.32'
                    country:
                      id: 67
                      iso: FI
                      iso3: FIN
                      name: Finland
                      iso_name: FINLAND
                      tax_rate: 0
                    shipping: '0.0'
                    country_iso: FI
                    currency_code: USD
                    display_price: $17.32 (USD)
                    currency_symbol: $
                    wholesale_price: '0.0'
                    subscription_price: '17.32'
                    display_wholesale_price: $0.00 (USD)
                    wholesale_subscription_price: '0.0'
                    display_wholesale_subscription_price: $0.00 (USD)
                  - id: 695
                    tax: '0.0'
                    price: '17.32'
                    country:
                      id: 148
                      iso: NG
                      iso3: NGA
                      name: Nigeria
                      iso_name: NIGERIA
                      tax_rate: 0
                    shipping: '0.0'
                    country_iso: NG
                    currency_code: USD
                    display_price: $17.32 (USD)
                    currency_symbol: $
                    wholesale_price: '0.0'
                    subscription_price: '17.32'
                    display_wholesale_price: $0.00 (USD)
                    wholesale_subscription_price: '0.0'
                    display_wholesale_subscription_price: $0.00 (USD)
                allow_subscription: true
            countries:
              - id: 214
                iso: US
                itn: false
                iso3: USA
                name: United States
                state: true
                active: true
                numcode: 840
                address3: false
                iso_name: UNITED STATES
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: USD
                currency_symbol: $
              - id: 65
                iso: FO
                itn: false
                iso3: FRO
                name: Faroe Islands
                state: true
                active: true
                numcode: 234
                address3: false
                iso_name: FAROE ISLANDS
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: DKK
                currency_symbol: kr.
              - id: 92
                iso: IN
                itn: false
                iso3: IND
                name: India
                state: true
                active: true
                numcode: 356
                address3: false
                iso_name: INDIA
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: INR
                currency_symbol: ₹
              - id: 146
                iso: NI
                itn: false
                iso3: NIC
                name: Nicaragua
                state: true
                active: true
                numcode: 558
                address3: false
                iso_name: NICARAGUA
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: NIO
                currency_symbol: C$
              - id: 172
                iso: LC
                itn: false
                iso3: LCA
                name: Saint Lucia
                state: true
                active: true
                numcode: 662
                address3: false
                iso_name: SAINT LUCIA
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: XCD
                currency_symbol: $
              - id: 66
                iso: FJ
                itn: false
                iso3: FJI
                name: Fiji
                state: true
                active: true
                numcode: 242
                address3: false
                iso_name: FIJI
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: FJD
                currency_symbol: $
              - id: 93
                iso: ID
                itn: false
                iso3: IDN
                name: Indonesia
                state: true
                active: true
                numcode: 360
                address3: false
                iso_name: INDONESIA
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: IDR
                currency_symbol: Rp
              - id: 147
                iso: NE
                itn: false
                iso3: NER
                name: Niger
                state: true
                active: true
                numcode: 562
                address3: false
                iso_name: NIGER
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: XOF
                currency_symbol: Fr
              - id: 67
                iso: FI
                itn: false
                iso3: FIN
                name: Finland
                state: true
                active: true
                numcode: 246
                address3: false
                iso_name: FINLAND
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: EUR
                currency_symbol: €
              - id: 148
                iso: NG
                itn: false
                iso3: NGA
                name: Nigeria
                state: true
                active: true
                numcode: 566
                address3: false
                iso_name: NIGERIA
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: NGN
                currency_symbol: ₦
              - id: 174
                iso: VC
                itn: false
                iso3: VCT
                name: Saint Vincent and the Grenadines
                state: true
                active: true
                numcode: 670
                address3: false
                iso_name: SAINT VINCENT AND THE GRENADINES
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: XCD
                currency_symbol: $
              - id: 68
                iso: FR
                itn: false
                iso3: FRA
                name: France
                state: true
                active: true
                numcode: 250
                address3: false
                iso_name: FRANCE
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: EUR
                currency_symbol: €
              - id: 94
                iso: IR
                itn: false
                iso3: IRN
                name: Iran, Islamic Republic of
                state: true
                active: true
                numcode: 364
                address3: false
                iso_name: IRAN, ISLAMIC REPUBLIC OF
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: IRR
                currency_symbol: ﷼
              - id: 149
                iso: NU
                itn: false
                iso3: NIU
                name: Niue
                state: true
                active: true
                numcode: 570
                address3: false
                iso_name: NIUE
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: NZD
                currency_symbol: $
              - id: 175
                iso: WS
                itn: false
                iso3: WSM
                name: Samoa
                state: true
                active: true
                numcode: 882
                address3: false
                iso_name: SAMOA
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: WST
                currency_symbol: T
              - id: 69
                iso: GF
                itn: false
                iso3: GUF
                name: French Guiana
                state: true
                active: true
                numcode: 254
                address3: false
                iso_name: FRENCH GUIANA
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: EUR
                currency_symbol: €
              - id: 95
                iso: IQ
                itn: false
                iso3: IRQ
                name: Iraq
                state: true
                active: true
                numcode: 368
                address3: false
                iso_name: IRAQ
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: IQD
                currency_symbol: ع.د
              - id: 176
                iso: SM
                itn: false
                iso3: SMR
                name: San Marino
                state: true
                active: true
                numcode: 674
                address3: false
                iso_name: SAN MARINO
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: EUR
                currency_symbol: €
              - id: 96
                iso: IE
                itn: false
                iso3: IRL
                name: Ireland
                state: true
                active: true
                numcode: 372
                address3: false
                iso_name: IRELAND
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: EUR
                currency_symbol: €
              - id: 177
                iso: ST
                itn: false
                iso3: STP
                name: Sao Tome and Principe
                state: true
                active: true
                numcode: 678
                address3: false
                iso_name: SAO TOME AND PRINCIPE
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: STD
                currency_symbol: Db
              - id: 39
                iso: TD
                itn: false
                iso3: TCD
                name: Chad
                state: true
                active: true
                numcode: 148
                address3: false
                iso_name: CHAD
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: XAF
                currency_symbol: CFA
              - id: 173
                iso: PM
                itn: false
                iso3: SPM
                name: Saint Pierre and Miquelon
                state: true
                active: true
                numcode: 666
                address3: false
                iso_name: SAINT PIERRE AND MIQUELON
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: EUR
                currency_symbol: €
            image_url: >-
              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
            commission: '10.0'
            country_id: null
            share_link: null
            shopify_id: null
            description:
              id: 122
              body: <div>Optimized clear-thinking access</div>
              name: description
              record_id: 113
              created_at: '2023-12-26T04:49:52.800Z'
              updated_at: '2023-12-26T06:37:59.551Z'
              record_type: Product
            price_range:
              - $17.32
              - $17.32
            country_code: td
            currency_code: USD
            display_price: ''
            option_values: null
            average_rating: 0
            shopify_handle: null
            currency_symbol: $
            default_variant:
              id: 113
              sku: QDPF7N2XOR
              size: 4cm
              price: null
              title: Default Variant
              width: null
              active: true
              height: null
              length: null
              weight: 10 kg
              hs_code: null
              taxable: true
              bar_code: null
              physical: null
              position: 1
              image_url: null
              is_master: true
              created_at: '2023-12-26T04:49:52.811Z'
              image_path: null
              product_id: 113
              shopify_id: null
              updated_at: '2023-12-26T08:32:24.878Z'
              external_id: null
              discarded_at: null
              keep_selling: false
              option_attrs: []
              unit_of_size: null
              track_quantity: true
              unit_of_weight: null
              inventory_policy: none
              country_of_origin: null
              allow_subscription: true
              inventory_quantity: 100
              variant_country_id: null
              customs_information_shipping: null
            enroll_products: []
            wholesale_price: null
            subscription_price: null
            unlimited_inventory: false
            publish_to_rep_store: true
            publish_to_share_tab: true
            price_range_formatted: $17.32
            display_wholesale_price: ''
            publish_to_retail_store: true
            display_subscription_price: null
            wholesale_subscription_price: null
            display_wholesale_subscription_price: null
        timestamp: '2023-12-26T08:32:25.284Z'
        identifier: product-1703579545113
    product_destroyed:
      title: product_destroyed
      required:
        - id
        - name
        - payload
        - timestamp
        - identifier
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        payload:
          allOf:
            - $ref: '#/components/schemas/Payload13'
            - {}
        timestamp:
          type: string
        identifier:
          type: string
      example:
        id: 105
        name: product_destroyed
        payload:
          product:
            id: 115
            sku: HTPGX14SE7
            image:
              full: >-
                https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
              mini: >-
                https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
              detail: >-
                https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
            leads: 0
            price: null
            title: Awesome Copper Computer45
            views: 0
            active: false
            images: []
            public: true
            vendor: null
            enrolls: []
            options: []
            prompts: []
            in_stock: true
            shipping: '4.7'
            stripped: Reactive intermediate moderator
            variants:
              - id: 115
                title: Default Variant
                buyable: true
                image_url: null
                option_value_ids: []
                variant_countries:
                  - id: 706
                    tax: '0.0'
                    price: '22.27'
                    country:
                      id: 214
                      iso: US
                      iso3: USA
                      name: United States
                      iso_name: UNITED STATES
                      tax_rate: 0
                    shipping: '0.0'
                    country_iso: US
                    currency_code: USD
                    display_price: $22.27 (USD)
                    currency_symbol: $
                    wholesale_price: '0.0'
                    subscription_price: '22.27'
                    display_wholesale_price: $0.00 (USD)
                    wholesale_subscription_price: '0.0'
                    display_wholesale_subscription_price: $0.00 (USD)
                  - id: 707
                    tax: '0.0'
                    price: '22.27'
                    country:
                      id: 65
                      iso: FO
                      iso3: FRO
                      name: Faroe Islands
                      iso_name: FAROE ISLANDS
                      tax_rate: 0
                    shipping: '0.0'
                    country_iso: FO
                    currency_code: USD
                    display_price: $22.27 (USD)
                    currency_symbol: $
                    wholesale_price: '0.0'
                    subscription_price: '22.27'
                    display_wholesale_price: $0.00 (USD)
                    wholesale_subscription_price: '0.0'
                    display_wholesale_subscription_price: $0.00 (USD)
                  - id: 708
                    tax: '0.0'
                    price: '22.27'
                    country:
                      id: 92
                      iso: IN
                      iso3: IND
                      name: India
                      iso_name: INDIA
                      tax_rate: 0
                    shipping: '0.0'
                    country_iso: IN
                    currency_code: USD
                    display_price: $22.27 (USD)
                    currency_symbol: $
                    wholesale_price: '0.0'
                    subscription_price: '22.27'
                    display_wholesale_price: $0.00 (USD)
                    wholesale_subscription_price: '0.0'
                    display_wholesale_subscription_price: $0.00 (USD)
                  - id: 709
                    tax: '0.0'
                    price: '22.27'
                    country:
                      id: 146
                      iso: NI
                      iso3: NIC
                      name: Nicaragua
                      iso_name: NICARAGUA
                      tax_rate: 0
                    shipping: '0.0'
                    country_iso: NI
                    currency_code: USD
                    display_price: $22.27 (USD)
                    currency_symbol: $
                    wholesale_price: '0.0'
                    subscription_price: '22.27'
                    display_wholesale_price: $0.00 (USD)
                    wholesale_subscription_price: '0.0'
                    display_wholesale_subscription_price: $0.00 (USD)
                  - id: 710
                    tax: '0.0'
                    price: '22.27'
                    country:
                      id: 172
                      iso: LC
                      iso3: LCA
                      name: Saint Lucia
                      iso_name: SAINT LUCIA
                      tax_rate: 0
                    shipping: '0.0'
                    country_iso: LC
                    currency_code: USD
                    display_price: $22.27 (USD)
                    currency_symbol: $
                    wholesale_price: '0.0'
                    subscription_price: '22.27'
                    display_wholesale_price: $0.00 (USD)
                    wholesale_subscription_price: '0.0'
                    display_wholesale_subscription_price: $0.00 (USD)
                  - id: 711
                    tax: '0.0'
                    price: '22.27'
                    country:
                      id: 66
                      iso: FJ
                      iso3: FJI
                      name: Fiji
                      iso_name: FIJI
                      tax_rate: 0
                    shipping: '0.0'
                    country_iso: FJ
                    currency_code: USD
                    display_price: $22.27 (USD)
                    currency_symbol: $
                    wholesale_price: '0.0'
                    subscription_price: '22.27'
                    display_wholesale_price: $0.00 (USD)
                    wholesale_subscription_price: '0.0'
                    display_wholesale_subscription_price: $0.00 (USD)
                  - id: 712
                    tax: '0.0'
                    price: '22.27'
                    country:
                      id: 93
                      iso: ID
                      iso3: IDN
                      name: Indonesia
                      iso_name: INDONESIA
                      tax_rate: 0
                    shipping: '0.0'
                    country_iso: ID
                    currency_code: USD
                    display_price: $22.27 (USD)
                    currency_symbol: $
                    wholesale_price: '0.0'
                    subscription_price: '22.27'
                    display_wholesale_price: $0.00 (USD)
                    wholesale_subscription_price: '0.0'
                    display_wholesale_subscription_price: $0.00 (USD)
                  - id: 713
                    tax: '0.0'
                    price: '22.27'
                    country:
                      id: 147
                      iso: NE
                      iso3: NER
                      name: Niger
                      iso_name: NIGER
                      tax_rate: 0
                    shipping: '0.0'
                    country_iso: NE
                    currency_code: USD
                    display_price: $22.27 (USD)
                    currency_symbol: $
                    wholesale_price: '0.0'
                    subscription_price: '22.27'
                    display_wholesale_price: $0.00 (USD)
                    wholesale_subscription_price: '0.0'
                    display_wholesale_subscription_price: $0.00 (USD)
                  - id: 714
                    tax: '0.0'
                    price: '22.27'
                    country:
                      id: 67
                      iso: FI
                      iso3: FIN
                      name: Finland
                      iso_name: FINLAND
                      tax_rate: 0
                    shipping: '0.0'
                    country_iso: FI
                    currency_code: USD
                    display_price: $22.27 (USD)
                    currency_symbol: $
                    wholesale_price: '0.0'
                    subscription_price: '22.27'
                    display_wholesale_price: $0.00 (USD)
                    wholesale_subscription_price: '0.0'
                    display_wholesale_subscription_price: $0.00 (USD)
                allow_subscription: true
            countries:
              - id: 214
                iso: US
                itn: false
                iso3: USA
                name: United States
                state: true
                active: true
                numcode: 840
                address3: false
                iso_name: UNITED STATES
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: USD
                currency_symbol: $
              - id: 65
                iso: FO
                itn: false
                iso3: FRO
                name: Faroe Islands
                state: true
                active: true
                numcode: 234
                address3: false
                iso_name: FAROE ISLANDS
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: DKK
                currency_symbol: kr.
              - id: 92
                iso: IN
                itn: false
                iso3: IND
                name: India
                state: true
                active: true
                numcode: 356
                address3: false
                iso_name: INDIA
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: INR
                currency_symbol: ₹
              - id: 146
                iso: NI
                itn: false
                iso3: NIC
                name: Nicaragua
                state: true
                active: true
                numcode: 558
                address3: false
                iso_name: NICARAGUA
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: NIO
                currency_symbol: C$
              - id: 172
                iso: LC
                itn: false
                iso3: LCA
                name: Saint Lucia
                state: true
                active: true
                numcode: 662
                address3: false
                iso_name: SAINT LUCIA
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: XCD
                currency_symbol: $
              - id: 66
                iso: FJ
                itn: false
                iso3: FJI
                name: Fiji
                state: true
                active: true
                numcode: 242
                address3: false
                iso_name: FIJI
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: FJD
                currency_symbol: $
              - id: 93
                iso: ID
                itn: false
                iso3: IDN
                name: Indonesia
                state: true
                active: true
                numcode: 360
                address3: false
                iso_name: INDONESIA
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: IDR
                currency_symbol: Rp
              - id: 147
                iso: NE
                itn: false
                iso3: NER
                name: Niger
                state: true
                active: true
                numcode: 562
                address3: false
                iso_name: NIGER
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: XOF
                currency_symbol: Fr
              - id: 67
                iso: FI
                itn: false
                iso3: FIN
                name: Finland
                state: true
                active: true
                numcode: 246
                address3: false
                iso_name: FINLAND
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: EUR
                currency_symbol: €
              - id: 148
                iso: NG
                itn: false
                iso3: NGA
                name: Nigeria
                state: true
                active: true
                numcode: 566
                address3: false
                iso_name: NIGERIA
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: NGN
                currency_symbol: ₦
              - id: 174
                iso: VC
                itn: false
                iso3: VCT
                name: Saint Vincent and the Grenadines
                state: true
                active: true
                numcode: 670
                address3: false
                iso_name: SAINT VINCENT AND THE GRENADINES
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: XCD
                currency_symbol: $
              - id: 68
                iso: FR
                itn: false
                iso3: FRA
                name: France
                state: true
                active: true
                numcode: 250
                address3: false
                iso_name: FRANCE
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: EUR
                currency_symbol: €
              - id: 94
                iso: IR
                itn: false
                iso3: IRN
                name: Iran, Islamic Republic of
                state: true
                active: true
                numcode: 364
                address3: false
                iso_name: IRAN, ISLAMIC REPUBLIC OF
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: IRR
                currency_symbol: ﷼
              - id: 149
                iso: NU
                itn: false
                iso3: NIU
                name: Niue
                state: true
                active: true
                numcode: 570
                address3: false
                iso_name: NIUE
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: NZD
                currency_symbol: $
              - id: 175
                iso: WS
                itn: false
                iso3: WSM
                name: Samoa
                state: true
                active: true
                numcode: 882
                address3: false
                iso_name: SAMOA
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: WST
                currency_symbol: T
              - id: 69
                iso: GF
                itn: false
                iso3: GUF
                name: French Guiana
                state: true
                active: true
                numcode: 254
                address3: false
                iso_name: FRENCH GUIANA
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: EUR
                currency_symbol: €
              - id: 95
                iso: IQ
                itn: false
                iso3: IRQ
                name: Iraq
                state: true
                active: true
                numcode: 368
                address3: false
                iso_name: IRAQ
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: IQD
                currency_symbol: ع.د
              - id: 176
                iso: SM
                itn: false
                iso3: SMR
                name: San Marino
                state: true
                active: true
                numcode: 674
                address3: false
                iso_name: SAN MARINO
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: EUR
                currency_symbol: €
              - id: 96
                iso: IE
                itn: false
                iso3: IRL
                name: Ireland
                state: true
                active: true
                numcode: 372
                address3: false
                iso_name: IRELAND
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: EUR
                currency_symbol: €
              - id: 177
                iso: ST
                itn: false
                iso3: STP
                name: Sao Tome and Principe
                state: true
                active: true
                numcode: 678
                address3: false
                iso_name: SAO TOME AND PRINCIPE
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: STD
                currency_symbol: Db
              - id: 39
                iso: TD
                itn: false
                iso3: TCD
                name: Chad
                state: true
                active: true
                numcode: 148
                address3: false
                iso_name: CHAD
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: XAF
                currency_symbol: CFA
              - id: 173
                iso: PM
                itn: false
                iso3: SPM
                name: Saint Pierre and Miquelon
                state: true
                active: true
                numcode: 666
                address3: false
                iso_name: SAINT PIERRE AND MIQUELON
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                currency_code: EUR
                currency_symbol: €
            image_url: >-
              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
            commission: '10.0'
            country_id: null
            share_link: null
            shopify_id: null
            description:
              id: 124
              body: Reactive intermediate moderator
              name: description
              record_id: 115
              created_at: '2023-12-26T04:49:52.800Z'
              updated_at: '2023-12-26T04:49:52.800Z'
              record_type: Product
            price_range:
              - $22.27
              - $22.27
            country_code: td
            currency_code: USD
            display_price: ''
            option_values: null
            average_rating: 0
            shopify_handle: null
            currency_symbol: $
            default_variant:
              id: 115
              sku: HTPGX14SE7
              size: 2 cm
              price: null
              title: Default Variant
              width: null
              active: true
              height: null
              length: null
              weight: 20 kg
              hs_code: null
              taxable: true
              bar_code: null
              physical: null
              position: 1
              image_url: null
              is_master: true
              created_at: '2023-12-26T04:49:52.811Z'
              image_path: null
              product_id: 115
              shopify_id: null
              updated_at: '2023-12-26T04:49:52.811Z'
              external_id: null
              discarded_at: null
              keep_selling: false
              option_attrs: []
              unit_of_size: null
              track_quantity: true
              unit_of_weight: null
              inventory_policy: none
              country_of_origin: null
              allow_subscription: true
              inventory_quantity: 1
              variant_country_id: null
              customs_information_shipping: null
            enroll_products: []
            wholesale_price: null
            subscription_price: null
            unlimited_inventory: false
            publish_to_rep_store: true
            publish_to_share_tab: true
            price_range_formatted: $22.27
            display_wholesale_price: ''
            publish_to_retail_store: true
            display_subscription_price: null
            wholesale_subscription_price: null
            display_wholesale_subscription_price: null
        timestamp: '2023-12-27T12:22:18.523Z'
        identifier: product-1703679738115
    subscription_started:
      title: subscription_started
      required:
        - id
        - name
        - payload
        - timestamp
        - identifier
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        payload:
          allOf:
            - $ref: '#/components/schemas/Payload16'
            - {}
        timestamp:
          type: string
        identifier:
          type: string
      example:
        id: 131
        name: subscription_started
        payload:
          subsctiption_order:
            cv: 0
            id: 53
            qv: 0
            tax: '0.0'
            type: SubscriptionOrder
            email: ram@fluid.com
            items:
              - id: 3
                sku: QDPF7N2XOR
                price: 17.32
                product:
                  id: 113
                  sku: QDPF7N2XOR
                  image:
                    full: >-
                      https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                    mini: >-
                      https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                    detail: >-
                      https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                  leads: 0
                  price: '17.32'
                  title: Aerodynamic Aluminum aaa
                  views: 0
                  active: true
                  images: []
                  public: true
                  vendor: null
                  enrolls: []
                  options: []
                  prompts: []
                  in_stock: true
                  shipping: '0.03'
                  stripped: Optimized clear-thinking access
                  variants:
                    - id: 113
                      title: Default Variant
                      buyable: true
                      image_url: null
                      option_value_ids: []
                      variant_countries:
                        - id: 686
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 214
                            iso: US
                            iso3: USA
                            name: United States
                            iso_name: UNITED STATES
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: US
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 687
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 65
                            iso: FO
                            iso3: FRO
                            name: Faroe Islands
                            iso_name: FAROE ISLANDS
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: FO
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 688
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 92
                            iso: IN
                            iso3: IND
                            name: India
                            iso_name: INDIA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: IN
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 689
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 146
                            iso: NI
                            iso3: NIC
                            name: Nicaragua
                            iso_name: NICARAGUA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: NI
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 690
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 172
                            iso: LC
                            iso3: LCA
                            name: Saint Lucia
                            iso_name: SAINT LUCIA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: LC
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 691
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 66
                            iso: FJ
                            iso3: FJI
                            name: Fiji
                            iso_name: FIJI
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: FJ
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 692
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 93
                            iso: ID
                            iso3: IDN
                            name: Indonesia
                            iso_name: INDONESIA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: ID
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 693
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 147
                            iso: NE
                            iso3: NER
                            name: Niger
                            iso_name: NIGER
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: NE
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 694
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 67
                            iso: FI
                            iso3: FIN
                            name: Finland
                            iso_name: FINLAND
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: FI
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 695
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 148
                            iso: NG
                            iso3: NGA
                            name: Nigeria
                            iso_name: NIGERIA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: NG
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                      allow_subscription: true
                  countries:
                    - id: 214
                      iso: US
                      itn: false
                      iso3: USA
                      name: United States
                      state: true
                      active: true
                      numcode: 840
                      address3: false
                      iso_name: UNITED STATES
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: USD
                      currency_symbol: $
                    - id: 65
                      iso: FO
                      itn: false
                      iso3: FRO
                      name: Faroe Islands
                      state: true
                      active: true
                      numcode: 234
                      address3: false
                      iso_name: FAROE ISLANDS
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: DKK
                      currency_symbol: kr.
                    - id: 92
                      iso: IN
                      itn: false
                      iso3: IND
                      name: India
                      state: true
                      active: true
                      numcode: 356
                      address3: false
                      iso_name: INDIA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: INR
                      currency_symbol: ₹
                    - id: 146
                      iso: NI
                      itn: false
                      iso3: NIC
                      name: Nicaragua
                      state: true
                      active: true
                      numcode: 558
                      address3: false
                      iso_name: NICARAGUA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: NIO
                      currency_symbol: C$
                    - id: 172
                      iso: LC
                      itn: false
                      iso3: LCA
                      name: Saint Lucia
                      state: true
                      active: true
                      numcode: 662
                      address3: false
                      iso_name: SAINT LUCIA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: XCD
                      currency_symbol: $
                    - id: 66
                      iso: FJ
                      itn: false
                      iso3: FJI
                      name: Fiji
                      state: true
                      active: true
                      numcode: 242
                      address3: false
                      iso_name: FIJI
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: FJD
                      currency_symbol: $
                    - id: 93
                      iso: ID
                      itn: false
                      iso3: IDN
                      name: Indonesia
                      state: true
                      active: true
                      numcode: 360
                      address3: false
                      iso_name: INDONESIA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: IDR
                      currency_symbol: Rp
                    - id: 147
                      iso: NE
                      itn: false
                      iso3: NER
                      name: Niger
                      state: true
                      active: true
                      numcode: 562
                      address3: false
                      iso_name: NIGER
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: XOF
                      currency_symbol: Fr
                    - id: 67
                      iso: FI
                      itn: false
                      iso3: FIN
                      name: Finland
                      state: true
                      active: true
                      numcode: 246
                      address3: false
                      iso_name: FINLAND
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 148
                      iso: NG
                      itn: false
                      iso3: NGA
                      name: Nigeria
                      state: true
                      active: true
                      numcode: 566
                      address3: false
                      iso_name: NIGERIA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: NGN
                      currency_symbol: ₦
                    - id: 174
                      iso: VC
                      itn: false
                      iso3: VCT
                      name: Saint Vincent and the Grenadines
                      state: true
                      active: true
                      numcode: 670
                      address3: false
                      iso_name: SAINT VINCENT AND THE GRENADINES
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: XCD
                      currency_symbol: $
                    - id: 68
                      iso: FR
                      itn: false
                      iso3: FRA
                      name: France
                      state: true
                      active: true
                      numcode: 250
                      address3: false
                      iso_name: FRANCE
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 94
                      iso: IR
                      itn: false
                      iso3: IRN
                      name: Iran, Islamic Republic of
                      state: true
                      active: true
                      numcode: 364
                      address3: false
                      iso_name: IRAN, ISLAMIC REPUBLIC OF
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: IRR
                      currency_symbol: ﷼
                    - id: 149
                      iso: NU
                      itn: false
                      iso3: NIU
                      name: Niue
                      state: true
                      active: true
                      numcode: 570
                      address3: false
                      iso_name: NIUE
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: NZD
                      currency_symbol: $
                    - id: 175
                      iso: WS
                      itn: false
                      iso3: WSM
                      name: Samoa
                      state: true
                      active: true
                      numcode: 882
                      address3: false
                      iso_name: SAMOA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: WST
                      currency_symbol: T
                    - id: 69
                      iso: GF
                      itn: false
                      iso3: GUF
                      name: French Guiana
                      state: true
                      active: true
                      numcode: 254
                      address3: false
                      iso_name: FRENCH GUIANA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 95
                      iso: IQ
                      itn: false
                      iso3: IRQ
                      name: Iraq
                      state: true
                      active: true
                      numcode: 368
                      address3: false
                      iso_name: IRAQ
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: IQD
                      currency_symbol: ع.د
                    - id: 176
                      iso: SM
                      itn: false
                      iso3: SMR
                      name: San Marino
                      state: true
                      active: true
                      numcode: 674
                      address3: false
                      iso_name: SAN MARINO
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 96
                      iso: IE
                      itn: false
                      iso3: IRL
                      name: Ireland
                      state: true
                      active: true
                      numcode: 372
                      address3: false
                      iso_name: IRELAND
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 177
                      iso: ST
                      itn: false
                      iso3: STP
                      name: Sao Tome and Principe
                      state: true
                      active: true
                      numcode: 678
                      address3: false
                      iso_name: SAO TOME AND PRINCIPE
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: STD
                      currency_symbol: Db
                    - id: 39
                      iso: TD
                      itn: false
                      iso3: TCD
                      name: Chad
                      state: true
                      active: true
                      numcode: 148
                      address3: false
                      iso_name: CHAD
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: XAF
                      currency_symbol: CFA
                    - id: 173
                      iso: PM
                      itn: false
                      iso3: SPM
                      name: Saint Pierre and Miquelon
                      state: true
                      active: true
                      numcode: 666
                      address3: false
                      iso_name: SAINT PIERRE AND MIQUELON
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                  image_url: >-
                    https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                  commission: '10.0'
                  country_id: null
                  share_link: null
                  shopify_id: null
                  description:
                    id: 122
                    body: <div>Optimized clear-thinking access</div>
                    name: description
                    record_id: 113
                    created_at: '2023-12-26T04:49:52.800Z'
                    updated_at: '2023-12-26T06:37:59.551Z'
                    record_type: Product
                  price_range:
                    - $17.32
                    - $17.32
                  country_code: td
                  currency_code: USD
                  display_price: $17.32 (USD)
                  option_values: {}
                  average_rating: 0
                  shopify_handle: null
                  currency_symbol: $
                  default_variant:
                    id: 113
                    sku: QDPF7N2XOR
                    size: 4cm
                    price: null
                    title: Default Variant
                    width: null
                    active: true
                    height: null
                    length: null
                    weight: 10 kg
                    hs_code: null
                    taxable: true
                    bar_code: null
                    physical: null
                    position: 1
                    image_url: null
                    is_master: true
                    created_at: '2023-12-26T04:49:52.811Z'
                    image_path: null
                    product_id: 113
                    shopify_id: null
                    updated_at: '2023-12-27T12:48:04.588Z'
                    external_id: null
                    discarded_at: null
                    keep_selling: false
                    option_attrs: []
                    unit_of_size: null
                    track_quantity: true
                    unit_of_weight: null
                    inventory_policy: none
                    country_of_origin: null
                    allow_subscription: true
                    inventory_quantity: 99
                    variant_country_id: null
                    customs_information_shipping: null
                  enroll_products: []
                  wholesale_price: '0.0'
                  subscription_price: '17.32'
                  unlimited_inventory: false
                  publish_to_rep_store: true
                  publish_to_share_tab: true
                  price_range_formatted: $17.32
                  display_wholesale_price: $0.00 (USD)
                  publish_to_retail_store: true
                  display_subscription_price: $17.32 (USD)
                  wholesale_subscription_price: '0.0'
                  display_wholesale_subscription_price: $0.00 (USD)
                quantity: 1
                ordered_variant: ''
            phone: null
            amount: '17.32'
            rating: 5
            review: ''
            status: awaiting_payment
            contact:
              id: 20
              ip: null
              city: null
              email: amir@danpheit.com
              hours: null
              phone: null
              state: null
              token: qgUpmwfwPpCiVmrQTnw6DZQR
              email2: null
              income: null
              invest: null
              phone2: null
              reason: null
              status: new
              address: null
              address2: null
              interest: null
              phone_id: null
              best_time: null
              full_name: a
              last_name: ''
              lead_type: null
              time_zone: null
              avatar_url: null
              country_id: null
              first_name: a
              language_id: null
              postal_code: null
              requested_at: null
            ship_to:
              id: 980190974
              city: a
              name: a
              state: Alaska
              country:
                id: 214
                iso: US
                itn: false
                iso3: USA
                name: United States
                state: true
                active: true
                default: true
                numcode: 840
                address3: false
                iso_name: UNITED STATES
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                created_at: '2023-12-26T04:48:23.479Z'
                updated_at: '2023-12-26T04:48:23.479Z'
                currency_code: USD
                geo_entity_id: null
                currency_symbol: $
              default: false
              address1: a
              address2: a
              address3: null
              postal_code: '11111'
              country_code: null
            referrer: Maritzaa Gutkowski
            shipping: '0.0'
            subtotal: '17.32'
            tracking: null
            last_name: ''
            sale_date: '2023-12-27T12:47:59.832Z'
            created_at: '2023-12-27T12:47:59.832Z'
            first_name: a
            order_type: null
            refundable: false
            display_tax: $0.00 (USD)
            order_number: F53375259023
            currency_code: USD
            display_amount: $17.32 (USD)
            currency_symbol: $
            display_refunds: (0 CV, 0 QV) -$0.00 (USD)
            friendly_status: pending
            order_thumbnail: >-
              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
            display_discount: $0.00 (USD)
            display_shipping: $0.00 (USD)
            display_subtotal: $17.32 (USD)
            max_refundable_tax: '0.0'
            recognized_ship_date: '2024-01-27'
            max_refundable_amount: '17.32'
            tracking_informations: []
            max_refundable_shipping: '0.0'
            max_refundable_product_price: '17.32'
        timestamp: '2023-12-27T12:50:30.039Z'
        identifier: subscriptionorder-170368143053
    Payload16:
      title: Payload16
      required:
        - subsctiption_order
      type: object
      properties:
        subsctiption_order:
          allOf:
            - $ref: '#/components/schemas/SubsctiptionOrder'
            - {}
      example:
        subsctiption_order:
          cv: 0
          id: 53
          qv: 0
          tax: '0.0'
          type: SubscriptionOrder
          email: ram@fluid.com
          items:
            - id: 3
              sku: QDPF7N2XOR
              price: 17.32
              product:
                id: 113
                sku: QDPF7N2XOR
                image:
                  full: >-
                    https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                  mini: >-
                    https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                  detail: >-
                    https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                leads: 0
                price: '17.32'
                title: Aerodynamic Aluminum aaa
                views: 0
                active: true
                images: []
                public: true
                vendor: null
                enrolls: []
                options: []
                prompts: []
                in_stock: true
                shipping: '0.03'
                stripped: Optimized clear-thinking access
                variants:
                  - id: 113
                    title: Default Variant
                    buyable: true
                    image_url: null
                    option_value_ids: []
                    variant_countries:
                      - id: 686
                        tax: '0.0'
                        price: '17.32'
                        country:
                          id: 214
                          iso: US
                          iso3: USA
                          name: United States
                          iso_name: UNITED STATES
                          tax_rate: 0
                        shipping: '0.0'
                        country_iso: US
                        currency_code: USD
                        display_price: $17.32 (USD)
                        currency_symbol: $
                        wholesale_price: '0.0'
                        subscription_price: '17.32'
                        display_wholesale_price: $0.00 (USD)
                        wholesale_subscription_price: '0.0'
                        display_wholesale_subscription_price: $0.00 (USD)
                      - id: 687
                        tax: '0.0'
                        price: '17.32'
                        country:
                          id: 65
                          iso: FO
                          iso3: FRO
                          name: Faroe Islands
                          iso_name: FAROE ISLANDS
                          tax_rate: 0
                        shipping: '0.0'
                        country_iso: FO
                        currency_code: USD
                        display_price: $17.32 (USD)
                        currency_symbol: $
                        wholesale_price: '0.0'
                        subscription_price: '17.32'
                        display_wholesale_price: $0.00 (USD)
                        wholesale_subscription_price: '0.0'
                        display_wholesale_subscription_price: $0.00 (USD)
                      - id: 688
                        tax: '0.0'
                        price: '17.32'
                        country:
                          id: 92
                          iso: IN
                          iso3: IND
                          name: India
                          iso_name: INDIA
                          tax_rate: 0
                        shipping: '0.0'
                        country_iso: IN
                        currency_code: USD
                        display_price: $17.32 (USD)
                        currency_symbol: $
                        wholesale_price: '0.0'
                        subscription_price: '17.32'
                        display_wholesale_price: $0.00 (USD)
                        wholesale_subscription_price: '0.0'
                        display_wholesale_subscription_price: $0.00 (USD)
                      - id: 689
                        tax: '0.0'
                        price: '17.32'
                        country:
                          id: 146
                          iso: NI
                          iso3: NIC
                          name: Nicaragua
                          iso_name: NICARAGUA
                          tax_rate: 0
                        shipping: '0.0'
                        country_iso: NI
                        currency_code: USD
                        display_price: $17.32 (USD)
                        currency_symbol: $
                        wholesale_price: '0.0'
                        subscription_price: '17.32'
                        display_wholesale_price: $0.00 (USD)
                        wholesale_subscription_price: '0.0'
                        display_wholesale_subscription_price: $0.00 (USD)
                      - id: 690
                        tax: '0.0'
                        price: '17.32'
                        country:
                          id: 172
                          iso: LC
                          iso3: LCA
                          name: Saint Lucia
                          iso_name: SAINT LUCIA
                          tax_rate: 0
                        shipping: '0.0'
                        country_iso: LC
                        currency_code: USD
                        display_price: $17.32 (USD)
                        currency_symbol: $
                        wholesale_price: '0.0'
                        subscription_price: '17.32'
                        display_wholesale_price: $0.00 (USD)
                        wholesale_subscription_price: '0.0'
                        display_wholesale_subscription_price: $0.00 (USD)
                      - id: 691
                        tax: '0.0'
                        price: '17.32'
                        country:
                          id: 66
                          iso: FJ
                          iso3: FJI
                          name: Fiji
                          iso_name: FIJI
                          tax_rate: 0
                        shipping: '0.0'
                        country_iso: FJ
                        currency_code: USD
                        display_price: $17.32 (USD)
                        currency_symbol: $
                        wholesale_price: '0.0'
                        subscription_price: '17.32'
                        display_wholesale_price: $0.00 (USD)
                        wholesale_subscription_price: '0.0'
                        display_wholesale_subscription_price: $0.00 (USD)
                      - id: 692
                        tax: '0.0'
                        price: '17.32'
                        country:
                          id: 93
                          iso: ID
                          iso3: IDN
                          name: Indonesia
                          iso_name: INDONESIA
                          tax_rate: 0
                        shipping: '0.0'
                        country_iso: ID
                        currency_code: USD
                        display_price: $17.32 (USD)
                        currency_symbol: $
                        wholesale_price: '0.0'
                        subscription_price: '17.32'
                        display_wholesale_price: $0.00 (USD)
                        wholesale_subscription_price: '0.0'
                        display_wholesale_subscription_price: $0.00 (USD)
                      - id: 693
                        tax: '0.0'
                        price: '17.32'
                        country:
                          id: 147
                          iso: NE
                          iso3: NER
                          name: Niger
                          iso_name: NIGER
                          tax_rate: 0
                        shipping: '0.0'
                        country_iso: NE
                        currency_code: USD
                        display_price: $17.32 (USD)
                        currency_symbol: $
                        wholesale_price: '0.0'
                        subscription_price: '17.32'
                        display_wholesale_price: $0.00 (USD)
                        wholesale_subscription_price: '0.0'
                        display_wholesale_subscription_price: $0.00 (USD)
                      - id: 694
                        tax: '0.0'
                        price: '17.32'
                        country:
                          id: 67
                          iso: FI
                          iso3: FIN
                          name: Finland
                          iso_name: FINLAND
                          tax_rate: 0
                        shipping: '0.0'
                        country_iso: FI
                        currency_code: USD
                        display_price: $17.32 (USD)
                        currency_symbol: $
                        wholesale_price: '0.0'
                        subscription_price: '17.32'
                        display_wholesale_price: $0.00 (USD)
                        wholesale_subscription_price: '0.0'
                        display_wholesale_subscription_price: $0.00 (USD)
                      - id: 695
                        tax: '0.0'
                        price: '17.32'
                        country:
                          id: 148
                          iso: NG
                          iso3: NGA
                          name: Nigeria
                          iso_name: NIGERIA
                          tax_rate: 0
                        shipping: '0.0'
                        country_iso: NG
                        currency_code: USD
                        display_price: $17.32 (USD)
                        currency_symbol: $
                        wholesale_price: '0.0'
                        subscription_price: '17.32'
                        display_wholesale_price: $0.00 (USD)
                        wholesale_subscription_price: '0.0'
                        display_wholesale_subscription_price: $0.00 (USD)
                    allow_subscription: true
                countries:
                  - id: 214
                    iso: US
                    itn: false
                    iso3: USA
                    name: United States
                    state: true
                    active: true
                    numcode: 840
                    address3: false
                    iso_name: UNITED STATES
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: USD
                    currency_symbol: $
                  - id: 65
                    iso: FO
                    itn: false
                    iso3: FRO
                    name: Faroe Islands
                    state: true
                    active: true
                    numcode: 234
                    address3: false
                    iso_name: FAROE ISLANDS
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: DKK
                    currency_symbol: kr.
                  - id: 92
                    iso: IN
                    itn: false
                    iso3: IND
                    name: India
                    state: true
                    active: true
                    numcode: 356
                    address3: false
                    iso_name: INDIA
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: INR
                    currency_symbol: ₹
                  - id: 146
                    iso: NI
                    itn: false
                    iso3: NIC
                    name: Nicaragua
                    state: true
                    active: true
                    numcode: 558
                    address3: false
                    iso_name: NICARAGUA
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: NIO
                    currency_symbol: C$
                  - id: 172
                    iso: LC
                    itn: false
                    iso3: LCA
                    name: Saint Lucia
                    state: true
                    active: true
                    numcode: 662
                    address3: false
                    iso_name: SAINT LUCIA
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: XCD
                    currency_symbol: $
                  - id: 66
                    iso: FJ
                    itn: false
                    iso3: FJI
                    name: Fiji
                    state: true
                    active: true
                    numcode: 242
                    address3: false
                    iso_name: FIJI
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: FJD
                    currency_symbol: $
                  - id: 93
                    iso: ID
                    itn: false
                    iso3: IDN
                    name: Indonesia
                    state: true
                    active: true
                    numcode: 360
                    address3: false
                    iso_name: INDONESIA
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: IDR
                    currency_symbol: Rp
                  - id: 147
                    iso: NE
                    itn: false
                    iso3: NER
                    name: Niger
                    state: true
                    active: true
                    numcode: 562
                    address3: false
                    iso_name: NIGER
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: XOF
                    currency_symbol: Fr
                  - id: 67
                    iso: FI
                    itn: false
                    iso3: FIN
                    name: Finland
                    state: true
                    active: true
                    numcode: 246
                    address3: false
                    iso_name: FINLAND
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: EUR
                    currency_symbol: €
                  - id: 148
                    iso: NG
                    itn: false
                    iso3: NGA
                    name: Nigeria
                    state: true
                    active: true
                    numcode: 566
                    address3: false
                    iso_name: NIGERIA
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: NGN
                    currency_symbol: ₦
                  - id: 174
                    iso: VC
                    itn: false
                    iso3: VCT
                    name: Saint Vincent and the Grenadines
                    state: true
                    active: true
                    numcode: 670
                    address3: false
                    iso_name: SAINT VINCENT AND THE GRENADINES
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: XCD
                    currency_symbol: $
                  - id: 68
                    iso: FR
                    itn: false
                    iso3: FRA
                    name: France
                    state: true
                    active: true
                    numcode: 250
                    address3: false
                    iso_name: FRANCE
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: EUR
                    currency_symbol: €
                  - id: 94
                    iso: IR
                    itn: false
                    iso3: IRN
                    name: Iran, Islamic Republic of
                    state: true
                    active: true
                    numcode: 364
                    address3: false
                    iso_name: IRAN, ISLAMIC REPUBLIC OF
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: IRR
                    currency_symbol: ﷼
                  - id: 149
                    iso: NU
                    itn: false
                    iso3: NIU
                    name: Niue
                    state: true
                    active: true
                    numcode: 570
                    address3: false
                    iso_name: NIUE
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: NZD
                    currency_symbol: $
                  - id: 175
                    iso: WS
                    itn: false
                    iso3: WSM
                    name: Samoa
                    state: true
                    active: true
                    numcode: 882
                    address3: false
                    iso_name: SAMOA
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: WST
                    currency_symbol: T
                  - id: 69
                    iso: GF
                    itn: false
                    iso3: GUF
                    name: French Guiana
                    state: true
                    active: true
                    numcode: 254
                    address3: false
                    iso_name: FRENCH GUIANA
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: EUR
                    currency_symbol: €
                  - id: 95
                    iso: IQ
                    itn: false
                    iso3: IRQ
                    name: Iraq
                    state: true
                    active: true
                    numcode: 368
                    address3: false
                    iso_name: IRAQ
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: IQD
                    currency_symbol: ع.د
                  - id: 176
                    iso: SM
                    itn: false
                    iso3: SMR
                    name: San Marino
                    state: true
                    active: true
                    numcode: 674
                    address3: false
                    iso_name: SAN MARINO
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: EUR
                    currency_symbol: €
                  - id: 96
                    iso: IE
                    itn: false
                    iso3: IRL
                    name: Ireland
                    state: true
                    active: true
                    numcode: 372
                    address3: false
                    iso_name: IRELAND
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: EUR
                    currency_symbol: €
                  - id: 177
                    iso: ST
                    itn: false
                    iso3: STP
                    name: Sao Tome and Principe
                    state: true
                    active: true
                    numcode: 678
                    address3: false
                    iso_name: SAO TOME AND PRINCIPE
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: STD
                    currency_symbol: Db
                  - id: 39
                    iso: TD
                    itn: false
                    iso3: TCD
                    name: Chad
                    state: true
                    active: true
                    numcode: 148
                    address3: false
                    iso_name: CHAD
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: XAF
                    currency_symbol: CFA
                  - id: 173
                    iso: PM
                    itn: false
                    iso3: SPM
                    name: Saint Pierre and Miquelon
                    state: true
                    active: true
                    numcode: 666
                    address3: false
                    iso_name: SAINT PIERRE AND MIQUELON
                    passport: false
                    tax_rate: 0
                    delimiter: ','
                    separator: .
                    currency_code: EUR
                    currency_symbol: €
                image_url: >-
                  https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                commission: '10.0'
                country_id: null
                share_link: null
                shopify_id: null
                description:
                  id: 122
                  body: <div>Optimized clear-thinking access</div>
                  name: description
                  record_id: 113
                  created_at: '2023-12-26T04:49:52.800Z'
                  updated_at: '2023-12-26T06:37:59.551Z'
                  record_type: Product
                price_range:
                  - $17.32
                  - $17.32
                country_code: td
                currency_code: USD
                display_price: $17.32 (USD)
                option_values: {}
                average_rating: 0
                shopify_handle: null
                currency_symbol: $
                default_variant:
                  id: 113
                  sku: QDPF7N2XOR
                  size: 4cm
                  price: null
                  title: Default Variant
                  width: null
                  active: true
                  height: null
                  length: null
                  weight: 10 kg
                  hs_code: null
                  taxable: true
                  bar_code: null
                  physical: null
                  position: 1
                  image_url: null
                  is_master: true
                  created_at: '2023-12-26T04:49:52.811Z'
                  image_path: null
                  product_id: 113
                  shopify_id: null
                  updated_at: '2023-12-27T12:48:04.588Z'
                  external_id: null
                  discarded_at: null
                  keep_selling: false
                  option_attrs: []
                  unit_of_size: null
                  track_quantity: true
                  unit_of_weight: null
                  inventory_policy: none
                  country_of_origin: null
                  allow_subscription: true
                  inventory_quantity: 99
                  variant_country_id: null
                  customs_information_shipping: null
                enroll_products: []
                wholesale_price: '0.0'
                subscription_price: '17.32'
                unlimited_inventory: false
                publish_to_rep_store: true
                publish_to_share_tab: true
                price_range_formatted: $17.32
                display_wholesale_price: $0.00 (USD)
                publish_to_retail_store: true
                display_subscription_price: $17.32 (USD)
                wholesale_subscription_price: '0.0'
                display_wholesale_subscription_price: $0.00 (USD)
              quantity: 1
              ordered_variant: ''
          phone: null
          amount: '17.32'
          rating: 5
          review: ''
          status: awaiting_payment
          contact:
            id: 20
            ip: null
            city: null
            email: amir@danpheit.com
            hours: null
            phone: null
            state: null
            token: qgUpmwfwPpCiVmrQTnw6DZQR
            email2: null
            income: null
            invest: null
            phone2: null
            reason: null
            status: new
            address: null
            address2: null
            interest: null
            phone_id: null
            best_time: null
            full_name: a
            last_name: ''
            lead_type: null
            time_zone: null
            avatar_url: null
            country_id: null
            first_name: a
            language_id: null
            postal_code: null
            requested_at: null
          ship_to:
            id: 980190974
            city: a
            name: a
            state: Alaska
            country:
              id: 214
              iso: US
              itn: false
              iso3: USA
              name: United States
              state: true
              active: true
              default: true
              numcode: 840
              address3: false
              iso_name: UNITED STATES
              passport: false
              tax_rate: 0
              delimiter: ','
              separator: .
              created_at: '2023-12-26T04:48:23.479Z'
              updated_at: '2023-12-26T04:48:23.479Z'
              currency_code: USD
              geo_entity_id: null
              currency_symbol: $
            default: false
            address1: a
            address2: a
            address3: null
            postal_code: '11111'
            country_code: null
          referrer: Maritzaa Gutkowski
          shipping: '0.0'
          subtotal: '17.32'
          tracking: null
          last_name: ''
          sale_date: '2023-12-27T12:47:59.832Z'
          created_at: '2023-12-27T12:47:59.832Z'
          first_name: a
          order_type: null
          refundable: false
          display_tax: $0.00 (USD)
          order_number: F53375259023
          currency_code: USD
          display_amount: $17.32 (USD)
          currency_symbol: $
          display_refunds: (0 CV, 0 QV) -$0.00 (USD)
          friendly_status: pending
          order_thumbnail: >-
            https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
          display_discount: $0.00 (USD)
          display_shipping: $0.00 (USD)
          display_subtotal: $17.32 (USD)
          max_refundable_tax: '0.0'
          recognized_ship_date: '2024-01-27'
          max_refundable_amount: '17.32'
          tracking_informations: []
          max_refundable_shipping: '0.0'
          max_refundable_product_price: '17.32'
    SubsctiptionOrder:
      title: SubsctiptionOrder
      required:
        - cv
        - id
        - qv
        - tax
        - type
        - email
        - items
        - phone
        - amount
        - rating
        - review
        - status
        - contact
        - ship_to
        - referrer
        - shipping
        - subtotal
        - tracking
        - last_name
        - sale_date
        - created_at
        - first_name
        - order_type
        - refundable
        - display_tax
        - order_number
        - currency_code
        - display_amount
        - currency_symbol
        - display_refunds
        - friendly_status
        - order_thumbnail
        - display_discount
        - display_shipping
        - display_subtotal
        - max_refundable_tax
        - recognized_ship_date
        - max_refundable_amount
        - tracking_informations
        - max_refundable_shipping
        - max_refundable_product_price
      type: object
      properties:
        cv:
          type: integer
          format: int32
        id:
          type: integer
          format: int32
        qv:
          type: integer
          format: int32
        tax:
          type: string
        type:
          type: string
        email:
          type: string
        items:
          type: array
          items:
            $ref: '#/components/schemas/Item5'
          description: ''
        phone:
          type: string
        amount:
          type: string
        rating:
          type: integer
          format: int32
        review:
          type: string
        status:
          type: string
        contact:
          allOf:
            - $ref: '#/components/schemas/Contact1'
            - {}
        ship_to:
          allOf:
            - $ref: '#/components/schemas/ShipTo7'
            - {}
        referrer:
          type: string
        shipping:
          type: string
        subtotal:
          type: string
        tracking:
          type: string
        last_name:
          type: string
        sale_date:
          type: string
        created_at:
          type: string
        first_name:
          type: string
        order_type:
          type: string
        refundable:
          type: boolean
        display_tax:
          type: string
        order_number:
          type: string
        currency_code:
          type: string
        display_amount:
          type: string
        currency_symbol:
          type: string
        display_refunds:
          type: string
        friendly_status:
          type: string
        order_thumbnail:
          type: string
        display_discount:
          type: string
        display_shipping:
          type: string
        display_subtotal:
          type: string
        max_refundable_tax:
          type: string
        recognized_ship_date:
          type: string
        max_refundable_amount:
          type: string
        tracking_informations:
          type: array
          items:
            type: string
          description: ''
        max_refundable_shipping:
          type: string
        max_refundable_product_price:
          type: string
      example:
        cv: 0
        id: 53
        qv: 0
        tax: '0.0'
        type: SubscriptionOrder
        email: ram@fluid.com
        items:
          - id: 3
            sku: QDPF7N2XOR
            price: 17.32
            product:
              id: 113
              sku: QDPF7N2XOR
              image:
                full: >-
                  https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                mini: >-
                  https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                detail: >-
                  https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
              leads: 0
              price: '17.32'
              title: Aerodynamic Aluminum aaa
              views: 0
              active: true
              images: []
              public: true
              vendor: null
              enrolls: []
              options: []
              prompts: []
              in_stock: true
              shipping: '0.03'
              stripped: Optimized clear-thinking access
              variants:
                - id: 113
                  title: Default Variant
                  buyable: true
                  image_url: null
                  option_value_ids: []
                  variant_countries:
                    - id: 686
                      tax: '0.0'
                      price: '17.32'
                      country:
                        id: 214
                        iso: US
                        iso3: USA
                        name: United States
                        iso_name: UNITED STATES
                        tax_rate: 0
                      shipping: '0.0'
                      country_iso: US
                      currency_code: USD
                      display_price: $17.32 (USD)
                      currency_symbol: $
                      wholesale_price: '0.0'
                      subscription_price: '17.32'
                      display_wholesale_price: $0.00 (USD)
                      wholesale_subscription_price: '0.0'
                      display_wholesale_subscription_price: $0.00 (USD)
                    - id: 687
                      tax: '0.0'
                      price: '17.32'
                      country:
                        id: 65
                        iso: FO
                        iso3: FRO
                        name: Faroe Islands
                        iso_name: FAROE ISLANDS
                        tax_rate: 0
                      shipping: '0.0'
                      country_iso: FO
                      currency_code: USD
                      display_price: $17.32 (USD)
                      currency_symbol: $
                      wholesale_price: '0.0'
                      subscription_price: '17.32'
                      display_wholesale_price: $0.00 (USD)
                      wholesale_subscription_price: '0.0'
                      display_wholesale_subscription_price: $0.00 (USD)
                    - id: 688
                      tax: '0.0'
                      price: '17.32'
                      country:
                        id: 92
                        iso: IN
                        iso3: IND
                        name: India
                        iso_name: INDIA
                        tax_rate: 0
                      shipping: '0.0'
                      country_iso: IN
                      currency_code: USD
                      display_price: $17.32 (USD)
                      currency_symbol: $
                      wholesale_price: '0.0'
                      subscription_price: '17.32'
                      display_wholesale_price: $0.00 (USD)
                      wholesale_subscription_price: '0.0'
                      display_wholesale_subscription_price: $0.00 (USD)
                    - id: 689
                      tax: '0.0'
                      price: '17.32'
                      country:
                        id: 146
                        iso: NI
                        iso3: NIC
                        name: Nicaragua
                        iso_name: NICARAGUA
                        tax_rate: 0
                      shipping: '0.0'
                      country_iso: NI
                      currency_code: USD
                      display_price: $17.32 (USD)
                      currency_symbol: $
                      wholesale_price: '0.0'
                      subscription_price: '17.32'
                      display_wholesale_price: $0.00 (USD)
                      wholesale_subscription_price: '0.0'
                      display_wholesale_subscription_price: $0.00 (USD)
                    - id: 690
                      tax: '0.0'
                      price: '17.32'
                      country:
                        id: 172
                        iso: LC
                        iso3: LCA
                        name: Saint Lucia
                        iso_name: SAINT LUCIA
                        tax_rate: 0
                      shipping: '0.0'
                      country_iso: LC
                      currency_code: USD
                      display_price: $17.32 (USD)
                      currency_symbol: $
                      wholesale_price: '0.0'
                      subscription_price: '17.32'
                      display_wholesale_price: $0.00 (USD)
                      wholesale_subscription_price: '0.0'
                      display_wholesale_subscription_price: $0.00 (USD)
                    - id: 691
                      tax: '0.0'
                      price: '17.32'
                      country:
                        id: 66
                        iso: FJ
                        iso3: FJI
                        name: Fiji
                        iso_name: FIJI
                        tax_rate: 0
                      shipping: '0.0'
                      country_iso: FJ
                      currency_code: USD
                      display_price: $17.32 (USD)
                      currency_symbol: $
                      wholesale_price: '0.0'
                      subscription_price: '17.32'
                      display_wholesale_price: $0.00 (USD)
                      wholesale_subscription_price: '0.0'
                      display_wholesale_subscription_price: $0.00 (USD)
                    - id: 692
                      tax: '0.0'
                      price: '17.32'
                      country:
                        id: 93
                        iso: ID
                        iso3: IDN
                        name: Indonesia
                        iso_name: INDONESIA
                        tax_rate: 0
                      shipping: '0.0'
                      country_iso: ID
                      currency_code: USD
                      display_price: $17.32 (USD)
                      currency_symbol: $
                      wholesale_price: '0.0'
                      subscription_price: '17.32'
                      display_wholesale_price: $0.00 (USD)
                      wholesale_subscription_price: '0.0'
                      display_wholesale_subscription_price: $0.00 (USD)
                    - id: 693
                      tax: '0.0'
                      price: '17.32'
                      country:
                        id: 147
                        iso: NE
                        iso3: NER
                        name: Niger
                        iso_name: NIGER
                        tax_rate: 0
                      shipping: '0.0'
                      country_iso: NE
                      currency_code: USD
                      display_price: $17.32 (USD)
                      currency_symbol: $
                      wholesale_price: '0.0'
                      subscription_price: '17.32'
                      display_wholesale_price: $0.00 (USD)
                      wholesale_subscription_price: '0.0'
                      display_wholesale_subscription_price: $0.00 (USD)
                    - id: 694
                      tax: '0.0'
                      price: '17.32'
                      country:
                        id: 67
                        iso: FI
                        iso3: FIN
                        name: Finland
                        iso_name: FINLAND
                        tax_rate: 0
                      shipping: '0.0'
                      country_iso: FI
                      currency_code: USD
                      display_price: $17.32 (USD)
                      currency_symbol: $
                      wholesale_price: '0.0'
                      subscription_price: '17.32'
                      display_wholesale_price: $0.00 (USD)
                      wholesale_subscription_price: '0.0'
                      display_wholesale_subscription_price: $0.00 (USD)
                    - id: 695
                      tax: '0.0'
                      price: '17.32'
                      country:
                        id: 148
                        iso: NG
                        iso3: NGA
                        name: Nigeria
                        iso_name: NIGERIA
                        tax_rate: 0
                      shipping: '0.0'
                      country_iso: NG
                      currency_code: USD
                      display_price: $17.32 (USD)
                      currency_symbol: $
                      wholesale_price: '0.0'
                      subscription_price: '17.32'
                      display_wholesale_price: $0.00 (USD)
                      wholesale_subscription_price: '0.0'
                      display_wholesale_subscription_price: $0.00 (USD)
                  allow_subscription: true
              countries:
                - id: 214
                  iso: US
                  itn: false
                  iso3: USA
                  name: United States
                  state: true
                  active: true
                  numcode: 840
                  address3: false
                  iso_name: UNITED STATES
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: USD
                  currency_symbol: $
                - id: 65
                  iso: FO
                  itn: false
                  iso3: FRO
                  name: Faroe Islands
                  state: true
                  active: true
                  numcode: 234
                  address3: false
                  iso_name: FAROE ISLANDS
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: DKK
                  currency_symbol: kr.
                - id: 92
                  iso: IN
                  itn: false
                  iso3: IND
                  name: India
                  state: true
                  active: true
                  numcode: 356
                  address3: false
                  iso_name: INDIA
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: INR
                  currency_symbol: ₹
                - id: 146
                  iso: NI
                  itn: false
                  iso3: NIC
                  name: Nicaragua
                  state: true
                  active: true
                  numcode: 558
                  address3: false
                  iso_name: NICARAGUA
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: NIO
                  currency_symbol: C$
                - id: 172
                  iso: LC
                  itn: false
                  iso3: LCA
                  name: Saint Lucia
                  state: true
                  active: true
                  numcode: 662
                  address3: false
                  iso_name: SAINT LUCIA
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: XCD
                  currency_symbol: $
                - id: 66
                  iso: FJ
                  itn: false
                  iso3: FJI
                  name: Fiji
                  state: true
                  active: true
                  numcode: 242
                  address3: false
                  iso_name: FIJI
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: FJD
                  currency_symbol: $
                - id: 93
                  iso: ID
                  itn: false
                  iso3: IDN
                  name: Indonesia
                  state: true
                  active: true
                  numcode: 360
                  address3: false
                  iso_name: INDONESIA
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: IDR
                  currency_symbol: Rp
                - id: 147
                  iso: NE
                  itn: false
                  iso3: NER
                  name: Niger
                  state: true
                  active: true
                  numcode: 562
                  address3: false
                  iso_name: NIGER
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: XOF
                  currency_symbol: Fr
                - id: 67
                  iso: FI
                  itn: false
                  iso3: FIN
                  name: Finland
                  state: true
                  active: true
                  numcode: 246
                  address3: false
                  iso_name: FINLAND
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: EUR
                  currency_symbol: €
                - id: 148
                  iso: NG
                  itn: false
                  iso3: NGA
                  name: Nigeria
                  state: true
                  active: true
                  numcode: 566
                  address3: false
                  iso_name: NIGERIA
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: NGN
                  currency_symbol: ₦
                - id: 174
                  iso: VC
                  itn: false
                  iso3: VCT
                  name: Saint Vincent and the Grenadines
                  state: true
                  active: true
                  numcode: 670
                  address3: false
                  iso_name: SAINT VINCENT AND THE GRENADINES
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: XCD
                  currency_symbol: $
                - id: 68
                  iso: FR
                  itn: false
                  iso3: FRA
                  name: France
                  state: true
                  active: true
                  numcode: 250
                  address3: false
                  iso_name: FRANCE
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: EUR
                  currency_symbol: €
                - id: 94
                  iso: IR
                  itn: false
                  iso3: IRN
                  name: Iran, Islamic Republic of
                  state: true
                  active: true
                  numcode: 364
                  address3: false
                  iso_name: IRAN, ISLAMIC REPUBLIC OF
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: IRR
                  currency_symbol: ﷼
                - id: 149
                  iso: NU
                  itn: false
                  iso3: NIU
                  name: Niue
                  state: true
                  active: true
                  numcode: 570
                  address3: false
                  iso_name: NIUE
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: NZD
                  currency_symbol: $
                - id: 175
                  iso: WS
                  itn: false
                  iso3: WSM
                  name: Samoa
                  state: true
                  active: true
                  numcode: 882
                  address3: false
                  iso_name: SAMOA
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: WST
                  currency_symbol: T
                - id: 69
                  iso: GF
                  itn: false
                  iso3: GUF
                  name: French Guiana
                  state: true
                  active: true
                  numcode: 254
                  address3: false
                  iso_name: FRENCH GUIANA
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: EUR
                  currency_symbol: €
                - id: 95
                  iso: IQ
                  itn: false
                  iso3: IRQ
                  name: Iraq
                  state: true
                  active: true
                  numcode: 368
                  address3: false
                  iso_name: IRAQ
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: IQD
                  currency_symbol: ع.د
                - id: 176
                  iso: SM
                  itn: false
                  iso3: SMR
                  name: San Marino
                  state: true
                  active: true
                  numcode: 674
                  address3: false
                  iso_name: SAN MARINO
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: EUR
                  currency_symbol: €
                - id: 96
                  iso: IE
                  itn: false
                  iso3: IRL
                  name: Ireland
                  state: true
                  active: true
                  numcode: 372
                  address3: false
                  iso_name: IRELAND
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: EUR
                  currency_symbol: €
                - id: 177
                  iso: ST
                  itn: false
                  iso3: STP
                  name: Sao Tome and Principe
                  state: true
                  active: true
                  numcode: 678
                  address3: false
                  iso_name: SAO TOME AND PRINCIPE
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: STD
                  currency_symbol: Db
                - id: 39
                  iso: TD
                  itn: false
                  iso3: TCD
                  name: Chad
                  state: true
                  active: true
                  numcode: 148
                  address3: false
                  iso_name: CHAD
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: XAF
                  currency_symbol: CFA
                - id: 173
                  iso: PM
                  itn: false
                  iso3: SPM
                  name: Saint Pierre and Miquelon
                  state: true
                  active: true
                  numcode: 666
                  address3: false
                  iso_name: SAINT PIERRE AND MIQUELON
                  passport: false
                  tax_rate: 0
                  delimiter: ','
                  separator: .
                  currency_code: EUR
                  currency_symbol: €
              image_url: >-
                https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
              commission: '10.0'
              country_id: null
              share_link: null
              shopify_id: null
              description:
                id: 122
                body: <div>Optimized clear-thinking access</div>
                name: description
                record_id: 113
                created_at: '2023-12-26T04:49:52.800Z'
                updated_at: '2023-12-26T06:37:59.551Z'
                record_type: Product
              price_range:
                - $17.32
                - $17.32
              country_code: td
              currency_code: USD
              display_price: $17.32 (USD)
              option_values: {}
              average_rating: 0
              shopify_handle: null
              currency_symbol: $
              default_variant:
                id: 113
                sku: QDPF7N2XOR
                size: 4cm
                price: null
                title: Default Variant
                width: null
                active: true
                height: null
                length: null
                weight: 10 kg
                hs_code: null
                taxable: true
                bar_code: null
                physical: null
                position: 1
                image_url: null
                is_master: true
                created_at: '2023-12-26T04:49:52.811Z'
                image_path: null
                product_id: 113
                shopify_id: null
                updated_at: '2023-12-27T12:48:04.588Z'
                external_id: null
                discarded_at: null
                keep_selling: false
                option_attrs: []
                unit_of_size: null
                track_quantity: true
                unit_of_weight: null
                inventory_policy: none
                country_of_origin: null
                allow_subscription: true
                inventory_quantity: 99
                variant_country_id: null
                customs_information_shipping: null
              enroll_products: []
              wholesale_price: '0.0'
              subscription_price: '17.32'
              unlimited_inventory: false
              publish_to_rep_store: true
              publish_to_share_tab: true
              price_range_formatted: $17.32
              display_wholesale_price: $0.00 (USD)
              publish_to_retail_store: true
              display_subscription_price: $17.32 (USD)
              wholesale_subscription_price: '0.0'
              display_wholesale_subscription_price: $0.00 (USD)
            quantity: 1
            ordered_variant: ''
        phone: null
        amount: '17.32'
        rating: 5
        review: ''
        status: awaiting_payment
        contact:
          id: 20
          ip: null
          city: null
          email: amir@danpheit.com
          hours: null
          phone: null
          state: null
          token: qgUpmwfwPpCiVmrQTnw6DZQR
          email2: null
          income: null
          invest: null
          phone2: null
          reason: null
          status: new
          address: null
          address2: null
          interest: null
          phone_id: null
          best_time: null
          full_name: a
          last_name: ''
          lead_type: null
          time_zone: null
          avatar_url: null
          country_id: null
          first_name: a
          language_id: null
          postal_code: null
          requested_at: null
        ship_to:
          id: 980190974
          city: a
          name: a
          state: Alaska
          country:
            id: 214
            iso: US
            itn: false
            iso3: USA
            name: United States
            state: true
            active: true
            default: true
            numcode: 840
            address3: false
            iso_name: UNITED STATES
            passport: false
            tax_rate: 0
            delimiter: ','
            separator: .
            created_at: '2023-12-26T04:48:23.479Z'
            updated_at: '2023-12-26T04:48:23.479Z'
            currency_code: USD
            geo_entity_id: null
            currency_symbol: $
          default: false
          address1: a
          address2: a
          address3: null
          postal_code: '11111'
          country_code: null
        referrer: Maritzaa Gutkowski
        shipping: '0.0'
        subtotal: '17.32'
        tracking: null
        last_name: ''
        sale_date: '2023-12-27T12:47:59.832Z'
        created_at: '2023-12-27T12:47:59.832Z'
        first_name: a
        order_type: null
        refundable: false
        display_tax: $0.00 (USD)
        order_number: F53375259023
        currency_code: USD
        display_amount: $17.32 (USD)
        currency_symbol: $
        display_refunds: (0 CV, 0 QV) -$0.00 (USD)
        friendly_status: pending
        order_thumbnail: >-
          https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
        display_discount: $0.00 (USD)
        display_shipping: $0.00 (USD)
        display_subtotal: $17.32 (USD)
        max_refundable_tax: '0.0'
        recognized_ship_date: '2024-01-27'
        max_refundable_amount: '17.32'
        tracking_informations: []
        max_refundable_shipping: '0.0'
        max_refundable_product_price: '17.32'
    subscription_paused:
      title: subscription_paused
      required:
        - id
        - name
        - payload
        - timestamp
        - identifier
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        payload:
          allOf:
            - $ref: '#/components/schemas/Payload16'
            - {}
        timestamp:
          type: string
        identifier:
          type: string
      example:
        id: 132
        name: subscription_paused
        payload:
          subsctiption_order:
            cv: 0
            id: 53
            qv: 0
            tax: '0.0'
            type: SubscriptionOrder
            email: ram@fluid.com
            items:
              - id: 3
                sku: QDPF7N2XOR
                price: 17.32
                product:
                  id: 113
                  sku: QDPF7N2XOR
                  image:
                    full: >-
                      https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                    mini: >-
                      https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                    detail: >-
                      https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                  leads: 0
                  price: '17.32'
                  title: Aerodynamic Aluminum aaa
                  views: 0
                  active: true
                  images: []
                  public: true
                  vendor: null
                  enrolls: []
                  options: []
                  prompts: []
                  in_stock: true
                  shipping: '0.03'
                  stripped: Optimized clear-thinking access
                  variants:
                    - id: 113
                      title: Default Variant
                      buyable: true
                      image_url: null
                      option_value_ids: []
                      variant_countries:
                        - id: 686
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 214
                            iso: US
                            iso3: USA
                            name: United States
                            iso_name: UNITED STATES
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: US
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 687
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 65
                            iso: FO
                            iso3: FRO
                            name: Faroe Islands
                            iso_name: FAROE ISLANDS
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: FO
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 688
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 92
                            iso: IN
                            iso3: IND
                            name: India
                            iso_name: INDIA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: IN
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 689
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 146
                            iso: NI
                            iso3: NIC
                            name: Nicaragua
                            iso_name: NICARAGUA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: NI
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 690
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 172
                            iso: LC
                            iso3: LCA
                            name: Saint Lucia
                            iso_name: SAINT LUCIA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: LC
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 691
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 66
                            iso: FJ
                            iso3: FJI
                            name: Fiji
                            iso_name: FIJI
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: FJ
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 692
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 93
                            iso: ID
                            iso3: IDN
                            name: Indonesia
                            iso_name: INDONESIA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: ID
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 693
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 147
                            iso: NE
                            iso3: NER
                            name: Niger
                            iso_name: NIGER
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: NE
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 694
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 67
                            iso: FI
                            iso3: FIN
                            name: Finland
                            iso_name: FINLAND
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: FI
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 695
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 148
                            iso: NG
                            iso3: NGA
                            name: Nigeria
                            iso_name: NIGERIA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: NG
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                      allow_subscription: true
                  countries:
                    - id: 214
                      iso: US
                      itn: false
                      iso3: USA
                      name: United States
                      state: true
                      active: true
                      numcode: 840
                      address3: false
                      iso_name: UNITED STATES
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: USD
                      currency_symbol: $
                    - id: 65
                      iso: FO
                      itn: false
                      iso3: FRO
                      name: Faroe Islands
                      state: true
                      active: true
                      numcode: 234
                      address3: false
                      iso_name: FAROE ISLANDS
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: DKK
                      currency_symbol: kr.
                    - id: 92
                      iso: IN
                      itn: false
                      iso3: IND
                      name: India
                      state: true
                      active: true
                      numcode: 356
                      address3: false
                      iso_name: INDIA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: INR
                      currency_symbol: ₹
                    - id: 146
                      iso: NI
                      itn: false
                      iso3: NIC
                      name: Nicaragua
                      state: true
                      active: true
                      numcode: 558
                      address3: false
                      iso_name: NICARAGUA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: NIO
                      currency_symbol: C$
                    - id: 172
                      iso: LC
                      itn: false
                      iso3: LCA
                      name: Saint Lucia
                      state: true
                      active: true
                      numcode: 662
                      address3: false
                      iso_name: SAINT LUCIA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: XCD
                      currency_symbol: $
                    - id: 66
                      iso: FJ
                      itn: false
                      iso3: FJI
                      name: Fiji
                      state: true
                      active: true
                      numcode: 242
                      address3: false
                      iso_name: FIJI
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: FJD
                      currency_symbol: $
                    - id: 93
                      iso: ID
                      itn: false
                      iso3: IDN
                      name: Indonesia
                      state: true
                      active: true
                      numcode: 360
                      address3: false
                      iso_name: INDONESIA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: IDR
                      currency_symbol: Rp
                    - id: 147
                      iso: NE
                      itn: false
                      iso3: NER
                      name: Niger
                      state: true
                      active: true
                      numcode: 562
                      address3: false
                      iso_name: NIGER
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: XOF
                      currency_symbol: Fr
                    - id: 67
                      iso: FI
                      itn: false
                      iso3: FIN
                      name: Finland
                      state: true
                      active: true
                      numcode: 246
                      address3: false
                      iso_name: FINLAND
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 148
                      iso: NG
                      itn: false
                      iso3: NGA
                      name: Nigeria
                      state: true
                      active: true
                      numcode: 566
                      address3: false
                      iso_name: NIGERIA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: NGN
                      currency_symbol: ₦
                    - id: 174
                      iso: VC
                      itn: false
                      iso3: VCT
                      name: Saint Vincent and the Grenadines
                      state: true
                      active: true
                      numcode: 670
                      address3: false
                      iso_name: SAINT VINCENT AND THE GRENADINES
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: XCD
                      currency_symbol: $
                    - id: 68
                      iso: FR
                      itn: false
                      iso3: FRA
                      name: France
                      state: true
                      active: true
                      numcode: 250
                      address3: false
                      iso_name: FRANCE
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 94
                      iso: IR
                      itn: false
                      iso3: IRN
                      name: Iran, Islamic Republic of
                      state: true
                      active: true
                      numcode: 364
                      address3: false
                      iso_name: IRAN, ISLAMIC REPUBLIC OF
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: IRR
                      currency_symbol: ﷼
                    - id: 149
                      iso: NU
                      itn: false
                      iso3: NIU
                      name: Niue
                      state: true
                      active: true
                      numcode: 570
                      address3: false
                      iso_name: NIUE
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: NZD
                      currency_symbol: $
                    - id: 175
                      iso: WS
                      itn: false
                      iso3: WSM
                      name: Samoa
                      state: true
                      active: true
                      numcode: 882
                      address3: false
                      iso_name: SAMOA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: WST
                      currency_symbol: T
                    - id: 69
                      iso: GF
                      itn: false
                      iso3: GUF
                      name: French Guiana
                      state: true
                      active: true
                      numcode: 254
                      address3: false
                      iso_name: FRENCH GUIANA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 95
                      iso: IQ
                      itn: false
                      iso3: IRQ
                      name: Iraq
                      state: true
                      active: true
                      numcode: 368
                      address3: false
                      iso_name: IRAQ
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: IQD
                      currency_symbol: ع.د
                    - id: 176
                      iso: SM
                      itn: false
                      iso3: SMR
                      name: San Marino
                      state: true
                      active: true
                      numcode: 674
                      address3: false
                      iso_name: SAN MARINO
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 96
                      iso: IE
                      itn: false
                      iso3: IRL
                      name: Ireland
                      state: true
                      active: true
                      numcode: 372
                      address3: false
                      iso_name: IRELAND
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 177
                      iso: ST
                      itn: false
                      iso3: STP
                      name: Sao Tome and Principe
                      state: true
                      active: true
                      numcode: 678
                      address3: false
                      iso_name: SAO TOME AND PRINCIPE
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: STD
                      currency_symbol: Db
                    - id: 39
                      iso: TD
                      itn: false
                      iso3: TCD
                      name: Chad
                      state: true
                      active: true
                      numcode: 148
                      address3: false
                      iso_name: CHAD
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: XAF
                      currency_symbol: CFA
                    - id: 173
                      iso: PM
                      itn: false
                      iso3: SPM
                      name: Saint Pierre and Miquelon
                      state: true
                      active: true
                      numcode: 666
                      address3: false
                      iso_name: SAINT PIERRE AND MIQUELON
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                  image_url: >-
                    https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                  commission: '10.0'
                  country_id: null
                  share_link: null
                  shopify_id: null
                  description:
                    id: 122
                    body: <div>Optimized clear-thinking access</div>
                    name: description
                    record_id: 113
                    created_at: '2023-12-26T04:49:52.800Z'
                    updated_at: '2023-12-26T06:37:59.551Z'
                    record_type: Product
                  price_range:
                    - $17.32
                    - $17.32
                  country_code: td
                  currency_code: USD
                  display_price: $17.32 (USD)
                  option_values: {}
                  average_rating: 0
                  shopify_handle: null
                  currency_symbol: $
                  default_variant:
                    id: 113
                    sku: QDPF7N2XOR
                    size: 4cm
                    price: null
                    title: Default Variant
                    width: null
                    active: true
                    height: null
                    length: null
                    weight: 10 kg
                    hs_code: null
                    taxable: true
                    bar_code: null
                    physical: null
                    position: 1
                    image_url: null
                    is_master: true
                    created_at: '2023-12-26T04:49:52.811Z'
                    image_path: null
                    product_id: 113
                    shopify_id: null
                    updated_at: '2023-12-27T12:48:04.588Z'
                    external_id: null
                    discarded_at: null
                    keep_selling: false
                    option_attrs: []
                    unit_of_size: null
                    track_quantity: true
                    unit_of_weight: null
                    inventory_policy: none
                    country_of_origin: null
                    allow_subscription: true
                    inventory_quantity: 99
                    variant_country_id: null
                    customs_information_shipping: null
                  enroll_products: []
                  wholesale_price: '0.0'
                  subscription_price: '17.32'
                  unlimited_inventory: false
                  publish_to_rep_store: true
                  publish_to_share_tab: true
                  price_range_formatted: $17.32
                  display_wholesale_price: $0.00 (USD)
                  publish_to_retail_store: true
                  display_subscription_price: $17.32 (USD)
                  wholesale_subscription_price: '0.0'
                  display_wholesale_subscription_price: $0.00 (USD)
                quantity: 1
                ordered_variant: ''
            phone: null
            amount: '17.32'
            rating: 5
            review: >-
              Lorem Ipsum is simply dummy text of the printing and typesetting
              industry. Lorem Ipsum has been the industry's standard dummy text
              ever since the 1500s, when an unknown printer took a galley of
              type and scrambled it to make a type specimen book. It has
              survived not only five centuries, but also the leap into
              electronic typesetting, remaining essentially unchanged.
            status: awaiting_payment
            contact:
              id: 20
              ip: null
              city: null
              email: amir@danpheit.com
              hours: null
              phone: null
              state: null
              token: qgUpmwfwPpCiVmrQTnw6DZQR
              email2: null
              income: null
              invest: null
              phone2: null
              reason: null
              status: new
              address: null
              address2: null
              interest: null
              phone_id: null
              best_time: null
              full_name: a
              last_name: ''
              lead_type: null
              time_zone: null
              avatar_url: null
              country_id: null
              first_name: a
              language_id: null
              postal_code: null
              requested_at: null
            ship_to:
              id: 980190974
              city: a
              name: a
              state: Alaska
              country:
                id: 214
                iso: US
                itn: false
                iso3: USA
                name: United States
                state: true
                active: true
                default: true
                numcode: 840
                address3: false
                iso_name: UNITED STATES
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                created_at: '2023-12-26T04:48:23.479Z'
                updated_at: '2023-12-26T04:48:23.479Z'
                currency_code: USD
                geo_entity_id: null
                currency_symbol: $
              default: false
              address1: a
              address2: a
              address3: null
              postal_code: '11111'
              country_code: null
            referrer: Maritzaa Gutkowski
            shipping: '0.0'
            subtotal: '17.32'
            tracking: null
            last_name: ''
            sale_date: '2023-12-27T12:47:59.832Z'
            created_at: '2023-12-27T12:47:59.832Z'
            first_name: a
            order_type: null
            refundable: false
            display_tax: $0.00 (USD)
            order_number: F53375259023
            currency_code: USD
            display_amount: $17.32 (USD)
            currency_symbol: $
            display_refunds: (0 CV, 0 QV) -$0.00 (USD)
            friendly_status: pending
            order_thumbnail: >-
              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
            display_discount: $0.00 (USD)
            display_shipping: $0.00 (USD)
            display_subtotal: $17.32 (USD)
            max_refundable_tax: '0.0'
            recognized_ship_date: '2024-01-27'
            max_refundable_amount: '17.32'
            tracking_informations: []
            max_refundable_shipping: '0.0'
            max_refundable_product_price: '17.32'
        timestamp: '2023-12-28T04:02:39.337Z'
        identifier: subscriptionorder-170373615953
    subscription_cancelled:
      title: subscription_cancelled
      required:
        - id
        - name
        - payload
        - timestamp
        - identifier
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        payload:
          allOf:
            - $ref: '#/components/schemas/Payload16'
            - {}
        timestamp:
          type: string
        identifier:
          type: string
      example:
        id: 133
        name: subscription_cancelled
        payload:
          subsctiption_order:
            cv: 0
            id: 53
            qv: 0
            tax: '0.0'
            type: SubscriptionOrder
            email: ram@fluid.com
            items:
              - id: 3
                sku: QDPF7N2XOR
                price: 17.32
                product:
                  id: 113
                  sku: QDPF7N2XOR
                  image:
                    full: >-
                      https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                    mini: >-
                      https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                    detail: >-
                      https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                  leads: 0
                  price: '17.32'
                  title: Aerodynamic Aluminum aaa
                  views: 0
                  active: true
                  images: []
                  public: true
                  vendor: null
                  enrolls: []
                  options: []
                  prompts: []
                  in_stock: true
                  shipping: '0.03'
                  stripped: Optimized clear-thinking access
                  variants:
                    - id: 113
                      title: Default Variant
                      buyable: true
                      image_url: null
                      option_value_ids: []
                      variant_countries:
                        - id: 686
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 214
                            iso: US
                            iso3: USA
                            name: United States
                            iso_name: UNITED STATES
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: US
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 687
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 65
                            iso: FO
                            iso3: FRO
                            name: Faroe Islands
                            iso_name: FAROE ISLANDS
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: FO
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 688
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 92
                            iso: IN
                            iso3: IND
                            name: India
                            iso_name: INDIA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: IN
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 689
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 146
                            iso: NI
                            iso3: NIC
                            name: Nicaragua
                            iso_name: NICARAGUA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: NI
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 690
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 172
                            iso: LC
                            iso3: LCA
                            name: Saint Lucia
                            iso_name: SAINT LUCIA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: LC
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 691
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 66
                            iso: FJ
                            iso3: FJI
                            name: Fiji
                            iso_name: FIJI
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: FJ
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 692
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 93
                            iso: ID
                            iso3: IDN
                            name: Indonesia
                            iso_name: INDONESIA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: ID
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 693
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 147
                            iso: NE
                            iso3: NER
                            name: Niger
                            iso_name: NIGER
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: NE
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 694
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 67
                            iso: FI
                            iso3: FIN
                            name: Finland
                            iso_name: FINLAND
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: FI
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        - id: 695
                          tax: '0.0'
                          price: '17.32'
                          country:
                            id: 148
                            iso: NG
                            iso3: NGA
                            name: Nigeria
                            iso_name: NIGERIA
                            tax_rate: 0
                          shipping: '0.0'
                          country_iso: NG
                          currency_code: USD
                          display_price: $17.32 (USD)
                          currency_symbol: $
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          display_wholesale_price: $0.00 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                      allow_subscription: true
                  countries:
                    - id: 214
                      iso: US
                      itn: false
                      iso3: USA
                      name: United States
                      state: true
                      active: true
                      numcode: 840
                      address3: false
                      iso_name: UNITED STATES
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: USD
                      currency_symbol: $
                    - id: 65
                      iso: FO
                      itn: false
                      iso3: FRO
                      name: Faroe Islands
                      state: true
                      active: true
                      numcode: 234
                      address3: false
                      iso_name: FAROE ISLANDS
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: DKK
                      currency_symbol: kr.
                    - id: 92
                      iso: IN
                      itn: false
                      iso3: IND
                      name: India
                      state: true
                      active: true
                      numcode: 356
                      address3: false
                      iso_name: INDIA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: INR
                      currency_symbol: ₹
                    - id: 146
                      iso: NI
                      itn: false
                      iso3: NIC
                      name: Nicaragua
                      state: true
                      active: true
                      numcode: 558
                      address3: false
                      iso_name: NICARAGUA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: NIO
                      currency_symbol: C$
                    - id: 172
                      iso: LC
                      itn: false
                      iso3: LCA
                      name: Saint Lucia
                      state: true
                      active: true
                      numcode: 662
                      address3: false
                      iso_name: SAINT LUCIA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: XCD
                      currency_symbol: $
                    - id: 66
                      iso: FJ
                      itn: false
                      iso3: FJI
                      name: Fiji
                      state: true
                      active: true
                      numcode: 242
                      address3: false
                      iso_name: FIJI
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: FJD
                      currency_symbol: $
                    - id: 93
                      iso: ID
                      itn: false
                      iso3: IDN
                      name: Indonesia
                      state: true
                      active: true
                      numcode: 360
                      address3: false
                      iso_name: INDONESIA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: IDR
                      currency_symbol: Rp
                    - id: 147
                      iso: NE
                      itn: false
                      iso3: NER
                      name: Niger
                      state: true
                      active: true
                      numcode: 562
                      address3: false
                      iso_name: NIGER
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: XOF
                      currency_symbol: Fr
                    - id: 67
                      iso: FI
                      itn: false
                      iso3: FIN
                      name: Finland
                      state: true
                      active: true
                      numcode: 246
                      address3: false
                      iso_name: FINLAND
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 148
                      iso: NG
                      itn: false
                      iso3: NGA
                      name: Nigeria
                      state: true
                      active: true
                      numcode: 566
                      address3: false
                      iso_name: NIGERIA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: NGN
                      currency_symbol: ₦
                    - id: 174
                      iso: VC
                      itn: false
                      iso3: VCT
                      name: Saint Vincent and the Grenadines
                      state: true
                      active: true
                      numcode: 670
                      address3: false
                      iso_name: SAINT VINCENT AND THE GRENADINES
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: XCD
                      currency_symbol: $
                    - id: 68
                      iso: FR
                      itn: false
                      iso3: FRA
                      name: France
                      state: true
                      active: true
                      numcode: 250
                      address3: false
                      iso_name: FRANCE
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 94
                      iso: IR
                      itn: false
                      iso3: IRN
                      name: Iran, Islamic Republic of
                      state: true
                      active: true
                      numcode: 364
                      address3: false
                      iso_name: IRAN, ISLAMIC REPUBLIC OF
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: IRR
                      currency_symbol: ﷼
                    - id: 149
                      iso: NU
                      itn: false
                      iso3: NIU
                      name: Niue
                      state: true
                      active: true
                      numcode: 570
                      address3: false
                      iso_name: NIUE
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: NZD
                      currency_symbol: $
                    - id: 175
                      iso: WS
                      itn: false
                      iso3: WSM
                      name: Samoa
                      state: true
                      active: true
                      numcode: 882
                      address3: false
                      iso_name: SAMOA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: WST
                      currency_symbol: T
                    - id: 69
                      iso: GF
                      itn: false
                      iso3: GUF
                      name: French Guiana
                      state: true
                      active: true
                      numcode: 254
                      address3: false
                      iso_name: FRENCH GUIANA
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 95
                      iso: IQ
                      itn: false
                      iso3: IRQ
                      name: Iraq
                      state: true
                      active: true
                      numcode: 368
                      address3: false
                      iso_name: IRAQ
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: IQD
                      currency_symbol: ع.د
                    - id: 176
                      iso: SM
                      itn: false
                      iso3: SMR
                      name: San Marino
                      state: true
                      active: true
                      numcode: 674
                      address3: false
                      iso_name: SAN MARINO
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 96
                      iso: IE
                      itn: false
                      iso3: IRL
                      name: Ireland
                      state: true
                      active: true
                      numcode: 372
                      address3: false
                      iso_name: IRELAND
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                    - id: 177
                      iso: ST
                      itn: false
                      iso3: STP
                      name: Sao Tome and Principe
                      state: true
                      active: true
                      numcode: 678
                      address3: false
                      iso_name: SAO TOME AND PRINCIPE
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: STD
                      currency_symbol: Db
                    - id: 39
                      iso: TD
                      itn: false
                      iso3: TCD
                      name: Chad
                      state: true
                      active: true
                      numcode: 148
                      address3: false
                      iso_name: CHAD
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: XAF
                      currency_symbol: CFA
                    - id: 173
                      iso: PM
                      itn: false
                      iso3: SPM
                      name: Saint Pierre and Miquelon
                      state: true
                      active: true
                      numcode: 666
                      address3: false
                      iso_name: SAINT PIERRE AND MIQUELON
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      currency_code: EUR
                      currency_symbol: €
                  image_url: >-
                    https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                  commission: '10.0'
                  country_id: null
                  share_link: null
                  shopify_id: null
                  description:
                    id: 122
                    body: <div>Optimized clear-thinking access</div>
                    name: description
                    record_id: 113
                    created_at: '2023-12-26T04:49:52.800Z'
                    updated_at: '2023-12-26T06:37:59.551Z'
                    record_type: Product
                  price_range:
                    - $17.32
                    - $17.32
                  country_code: td
                  currency_code: USD
                  display_price: $17.32 (USD)
                  option_values: {}
                  average_rating: 0
                  shopify_handle: null
                  currency_symbol: $
                  default_variant:
                    id: 113
                    sku: QDPF7N2XOR
                    size: 4cm
                    price: null
                    title: Default Variant
                    width: null
                    active: true
                    height: null
                    length: null
                    weight: 10 kg
                    hs_code: null
                    taxable: true
                    bar_code: null
                    physical: null
                    position: 1
                    image_url: null
                    is_master: true
                    created_at: '2023-12-26T04:49:52.811Z'
                    image_path: null
                    product_id: 113
                    shopify_id: null
                    updated_at: '2023-12-27T12:48:04.588Z'
                    external_id: null
                    discarded_at: null
                    keep_selling: false
                    option_attrs: []
                    unit_of_size: null
                    track_quantity: true
                    unit_of_weight: null
                    inventory_policy: none
                    country_of_origin: null
                    allow_subscription: true
                    inventory_quantity: 99
                    variant_country_id: null
                    customs_information_shipping: null
                  enroll_products: []
                  wholesale_price: '0.0'
                  subscription_price: '17.32'
                  unlimited_inventory: false
                  publish_to_rep_store: true
                  publish_to_share_tab: true
                  price_range_formatted: $17.32
                  display_wholesale_price: $0.00 (USD)
                  publish_to_retail_store: true
                  display_subscription_price: $17.32 (USD)
                  wholesale_subscription_price: '0.0'
                  display_wholesale_subscription_price: $0.00 (USD)
                quantity: 1
                ordered_variant: ''
            phone: null
            amount: '17.32'
            rating: 5
            review: ''
            status: awaiting_payment
            contact:
              id: 20
              ip: null
              city: null
              email: amir@danpheit.com
              hours: null
              phone: null
              state: null
              token: qgUpmwfwPpCiVmrQTnw6DZQR
              email2: null
              income: null
              invest: null
              phone2: null
              reason: null
              status: new
              address: null
              address2: null
              interest: null
              phone_id: null
              best_time: null
              full_name: a
              last_name: ''
              lead_type: null
              time_zone: null
              avatar_url: null
              country_id: null
              first_name: a
              language_id: null
              postal_code: null
              requested_at: null
            ship_to:
              id: 980190974
              city: a
              name: a
              state: Alaska
              country:
                id: 214
                iso: US
                itn: false
                iso3: USA
                name: United States
                state: true
                active: true
                default: true
                numcode: 840
                address3: false
                iso_name: UNITED STATES
                passport: false
                tax_rate: 0
                delimiter: ','
                separator: .
                created_at: '2023-12-26T04:48:23.479Z'
                updated_at: '2023-12-26T04:48:23.479Z'
                currency_code: USD
                geo_entity_id: null
                currency_symbol: $
              default: false
              address1: a
              address2: a
              address3: null
              postal_code: '11111'
              country_code: null
            referrer: Maritzaa Gutkowski
            shipping: '0.0'
            subtotal: '17.32'
            tracking: null
            last_name: ''
            sale_date: '2023-12-27T12:47:59.832Z'
            created_at: '2023-12-27T12:47:59.832Z'
            first_name: a
            order_type: null
            refundable: false
            display_tax: $0.00 (USD)
            order_number: F53375259023
            currency_code: USD
            display_amount: $17.32 (USD)
            currency_symbol: $
            display_refunds: (0 CV, 0 QV) -$0.00 (USD)
            friendly_status: pending
            order_thumbnail: >-
              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
            display_discount: $0.00 (USD)
            display_shipping: $0.00 (USD)
            display_subtotal: $17.32 (USD)
            max_refundable_tax: '0.0'
            recognized_ship_date: '2024-01-27'
            max_refundable_amount: '17.32'
            tracking_informations: []
            max_refundable_shipping: '0.0'
            max_refundable_product_price: '17.32'
        timestamp: '2023-12-28T04:04:18.669Z'
        identifier: subscriptionorder-170373625853
    user_created:
      title: user_created
      required:
        - id
        - name
        - payload
        - timestamp
        - identifier
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        payload:
          allOf:
            - $ref: '#/components/schemas/Payload19'
            - {}
        timestamp:
          type: string
        identifier:
          type: string
      example:
        id: 163
        name: user_created
        payload:
          user:
            id: 124
            user:
              bio: null
              dob: null
              email: ram@gmailc.om
              phone: null
              avatar: null
              gender: null
              wechat: null
              twitter: null
              youtube: null
              facebook: null
              linkedin: null
              whatsapp: null
              zip_code: null
              google_id: null
              instagram: null
              last_name: Gm
              time_zone: null
              first_name: Ram
            active: false
            username: null
            affiliate:
              id: 1
              email: tingeym2@gmail.com
              username: tobias
              external_id: '2284189'
            external_id: null
        timestamp: '2023-12-28T05:26:09.157Z'
        identifier: usercompany-1703741169124
    Payload19:
      title: Payload19
      required:
        - user
      type: object
      properties:
        user:
          allOf:
            - $ref: '#/components/schemas/User5'
            - {}
      example:
        user:
          id: 124
          user:
            bio: null
            dob: null
            email: ram@gmailc.om
            phone: null
            avatar: null
            gender: null
            wechat: null
            twitter: null
            youtube: null
            facebook: null
            linkedin: null
            whatsapp: null
            zip_code: null
            google_id: null
            instagram: null
            last_name: Gm
            time_zone: null
            first_name: Ram
          active: false
          username: null
          affiliate:
            id: 1
            email: tingeym2@gmail.com
            username: tobias
            external_id: '2284189'
          external_id: null
    User5:
      title: User5
      required:
        - id
        - user
        - active
        - username
        - affiliate
        - external_id
      type: object
      properties:
        id:
          type: integer
          format: int32
        user:
          allOf:
            - $ref: '#/components/schemas/User6'
            - {}
        active:
          type: boolean
        username:
          type: string
        affiliate:
          allOf:
            - $ref: '#/components/schemas/Affiliate7'
            - {}
        external_id:
          type: string
      example:
        id: 124
        user:
          bio: null
          dob: null
          email: ram@gmailc.om
          phone: null
          avatar: null
          gender: null
          wechat: null
          twitter: null
          youtube: null
          facebook: null
          linkedin: null
          whatsapp: null
          zip_code: null
          google_id: null
          instagram: null
          last_name: Gm
          time_zone: null
          first_name: Ram
        active: false
        username: null
        affiliate:
          id: 1
          email: tingeym2@gmail.com
          username: tobias
          external_id: '2284189'
        external_id: null
    User6:
      title: User6
      required:
        - bio
        - dob
        - email
        - phone
        - avatar
        - gender
        - wechat
        - twitter
        - youtube
        - facebook
        - linkedin
        - whatsapp
        - zip_code
        - google_id
        - instagram
        - last_name
        - time_zone
        - first_name
      type: object
      properties:
        bio:
          type: string
        dob:
          type: string
        email:
          type: string
        phone:
          type: string
        avatar:
          type: string
        gender:
          type: string
        wechat:
          type: string
        twitter:
          type: string
        youtube:
          type: string
        facebook:
          type: string
        linkedin:
          type: string
        whatsapp:
          type: string
        zip_code:
          type: string
        google_id:
          type: string
        instagram:
          type: string
        last_name:
          type: string
        time_zone:
          type: string
        first_name:
          type: string
      example:
        bio: null
        dob: null
        email: ram@gmailc.om
        phone: null
        avatar: null
        gender: null
        wechat: null
        twitter: null
        youtube: null
        facebook: null
        linkedin: null
        whatsapp: null
        zip_code: null
        google_id: null
        instagram: null
        last_name: Gm
        time_zone: null
        first_name: Ram
    Affiliate7:
      title: Affiliate7
      required:
        - id
        - email
        - username
        - external_id
      type: object
      properties:
        id:
          type: integer
          format: int32
        email:
          type: string
        username:
          type: string
        external_id:
          type: string
      example:
        id: 1
        email: tingeym2@gmail.com
        username: tobias
        external_id: '2284189'
    user_updated:
      title: user_updated
      required:
        - id
        - name
        - payload
        - timestamp
        - identifier
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        payload:
          allOf:
            - $ref: '#/components/schemas/Payload19'
            - {}
        timestamp:
          type: string
        identifier:
          type: string
      example:
        id: 162
        name: user_updated
        payload:
          user:
            id: 124
            user:
              bio: null
              dob: null
              email: ram@gmailc.om
              phone: null
              avatar: null
              gender: null
              wechat: null
              twitter: null
              youtube: null
              facebook: null
              linkedin: null
              whatsapp: null
              zip_code: null
              google_id: null
              instagram: null
              last_name: Gm
              time_zone: null
              first_name: Ram
            active: false
            username: null
            affiliate:
              id: 1
              email: tingeym2@gmail.com
              username: tobias
              external_id: '2284189'
            external_id: null
        timestamp: '2023-12-28T05:25:29.021Z'
        identifier: usercompany-1703741129124
    user_deactivated:
      title: user_deactivated
      required:
        - id
        - name
        - payload
        - timestamp
        - identifier
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        payload:
          allOf:
            - $ref: '#/components/schemas/Payload19'
            - {}
        timestamp:
          type: string
        identifier:
          type: string
      example:
        id: 164
        name: user_deactivated
        payload:
          user:
            id: 124
            user:
              bio: null
              dob: null
              email: ram@gmailc.om
              phone: null
              avatar: null
              gender: null
              wechat: null
              twitter: null
              youtube: null
              facebook: null
              linkedin: null
              whatsapp: null
              zip_code: null
              google_id: null
              instagram: null
              last_name: Gm
              time_zone: null
              first_name: Ram
            active: false
            username: null
            affiliate:
              id: 1
              email: tingeym2@gmail.com
              username: tobias
              external_id: '2284189'
            external_id: null
        timestamp: '2023-12-28T05:26:57.115Z'
        identifier: usercompany-1703741217124
    createrequest10:
      title: createrequest10
      required:
        - event
      type: object
      properties:
        event:
          allOf:
            - $ref: '#/components/schemas/Event3'
            - {}
      example:
        event:
          title: Type Race
          description: >-
            Fluid Type Racing Game. Winner gets all expenses paid 1 month
            vacation trip to Bali.
          start_date: '2024-03-28'
          end_date: '2024-04-01'
          start_time: '9:56:0'
          end_time: '19:56:0'
          time_zone: Asia/Kathmandu
          url: https://google.com
          active: true
          venue: Pokhara
          available_countries:
            - us
            - in
            - fin
          images_attributes:
            - image_url: >-
                https://images.furnituredealer.net/img/products/liberty_furniture/color/double%20bridge--816253672_152-cd-gts-b6.jpg
              position: 1
            - image_url: >-
                https://images.furnituredealer.net/img/products/steve_silver/color/david-1172854226_di100c-b1.jpg
    Event3:
      title: Event3
      required:
        - title
        - description
        - start_date
        - end_date
        - start_time
        - end_time
        - time_zone
        - url
        - active
        - venue
        - available_countries
        - images_attributes
      type: object
      properties:
        title:
          type: string
        description:
          type: string
        start_date:
          type: string
        end_date:
          type: string
        start_time:
          type: string
        end_time:
          type: string
        time_zone:
          type: string
        url:
          type: string
        active:
          type: boolean
        venue:
          type: string
        available_countries:
          type: array
          items:
            type: string
          description: ''
        images_attributes:
          type: array
          items:
            $ref: '#/components/schemas/ImagesAttribute'
          description: ''
      example:
        title: Type Race
        description: >-
          Fluid Type Racing Game. Winner gets all expenses paid 1 month vacation
          trip to Bali.
        start_date: '2024-03-28'
        end_date: '2024-04-01'
        start_time: '9:56:0'
        end_time: '19:56:0'
        time_zone: Asia/Kathmandu
        url: https://google.com
        active: true
        venue: Pokhara
        available_countries:
          - us
          - in
          - fin
        images_attributes:
          - image_url: >-
              https://images.furnituredealer.net/img/products/liberty_furniture/color/double%20bridge--816253672_152-cd-gts-b6.jpg
            position: 1
          - image_url: >-
              https://images.furnituredealer.net/img/products/steve_silver/color/david-1172854226_di100c-b1.jpg
    ImagesAttribute:
      title: ImagesAttribute
      required:
        - image_url
      type: object
      properties:
        image_url:
          type: string
        position:
          type: integer
          format: int32
      example:
        image_url: >-
          https://images.furnituredealer.net/img/products/liberty_furniture/color/double%20bridge--816253672_152-cd-gts-b6.jpg
        position: 1
    updaterequest9:
      title: updaterequest9
      required:
        - event
      type: object
      properties:
        event:
          allOf:
            - $ref: '#/components/schemas/Event4'
            - {}
      example:
        event:
          title: Type Race
          description: >-
            Fluid Type Racing Game. Winner gets all expense paid 1 month
            vacation trip to Bali. The winner will also get the salary/wages for
            the vacation month.
          available_countries:
            - npl
            - us
    Event4:
      title: Event4
      required:
        - title
        - description
        - available_countries
      type: object
      properties:
        title:
          type: string
        description:
          type: string
        available_countries:
          type: array
          items:
            type: string
          description: ''
      example:
        title: Type Race
        description: >-
          Fluid Type Racing Game. Winner gets all expense paid 1 month vacation
          trip to Bali. The winner will also get the salary/wages for the
          vacation month.
        available_countries:
          - npl
          - us
    createrequest11:
      title: createrequest11
      required:
        - lang
        - custom_page
      type: object
      properties:
        lang:
          type: string
        custom_page:
          allOf:
            - $ref: '#/components/schemas/CustomPage'
            - {}
      example:
        lang: en
        custom_page:
          title: El Condor Pasa
          html_code: <p>Es un detalles</p>
          image_url: >-
            https://wallup.net/wp-content/uploads/2019/09/841798-lamborghini-aventador-super-veloce-cars-supercars-red.jpg
          active: true
          use_fluid_menu: true
          default: true
          use_for_shop: true
          use_search_engine: false
          available_countries:
            - us
            - in
            - fin
    MobileWidget:
      type: object
      properties:
        id:
          type: integer
          description: Unique identifier of the mobile widget
        droplet_installation_id:
          type:
            - integer
            - 'null'
          description: ID of the company droplet
        company_id:
          type: integer
          description: ID of the company
        cover_image_url:
          type: string
          description: URL of the widget's cover image
        created_at:
          type: string
          format: date-time
          description: Creation timestamp
        embed_url:
          type: string
          description: URL where the widget is embedded
        height:
          type: integer
          description: Height of the widget in pixels
        name:
          type: string
          description: Name of the mobile widget
        page_scope:
          type: object
          properties:
            home:
              type: boolean
              description: Whether the widget appears on home page
            explore:
              type: boolean
              description: Whether the widget appears on explore page
        updated_at:
          type: string
          format: date-time
          description: Last update timestamp
    PaginationMeta:
      type: object
      properties:
        request_id:
          type: string
          description: Unique identifier for the request
        timestamp:
          type: string
          format: date-time
          description: Timestamp of the response
        total_count:
          type: integer
          description: Total number of items
        total_pages:
          type: integer
          description: Total number of pages
        current_page:
          type: integer
          description: Current page number
    CustomPage:
      title: CustomPage
      required:
        - title
        - html_code
        - image_url
        - active
        - use_fluid_menu
        - default
        - use_for_shop
        - use_search_engine
        - available_countries
      type: object
      properties:
        title:
          type: string
        html_code:
          type: string
        image_url:
          type: string
        active:
          type: boolean
        use_fluid_menu:
          type: boolean
        default:
          type: boolean
        use_for_shop:
          type: boolean
        use_search_engine:
          type: boolean
        available_countries:
          type: array
          items:
            type: string
          description: ''
      example:
        title: El Condor Pasa
        html_code: <p>Es un detalles</p>
        image_url: >-
          https://wallup.net/wp-content/uploads/2019/09/841798-lamborghini-aventador-super-veloce-cars-supercars-red.jpg
        active: true
        use_fluid_menu: true
        default: true
        use_for_shop: true
        use_search_engine: false
        available_countries:
          - us
          - in
          - fin
    updaterequest10:
      title: updaterequest10
      required:
        - lang
        - custom_page
      type: object
      properties:
        lang:
          type: string
        custom_page:
          allOf:
            - $ref: '#/components/schemas/CustomPage1'
            - {}
      example:
        lang: es
        custom_page:
          title: El Pais
          html_code: <p>Hola, Espanol, que tal?</p>
          active: true
          use_fluid_menu: true
          default: true
          use_for_shop: true
          use_search_engine: false
          available_countries:
            - ind
          label_id: 16
    CustomPage1:
      title: CustomPage1
      required:
        - title
        - html_code
        - active
        - use_fluid_menu
        - default
        - use_for_shop
        - use_search_engine
        - available_countries
        - label_id
      type: object
      properties:
        title:
          type: string
        html_code:
          type: string
        active:
          type: boolean
        use_fluid_menu:
          type: boolean
        default:
          type: boolean
        use_for_shop:
          type: boolean
        use_search_engine:
          type: boolean
        available_countries:
          type: array
          items:
            type: string
          description: ''
        label_id:
          type: integer
          format: int32
      example:
        title: El Pais
        html_code: <p>Hola, Espanol, que tal?</p>
        active: true
        use_fluid_menu: true
        default: true
        use_for_shop: true
        use_search_engine: false
        available_countries:
          - ind
        label_id: 16
    index9:
      title: index9
      required:
        - id
        - title
        - slug
        - share_link
        - views
        - leads
        - company_library
        - affiliate_id
        - label
        - display_tag
        - library_items
      type: object
      properties:
        id:
          type: integer
          format: int32
        title:
          type: string
        slug:
          type: string
        share_link:
          type: string
        views:
          type: integer
          format: int32
        leads:
          type: integer
          format: int32
        company_library:
          type: string
        affiliate_id:
          type: integer
          format: int32
        label:
          type: string
        display_tag:
          type: string
        library_items:
          type: array
          items:
            oneOf:
              - $ref: '#/components/schemas/LibraryItem'
              - allOf:
                  - $ref: '#/components/schemas/LibraryItem1'
                  - example:
                      id: 362
                      order: null
                      relateable_type: Product
                      relateable:
                        id: 1981
                        active: true
                        title: In iste aliquip aliq
                        description:
                          id: 2025
                          name: description
                          body: <div>Minus eum proident, .</div>
                          record_type: Product
                          record_id: 1981
                          created_at: '2022-06-17T09:25:58.301Z'
                          updated_at: '2022-06-17T09:25:58.301Z'
                          locale: null
                        stripped: Minus eum proident, .
                        price: '182.0'
                        display_price: Rs.182.00 (NPR)
                        subscription_price: '182.0'
                        display_subscription_price: Rs.182.00 (NPR)
                        wholesale_price: '0.0'
                        display_wholesale_price: Rs.0.00 (NPR)
                        wholesale_subscription_price: '0.0'
                        display_wholesale_subscription_price: Rs.0.00 (NPR)
                        shipping: '737.0'
                        image:
                          mini: >-
                            https://ik.imagekit.io/fluid/s3/GwzQ01WQF2ZQnueJG5W2_missing_image.jpg
                          detail: >-
                            https://ik.imagekit.io/fluid/s3/GwzQ01WQF2ZQnueJG5W2_missing_image.jpg
                          full: >-
                            https://ik.imagekit.io/fluid/s3/GwzQ01WQF2ZQnueJG5W2_missing_image.jpg
                        image_url: >-
                          https://ik.imagekit.io/fluid/s3/GwzQ01WQF2ZQnueJG5W2_missing_image.jpg
                        sku: Alias rerum quis asp
                        country_code: np
                        country_id: 141
                        views: 0
                        leads: 0
                        share_link: null
                        commission: '10.0'
                        public: true
                        shopify_id: null
                        shopify_handle: null
                        in_stock: true
                        vendor: null
                        price_range:
                          - Rs.182.00
                          - Rs.182.00
                        price_range_formatted: Rs.182.00
                        unlimited_inventory: false
                        default_variant:
                          id: 9970
                          product_id: 1981
                          shopify_id: null
                          title: null
                          sku: Alias rerum quis asp
                          position: 84
                          inventory_policy: none
                          taxable: true
                          inventory_quantity: 1
                          created_at: '2022-06-17T09:25:58.326Z'
                          updated_at: '2024-03-13T07:38:28.858Z'
                          external_id: null
                          variant_country_id: null
                          image_url: null
                          image_path: null
                          is_master: true
                          discarded_at: null
                          price: null
                          weight: null
                          size: null
                          physical: null
                          unit_of_weight: null
                          height: 0
                          width: 0
                          length: 0
                          unit_of_size: null
                          hs_code: null
                          country_of_origin: null
                          customs_information_shipping: null
                          active: true
                          bar_code: null
                          track_quantity: null
                          keep_selling: null
                          option_attrs: []
                          allow_subscription: true
                          subscription_only: false
                          limit_subscription: false
                          subscription_max_qty: null
                          shipping_included_in_price: false
                          subscription_interval: 1
                        currency_symbol: Rs.
                        currency_code: NPR
                        average_rating: 0
                        option_values: {}
                        publish_to_retail_store: true
                        publish_to_rep_store: true
                        publish_to_share_tab: true
                        hide_rating?: true
                        hide_reviews?: true
                        prompts_enabled: false
                        label: null
                        display_tag: null
                        images:
                          - id: 1881
                            image:
                              mini: >-
                                https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/GwzQ01WQF2ZQnueJG5W2_missing_image.jpg
                              detail: >-
                                https://ik.imagekit.io/fluid/s3/tr:n-video_poster/GwzQ01WQF2ZQnueJG5W2_missing_image.jpg
                              full: >-
                                https://ik.imagekit.io/fluid/s3/GwzQ01WQF2ZQnueJG5W2_missing_image.jpg
                            image_url: >-
                              https://ik.imagekit.io/fluid/s3/GwzQ01WQF2ZQnueJG5W2_missing_image.jpg
                            position: null
                            shopify_id: null
                        countries:
                          - id: 24
                            iso_name: BHUTAN
                            iso: BT
                            iso3: BTN
                            name: Bhutan
                            numcode: 64
                            active: true
                            currency_code: BTN
                            currency_symbol: Nu.
                            separator: .
                            delimiter: ','
                            address3: false
                            state: true
                            passport: false
                            itn: false
                            tax_rate: 0
                          - id: 92
                            iso_name: INDIA
                            iso: IN
                            iso3: IND
                            name: India
                            numcode: 356
                            active: true
                            currency_code: INR
                            currency_symbol: ₹
                            separator: .
                            delimiter: ','
                            address3: false
                            state: true
                            passport: false
                            itn: false
                            tax_rate: 0
                          - id: 214
                            iso_name: UNITED STATES
                            iso: US
                            iso3: USA
                            name: United States
                            numcode: 840
                            active: true
                            currency_code: USD
                            currency_symbol: $
                            separator: .
                            delimiter: ','
                            address3: false
                            state: true
                            passport: false
                            itn: false
                            tax_rate: 0
                          - id: 141
                            iso_name: NEPAL
                            iso: NP
                            iso3: NPL
                            name: Nepal
                            numcode: 524
                            active: true
                            currency_code: NPR
                            currency_symbol: Rs.
                            separator: .
                            delimiter: ','
                            address3: false
                            state: true
                            passport: false
                            itn: false
                            tax_rate: 0
                          - id: 1
                            iso_name: AFGHANISTAN
                            iso: AF
                            iso3: AFG
                            name: Afghanistan
                            numcode: 4
                            active: true
                            currency_code: AFN
                            currency_symbol: ؋
                            separator: .
                            delimiter: ','
                            address3: false
                            state: true
                            passport: false
                            itn: false
                            tax_rate: 0
                        variants:
                          - id: 9970
                            title: null
                            image_url: null
                            buyable: true
                            option_value_ids: []
                            allow_subscription: true
                            subscription_only: false
                            shipping_included_in_price: false
                            variant_countries:
                              - id: 99273
                                price: '182.0'
                                shipping: '737.0'
                                tax: '0.0'
                                currency_code: NPR
                                currency_symbol: Rs.
                                display_price: Rs.182.00
                                country_iso: NP
                                subscription_price: '182.0'
                                display_wholesale_price: Rs.0.00
                                display_wholesale_subscription_price: Rs.0.00
                                wholesale_price: '0.0'
                                wholesale_subscription_price: '0.0'
                                country:
                                  id: 141
                                  iso: NP
                                  iso_name: NEPAL
                                  iso3: NPL
                                  name: Nepal
                                  tax_rate: 0
                        options: []
                        prompts: []
                        enroll_products: []
                        enrollment_packs: []
          description: ''
      example:
        id: 361
        title: New library
        slug: new-library
        share_link: null
        views: 0
        leads: 0
        company_library: null
        affiliate_id: 2707
        label: null
        display_tag: null
        library_items: []
    LibraryItem:
      title: LibraryItem
      type: object
      properties:
        id:
          type: integer
          format: int32
        order:
          type: string
        relateable_type:
          type: string
        relateable:
          allOf:
            - $ref: '#/components/schemas/Relateable'
            - {}
    Relateable:
      title: Relateable
      required:
        - id
        - active
        - title
        - description
        - stripped
        - price
        - display_price
        - subscription_price
        - display_subscription_price
        - wholesale_price
        - display_wholesale_price
        - wholesale_subscription_price
        - display_wholesale_subscription_price
        - shipping
        - image
        - image_url
        - sku
        - country_code
        - country_id
        - views
        - leads
        - share_link
        - commission
        - public
        - shopify_id
        - shopify_handle
        - in_stock
        - vendor
        - price_range
        - price_range_formatted
        - unlimited_inventory
        - default_variant
        - currency_symbol
        - currency_code
        - average_rating
        - option_values
        - publish_to_retail_store
        - publish_to_rep_store
        - publish_to_share_tab
        - hide_rating?
        - hide_reviews?
        - prompts_enabled
        - label
        - display_tag
        - images
        - countries
        - variants
        - options
        - prompts
        - enroll_products
        - enrollment_packs
      type: object
      properties:
        id:
          type: integer
          format: int32
        active:
          type: boolean
        title:
          type: string
        description:
          allOf:
            - $ref: '#/components/schemas/Description19'
            - {}
        stripped:
          type: string
        price:
          type: string
        display_price:
          type: string
        subscription_price:
          type: string
        display_subscription_price:
          type: string
        wholesale_price:
          type: string
        display_wholesale_price:
          type: string
        wholesale_subscription_price:
          type: string
        display_wholesale_subscription_price:
          type: string
        shipping:
          type: string
        image:
          allOf:
            - $ref: '#/components/schemas/Image3'
            - {}
        image_url:
          type: string
        sku:
          type: string
        country_code:
          type: string
        country_id:
          type: integer
          format: int32
        views:
          type: integer
          format: int32
        leads:
          type: integer
          format: int32
        share_link:
          type: string
        commission:
          type: string
        public:
          type: boolean
        shopify_id:
          type: string
        shopify_handle:
          type: string
        in_stock:
          type: boolean
        vendor:
          type: string
        price_range:
          type: array
          items:
            type: string
          description: ''
        price_range_formatted:
          type: string
        unlimited_inventory:
          type: boolean
        default_variant:
          allOf:
            - $ref: '#/components/schemas/DefaultVariant16'
            - {}
        currency_symbol:
          type: string
        currency_code:
          type: string
        average_rating:
          type: integer
          format: int32
        option_values:
          type: object
        publish_to_retail_store:
          type: boolean
        publish_to_rep_store:
          type: boolean
        publish_to_share_tab:
          type: boolean
        hide_rating?:
          type: boolean
        hide_reviews?:
          type: boolean
        prompts_enabled:
          type: boolean
        label:
          type: string
        display_tag:
          type: string
        images:
          type: array
          items:
            $ref: '#/components/schemas/Image9'
          description: ''
        countries:
          type: array
          items:
            $ref: '#/components/schemas/Country7'
          description: ''
        variants:
          type: array
          items:
            $ref: '#/components/schemas/Variant22'
          description: ''
        options:
          type: array
          items:
            type: string
          description: ''
        prompts:
          type: array
          items:
            type: string
          description: ''
        enroll_products:
          type: array
          items:
            type: string
          description: ''
        enrollment_packs:
          type: array
          items:
            type: string
          description: ''
      example:
        id: 1981
        active: true
        title: In iste aliquip aliq
        description:
          id: 2025
          name: description
          body: <div>Minus eum proident, .</div>
          record_type: Product
          record_id: 1981
          created_at: '2022-06-17T09:25:58.301Z'
          updated_at: '2022-06-17T09:25:58.301Z'
          locale: null
        stripped: Minus eum proident, .
        price: '182.0'
        display_price: Rs.182.00 (NPR)
        subscription_price: '182.0'
        display_subscription_price: Rs.182.00 (NPR)
        wholesale_price: '0.0'
        display_wholesale_price: Rs.0.00 (NPR)
        wholesale_subscription_price: '0.0'
        display_wholesale_subscription_price: Rs.0.00 (NPR)
        shipping: '737.0'
        image:
          mini: >-
            https://ik.imagekit.io/fluid/s3/GwzQ01WQF2ZQnueJG5W2_missing_image.jpg
          detail: >-
            https://ik.imagekit.io/fluid/s3/GwzQ01WQF2ZQnueJG5W2_missing_image.jpg
          full: >-
            https://ik.imagekit.io/fluid/s3/GwzQ01WQF2ZQnueJG5W2_missing_image.jpg
        image_url: https://ik.imagekit.io/fluid/s3/GwzQ01WQF2ZQnueJG5W2_missing_image.jpg
        sku: Alias rerum quis asp
        country_code: np
        country_id: 141
        views: 0
        leads: 0
        share_link: null
        commission: '10.0'
        public: true
        shopify_id: null
        shopify_handle: null
        in_stock: true
        vendor: null
        price_range:
          - Rs.182.00
          - Rs.182.00
        price_range_formatted: Rs.182.00
        unlimited_inventory: false
        default_variant:
          id: 9970
          product_id: 1981
          shopify_id: null
          title: null
          sku: Alias rerum quis asp
          position: 84
          inventory_policy: none
          taxable: true
          inventory_quantity: 1
          created_at: '2022-06-17T09:25:58.326Z'
          updated_at: '2024-03-13T07:38:28.858Z'
          external_id: null
          variant_country_id: null
          image_url: null
          image_path: null
          is_master: true
          discarded_at: null
          price: null
          weight: null
          size: null
          physical: null
          unit_of_weight: null
          height: 0
          width: 0
          length: 0
          unit_of_size: null
          hs_code: null
          country_of_origin: null
          customs_information_shipping: null
          active: true
          bar_code: null
          track_quantity: null
          keep_selling: null
          option_attrs: []
          allow_subscription: true
          subscription_only: false
          limit_subscription: false
          subscription_max_qty: null
          shipping_included_in_price: false
          subscription_interval: 1
        currency_symbol: Rs.
        currency_code: NPR
        average_rating: 0
        option_values: {}
        publish_to_retail_store: true
        publish_to_rep_store: true
        publish_to_share_tab: true
        hide_rating?: true
        hide_reviews?: true
        prompts_enabled: false
        label: null
        display_tag: null
        images:
          - id: 1881
            image:
              mini: >-
                https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/GwzQ01WQF2ZQnueJG5W2_missing_image.jpg
              detail: >-
                https://ik.imagekit.io/fluid/s3/tr:n-video_poster/GwzQ01WQF2ZQnueJG5W2_missing_image.jpg
              full: >-
                https://ik.imagekit.io/fluid/s3/GwzQ01WQF2ZQnueJG5W2_missing_image.jpg
            image_url: >-
              https://ik.imagekit.io/fluid/s3/GwzQ01WQF2ZQnueJG5W2_missing_image.jpg
            position: null
            shopify_id: null
        countries:
          - id: 24
            iso_name: BHUTAN
            iso: BT
            iso3: BTN
            name: Bhutan
            numcode: 64
            active: true
            currency_code: BTN
            currency_symbol: Nu.
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 92
            iso_name: INDIA
            iso: IN
            iso3: IND
            name: India
            numcode: 356
            active: true
            currency_code: INR
            currency_symbol: ₹
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 214
            iso_name: UNITED STATES
            iso: US
            iso3: USA
            name: United States
            numcode: 840
            active: true
            currency_code: USD
            currency_symbol: $
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 141
            iso_name: NEPAL
            iso: NP
            iso3: NPL
            name: Nepal
            numcode: 524
            active: true
            currency_code: NPR
            currency_symbol: Rs.
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 1
            iso_name: AFGHANISTAN
            iso: AF
            iso3: AFG
            name: Afghanistan
            numcode: 4
            active: true
            currency_code: AFN
            currency_symbol: ؋
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
        variants:
          - id: 9970
            title: null
            image_url: null
            buyable: true
            option_value_ids: []
            allow_subscription: true
            subscription_only: false
            shipping_included_in_price: false
            variant_countries:
              - id: 99273
                price: '182.0'
                shipping: '737.0'
                tax: '0.0'
                currency_code: NPR
                currency_symbol: Rs.
                display_price: Rs.182.00
                country_iso: NP
                subscription_price: '182.0'
                display_wholesale_price: Rs.0.00
                display_wholesale_subscription_price: Rs.0.00
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 141
                  iso: NP
                  iso_name: NEPAL
                  iso3: NPL
                  name: Nepal
                  tax_rate: 0
        options: []
        prompts: []
        enroll_products: []
        enrollment_packs: []
    Description19:
      title: Description19
      required:
        - id
        - name
        - body
        - record_type
        - record_id
        - created_at
        - updated_at
        - locale
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        body:
          type: string
        record_type:
          type: string
        record_id:
          type: integer
          format: int32
        created_at:
          type: string
        updated_at:
          type: string
        locale:
          type: string
      example:
        id: 2025
        name: description
        body: <div>Minus eum proident, .</div>
        record_type: Product
        record_id: 1981
        created_at: '2022-06-17T09:25:58.301Z'
        updated_at: '2022-06-17T09:25:58.301Z'
        locale: null
    DefaultVariant16:
      title: DefaultVariant16
      required:
        - id
        - product_id
        - shopify_id
        - title
        - sku
        - position
        - inventory_policy
        - taxable
        - inventory_quantity
        - created_at
        - updated_at
        - external_id
        - variant_country_id
        - image_url
        - image_path
        - is_master
        - discarded_at
        - price
        - weight
        - size
        - physical
        - unit_of_weight
        - height
        - width
        - length
        - unit_of_size
        - hs_code
        - country_of_origin
        - customs_information_shipping
        - active
        - bar_code
        - track_quantity
        - keep_selling
        - option_attrs
        - allow_subscription
        - subscription_only
        - limit_subscription
        - subscription_max_qty
        - shipping_included_in_price
        - subscription_interval
      type: object
      properties:
        id:
          type: integer
          format: int32
        product_id:
          type: integer
          format: int32
        shopify_id:
          type: string
        title:
          type: string
        sku:
          type: string
        position:
          type: integer
          format: int32
        inventory_policy:
          type: string
        taxable:
          type: boolean
        inventory_quantity:
          type: integer
          format: int32
        created_at:
          type: string
        updated_at:
          type: string
        external_id:
          type: string
        variant_country_id:
          type: string
        image_url:
          type: string
        image_path:
          type: string
        is_master:
          type: boolean
        discarded_at:
          type: string
        price:
          type: string
        weight:
          type: string
        size:
          type: string
        physical:
          type: string
        unit_of_weight:
          type: string
        height:
          type: integer
          format: int32
        width:
          type: integer
          format: int32
        length:
          type: integer
          format: int32
        unit_of_size:
          type: string
        hs_code:
          type: string
        country_of_origin:
          type: string
        customs_information_shipping:
          type: string
        active:
          type: boolean
        bar_code:
          type: string
        track_quantity:
          type: string
        keep_selling:
          type: string
        option_attrs:
          type: array
          items:
            type: string
          description: ''
        allow_subscription:
          type: boolean
        subscription_only:
          type: boolean
        limit_subscription:
          type: boolean
        subscription_max_qty:
          type: string
        shipping_included_in_price:
          type: boolean
        subscription_interval:
          type: integer
          format: int32
      example:
        id: 9970
        product_id: 1981
        shopify_id: null
        title: null
        sku: Alias rerum quis asp
        position: 84
        inventory_policy: none
        taxable: true
        inventory_quantity: 1
        created_at: '2022-06-17T09:25:58.326Z'
        updated_at: '2024-03-13T07:38:28.858Z'
        external_id: null
        variant_country_id: null
        image_url: null
        image_path: null
        is_master: true
        discarded_at: null
        price: null
        weight: null
        size: null
        physical: null
        unit_of_weight: null
        height: 0
        width: 0
        length: 0
        unit_of_size: null
        hs_code: null
        country_of_origin: null
        customs_information_shipping: null
        active: true
        bar_code: null
        track_quantity: null
        keep_selling: null
        option_attrs: []
        allow_subscription: true
        subscription_only: false
        limit_subscription: false
        subscription_max_qty: null
        shipping_included_in_price: false
        subscription_interval: 1
    Variant22:
      title: Variant22
      required:
        - id
        - title
        - image_url
        - buyable
        - option_value_ids
        - allow_subscription
        - subscription_only
        - shipping_included_in_price
        - variant_countries
      type: object
      properties:
        id:
          type: integer
          format: int32
        title:
          type: string
        image_url:
          type: string
        buyable:
          type: boolean
        option_value_ids:
          type: array
          items:
            type: string
          description: ''
        allow_subscription:
          type: boolean
        subscription_only:
          type: boolean
        shipping_included_in_price:
          type: boolean
        variant_countries:
          type: array
          items:
            $ref: '#/components/schemas/VariantCountries5'
          description: ''
      example:
        id: 9970
        title: null
        image_url: null
        buyable: true
        option_value_ids: []
        allow_subscription: true
        subscription_only: false
        shipping_included_in_price: false
        variant_countries:
          - id: 99273
            price: '182.0'
            shipping: '737.0'
            tax: '0.0'
            currency_code: NPR
            currency_symbol: Rs.
            display_price: Rs.182.00
            country_iso: NP
            subscription_price: '182.0'
            display_wholesale_price: Rs.0.00
            display_wholesale_subscription_price: Rs.0.00
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 141
              iso: NP
              iso_name: NEPAL
              iso3: NPL
              name: Nepal
              tax_rate: 0
    LibraryItem1:
      title: LibraryItem1
      required:
        - id
        - order
        - relateable_type
        - relateable
      type: object
      properties:
        id:
          type: integer
          format: int32
        order:
          type: string
        relateable_type:
          type: string
        relateable:
          allOf:
            - $ref: '#/components/schemas/Relateable'
            - {}
      example:
        id: 362
        order: null
        relateable_type: Product
        relateable:
          id: 1981
          active: true
          title: In iste aliquip aliq
          description:
            id: 2025
            name: description
            body: <div>Minus eum proident, .</div>
            record_type: Product
            record_id: 1981
            created_at: '2022-06-17T09:25:58.301Z'
            updated_at: '2022-06-17T09:25:58.301Z'
            locale: null
          stripped: Minus eum proident, .
          price: '182.0'
          display_price: Rs.182.00 (NPR)
          subscription_price: '182.0'
          display_subscription_price: Rs.182.00 (NPR)
          wholesale_price: '0.0'
          display_wholesale_price: Rs.0.00 (NPR)
          wholesale_subscription_price: '0.0'
          display_wholesale_subscription_price: Rs.0.00 (NPR)
          shipping: '737.0'
          image:
            mini: >-
              https://ik.imagekit.io/fluid/s3/GwzQ01WQF2ZQnueJG5W2_missing_image.jpg
            detail: >-
              https://ik.imagekit.io/fluid/s3/GwzQ01WQF2ZQnueJG5W2_missing_image.jpg
            full: >-
              https://ik.imagekit.io/fluid/s3/GwzQ01WQF2ZQnueJG5W2_missing_image.jpg
          image_url: >-
            https://ik.imagekit.io/fluid/s3/GwzQ01WQF2ZQnueJG5W2_missing_image.jpg
          sku: Alias rerum quis asp
          country_code: np
          country_id: 141
          views: 0
          leads: 0
          share_link: null
          commission: '10.0'
          public: true
          shopify_id: null
          shopify_handle: null
          in_stock: true
          vendor: null
          price_range:
            - Rs.182.00
            - Rs.182.00
          price_range_formatted: Rs.182.00
          unlimited_inventory: false
          default_variant:
            id: 9970
            product_id: 1981
            shopify_id: null
            title: null
            sku: Alias rerum quis asp
            position: 84
            inventory_policy: none
            taxable: true
            inventory_quantity: 1
            created_at: '2022-06-17T09:25:58.326Z'
            updated_at: '2024-03-13T07:38:28.858Z'
            external_id: null
            variant_country_id: null
            image_url: null
            image_path: null
            is_master: true
            discarded_at: null
            price: null
            weight: null
            size: null
            physical: null
            unit_of_weight: null
            height: 0
            width: 0
            length: 0
            unit_of_size: null
            hs_code: null
            country_of_origin: null
            customs_information_shipping: null
            active: true
            bar_code: null
            track_quantity: null
            keep_selling: null
            option_attrs: []
            allow_subscription: true
            subscription_only: false
            limit_subscription: false
            subscription_max_qty: null
            shipping_included_in_price: false
            subscription_interval: 1
          currency_symbol: Rs.
          currency_code: NPR
          average_rating: 0
          option_values: {}
          publish_to_retail_store: true
          publish_to_rep_store: true
          publish_to_share_tab: true
          hide_rating?: true
          hide_reviews?: true
          prompts_enabled: false
          label: null
          display_tag: null
          images:
            - id: 1881
              image:
                mini: >-
                  https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/GwzQ01WQF2ZQnueJG5W2_missing_image.jpg
                detail: >-
                  https://ik.imagekit.io/fluid/s3/tr:n-video_poster/GwzQ01WQF2ZQnueJG5W2_missing_image.jpg
                full: >-
                  https://ik.imagekit.io/fluid/s3/GwzQ01WQF2ZQnueJG5W2_missing_image.jpg
              image_url: >-
                https://ik.imagekit.io/fluid/s3/GwzQ01WQF2ZQnueJG5W2_missing_image.jpg
              position: null
              shopify_id: null
          countries:
            - id: 24
              iso_name: BHUTAN
              iso: BT
              iso3: BTN
              name: Bhutan
              numcode: 64
              active: true
              currency_code: BTN
              currency_symbol: Nu.
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 92
              iso_name: INDIA
              iso: IN
              iso3: IND
              name: India
              numcode: 356
              active: true
              currency_code: INR
              currency_symbol: ₹
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 214
              iso_name: UNITED STATES
              iso: US
              iso3: USA
              name: United States
              numcode: 840
              active: true
              currency_code: USD
              currency_symbol: $
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 141
              iso_name: NEPAL
              iso: NP
              iso3: NPL
              name: Nepal
              numcode: 524
              active: true
              currency_code: NPR
              currency_symbol: Rs.
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 1
              iso_name: AFGHANISTAN
              iso: AF
              iso3: AFG
              name: Afghanistan
              numcode: 4
              active: true
              currency_code: AFN
              currency_symbol: ؋
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
          variants:
            - id: 9970
              title: null
              image_url: null
              buyable: true
              option_value_ids: []
              allow_subscription: true
              subscription_only: false
              shipping_included_in_price: false
              variant_countries:
                - id: 99273
                  price: '182.0'
                  shipping: '737.0'
                  tax: '0.0'
                  currency_code: NPR
                  currency_symbol: Rs.
                  display_price: Rs.182.00
                  country_iso: NP
                  subscription_price: '182.0'
                  display_wholesale_price: Rs.0.00
                  display_wholesale_subscription_price: Rs.0.00
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 141
                    iso: NP
                    iso_name: NEPAL
                    iso3: NPL
                    name: Nepal
                    tax_rate: 0
          options: []
          prompts: []
          enroll_products: []
          enrollment_packs: []
    show8:
      title: show8
      required:
        - id
        - title
        - slug
        - share_link
        - views
        - leads
        - company_library
        - affiliate_id
        - label
        - display_tag
        - library_items
      type: object
      properties:
        id:
          type: integer
          format: int32
        title:
          type: string
        slug:
          type: string
        share_link:
          type: string
        views:
          type: integer
          format: int32
        leads:
          type: integer
          format: int32
        company_library:
          type: string
        affiliate_id:
          type: integer
          format: int32
        label:
          type: string
        display_tag:
          type: string
        library_items:
          type: array
          items:
            type: string
          description: ''
      example:
        id: 361
        title: New library
        slug: new-library
        share_link: null
        views: 0
        leads: 0
        company_library: null
        affiliate_id: 2707
        label: null
        display_tag: null
        library_items: []
    createrequest12:
      title: createrequest12
      required:
        - library
      type: object
      properties:
        library:
          allOf:
            - $ref: '#/components/schemas/Library'
            - {}
      example:
        library:
          title: Library from API
          affiliate_id: 1
          library_items_attributes:
            - relateable_type: Product
              relateable_id: 1
              order: 3
            - relateable_type: Medium
              relateable_id: 1
              order: 2
            - relateable_type: Product
              relateable_id: 2
              order: 1
    Library:
      title: Library
      required:
        - title
        - affiliate_id
        - library_items_attributes
      type: object
      properties:
        title:
          type: string
        affiliate_id:
          type: integer
          format: int32
        library_items_attributes:
          type: array
          items:
            $ref: '#/components/schemas/LibraryItemsAttribute'
          description: ''
      example:
        title: Library from API
        affiliate_id: 1
        library_items_attributes:
          - relateable_type: Product
            relateable_id: 1
            order: 3
          - relateable_type: Medium
            relateable_id: 1
            order: 2
          - relateable_type: Product
            relateable_id: 2
            order: 1
    LibraryItemsAttribute:
      title: LibraryItemsAttribute
      required:
        - relateable_type
        - relateable_id
        - order
      type: object
      properties:
        relateable_type:
          type: string
        relateable_id:
          type: integer
          format: int32
        order:
          type: integer
          format: int32
      example:
        relateable_type: Product
        relateable_id: 1
        order: 3
    create9:
      title: create9
      required:
        - id
        - title
        - slug
        - share_link
        - views
        - leads
        - company_library
        - affiliate_id
        - label
        - display_tag
        - library_items
      type: object
      properties:
        id:
          type: integer
          format: int32
        title:
          type: string
        slug:
          type: string
        share_link:
          type: string
        views:
          type: integer
          format: int32
        leads:
          type: integer
          format: int32
        company_library:
          type: string
        affiliate_id:
          type: integer
          format: int32
        label:
          type: string
        display_tag:
          type: string
        library_items:
          type: array
          items:
            $ref: '#/components/schemas/LibraryItem3'
          description: ''
    LibraryItem3:
      title: LibraryItem3
      required:
        - id
        - order
        - relateable_type
        - relateable
      type: object
      properties:
        id:
          type: integer
          format: int32
        order:
          type: integer
          format: int32
        relateable_type:
          type: string
        relateable:
          allOf:
            - $ref: '#/components/schemas/Relateable2'
            - {}
      example:
        id: 1351
        order: 1
        relateable_type: Product
        relateable:
          id: 2198
          active: true
          title: not again
          description:
            id: 4729
            name: description
            body: <div>no not again never</div>
            record_type: Product
            record_id: 2198
            created_at: '2022-12-19T08:37:40.643Z'
            updated_at: '2022-12-19T08:37:40.643Z'
            locale: null
          stripped: no not again never
          price: null
          display_price: ''
          subscription_price: null
          display_subscription_price: null
          wholesale_price: null
          display_wholesale_price: ''
          wholesale_subscription_price: null
          display_wholesale_subscription_price: null
          shipping: '1.0'
          image:
            mini: https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg
            detail: https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg
            full: https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg
          image_url: https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg
          sku: not again
          country_code: bt
          country_id: null
          views: 0
          leads: 0
          share_link: null
          commission: '10.0'
          public: true
          shopify_id: null
          shopify_handle: null
          in_stock: true
          vendor: null
          price_range:
            - Rs.0.00
            - Rs.156.00
          price_range_formatted: Rs.0.00 - Rs.156.00
          unlimited_inventory: false
          default_variant:
            id: 19511
            product_id: 2198
            shopify_id: null
            title: null
            sku: not again
            position: 12580
            inventory_policy: none
            taxable: true
            inventory_quantity: 1
            created_at: '2022-12-19T08:37:40.716Z'
            updated_at: '2024-03-13T07:38:28.858Z'
            external_id: null
            variant_country_id: null
            image_url: null
            image_path: null
            is_master: true
            discarded_at: null
            price: null
            weight: ''
            size: ''
            physical: null
            unit_of_weight: null
            height: 0
            width: 0
            length: 0
            unit_of_size: null
            hs_code: null
            country_of_origin: null
            customs_information_shipping: null
            active: true
            bar_code: null
            track_quantity: null
            keep_selling: null
            option_attrs: []
            allow_subscription: true
            subscription_only: false
            limit_subscription: false
            subscription_max_qty: null
            shipping_included_in_price: false
            subscription_interval: 1
          currency_symbol: $
          currency_code: USD
          average_rating: 0
          option_values: null
          publish_to_retail_store: true
          publish_to_rep_store: true
          publish_to_share_tab: true
          hide_rating?: true
          hide_reviews?: true
          prompts_enabled: false
          label: null
          display_tag: null
          images:
            - id: 2047
              image:
                mini: >-
                  https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/7Mtcu95PROKoBjsvrmgc_download.jpeg
                detail: >-
                  https://ik.imagekit.io/fluid/s3/tr:n-video_poster/7Mtcu95PROKoBjsvrmgc_download.jpeg
                full: >-
                  https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg
              image_url: >-
                https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg
              position: null
              shopify_id: null
          countries:
            - id: 24
              iso_name: BHUTAN
              iso: BT
              iso3: BTN
              name: Bhutan
              numcode: 64
              active: true
              currency_code: BTN
              currency_symbol: Nu.
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 92
              iso_name: INDIA
              iso: IN
              iso3: IND
              name: India
              numcode: 356
              active: true
              currency_code: INR
              currency_symbol: ₹
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 214
              iso_name: UNITED STATES
              iso: US
              iso3: USA
              name: United States
              numcode: 840
              active: true
              currency_code: USD
              currency_symbol: $
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 141
              iso_name: NEPAL
              iso: NP
              iso3: NPL
              name: Nepal
              numcode: 524
              active: true
              currency_code: NPR
              currency_symbol: Rs.
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 1
              iso_name: AFGHANISTAN
              iso: AF
              iso3: AFG
              name: Afghanistan
              numcode: 4
              active: true
              currency_code: AFN
              currency_symbol: ؋
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
          variants:
            - id: 19511
              title: null
              image_url: null
              buyable: true
              option_value_ids: []
              allow_subscription: true
              subscription_only: false
              shipping_included_in_price: false
              variant_countries:
                - id: 125486
                  price: '156.0'
                  shipping: '1.0'
                  tax: '1.0'
                  currency_code: BTN
                  currency_symbol: Nu.
                  display_price: Nu.156.00
                  country_iso: BT
                  subscription_price: '156.0'
                  display_wholesale_price: Nu.0.00
                  display_wholesale_subscription_price: Nu.0.00
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 24
                    iso: BT
                    iso_name: BHUTAN
                    iso3: BTN
                    name: Bhutan
                    tax_rate: 0
          options: []
          prompts: []
          enroll_products: []
          enrollment_packs: []
    Relateable2:
      title: Relateable2
      required:
        - id
        - active
        - title
        - description
        - stripped
        - image_url
        - views
        - leads
        - share_link
        - prompts_enabled
        - label
        - display_tag
        - prompts
      type: object
      properties:
        id:
          type: integer
          format: int32
        active:
          type: boolean
        title:
          type: string
        description:
          allOf:
            - $ref: '#/components/schemas/Description19'
            - {}
        stripped:
          type: string
        price:
          type: string
        display_price:
          type: string
        subscription_price:
          type: string
        display_subscription_price:
          type: string
        wholesale_price:
          type: string
        display_wholesale_price:
          type: string
        wholesale_subscription_price:
          type: string
        display_wholesale_subscription_price:
          type: string
        shipping:
          type: string
        image:
          allOf:
            - $ref: '#/components/schemas/Image3'
            - {}
        image_url:
          type: string
        sku:
          type: string
        country_code:
          type: string
        country_id:
          type: string
        views:
          type: integer
          format: int32
        leads:
          type: integer
          format: int32
        share_link:
          type: string
        commission:
          type: string
        public:
          type: boolean
        shopify_id:
          type: string
        shopify_handle:
          type: string
        in_stock:
          type: boolean
        vendor:
          type: string
        price_range:
          type: array
          items:
            type: string
          description: ''
        price_range_formatted:
          type: string
        unlimited_inventory:
          type: boolean
        default_variant:
          allOf:
            - $ref: '#/components/schemas/DefaultVariant18'
            - {}
        currency_symbol:
          type: string
        currency_code:
          type: string
        average_rating:
          type: integer
          format: int32
        option_values:
          type: string
        publish_to_retail_store:
          type: boolean
        publish_to_rep_store:
          type: boolean
        publish_to_share_tab:
          type: boolean
        hide_rating?:
          type: boolean
        hide_reviews?:
          type: boolean
        prompts_enabled:
          type: boolean
        label:
          type: string
        display_tag:
          type: string
        images:
          type: array
          items:
            $ref: '#/components/schemas/Image9'
          description: ''
        countries:
          type: array
          items:
            $ref: '#/components/schemas/Country7'
          description: ''
        variants:
          type: array
          items:
            $ref: '#/components/schemas/Variant24'
          description: ''
        options:
          type: array
          items:
            oneOf:
              - $ref: '#/components/schemas/Option3'
              - allOf:
                  - $ref: '#/components/schemas/Option31'
                  - example:
                      id: 31
                      title: variant
                      position: 21
                      presentation: variant
          description: ''
        prompts:
          type: array
          items:
            type: string
          description: ''
        enroll_products:
          type: array
          items:
            type: string
          description: ''
        enrollment_packs:
          type: array
          items:
            type: string
          description: ''
        user_id:
          type: string
        media_type:
          type: string
        media_format:
          type: string
        video_url:
          type: string
        pdf_url:
          type: string
        kind:
          type: string
        visibility:
          type: string
        watch:
          type: string
        video_status:
          type: string
        duration:
          type: integer
          format: int32
        cta_url:
          type: string
        cta_button_text:
          type: string
        cta_enabled:
          type: boolean
        cta_action_type:
          type: string
        video_shopping_enabled:
          type: boolean
        attached_shareables:
          type: array
          items:
            type: string
          description: ''
      example:
        id: 2198
        active: true
        title: not again
        description:
          id: 4729
          name: description
          body: <div>no not again never</div>
          record_type: Product
          record_id: 2198
          created_at: '2022-12-19T08:37:40.643Z'
          updated_at: '2022-12-19T08:37:40.643Z'
          locale: null
        stripped: no not again never
        price: null
        display_price: ''
        subscription_price: null
        display_subscription_price: null
        wholesale_price: null
        display_wholesale_price: ''
        wholesale_subscription_price: null
        display_wholesale_subscription_price: null
        shipping: '1.0'
        image:
          mini: https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg
          detail: https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg
          full: https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg
        image_url: https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg
        sku: not again
        country_code: bt
        country_id: null
        views: 0
        leads: 0
        share_link: null
        commission: '10.0'
        public: true
        shopify_id: null
        shopify_handle: null
        in_stock: true
        vendor: null
        price_range:
          - Rs.0.00
          - Rs.156.00
        price_range_formatted: Rs.0.00 - Rs.156.00
        unlimited_inventory: false
        default_variant:
          id: 19511
          product_id: 2198
          shopify_id: null
          title: null
          sku: not again
          position: 12580
          inventory_policy: none
          taxable: true
          inventory_quantity: 1
          created_at: '2022-12-19T08:37:40.716Z'
          updated_at: '2024-03-13T07:38:28.858Z'
          external_id: null
          variant_country_id: null
          image_url: null
          image_path: null
          is_master: true
          discarded_at: null
          price: null
          weight: ''
          size: ''
          physical: null
          unit_of_weight: null
          height: 0
          width: 0
          length: 0
          unit_of_size: null
          hs_code: null
          country_of_origin: null
          customs_information_shipping: null
          active: true
          bar_code: null
          track_quantity: null
          keep_selling: null
          option_attrs: []
          allow_subscription: true
          subscription_only: false
          limit_subscription: false
          subscription_max_qty: null
          shipping_included_in_price: false
          subscription_interval: 1
        currency_symbol: $
        currency_code: USD
        average_rating: 0
        option_values: null
        publish_to_retail_store: true
        publish_to_rep_store: true
        publish_to_share_tab: true
        hide_rating?: true
        hide_reviews?: true
        prompts_enabled: false
        label: null
        display_tag: null
        images:
          - id: 2047
            image:
              mini: >-
                https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/7Mtcu95PROKoBjsvrmgc_download.jpeg
              detail: >-
                https://ik.imagekit.io/fluid/s3/tr:n-video_poster/7Mtcu95PROKoBjsvrmgc_download.jpeg
              full: >-
                https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg
            image_url: https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg
            position: null
            shopify_id: null
        countries:
          - id: 24
            iso_name: BHUTAN
            iso: BT
            iso3: BTN
            name: Bhutan
            numcode: 64
            active: true
            currency_code: BTN
            currency_symbol: Nu.
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 92
            iso_name: INDIA
            iso: IN
            iso3: IND
            name: India
            numcode: 356
            active: true
            currency_code: INR
            currency_symbol: ₹
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 214
            iso_name: UNITED STATES
            iso: US
            iso3: USA
            name: United States
            numcode: 840
            active: true
            currency_code: USD
            currency_symbol: $
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 141
            iso_name: NEPAL
            iso: NP
            iso3: NPL
            name: Nepal
            numcode: 524
            active: true
            currency_code: NPR
            currency_symbol: Rs.
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 1
            iso_name: AFGHANISTAN
            iso: AF
            iso3: AFG
            name: Afghanistan
            numcode: 4
            active: true
            currency_code: AFN
            currency_symbol: ؋
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
        variants:
          - id: 19511
            title: null
            image_url: null
            buyable: true
            option_value_ids: []
            allow_subscription: true
            subscription_only: false
            shipping_included_in_price: false
            variant_countries:
              - id: 125486
                price: '156.0'
                shipping: '1.0'
                tax: '1.0'
                currency_code: BTN
                currency_symbol: Nu.
                display_price: Nu.156.00
                country_iso: BT
                subscription_price: '156.0'
                display_wholesale_price: Nu.0.00
                display_wholesale_subscription_price: Nu.0.00
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 24
                  iso: BT
                  iso_name: BHUTAN
                  iso3: BTN
                  name: Bhutan
                  tax_rate: 0
        options: []
        prompts: []
        enroll_products: []
        enrollment_packs: []
    DefaultVariant18:
      title: DefaultVariant18
      required:
        - id
        - product_id
        - shopify_id
        - title
        - sku
        - position
        - inventory_policy
        - taxable
        - inventory_quantity
        - created_at
        - updated_at
        - external_id
        - variant_country_id
        - image_url
        - image_path
        - is_master
        - discarded_at
        - price
        - weight
        - size
        - physical
        - unit_of_weight
        - height
        - width
        - length
        - unit_of_size
        - hs_code
        - country_of_origin
        - customs_information_shipping
        - active
        - bar_code
        - track_quantity
        - keep_selling
        - option_attrs
        - allow_subscription
        - subscription_only
        - limit_subscription
        - subscription_max_qty
        - shipping_included_in_price
        - subscription_interval
      type: object
      properties:
        id:
          type: integer
          format: int32
        product_id:
          type: integer
          format: int32
        shopify_id:
          type: string
        title:
          type: string
        sku:
          type: string
        position:
          type: integer
          format: int32
        inventory_policy:
          type: string
        taxable:
          type: boolean
        inventory_quantity:
          type: integer
          format: int32
        created_at:
          type: string
        updated_at:
          type: string
        external_id:
          type: string
        variant_country_id:
          type: string
        image_url:
          type: string
        image_path:
          type: string
        is_master:
          type: boolean
        discarded_at:
          type: string
        price:
          type: string
        weight:
          type: string
        size:
          type: string
        physical:
          type: string
        unit_of_weight:
          type: string
        height:
          type: integer
          format: int32
        width:
          type: integer
          format: int32
        length:
          type: integer
          format: int32
        unit_of_size:
          type: string
        hs_code:
          type: string
        country_of_origin:
          type: string
        customs_information_shipping:
          type: string
        active:
          type: boolean
        bar_code:
          type: string
        track_quantity:
          type: string
        keep_selling:
          type: string
        option_attrs:
          type: array
          items:
            type: string
          description: ''
        allow_subscription:
          type: boolean
        subscription_only:
          type: boolean
        limit_subscription:
          type: boolean
        subscription_max_qty:
          type: string
        shipping_included_in_price:
          type: boolean
        subscription_interval:
          type: integer
          format: int32
      example:
        id: 19511
        product_id: 2198
        shopify_id: null
        title: null
        sku: not again
        position: 12580
        inventory_policy: none
        taxable: true
        inventory_quantity: 1
        created_at: '2022-12-19T08:37:40.716Z'
        updated_at: '2024-03-13T07:38:28.858Z'
        external_id: null
        variant_country_id: null
        image_url: null
        image_path: null
        is_master: true
        discarded_at: null
        price: null
        weight: ''
        size: ''
        physical: null
        unit_of_weight: null
        height: 0
        width: 0
        length: 0
        unit_of_size: null
        hs_code: null
        country_of_origin: null
        customs_information_shipping: null
        active: true
        bar_code: null
        track_quantity: null
        keep_selling: null
        option_attrs: []
        allow_subscription: true
        subscription_only: false
        limit_subscription: false
        subscription_max_qty: null
        shipping_included_in_price: false
        subscription_interval: 1
    Variant24:
      title: Variant24
      required:
        - id
        - title
        - image_url
        - buyable
        - option_value_ids
        - allow_subscription
        - subscription_only
        - shipping_included_in_price
        - variant_countries
      type: object
      properties:
        id:
          type: integer
          format: int32
        title:
          type: string
        image_url:
          type: string
        buyable:
          type: boolean
        option_value_ids:
          type: array
          items:
            oneOf:
              - type: string
              - type: integer
                format: int32
          description: ''
        allow_subscription:
          type: boolean
        subscription_only:
          type: boolean
        shipping_included_in_price:
          type: boolean
        variant_countries:
          type: array
          items:
            $ref: '#/components/schemas/VariantCountries5'
          description: ''
      example:
        id: 19511
        title: null
        image_url: null
        buyable: true
        option_value_ids: []
        allow_subscription: true
        subscription_only: false
        shipping_included_in_price: false
        variant_countries:
          - id: 125486
            price: '156.0'
            shipping: '1.0'
            tax: '1.0'
            currency_code: BTN
            currency_symbol: Nu.
            display_price: Nu.156.00
            country_iso: BT
            subscription_price: '156.0'
            display_wholesale_price: Nu.0.00
            display_wholesale_subscription_price: Nu.0.00
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 24
              iso: BT
              iso_name: BHUTAN
              iso3: BTN
              name: Bhutan
              tax_rate: 0
    Option3:
      title: Option3
      type: object
      properties:
        id:
          type: integer
          format: int32
        title:
          type: string
        position:
          type: integer
          format: int32
        presentation:
          type: string
    Option31:
      title: Option31
      required:
        - id
        - title
        - position
        - presentation
      type: object
      properties:
        id:
          type: integer
          format: int32
        title:
          type: string
        position:
          type: integer
          format: int32
        presentation:
          type: string
      example:
        id: 31
        title: variant
        position: 21
        presentation: variant
    updaterequest11:
      title: updaterequest11
      required:
        - library
      type: object
      properties:
        library:
          allOf:
            - $ref: '#/components/schemas/Library1'
            - {}
      example:
        library:
          title: Edited Title
          affiliate_id: 5
          company_library: true
    Library1:
      title: Library1
      required:
        - title
        - affiliate_id
        - company_library
      type: object
      properties:
        title:
          type: string
        affiliate_id:
          type: integer
          format: int32
        company_library:
          type: boolean
      example:
        title: Edited Title
        affiliate_id: 5
        company_library: true
    update8:
      title: update8
      required:
        - id
        - title
        - slug
        - share_link
        - views
        - leads
        - company_library
        - affiliate_id
        - label
        - display_tag
        - library_items
      type: object
      properties:
        id:
          type: integer
          format: int32
        title:
          type: string
        slug:
          type: string
        share_link:
          type: string
        views:
          type: integer
          format: int32
        leads:
          type: integer
          format: int32
        company_library:
          type: boolean
        affiliate_id:
          type: integer
          format: int32
        label:
          type: string
        display_tag:
          type: string
        library_items:
          type: array
          items:
            $ref: '#/components/schemas/LibraryItem3'
          description: ''
    add_item_request:
      title: add_item_request
      required:
        - library_item
      type: object
      properties:
        library_item:
          allOf:
            - $ref: '#/components/schemas/LibraryItem5'
            - {}
      example:
        library_item:
          relateable_type: Product
          relateable_id: 3
          order: 1
    LibraryItem5:
      title: LibraryItem5
      required:
        - relateable_type
        - relateable_id
        - order
      type: object
      properties:
        relateable_type:
          type: string
        relateable_id:
          type: integer
          format: int32
        order:
          type: integer
          format: int32
      example:
        relateable_type: Product
        relateable_id: 3
        order: 1
    add_item:
      title: add_item
      required:
        - id
        - title
        - slug
        - share_link
        - views
        - leads
        - company_library
        - affiliate_id
        - label
        - display_tag
        - library_items
      type: object
      properties:
        id:
          type: integer
          format: int32
        title:
          type: string
        slug:
          type: string
        share_link:
          type: string
        views:
          type: integer
          format: int32
        leads:
          type: integer
          format: int32
        company_library:
          type: boolean
        affiliate_id:
          type: integer
          format: int32
        label:
          type: string
        display_tag:
          type: string
        library_items:
          type: array
          items:
            $ref: '#/components/schemas/LibraryItem3'
          description: ''
    remove_item:
      title: remove_item
      required:
        - id
        - title
        - slug
        - share_link
        - views
        - leads
        - company_library
        - affiliate_id
        - label
        - display_tag
        - library_items
      type: object
      properties:
        id:
          type: integer
          format: int32
        title:
          type: string
        slug:
          type: string
        share_link:
          type: string
        views:
          type: integer
          format: int32
        leads:
          type: integer
          format: int32
        company_library:
          type: boolean
        affiliate_id:
          type: integer
          format: int32
        label:
          type: string
        display_tag:
          type: string
        library_items:
          type: array
          items:
            $ref: '#/components/schemas/LibraryItem3'
          description: ''
    clone_company_library_request:
      title: clone_company_library_request
      required:
        - affiliate_id
      type: object
      properties:
        affiliate_id:
          type: integer
          format: int32
      example:
        affiliate_id: 2707
    clone_company_library:
      title: clone_company_library
      required:
        - id
        - title
        - slug
        - share_link
        - views
        - leads
        - company_library
        - affiliate_id
        - label
        - display_tag
        - library_items
      type: object
      properties:
        id:
          type: integer
          format: int32
        title:
          type: string
        slug:
          type: string
        share_link:
          type: string
        views:
          type: integer
          format: int32
        leads:
          type: integer
          format: int32
        company_library:
          type: string
        affiliate_id:
          type: integer
          format: int32
        label:
          type: string
        display_tag:
          type: string
        library_items:
          type: array
          items:
            $ref: '#/components/schemas/LibraryItem8'
          description: ''
      example:
        id: 1276
        title: Edited Title-Copy
        slug: edited-title-copy
        share_link: null
        views: 0
        leads: 0
        company_library: null
        affiliate_id: 2707
        label: null
        display_tag: null
        library_items:
          - id: 1359
            order: 1
            relateable_type: Product
            relateable:
              id: 2206
              active: true
              title: wallpaper
              description:
                id: 4745
                name: description
                body: <div>wallpaper</div>
                record_type: Product
                record_id: 2206
                created_at: '2022-12-19T08:59:48.650Z'
                updated_at: '2022-12-19T08:59:48.650Z'
                locale: null
              stripped: wallpaper
              price: null
              display_price: ''
              subscription_price: null
              display_subscription_price: null
              wholesale_price: null
              display_wholesale_price: ''
              wholesale_subscription_price: null
              display_wholesale_subscription_price: null
              shipping: '1.0'
              image:
                mini: >-
                  https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
                detail: >-
                  https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
                full: >-
                  https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
              image_url: >-
                https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
              sku: wallpaper
              country_code: bt
              country_id: null
              views: 0
              leads: 0
              share_link: null
              commission: '10.0'
              public: true
              shopify_id: null
              shopify_handle: null
              in_stock: true
              vendor: null
              price_range:
                - Rs.78.00
                - Rs.78.00
              price_range_formatted: Rs.78.00
              unlimited_inventory: false
              default_variant:
                id: 19537
                product_id: 2206
                shopify_id: null
                title: '5'
                sku: null
                position: 12611
                inventory_policy: none
                taxable: true
                inventory_quantity: -3
                created_at: '2022-12-23T09:31:41.111Z'
                updated_at: '2024-08-03T20:54:57.333Z'
                external_id: null
                variant_country_id: null
                image_url: null
                image_path: null
                is_master: false
                discarded_at: null
                price: null
                weight: null
                size: null
                physical: null
                unit_of_weight: null
                height: 0
                width: 0
                length: 0
                unit_of_size: null
                hs_code: null
                country_of_origin: null
                customs_information_shipping: null
                active: true
                bar_code: null
                track_quantity: null
                keep_selling: null
                option_attrs: []
                allow_subscription: true
                subscription_only: false
                limit_subscription: false
                subscription_max_qty: null
                shipping_included_in_price: false
                subscription_interval: 1
              currency_symbol: $
              currency_code: USD
              average_rating: 0
              option_values: null
              publish_to_retail_store: true
              publish_to_rep_store: true
              publish_to_share_tab: true
              hide_rating?: true
              hide_reviews?: true
              prompts_enabled: false
              label: null
              display_tag: null
              images:
                - id: 2053
                  image:
                    mini: >-
                      https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
                    detail: >-
                      https://ik.imagekit.io/fluid/s3/tr:n-video_poster/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
                    full: >-
                      https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
                  image_url: >-
                    https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
                  position: null
                  shopify_id: null
              countries:
                - id: 24
                  iso_name: BHUTAN
                  iso: BT
                  iso3: BTN
                  name: Bhutan
                  numcode: 64
                  active: true
                  currency_code: BTN
                  currency_symbol: Nu.
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 92
                  iso_name: INDIA
                  iso: IN
                  iso3: IND
                  name: India
                  numcode: 356
                  active: true
                  currency_code: INR
                  currency_symbol: ₹
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 214
                  iso_name: UNITED STATES
                  iso: US
                  iso3: USA
                  name: United States
                  numcode: 840
                  active: true
                  currency_code: USD
                  currency_symbol: $
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 141
                  iso_name: NEPAL
                  iso: NP
                  iso3: NPL
                  name: Nepal
                  numcode: 524
                  active: true
                  currency_code: NPR
                  currency_symbol: Rs.
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 1
                  iso_name: AFGHANISTAN
                  iso: AF
                  iso3: AFG
                  name: Afghanistan
                  numcode: 4
                  active: true
                  currency_code: AFN
                  currency_symbol: ؋
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
              variants:
                - id: 19537
                  title: '5'
                  image_url: null
                  buyable: true
                  option_value_ids:
                    - 121
                  allow_subscription: true
                  subscription_only: false
                  shipping_included_in_price: false
                  variant_countries:
                    - id: 127470
                      price: '78.0'
                      shipping: '1.0'
                      tax: '1.0'
                      currency_code: NPR
                      currency_symbol: Rs.
                      display_price: Rs.78.00
                      country_iso: NP
                      subscription_price: '78.0'
                      display_wholesale_price: Rs.0.00
                      display_wholesale_subscription_price: Rs.0.00
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 141
                        iso: NP
                        iso_name: NEPAL
                        iso3: NPL
                        name: Nepal
                        tax_rate: 0
                    - id: 127469
                      price: '78.0'
                      shipping: '1.0'
                      tax: '1.0'
                      currency_code: BTN
                      currency_symbol: Nu.
                      display_price: Nu.78.00
                      country_iso: BT
                      subscription_price: '78.0'
                      display_wholesale_price: Nu.0.00
                      display_wholesale_subscription_price: Nu.0.00
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 24
                        iso: BT
                        iso_name: BHUTAN
                        iso3: BTN
                        name: Bhutan
                        tax_rate: 0
                    - id: 127471
                      price: '78.0'
                      shipping: '1.0'
                      tax: '1.0'
                      currency_code: AFN
                      currency_symbol: ؋
                      display_price: ؋78.00
                      country_iso: AF
                      subscription_price: '78.0'
                      display_wholesale_price: ؋0.00
                      display_wholesale_subscription_price: ؋0.00
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 1
                        iso: AF
                        iso_name: AFGHANISTAN
                        iso3: AFG
                        name: Afghanistan
                        tax_rate: 0
                - id: 19538
                  title: '2'
                  image_url: null
                  buyable: true
                  option_value_ids:
                    - 122
                  allow_subscription: true
                  subscription_only: false
                  shipping_included_in_price: false
                  variant_countries:
                    - id: 127473
                      price: '78.0'
                      shipping: '1.0'
                      tax: '1.0'
                      currency_code: NPR
                      currency_symbol: Rs.
                      display_price: Rs.78.00
                      country_iso: NP
                      subscription_price: '78.0'
                      display_wholesale_price: Rs.0.00
                      display_wholesale_subscription_price: Rs.0.00
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 141
                        iso: NP
                        iso_name: NEPAL
                        iso3: NPL
                        name: Nepal
                        tax_rate: 0
                    - id: 127472
                      price: '78.0'
                      shipping: '1.0'
                      tax: '1.0'
                      currency_code: BTN
                      currency_symbol: Nu.
                      display_price: Nu.78.00
                      country_iso: BT
                      subscription_price: '78.0'
                      display_wholesale_price: Nu.0.00
                      display_wholesale_subscription_price: Nu.0.00
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 24
                        iso: BT
                        iso_name: BHUTAN
                        iso3: BTN
                        name: Bhutan
                        tax_rate: 0
                    - id: 127474
                      price: '78.0'
                      shipping: '1.0'
                      tax: '1.0'
                      currency_code: AFN
                      currency_symbol: ؋
                      display_price: ؋78.00
                      country_iso: AF
                      subscription_price: '78.0'
                      display_wholesale_price: ؋0.00
                      display_wholesale_subscription_price: ؋0.00
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 1
                        iso: AF
                        iso_name: AFGHANISTAN
                        iso3: AFG
                        name: Afghanistan
                        tax_rate: 0
                - id: 19539
                  title: '3'
                  image_url: null
                  buyable: true
                  option_value_ids:
                    - 123
                  allow_subscription: true
                  subscription_only: false
                  shipping_included_in_price: false
                  variant_countries:
                    - id: 127476
                      price: '78.0'
                      shipping: '1.0'
                      tax: '1.0'
                      currency_code: NPR
                      currency_symbol: Rs.
                      display_price: Rs.78.00
                      country_iso: NP
                      subscription_price: '78.0'
                      display_wholesale_price: Rs.0.00
                      display_wholesale_subscription_price: Rs.0.00
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 141
                        iso: NP
                        iso_name: NEPAL
                        iso3: NPL
                        name: Nepal
                        tax_rate: 0
                    - id: 127475
                      price: '78.0'
                      shipping: '1.0'
                      tax: '1.0'
                      currency_code: BTN
                      currency_symbol: Nu.
                      display_price: Nu.78.00
                      country_iso: BT
                      subscription_price: '78.0'
                      display_wholesale_price: Nu.0.00
                      display_wholesale_subscription_price: Nu.0.00
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 24
                        iso: BT
                        iso_name: BHUTAN
                        iso3: BTN
                        name: Bhutan
                        tax_rate: 0
                    - id: 127477
                      price: '78.0'
                      shipping: '1.0'
                      tax: '1.0'
                      currency_code: AFN
                      currency_symbol: ؋
                      display_price: ؋78.00
                      country_iso: AF
                      subscription_price: '78.0'
                      display_wholesale_price: ؋0.00
                      display_wholesale_subscription_price: ؋0.00
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 1
                        iso: AF
                        iso_name: AFGHANISTAN
                        iso3: AFG
                        name: Afghanistan
                        tax_rate: 0
              options:
                - id: 31
                  title: variant
                  position: 21
                  presentation: variant
              prompts: []
              enroll_products: []
              enrollment_packs: []
          - id: 1358
            order: 2
            relateable_type: Medium
            relateable:
              id: 4431
              user_id: null
              media_type: share
              media_format: png
              image_url: >-
                https://ik.imagekit.io/fluid/s3/tr:n-video_poster/hCCYL9UwQw6UjENqRy84_kittya+snow+leopard+close1667812853.jpg
              video_url: ''
              pdf_url: ''
              title: null
              description:
                id: 4695
                name: description
                body: <div>iui</div>
                record_type: Medium
                record_id: 4431
                created_at: '2022-11-28T11:17:27.644Z'
                updated_at: '2022-11-28T11:17:27.644Z'
                locale: null
              stripped: iui
              kind: image
              active: true
              visibility: null
              share_link: null
              views: 0
              leads: 0
              watch: null
              video_status: null
              duration: 0
              cta_url: ''
              cta_button_text: Learn More
              cta_enabled: false
              cta_action_type: visit_on_click
              video_shopping_enabled: false
              prompts_enabled: false
              label: null
              display_tag: null
              prompts: []
              attached_shareables: []
          - id: 1357
            order: 3
            relateable_type: Product
            relateable:
              id: 2198
              active: true
              title: not again
              description:
                id: 4729
                name: description
                body: <div>no not again never</div>
                record_type: Product
                record_id: 2198
                created_at: '2022-12-19T08:37:40.643Z'
                updated_at: '2022-12-19T08:37:40.643Z'
                locale: null
              stripped: no not again never
              price: null
              display_price: ''
              subscription_price: null
              display_subscription_price: null
              wholesale_price: null
              display_wholesale_price: ''
              wholesale_subscription_price: null
              display_wholesale_subscription_price: null
              shipping: '1.0'
              image:
                mini: >-
                  https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg
                detail: >-
                  https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg
                full: >-
                  https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg
              image_url: >-
                https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg
              sku: not again
              country_code: bt
              country_id: null
              views: 0
              leads: 0
              share_link: null
              commission: '10.0'
              public: true
              shopify_id: null
              shopify_handle: null
              in_stock: true
              vendor: null
              price_range:
                - Rs.0.00
                - Rs.156.00
              price_range_formatted: Rs.0.00 - Rs.156.00
              unlimited_inventory: false
              default_variant:
                id: 19511
                product_id: 2198
                shopify_id: null
                title: null
                sku: not again
                position: 12580
                inventory_policy: none
                taxable: true
                inventory_quantity: 1
                created_at: '2022-12-19T08:37:40.716Z'
                updated_at: '2024-03-13T07:38:28.858Z'
                external_id: null
                variant_country_id: null
                image_url: null
                image_path: null
                is_master: true
                discarded_at: null
                price: null
                weight: ''
                size: ''
                physical: null
                unit_of_weight: null
                height: 0
                width: 0
                length: 0
                unit_of_size: null
                hs_code: null
                country_of_origin: null
                customs_information_shipping: null
                active: true
                bar_code: null
                track_quantity: null
                keep_selling: null
                option_attrs: []
                allow_subscription: true
                subscription_only: false
                limit_subscription: false
                subscription_max_qty: null
                shipping_included_in_price: false
                subscription_interval: 1
              currency_symbol: $
              currency_code: USD
              average_rating: 0
              option_values: null
              publish_to_retail_store: true
              publish_to_rep_store: true
              publish_to_share_tab: true
              hide_rating?: true
              hide_reviews?: true
              prompts_enabled: false
              label: null
              display_tag: null
              images:
                - id: 2047
                  image:
                    mini: >-
                      https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/7Mtcu95PROKoBjsvrmgc_download.jpeg
                    detail: >-
                      https://ik.imagekit.io/fluid/s3/tr:n-video_poster/7Mtcu95PROKoBjsvrmgc_download.jpeg
                    full: >-
                      https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg
                  image_url: >-
                    https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg
                  position: null
                  shopify_id: null
              countries:
                - id: 24
                  iso_name: BHUTAN
                  iso: BT
                  iso3: BTN
                  name: Bhutan
                  numcode: 64
                  active: true
                  currency_code: BTN
                  currency_symbol: Nu.
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 92
                  iso_name: INDIA
                  iso: IN
                  iso3: IND
                  name: India
                  numcode: 356
                  active: true
                  currency_code: INR
                  currency_symbol: ₹
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 214
                  iso_name: UNITED STATES
                  iso: US
                  iso3: USA
                  name: United States
                  numcode: 840
                  active: true
                  currency_code: USD
                  currency_symbol: $
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 141
                  iso_name: NEPAL
                  iso: NP
                  iso3: NPL
                  name: Nepal
                  numcode: 524
                  active: true
                  currency_code: NPR
                  currency_symbol: Rs.
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 1
                  iso_name: AFGHANISTAN
                  iso: AF
                  iso3: AFG
                  name: Afghanistan
                  numcode: 4
                  active: true
                  currency_code: AFN
                  currency_symbol: ؋
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
              variants:
                - id: 19511
                  title: null
                  image_url: null
                  buyable: true
                  option_value_ids: []
                  allow_subscription: true
                  subscription_only: false
                  shipping_included_in_price: false
                  variant_countries:
                    - id: 125486
                      price: '156.0'
                      shipping: '1.0'
                      tax: '1.0'
                      currency_code: BTN
                      currency_symbol: Nu.
                      display_price: Nu.156.00
                      country_iso: BT
                      subscription_price: '156.0'
                      display_wholesale_price: Nu.0.00
                      display_wholesale_subscription_price: Nu.0.00
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 24
                        iso: BT
                        iso_name: BHUTAN
                        iso3: BTN
                        name: Bhutan
                        tax_rate: 0
              options: []
              prompts: []
              enroll_products: []
              enrollment_packs: []
          - id: 1356
            order: 4
            relateable_type: Product
            relateable:
              id: 2204
              active: true
              title: lengthy image
              description:
                id: 4741
                name: description
                body: <div>lengthy image</div>
                record_type: Product
                record_id: 2204
                created_at: '2022-12-19T08:58:13.978Z'
                updated_at: '2022-12-19T08:58:13.978Z'
                locale: null
              stripped: lengthy image
              price: null
              display_price: ''
              subscription_price: null
              display_subscription_price: null
              wholesale_price: null
              display_wholesale_price: ''
              wholesale_subscription_price: null
              display_wholesale_subscription_price: null
              shipping: '1.0'
              image:
                mini: >-
                  https://ik.imagekit.io/fluid/s3/VMYnhvE3QZNIN65Djnis_lengthy+image.png
                detail: >-
                  https://ik.imagekit.io/fluid/s3/VMYnhvE3QZNIN65Djnis_lengthy+image.png
                full: >-
                  https://ik.imagekit.io/fluid/s3/VMYnhvE3QZNIN65Djnis_lengthy+image.png
              image_url: >-
                https://ik.imagekit.io/fluid/s3/VMYnhvE3QZNIN65Djnis_lengthy+image.png
              sku: lengthy image
              country_code: bt
              country_id: null
              views: 0
              leads: 0
              share_link: null
              commission: '10.0'
              public: true
              shopify_id: null
              shopify_handle: null
              in_stock: true
              vendor: null
              price_range:
                - Rs.0.00
                - Rs.89.00
              price_range_formatted: Rs.0.00 - Rs.89.00
              unlimited_inventory: false
              default_variant:
                id: 19517
                product_id: 2204
                shopify_id: null
                title: null
                sku: lengthy image
                position: 12588
                inventory_policy: none
                taxable: true
                inventory_quantity: 1
                created_at: '2022-12-19T08:58:14.026Z'
                updated_at: '2024-08-03T20:54:57.333Z'
                external_id: null
                variant_country_id: null
                image_url: null
                image_path: null
                is_master: true
                discarded_at: null
                price: null
                weight: ''
                size: ''
                physical: null
                unit_of_weight: null
                height: 0
                width: 0
                length: 0
                unit_of_size: null
                hs_code: null
                country_of_origin: null
                customs_information_shipping: null
                active: true
                bar_code: null
                track_quantity: null
                keep_selling: null
                option_attrs: []
                allow_subscription: true
                subscription_only: false
                limit_subscription: false
                subscription_max_qty: null
                shipping_included_in_price: false
                subscription_interval: 1
              currency_symbol: $
              currency_code: USD
              average_rating: 0
              option_values: null
              publish_to_retail_store: true
              publish_to_rep_store: true
              publish_to_share_tab: true
              hide_rating?: true
              hide_reviews?: true
              prompts_enabled: false
              label: null
              display_tag: null
              images:
                - id: 2052
                  image:
                    mini: >-
                      https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/VMYnhvE3QZNIN65Djnis_lengthy+image.png
                    detail: >-
                      https://ik.imagekit.io/fluid/s3/tr:n-video_poster/VMYnhvE3QZNIN65Djnis_lengthy+image.png
                    full: >-
                      https://ik.imagekit.io/fluid/s3/VMYnhvE3QZNIN65Djnis_lengthy+image.png
                  image_url: >-
                    https://ik.imagekit.io/fluid/s3/VMYnhvE3QZNIN65Djnis_lengthy+image.png
                  position: null
                  shopify_id: null
              countries:
                - id: 24
                  iso_name: BHUTAN
                  iso: BT
                  iso3: BTN
                  name: Bhutan
                  numcode: 64
                  active: true
                  currency_code: BTN
                  currency_symbol: Nu.
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 92
                  iso_name: INDIA
                  iso: IN
                  iso3: IND
                  name: India
                  numcode: 356
                  active: true
                  currency_code: INR
                  currency_symbol: ₹
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 214
                  iso_name: UNITED STATES
                  iso: US
                  iso3: USA
                  name: United States
                  numcode: 840
                  active: true
                  currency_code: USD
                  currency_symbol: $
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 141
                  iso_name: NEPAL
                  iso: NP
                  iso3: NPL
                  name: Nepal
                  numcode: 524
                  active: true
                  currency_code: NPR
                  currency_symbol: Rs.
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
                - id: 1
                  iso_name: AFGHANISTAN
                  iso: AF
                  iso3: AFG
                  name: Afghanistan
                  numcode: 4
                  active: true
                  currency_code: AFN
                  currency_symbol: ؋
                  separator: .
                  delimiter: ','
                  address3: false
                  state: true
                  passport: false
                  itn: false
                  tax_rate: 0
              variants:
                - id: 19517
                  title: null
                  image_url: null
                  buyable: true
                  option_value_ids: []
                  allow_subscription: true
                  subscription_only: false
                  shipping_included_in_price: false
                  variant_countries:
                    - id: 125495
                      price: '89.0'
                      shipping: '1.0'
                      tax: '1.0'
                      currency_code: BTN
                      currency_symbol: Nu.
                      display_price: Nu.89.00
                      country_iso: BT
                      subscription_price: '89.0'
                      display_wholesale_price: Nu.0.00
                      display_wholesale_subscription_price: Nu.0.00
                      wholesale_price: '0.0'
                      wholesale_subscription_price: '0.0'
                      country:
                        id: 24
                        iso: BT
                        iso_name: BHUTAN
                        iso3: BTN
                        name: Bhutan
                        tax_rate: 0
              options: []
              prompts: []
              enroll_products: []
              enrollment_packs: []
    LibraryItem8:
      title: LibraryItem8
      required:
        - id
        - order
        - relateable_type
        - relateable
      type: object
      properties:
        id:
          type: integer
          format: int32
        order:
          type: integer
          format: int32
        relateable_type:
          type: string
        relateable:
          allOf:
            - $ref: '#/components/schemas/Relateable6'
            - {}
      example:
        id: 1359
        order: 1
        relateable_type: Product
        relateable:
          id: 2206
          active: true
          title: wallpaper
          description:
            id: 4745
            name: description
            body: <div>wallpaper</div>
            record_type: Product
            record_id: 2206
            created_at: '2022-12-19T08:59:48.650Z'
            updated_at: '2022-12-19T08:59:48.650Z'
            locale: null
          stripped: wallpaper
          price: null
          display_price: ''
          subscription_price: null
          display_subscription_price: null
          wholesale_price: null
          display_wholesale_price: ''
          wholesale_subscription_price: null
          display_wholesale_subscription_price: null
          shipping: '1.0'
          image:
            mini: >-
              https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
            detail: >-
              https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
            full: >-
              https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
          image_url: >-
            https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
          sku: wallpaper
          country_code: bt
          country_id: null
          views: 0
          leads: 0
          share_link: null
          commission: '10.0'
          public: true
          shopify_id: null
          shopify_handle: null
          in_stock: true
          vendor: null
          price_range:
            - Rs.78.00
            - Rs.78.00
          price_range_formatted: Rs.78.00
          unlimited_inventory: false
          default_variant:
            id: 19537
            product_id: 2206
            shopify_id: null
            title: '5'
            sku: null
            position: 12611
            inventory_policy: none
            taxable: true
            inventory_quantity: -3
            created_at: '2022-12-23T09:31:41.111Z'
            updated_at: '2024-08-03T20:54:57.333Z'
            external_id: null
            variant_country_id: null
            image_url: null
            image_path: null
            is_master: false
            discarded_at: null
            price: null
            weight: null
            size: null
            physical: null
            unit_of_weight: null
            height: 0
            width: 0
            length: 0
            unit_of_size: null
            hs_code: null
            country_of_origin: null
            customs_information_shipping: null
            active: true
            bar_code: null
            track_quantity: null
            keep_selling: null
            option_attrs: []
            allow_subscription: true
            subscription_only: false
            limit_subscription: false
            subscription_max_qty: null
            shipping_included_in_price: false
            subscription_interval: 1
          currency_symbol: $
          currency_code: USD
          average_rating: 0
          option_values: null
          publish_to_retail_store: true
          publish_to_rep_store: true
          publish_to_share_tab: true
          hide_rating?: true
          hide_reviews?: true
          prompts_enabled: false
          label: null
          display_tag: null
          images:
            - id: 2053
              image:
                mini: >-
                  https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
                detail: >-
                  https://ik.imagekit.io/fluid/s3/tr:n-video_poster/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
                full: >-
                  https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
              image_url: >-
                https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
              position: null
              shopify_id: null
          countries:
            - id: 24
              iso_name: BHUTAN
              iso: BT
              iso3: BTN
              name: Bhutan
              numcode: 64
              active: true
              currency_code: BTN
              currency_symbol: Nu.
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 92
              iso_name: INDIA
              iso: IN
              iso3: IND
              name: India
              numcode: 356
              active: true
              currency_code: INR
              currency_symbol: ₹
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 214
              iso_name: UNITED STATES
              iso: US
              iso3: USA
              name: United States
              numcode: 840
              active: true
              currency_code: USD
              currency_symbol: $
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 141
              iso_name: NEPAL
              iso: NP
              iso3: NPL
              name: Nepal
              numcode: 524
              active: true
              currency_code: NPR
              currency_symbol: Rs.
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 1
              iso_name: AFGHANISTAN
              iso: AF
              iso3: AFG
              name: Afghanistan
              numcode: 4
              active: true
              currency_code: AFN
              currency_symbol: ؋
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
          variants:
            - id: 19537
              title: '5'
              image_url: null
              buyable: true
              option_value_ids:
                - 121
              allow_subscription: true
              subscription_only: false
              shipping_included_in_price: false
              variant_countries:
                - id: 127470
                  price: '78.0'
                  shipping: '1.0'
                  tax: '1.0'
                  currency_code: NPR
                  currency_symbol: Rs.
                  display_price: Rs.78.00
                  country_iso: NP
                  subscription_price: '78.0'
                  display_wholesale_price: Rs.0.00
                  display_wholesale_subscription_price: Rs.0.00
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 141
                    iso: NP
                    iso_name: NEPAL
                    iso3: NPL
                    name: Nepal
                    tax_rate: 0
                - id: 127469
                  price: '78.0'
                  shipping: '1.0'
                  tax: '1.0'
                  currency_code: BTN
                  currency_symbol: Nu.
                  display_price: Nu.78.00
                  country_iso: BT
                  subscription_price: '78.0'
                  display_wholesale_price: Nu.0.00
                  display_wholesale_subscription_price: Nu.0.00
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 24
                    iso: BT
                    iso_name: BHUTAN
                    iso3: BTN
                    name: Bhutan
                    tax_rate: 0
                - id: 127471
                  price: '78.0'
                  shipping: '1.0'
                  tax: '1.0'
                  currency_code: AFN
                  currency_symbol: ؋
                  display_price: ؋78.00
                  country_iso: AF
                  subscription_price: '78.0'
                  display_wholesale_price: ؋0.00
                  display_wholesale_subscription_price: ؋0.00
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 1
                    iso: AF
                    iso_name: AFGHANISTAN
                    iso3: AFG
                    name: Afghanistan
                    tax_rate: 0
            - id: 19538
              title: '2'
              image_url: null
              buyable: true
              option_value_ids:
                - 122
              allow_subscription: true
              subscription_only: false
              shipping_included_in_price: false
              variant_countries:
                - id: 127473
                  price: '78.0'
                  shipping: '1.0'
                  tax: '1.0'
                  currency_code: NPR
                  currency_symbol: Rs.
                  display_price: Rs.78.00
                  country_iso: NP
                  subscription_price: '78.0'
                  display_wholesale_price: Rs.0.00
                  display_wholesale_subscription_price: Rs.0.00
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 141
                    iso: NP
                    iso_name: NEPAL
                    iso3: NPL
                    name: Nepal
                    tax_rate: 0
                - id: 127472
                  price: '78.0'
                  shipping: '1.0'
                  tax: '1.0'
                  currency_code: BTN
                  currency_symbol: Nu.
                  display_price: Nu.78.00
                  country_iso: BT
                  subscription_price: '78.0'
                  display_wholesale_price: Nu.0.00
                  display_wholesale_subscription_price: Nu.0.00
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 24
                    iso: BT
                    iso_name: BHUTAN
                    iso3: BTN
                    name: Bhutan
                    tax_rate: 0
                - id: 127474
                  price: '78.0'
                  shipping: '1.0'
                  tax: '1.0'
                  currency_code: AFN
                  currency_symbol: ؋
                  display_price: ؋78.00
                  country_iso: AF
                  subscription_price: '78.0'
                  display_wholesale_price: ؋0.00
                  display_wholesale_subscription_price: ؋0.00
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 1
                    iso: AF
                    iso_name: AFGHANISTAN
                    iso3: AFG
                    name: Afghanistan
                    tax_rate: 0
            - id: 19539
              title: '3'
              image_url: null
              buyable: true
              option_value_ids:
                - 123
              allow_subscription: true
              subscription_only: false
              shipping_included_in_price: false
              variant_countries:
                - id: 127476
                  price: '78.0'
                  shipping: '1.0'
                  tax: '1.0'
                  currency_code: NPR
                  currency_symbol: Rs.
                  display_price: Rs.78.00
                  country_iso: NP
                  subscription_price: '78.0'
                  display_wholesale_price: Rs.0.00
                  display_wholesale_subscription_price: Rs.0.00
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 141
                    iso: NP
                    iso_name: NEPAL
                    iso3: NPL
                    name: Nepal
                    tax_rate: 0
                - id: 127475
                  price: '78.0'
                  shipping: '1.0'
                  tax: '1.0'
                  currency_code: BTN
                  currency_symbol: Nu.
                  display_price: Nu.78.00
                  country_iso: BT
                  subscription_price: '78.0'
                  display_wholesale_price: Nu.0.00
                  display_wholesale_subscription_price: Nu.0.00
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 24
                    iso: BT
                    iso_name: BHUTAN
                    iso3: BTN
                    name: Bhutan
                    tax_rate: 0
                - id: 127477
                  price: '78.0'
                  shipping: '1.0'
                  tax: '1.0'
                  currency_code: AFN
                  currency_symbol: ؋
                  display_price: ؋78.00
                  country_iso: AF
                  subscription_price: '78.0'
                  display_wholesale_price: ؋0.00
                  display_wholesale_subscription_price: ؋0.00
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 1
                    iso: AF
                    iso_name: AFGHANISTAN
                    iso3: AFG
                    name: Afghanistan
                    tax_rate: 0
          options:
            - id: 31
              title: variant
              position: 21
              presentation: variant
          prompts: []
          enroll_products: []
          enrollment_packs: []
    Relateable6:
      title: Relateable6
      required:
        - id
        - active
        - title
        - description
        - stripped
        - image_url
        - views
        - leads
        - share_link
        - prompts_enabled
        - label
        - display_tag
        - prompts
      type: object
      properties:
        id:
          type: integer
          format: int32
        active:
          type: boolean
        title:
          type: string
        description:
          allOf:
            - $ref: '#/components/schemas/Description19'
            - {}
        stripped:
          type: string
        price:
          type: string
        display_price:
          type: string
        subscription_price:
          type: string
        display_subscription_price:
          type: string
        wholesale_price:
          type: string
        display_wholesale_price:
          type: string
        wholesale_subscription_price:
          type: string
        display_wholesale_subscription_price:
          type: string
        shipping:
          type: string
        image:
          allOf:
            - $ref: '#/components/schemas/Image3'
            - {}
        image_url:
          type: string
        sku:
          type: string
        country_code:
          type: string
        country_id:
          type: string
        views:
          type: integer
          format: int32
        leads:
          type: integer
          format: int32
        share_link:
          type: string
        commission:
          type: string
        public:
          type: boolean
        shopify_id:
          type: string
        shopify_handle:
          type: string
        in_stock:
          type: boolean
        vendor:
          type: string
        price_range:
          type: array
          items:
            type: string
          description: ''
        price_range_formatted:
          type: string
        unlimited_inventory:
          type: boolean
        default_variant:
          allOf:
            - $ref: '#/components/schemas/DefaultVariant18'
            - {}
        currency_symbol:
          type: string
        currency_code:
          type: string
        average_rating:
          type: integer
          format: int32
        option_values:
          type: string
        publish_to_retail_store:
          type: boolean
        publish_to_rep_store:
          type: boolean
        publish_to_share_tab:
          type: boolean
        hide_rating?:
          type: boolean
        hide_reviews?:
          type: boolean
        prompts_enabled:
          type: boolean
        label:
          type: string
        display_tag:
          type: string
        images:
          type: array
          items:
            $ref: '#/components/schemas/Image9'
          description: ''
        countries:
          type: array
          items:
            $ref: '#/components/schemas/Country7'
          description: ''
        variants:
          type: array
          items:
            $ref: '#/components/schemas/Variant28'
          description: ''
        options:
          type: array
          items:
            oneOf:
              - allOf:
                  - $ref: '#/components/schemas/Option3'
                  - example:
                      id: 31
                      title: variant
                      position: 21
                      presentation: variant
              - type: string
          description: ''
        prompts:
          type: array
          items:
            type: string
          description: ''
        enroll_products:
          type: array
          items:
            type: string
          description: ''
        enrollment_packs:
          type: array
          items:
            type: string
          description: ''
        user_id:
          type: string
        media_type:
          type: string
        media_format:
          type: string
        video_url:
          type: string
        pdf_url:
          type: string
        kind:
          type: string
        visibility:
          type: string
        watch:
          type: string
        video_status:
          type: string
        duration:
          type: integer
          format: int32
        cta_url:
          type: string
        cta_button_text:
          type: string
        cta_enabled:
          type: boolean
        cta_action_type:
          type: string
        video_shopping_enabled:
          type: boolean
        attached_shareables:
          type: array
          items:
            type: string
          description: ''
      example:
        id: 2206
        active: true
        title: wallpaper
        description:
          id: 4745
          name: description
          body: <div>wallpaper</div>
          record_type: Product
          record_id: 2206
          created_at: '2022-12-19T08:59:48.650Z'
          updated_at: '2022-12-19T08:59:48.650Z'
          locale: null
        stripped: wallpaper
        price: null
        display_price: ''
        subscription_price: null
        display_subscription_price: null
        wholesale_price: null
        display_wholesale_price: ''
        wholesale_subscription_price: null
        display_wholesale_subscription_price: null
        shipping: '1.0'
        image:
          mini: >-
            https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
          detail: >-
            https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
          full: >-
            https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
        image_url: >-
          https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
        sku: wallpaper
        country_code: bt
        country_id: null
        views: 0
        leads: 0
        share_link: null
        commission: '10.0'
        public: true
        shopify_id: null
        shopify_handle: null
        in_stock: true
        vendor: null
        price_range:
          - Rs.78.00
          - Rs.78.00
        price_range_formatted: Rs.78.00
        unlimited_inventory: false
        default_variant:
          id: 19537
          product_id: 2206
          shopify_id: null
          title: '5'
          sku: null
          position: 12611
          inventory_policy: none
          taxable: true
          inventory_quantity: -3
          created_at: '2022-12-23T09:31:41.111Z'
          updated_at: '2024-08-03T20:54:57.333Z'
          external_id: null
          variant_country_id: null
          image_url: null
          image_path: null
          is_master: false
          discarded_at: null
          price: null
          weight: null
          size: null
          physical: null
          unit_of_weight: null
          height: 0
          width: 0
          length: 0
          unit_of_size: null
          hs_code: null
          country_of_origin: null
          customs_information_shipping: null
          active: true
          bar_code: null
          track_quantity: null
          keep_selling: null
          option_attrs: []
          allow_subscription: true
          subscription_only: false
          limit_subscription: false
          subscription_max_qty: null
          shipping_included_in_price: false
          subscription_interval: 1
        currency_symbol: $
        currency_code: USD
        average_rating: 0
        option_values: null
        publish_to_retail_store: true
        publish_to_rep_store: true
        publish_to_share_tab: true
        hide_rating?: true
        hide_reviews?: true
        prompts_enabled: false
        label: null
        display_tag: null
        images:
          - id: 2053
            image:
              mini: >-
                https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
              detail: >-
                https://ik.imagekit.io/fluid/s3/tr:n-video_poster/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
              full: >-
                https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
            image_url: >-
              https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
            position: null
            shopify_id: null
        countries:
          - id: 24
            iso_name: BHUTAN
            iso: BT
            iso3: BTN
            name: Bhutan
            numcode: 64
            active: true
            currency_code: BTN
            currency_symbol: Nu.
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 92
            iso_name: INDIA
            iso: IN
            iso3: IND
            name: India
            numcode: 356
            active: true
            currency_code: INR
            currency_symbol: ₹
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 214
            iso_name: UNITED STATES
            iso: US
            iso3: USA
            name: United States
            numcode: 840
            active: true
            currency_code: USD
            currency_symbol: $
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 141
            iso_name: NEPAL
            iso: NP
            iso3: NPL
            name: Nepal
            numcode: 524
            active: true
            currency_code: NPR
            currency_symbol: Rs.
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 1
            iso_name: AFGHANISTAN
            iso: AF
            iso3: AFG
            name: Afghanistan
            numcode: 4
            active: true
            currency_code: AFN
            currency_symbol: ؋
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
        variants:
          - id: 19537
            title: '5'
            image_url: null
            buyable: true
            option_value_ids:
              - 121
            allow_subscription: true
            subscription_only: false
            shipping_included_in_price: false
            variant_countries:
              - id: 127470
                price: '78.0'
                shipping: '1.0'
                tax: '1.0'
                currency_code: NPR
                currency_symbol: Rs.
                display_price: Rs.78.00
                country_iso: NP
                subscription_price: '78.0'
                display_wholesale_price: Rs.0.00
                display_wholesale_subscription_price: Rs.0.00
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 141
                  iso: NP
                  iso_name: NEPAL
                  iso3: NPL
                  name: Nepal
                  tax_rate: 0
              - id: 127469
                price: '78.0'
                shipping: '1.0'
                tax: '1.0'
                currency_code: BTN
                currency_symbol: Nu.
                display_price: Nu.78.00
                country_iso: BT
                subscription_price: '78.0'
                display_wholesale_price: Nu.0.00
                display_wholesale_subscription_price: Nu.0.00
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 24
                  iso: BT
                  iso_name: BHUTAN
                  iso3: BTN
                  name: Bhutan
                  tax_rate: 0
              - id: 127471
                price: '78.0'
                shipping: '1.0'
                tax: '1.0'
                currency_code: AFN
                currency_symbol: ؋
                display_price: ؋78.00
                country_iso: AF
                subscription_price: '78.0'
                display_wholesale_price: ؋0.00
                display_wholesale_subscription_price: ؋0.00
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 1
                  iso: AF
                  iso_name: AFGHANISTAN
                  iso3: AFG
                  name: Afghanistan
                  tax_rate: 0
          - id: 19538
            title: '2'
            image_url: null
            buyable: true
            option_value_ids:
              - 122
            allow_subscription: true
            subscription_only: false
            shipping_included_in_price: false
            variant_countries:
              - id: 127473
                price: '78.0'
                shipping: '1.0'
                tax: '1.0'
                currency_code: NPR
                currency_symbol: Rs.
                display_price: Rs.78.00
                country_iso: NP
                subscription_price: '78.0'
                display_wholesale_price: Rs.0.00
                display_wholesale_subscription_price: Rs.0.00
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 141
                  iso: NP
                  iso_name: NEPAL
                  iso3: NPL
                  name: Nepal
                  tax_rate: 0
              - id: 127472
                price: '78.0'
                shipping: '1.0'
                tax: '1.0'
                currency_code: BTN
                currency_symbol: Nu.
                display_price: Nu.78.00
                country_iso: BT
                subscription_price: '78.0'
                display_wholesale_price: Nu.0.00
                display_wholesale_subscription_price: Nu.0.00
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 24
                  iso: BT
                  iso_name: BHUTAN
                  iso3: BTN
                  name: Bhutan
                  tax_rate: 0
              - id: 127474
                price: '78.0'
                shipping: '1.0'
                tax: '1.0'
                currency_code: AFN
                currency_symbol: ؋
                display_price: ؋78.00
                country_iso: AF
                subscription_price: '78.0'
                display_wholesale_price: ؋0.00
                display_wholesale_subscription_price: ؋0.00
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 1
                  iso: AF
                  iso_name: AFGHANISTAN
                  iso3: AFG
                  name: Afghanistan
                  tax_rate: 0
          - id: 19539
            title: '3'
            image_url: null
            buyable: true
            option_value_ids:
              - 123
            allow_subscription: true
            subscription_only: false
            shipping_included_in_price: false
            variant_countries:
              - id: 127476
                price: '78.0'
                shipping: '1.0'
                tax: '1.0'
                currency_code: NPR
                currency_symbol: Rs.
                display_price: Rs.78.00
                country_iso: NP
                subscription_price: '78.0'
                display_wholesale_price: Rs.0.00
                display_wholesale_subscription_price: Rs.0.00
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 141
                  iso: NP
                  iso_name: NEPAL
                  iso3: NPL
                  name: Nepal
                  tax_rate: 0
              - id: 127475
                price: '78.0'
                shipping: '1.0'
                tax: '1.0'
                currency_code: BTN
                currency_symbol: Nu.
                display_price: Nu.78.00
                country_iso: BT
                subscription_price: '78.0'
                display_wholesale_price: Nu.0.00
                display_wholesale_subscription_price: Nu.0.00
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 24
                  iso: BT
                  iso_name: BHUTAN
                  iso3: BTN
                  name: Bhutan
                  tax_rate: 0
              - id: 127477
                price: '78.0'
                shipping: '1.0'
                tax: '1.0'
                currency_code: AFN
                currency_symbol: ؋
                display_price: ؋78.00
                country_iso: AF
                subscription_price: '78.0'
                display_wholesale_price: ؋0.00
                display_wholesale_subscription_price: ؋0.00
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 1
                  iso: AF
                  iso_name: AFGHANISTAN
                  iso3: AFG
                  name: Afghanistan
                  tax_rate: 0
        options:
          - id: 31
            title: variant
            position: 21
            presentation: variant
        prompts: []
        enroll_products: []
        enrollment_packs: []
    Variant28:
      title: Variant28
      required:
        - id
        - title
        - image_url
        - buyable
        - option_value_ids
        - allow_subscription
        - subscription_only
        - shipping_included_in_price
        - variant_countries
      type: object
      properties:
        id:
          type: integer
          format: int32
        title:
          type: string
        image_url:
          type: string
        buyable:
          type: boolean
        option_value_ids:
          type: array
          items:
            oneOf:
              - type: integer
                format: int32
              - type: string
          description: ''
        allow_subscription:
          type: boolean
        subscription_only:
          type: boolean
        shipping_included_in_price:
          type: boolean
        variant_countries:
          type: array
          items:
            $ref: '#/components/schemas/VariantCountries5'
          description: ''
      example:
        id: 19537
        title: '5'
        image_url: null
        buyable: true
        option_value_ids:
          - 121
        allow_subscription: true
        subscription_only: false
        shipping_included_in_price: false
        variant_countries:
          - id: 127470
            price: '78.0'
            shipping: '1.0'
            tax: '1.0'
            currency_code: NPR
            currency_symbol: Rs.
            display_price: Rs.78.00
            country_iso: NP
            subscription_price: '78.0'
            display_wholesale_price: Rs.0.00
            display_wholesale_subscription_price: Rs.0.00
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 141
              iso: NP
              iso_name: NEPAL
              iso3: NPL
              name: Nepal
              tax_rate: 0
          - id: 127469
            price: '78.0'
            shipping: '1.0'
            tax: '1.0'
            currency_code: BTN
            currency_symbol: Nu.
            display_price: Nu.78.00
            country_iso: BT
            subscription_price: '78.0'
            display_wholesale_price: Nu.0.00
            display_wholesale_subscription_price: Nu.0.00
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 24
              iso: BT
              iso_name: BHUTAN
              iso3: BTN
              name: Bhutan
              tax_rate: 0
          - id: 127471
            price: '78.0'
            shipping: '1.0'
            tax: '1.0'
            currency_code: AFN
            currency_symbol: ؋
            display_price: ؋78.00
            country_iso: AF
            subscription_price: '78.0'
            display_wholesale_price: ؋0.00
            display_wholesale_subscription_price: ؋0.00
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 1
              iso: AF
              iso_name: AFGHANISTAN
              iso3: AFG
              name: Afghanistan
              tax_rate: 0
    createrequest13:
      title: createrequest13
      required:
        - product_redirect
      type: object
      properties:
        product_redirect:
          allOf:
            - $ref: '#/components/schemas/ProductRedirect'
            - {}
      example:
        product_redirect:
          country: fin
          external_url: https://hoas.fi
    ProductRedirect:
      title: ProductRedirect
      required:
        - country
        - external_url
      type: object
      properties:
        country:
          type: string
        external_url:
          type: string
      example:
        country: fin
        external_url: https://hoas.fi
    updaterequest12:
      title: updaterequest12
      required:
        - product_redirect
      type: object
      properties:
        product_redirect:
          allOf:
            - $ref: '#/components/schemas/ProductRedirect1'
            - {}
      example:
        product_redirect:
          external_url: https://space.com
    ProductRedirect1:
      title: ProductRedirect1
      required:
        - external_url
      type: object
      properties:
        external_url:
          type: string
      example:
        external_url: https://space.com
    createrequest14:
      title: createrequest14
      required:
        - variant
      type: object
      properties:
        variant:
          allOf:
            - $ref: '#/components/schemas/Variant29'
            - {}
      example:
        variant:
          sku: NSXM10000
          inventory_quantity: 8000
          images_attributes:
            - image_url: https://hello.com/noice.jpg
          weight: 25
          weight1: 35
          weight2: 45
          unit_of_weight1: kg
          unit_of_weight2: lb
          height: 4
          width: 8
          length: 5
          unit_of_size: in
          customs_information_shipping: true
          country_of_origin: np
          physical: true
          unit_of_weight: kg
          hs_code: '978978'
          track_quantity: true
          keep_selling: true
          active: true
          allow_subscription: true
          bar_code: 788o798
          options:
            - name: Color
              value: Yellow
            - name: Size
              value: Large
          variant_countries_attributes:
            - country_id: 214
              active: true
              cv: 4
              qv: 6
              shipping: 10
              tax: 12
              price: 1000
              subscription_price: 950
              wholesale: 920
              wholesale_subscription_price: 900
              compare_price: 940
              cost_of_goods_sold: 50
    Variant29:
      title: Variant29
      required:
        - sku
        - inventory_quantity
        - images_attributes
        - weight
        - weight1
        - weight2
        - unit_of_weight1
        - unit_of_weight2
        - height
        - width
        - length
        - unit_of_size
        - customs_information_shipping
        - country_of_origin
        - physical
        - unit_of_weight
        - hs_code
        - track_quantity
        - keep_selling
        - active
        - allow_subscription
        - bar_code
        - options
        - variant_countries_attributes
      type: object
      properties:
        sku:
          type: string
        inventory_quantity:
          type: integer
          format: int32
        images_attributes:
          type: array
          items:
            $ref: '#/components/schemas/ImagesAttribute1'
          description: ''
        weight:
          type: integer
          format: int32
        weight1:
          type: integer
          format: int32
        weight2:
          type: integer
          format: int32
        unit_of_weight1:
          type: string
        unit_of_weight2:
          type: string
        height:
          type: integer
          format: int32
        width:
          type: integer
          format: int32
        length:
          type: integer
          format: int32
        unit_of_size:
          type: string
        customs_information_shipping:
          type: boolean
        country_of_origin:
          type: string
        physical:
          type: boolean
        unit_of_weight:
          type: string
        hs_code:
          type: string
        track_quantity:
          type: boolean
        keep_selling:
          type: boolean
        active:
          type: boolean
        allow_subscription:
          type: boolean
        bar_code:
          type: string
        options:
          type: array
          items:
            $ref: '#/components/schemas/Option8'
          description: ''
        variant_countries_attributes:
          type: array
          items:
            $ref: '#/components/schemas/VariantCountriesAttribute'
          description: ''
      example:
        sku: NSXM10000
        inventory_quantity: 8000
        images_attributes:
          - image_url: https://hello.com/noice.jpg
        weight: 25
        weight1: 35
        weight2: 45
        unit_of_weight1: kg
        unit_of_weight2: lb
        height: 4
        width: 8
        length: 5
        unit_of_size: in
        customs_information_shipping: true
        country_of_origin: np
        physical: true
        unit_of_weight: kg
        hs_code: '978978'
        track_quantity: true
        keep_selling: true
        active: true
        allow_subscription: true
        bar_code: 788o798
        options:
          - name: Color
            value: Yellow
          - name: Size
            value: Large
        variant_countries_attributes:
          - country_id: 214
            active: true
            cv: 4
            qv: 6
            shipping: 10
            tax: 12
            price: 1000
            subscription_price: 950
            wholesale: 920
            wholesale_subscription_price: 900
            compare_price: 940
            cost_of_goods_sold: 50
    ImagesAttribute1:
      title: ImagesAttribute1
      required:
        - image_url
      type: object
      properties:
        image_url:
          type: string
      example:
        image_url: https://hello.com/noice.jpg
    Option8:
      title: Option8
      required:
        - name
        - value
      type: object
      properties:
        name:
          type: string
        value:
          type: string
      example:
        name: Color
        value: Yellow
    VariantCountriesAttribute:
      title: VariantCountriesAttribute
      required:
        - country_id
        - active
        - cv
        - qv
        - shipping
        - tax
        - price
        - subscription_price
        - wholesale
        - wholesale_subscription_price
        - compare_price
        - cost_of_goods_sold
      type: object
      properties:
        country_id:
          type: integer
          format: int32
        active:
          type: boolean
        cv:
          type: integer
          format: int32
        qv:
          type: integer
          format: int32
        shipping:
          type: integer
          format: int32
        tax:
          type: integer
          format: int32
        price:
          type: integer
          format: int32
        subscription_price:
          type: integer
          format: int32
        wholesale:
          type: integer
          format: int32
        wholesale_subscription_price:
          type: integer
          format: int32
        compare_price:
          type: integer
          format: int32
        cost_of_goods_sold:
          type: integer
          format: int32
      example:
        country_id: 214
        active: true
        cv: 4
        qv: 6
        shipping: 10
        tax: 12
        price: 1000
        subscription_price: 950
        wholesale: 920
        wholesale_subscription_price: 900
        compare_price: 940
        cost_of_goods_sold: 50
    updaterequest13:
      title: updaterequest13
      required:
        - variant
      type: object
      properties:
        variant:
          allOf:
            - $ref: '#/components/schemas/Variant30'
            - {}
      example:
        variant:
          sku: NSXM00000
          inventory_quantity: 800
          images_attributes:
            - image_url: >-
                https://m.media-amazon.com/images/M/MV5BMjExMTg5OTU0NF5BMl5BanBnXkFtZTcwMjMxMzMzMw@@._V1_.jpg
          weight: 25
          weight1: 35
          weight2: 45
          unit_of_weight1: kg
          unit_of_weight2: lb
          height: 4
          width: 8
          length: 5
          unit_of_size: in
          customs_information_shipping: true
          country_of_origin: np
          physical: true
          unit_of_weight: kg
          hs_code: '978978'
          track_quantity: true
          keep_selling: true
          active: true
          allow_subscription: true
          bar_code: 788o798
          variant_countries_attributes:
            - country_id: 214
              active: true
              cv: 4
              qv: 6
              shipping: 10
              tax: 12
              price: 2000
              subscription_price: 950
              wholesale: 920
              wholesale_subscription_price: 900
              compare_price: 940
              cost_of_goods_sold: 50
            - country_id: 92
              active: true
              cv: 4
              qv: 6
              shipping: 10
              tax: 12
              price: 2000
              subscription_price: 950
              wholesale: 920
              wholesale_subscription_price: 900
              compare_price: 940
              cost_of_goods_sold: 50
    Variant30:
      title: Variant30
      required:
        - sku
        - inventory_quantity
        - images_attributes
        - weight
        - weight1
        - weight2
        - unit_of_weight1
        - unit_of_weight2
        - height
        - width
        - length
        - unit_of_size
        - customs_information_shipping
        - country_of_origin
        - physical
        - unit_of_weight
        - hs_code
        - track_quantity
        - keep_selling
        - active
        - allow_subscription
        - bar_code
        - variant_countries_attributes
      type: object
      properties:
        sku:
          type: string
        inventory_quantity:
          type: integer
          format: int32
        images_attributes:
          type: array
          items:
            $ref: '#/components/schemas/ImagesAttribute1'
          description: ''
        weight:
          type: integer
          format: int32
        weight1:
          type: integer
          format: int32
        weight2:
          type: integer
          format: int32
        unit_of_weight1:
          type: string
        unit_of_weight2:
          type: string
        height:
          type: integer
          format: int32
        width:
          type: integer
          format: int32
        length:
          type: integer
          format: int32
        unit_of_size:
          type: string
        customs_information_shipping:
          type: boolean
        country_of_origin:
          type: string
        physical:
          type: boolean
        unit_of_weight:
          type: string
        hs_code:
          type: string
        track_quantity:
          type: boolean
        keep_selling:
          type: boolean
        active:
          type: boolean
        allow_subscription:
          type: boolean
        bar_code:
          type: string
        variant_countries_attributes:
          type: array
          items:
            $ref: '#/components/schemas/VariantCountriesAttribute'
          description: ''
      example:
        sku: NSXM00000
        inventory_quantity: 800
        images_attributes:
          - image_url: >-
              https://m.media-amazon.com/images/M/MV5BMjExMTg5OTU0NF5BMl5BanBnXkFtZTcwMjMxMzMzMw@@._V1_.jpg
        weight: 25
        weight1: 35
        weight2: 45
        unit_of_weight1: kg
        unit_of_weight2: lb
        height: 4
        width: 8
        length: 5
        unit_of_size: in
        customs_information_shipping: true
        country_of_origin: np
        physical: true
        unit_of_weight: kg
        hs_code: '978978'
        track_quantity: true
        keep_selling: true
        active: true
        allow_subscription: true
        bar_code: 788o798
        variant_countries_attributes:
          - country_id: 214
            active: true
            cv: 4
            qv: 6
            shipping: 10
            tax: 12
            price: 2000
            subscription_price: 950
            wholesale: 920
            wholesale_subscription_price: 900
            compare_price: 940
            cost_of_goods_sold: 50
          - country_id: 92
            active: true
            cv: 4
            qv: 6
            shipping: 10
            tax: 12
            price: 2000
            subscription_price: 950
            wholesale: 920
            wholesale_subscription_price: 900
            compare_price: 940
            cost_of_goods_sold: 50
    index10:
      title: index10
      required:
        - id
        - user_id
        - media_type
        - media_format
        - image_url
        - video_url
        - pdf_url
        - title
        - description
        - stripped
        - kind
        - active
        - visibility
        - share_link
        - views
        - leads
        - language_id
        - watch
        - video_status
        - duration
        - cta_url
        - cta_button_text
        - cta_enabled
        - cta_action_type
        - video_shopping_enabled
        - prompts_enabled
        - label
        - display_tag
        - prompts
        - attached_shareables
      type: object
      properties:
        id:
          type: integer
          format: int32
        user_id:
          type: string
        media_type:
          type: string
        media_format:
          type: string
        image_url:
          type: string
        video_url:
          type: string
        pdf_url:
          type: string
        title:
          type: string
        description:
          allOf:
            - $ref: '#/components/schemas/Description19'
            - {}
        stripped:
          type: string
        kind:
          type: string
        active:
          type: boolean
        visibility:
          type: string
        share_link:
          type: string
        views:
          type: integer
          format: int32
        leads:
          type: integer
          format: int32
        language_id:
          type: integer
          format: int32
        watch:
          type: string
        video_status:
          type: string
        duration:
          type: integer
          format: int32
        cta_url:
          type: string
        cta_button_text:
          type: string
        cta_enabled:
          type: boolean
        cta_action_type:
          type: string
        video_shopping_enabled:
          type: boolean
        prompts_enabled:
          type: boolean
        label:
          oneOf:
            - allOf:
                - oneOf:
                    - type: 'null'
                    - $ref: '#/components/schemas/Label'
                - example:
                    id: 206
                    title: ARS
                    background: '#8E3596'
                    icon: >-
                      /assets/label_icons/home_icon-58cb9cd311890c97fc380e9fcac962420d5a0da49bc8a3ddd9c6f5fafecf09ac.svg
                    color: '#FF0000'
            - type: string
            - type: 'null'
        display_tag:
          type: string
        prompts:
          type: array
          items:
            type: string
          description: ''
        attached_shareables:
          type: array
          items:
            oneOf:
              - $ref: '#/components/schemas/AttachedShareable'
              - allOf:
                  - $ref: '#/components/schemas/AttachedShareable1'
                  - example:
                      id: 96
                      kind: video_shopping
                      timestamp: '2'
                      attachment:
                        id: 63
                        active: true
                        title: Citizen Cabin
                        description:
                          id: 14611
                          name: description
                          body: |-
                            <div class="trix-content">
                              <div>Amazing pre-built homes and cabins that can operate off the grid.</div>
                            </div>
                          record_type: Product
                          record_id: 63
                          created_at: '2024-01-17T18:22:04.997Z'
                          updated_at: '2024-01-17T18:22:04.997Z'
                          locale: en
                        stripped: |2-

                            Amazing pre-built homes and cabins that can operate off the grid.
                        price: '87.56'
                        display_price: $87.56 (USD)
                        subscription_price: '87.56'
                        display_subscription_price: $87.56 (USD)
                        wholesale_price: '0.0'
                        display_wholesale_price: $0.00 (USD)
                        wholesale_subscription_price: '0.0'
                        display_wholesale_subscription_price: $0.00 (USD)
                        shipping: '1.0'
                        image:
                          mini: >-
                            https://ik.imagekit.io/fluid/s3/jfuOhC2QRN6wyFalig9A_fJs9JlVXQhmoSCe3AtE8_undefined.jpg
                          detail: >-
                            https://ik.imagekit.io/fluid/s3/jfuOhC2QRN6wyFalig9A_fJs9JlVXQhmoSCe3AtE8_undefined.jpg
                          full: >-
                            https://ik.imagekit.io/fluid/s3/jfuOhC2QRN6wyFalig9A_fJs9JlVXQhmoSCe3AtE8_undefined.jpg
                        image_url: >-
                          https://ik.imagekit.io/fluid/s3/jfuOhC2QRN6wyFalig9A_fJs9JlVXQhmoSCe3AtE8_undefined.jpg
                        sku: CTZHOME
                        country_code: us
                        country_id: 214
                        views: 0
                        leads: 0
                        share_link: null
                        commission: '10.0'
                        public: true
                        shopify_id: null
                        shopify_handle: null
                        in_stock: true
                        vendor: null
                        price_range:
                          - $0.00
                          - $87.56
                        price_range_formatted: $0.00 - $87.56
                        unlimited_inventory: false
                        default_variant:
                          id: 2698
                          product_id: 63
                          shopify_id: null
                          title: ''
                          sku: CTZHOME
                          position: 2469
                          inventory_policy: none
                          taxable: true
                          inventory_quantity: 1
                          created_at: '2022-06-17T12:52:26.495Z'
                          updated_at: '2023-05-10T19:39:42.757Z'
                          external_id: null
                          variant_country_id: null
                          image_url: null
                          image_path: null
                          is_master: true
                          discarded_at: null
                          price: null
                          weight: null
                          size: null
                          physical: null
                          unit_of_weight: null
                          height: 0
                          width: 0
                          length: 0
                          unit_of_size: null
                          hs_code: null
                          country_of_origin: null
                          customs_information_shipping: null
                          active: true
                          bar_code: null
                          track_quantity: null
                          keep_selling: null
                          option_attrs: []
                          allow_subscription: true
                          subscription_only: false
                          limit_subscription: false
                          subscription_max_qty: null
                          shipping_included_in_price: false
                          subscription_interval: 1
                        currency_symbol: $
                        currency_code: USD
                        average_rating: 0
                        option_values: {}
                        publish_to_retail_store: true
                        publish_to_rep_store: true
                        publish_to_share_tab: true
                        hide_rating?: true
                        hide_reviews?: true
                        prompts_enabled: false
                        label: null
                        display_tag: null
                        images:
                          - id: 29
                            image:
                              mini: >-
                                https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/jfuOhC2QRN6wyFalig9A_fJs9JlVXQhmoSCe3AtE8_undefined.jpg
                              detail: >-
                                https://ik.imagekit.io/fluid/s3/tr:n-video_poster/jfuOhC2QRN6wyFalig9A_fJs9JlVXQhmoSCe3AtE8_undefined.jpg
                              full: >-
                                https://ik.imagekit.io/fluid/s3/jfuOhC2QRN6wyFalig9A_fJs9JlVXQhmoSCe3AtE8_undefined.jpg
                            image_url: >-
                              https://ik.imagekit.io/fluid/s3/jfuOhC2QRN6wyFalig9A_fJs9JlVXQhmoSCe3AtE8_undefined.jpg
                            position: null
                            shopify_id: null
                        countries:
                          - id: 214
                            iso_name: UNITED STATES
                            iso: US
                            iso3: USA
                            name: United States
                            numcode: 840
                            active: true
                            currency_code: USD
                            currency_symbol: $
                            separator: .
                            delimiter: ','
                            address3: false
                            state: true
                            passport: false
                            itn: false
                            tax_rate: 0
                          - id: 216
                            iso_name: UZBEKISTAN
                            iso: UZ
                            iso3: UZB
                            name: Uzbekistan
                            numcode: 860
                            active: true
                            currency_code: UZS
                            currency_symbol: so'm
                            separator: .
                            delimiter: ','
                            address3: false
                            state: true
                            passport: false
                            itn: false
                            tax_rate: 0
                          - id: 217
                            iso_name: VANUATU
                            iso: VU
                            iso3: VUT
                            name: Vanuatu
                            numcode: 548
                            active: true
                            currency_code: VUV
                            currency_symbol: Vt
                            separator: .
                            delimiter: ','
                            address3: false
                            state: true
                            passport: false
                            itn: false
                            tax_rate: 0
                          - id: 218
                            iso_name: VENEZUELA
                            iso: VE
                            iso3: VEN
                            name: Venezuela
                            numcode: 862
                            active: true
                            currency_code: VES
                            currency_symbol: Bs
                            separator: .
                            delimiter: ','
                            address3: false
                            state: true
                            passport: false
                            itn: false
                            tax_rate: 0
                          - id: 219
                            iso_name: VIET NAM
                            iso: VN
                            iso3: VNM
                            name: Viet Nam
                            numcode: 704
                            active: true
                            currency_code: VND
                            currency_symbol: ₫
                            separator: .
                            delimiter: ','
                            address3: false
                            state: true
                            passport: false
                            itn: false
                            tax_rate: 0
                          - id: 12
                            iso_name: AUSTRALIA
                            iso: AU
                            iso3: AUS
                            name: Australia
                            numcode: 36
                            active: true
                            currency_code: AUD
                            currency_symbol: $
                            separator: .
                            delimiter: ','
                            address3: false
                            state: true
                            passport: false
                            itn: false
                            tax_rate: 0
                          - id: 222
                            iso_name: WALLIS AND FUTUNA
                            iso: WF
                            iso3: WLF
                            name: Wallis and Futuna
                            numcode: 876
                            active: true
                            currency_code: XPF
                            currency_symbol: Fr
                            separator: .
                            delimiter: ','
                            address3: false
                            state: true
                            passport: false
                            itn: false
                            tax_rate: 0
                        variants:
                          - id: 2698
                            title: ''
                            image_url: null
                            buyable: true
                            option_value_ids: []
                            allow_subscription: true
                            subscription_only: false
                            shipping_included_in_price: false
                            variant_countries:
                              - id: 5042
                                price: '87.56'
                                shipping: '1.0'
                                tax: '0.0'
                                currency_code: USD
                                currency_symbol: $
                                display_price: $87.56
                                country_iso: US
                                subscription_price: '87.56'
                                display_wholesale_price: $0.00
                                display_wholesale_subscription_price: $0.00
                                wholesale_price: '0.0'
                                wholesale_subscription_price: '0.0'
                                country:
                                  id: 214
                                  iso: US
                                  iso_name: UNITED STATES
                                  iso3: USA
                                  name: United States
                                  tax_rate: 0
                        options: []
                        prompts: []
                        enroll_products: []
                        enrollment_packs: []
                      content: null
                      position: null
                      style: null
                      share_link: null
                      attachment_type: Product
          description: ''
        subtitles:
          allOf:
            - $ref: '#/components/schemas/Subtitles'
            - {}
        comments:
          type: array
          items:
            $ref: '#/components/schemas/Comment'
          description: ''
      example:
        id: 8504
        user_id: null
        media_type: share
        media_format: png
        image_url: >-
          https://ik.imagekit.io/fluid/s3/tr:n-video_poster/JqmCfzdPTQCdVtPKnHIA_fluid+logo.png
        video_url: ''
        pdf_url: ''
        title: test
        description:
          id: 23647
          name: description
          body: <div>test</div>
          record_type: Medium
          record_id: 8504
          created_at: '2024-05-29T17:16:02.540Z'
          updated_at: '2024-05-29T17:16:02.540Z'
          locale: null
        stripped: test
        kind: image
        active: true
        visibility: null
        share_link: null
        views: 0
        leads: 0
        language_id: 980190962
        watch: null
        video_status: null
        duration: 0
        cta_url: ''
        cta_button_text: Learn More
        cta_enabled: false
        cta_action_type: visit_on_click
        video_shopping_enabled: false
        prompts_enabled: false
        label:
          id: 206
          title: ARS
          background: '#8E3596'
          icon: >-
            /assets/label_icons/home_icon-58cb9cd311890c97fc380e9fcac962420d5a0da49bc8a3ddd9c6f5fafecf09ac.svg
          color: '#FF0000'
        display_tag: null
        prompts: []
        attached_shareables: []
    Label:
      title: Label
      type: object
      properties:
        id:
          type: integer
          format: int32
        title:
          type: string
        background:
          type: string
        icon:
          type: string
        color:
          type: string
      example:
        id: 206
        title: ARS
        background: '#8E3596'
        icon: >-
          /assets/label_icons/home_icon-58cb9cd311890c97fc380e9fcac962420d5a0da49bc8a3ddd9c6f5fafecf09ac.svg
        color: '#FF0000'
    AttachedShareable:
      title: AttachedShareable
      type: object
      properties:
        id:
          type: integer
          format: int32
        kind:
          type: string
        timestamp:
          type: string
        attachment:
          allOf:
            - $ref: '#/components/schemas/Attachment'
            - {}
        content:
          type: string
        position:
          type: string
        style:
          type: string
        share_link:
          type: string
        attachment_type:
          type: string
    Attachment:
      title: Attachment
      required:
        - id
        - active
        - title
        - description
        - stripped
        - price
        - display_price
        - subscription_price
        - display_subscription_price
        - wholesale_price
        - display_wholesale_price
        - wholesale_subscription_price
        - display_wholesale_subscription_price
        - shipping
        - image
        - image_url
        - sku
        - country_code
        - country_id
        - views
        - leads
        - share_link
        - commission
        - public
        - shopify_id
        - shopify_handle
        - in_stock
        - vendor
        - price_range
        - price_range_formatted
        - unlimited_inventory
        - default_variant
        - currency_symbol
        - currency_code
        - average_rating
        - option_values
        - publish_to_retail_store
        - publish_to_rep_store
        - publish_to_share_tab
        - hide_rating?
        - hide_reviews?
        - prompts_enabled
        - label
        - display_tag
        - images
        - countries
        - variants
        - options
        - prompts
        - enroll_products
        - enrollment_packs
      type: object
      properties:
        id:
          type: integer
          format: int32
        active:
          type: boolean
        title:
          type: string
        description:
          allOf:
            - $ref: '#/components/schemas/Description27'
            - {}
        stripped:
          type: string
        price:
          type: string
        display_price:
          type: string
        subscription_price:
          type: string
        display_subscription_price:
          type: string
        wholesale_price:
          type: string
        display_wholesale_price:
          type: string
        wholesale_subscription_price:
          type: string
        display_wholesale_subscription_price:
          type: string
        shipping:
          type: string
        image:
          allOf:
            - $ref: '#/components/schemas/Image3'
            - {}
        image_url:
          type: string
        sku:
          type: string
        country_code:
          type: string
        country_id:
          type: integer
          format: int32
        views:
          type: integer
          format: int32
        leads:
          type: integer
          format: int32
        share_link:
          type: string
        commission:
          type: string
        public:
          type: boolean
        shopify_id:
          type: string
        shopify_handle:
          type: string
        in_stock:
          type: boolean
        vendor:
          type: string
        price_range:
          type: array
          items:
            type: string
          description: ''
        price_range_formatted:
          type: string
        unlimited_inventory:
          type: boolean
        default_variant:
          allOf:
            - $ref: '#/components/schemas/DefaultVariant23'
            - {}
        currency_symbol:
          type: string
        currency_code:
          type: string
        average_rating:
          type: integer
          format: int32
        option_values:
          type: object
        publish_to_retail_store:
          type: boolean
        publish_to_rep_store:
          type: boolean
        publish_to_share_tab:
          type: boolean
        hide_rating?:
          type: boolean
        hide_reviews?:
          type: boolean
        prompts_enabled:
          type: boolean
        label:
          type: string
        display_tag:
          type: string
        images:
          type: array
          items:
            $ref: '#/components/schemas/Image9'
          description: ''
        countries:
          type: array
          items:
            $ref: '#/components/schemas/Country7'
          description: ''
        variants:
          type: array
          items:
            $ref: '#/components/schemas/Variant31'
          description: ''
        options:
          type: array
          items:
            type: string
          description: ''
        prompts:
          type: array
          items:
            type: string
          description: ''
        enroll_products:
          type: array
          items:
            type: string
          description: ''
        enrollment_packs:
          type: array
          items:
            type: string
          description: ''
      example:
        id: 63
        active: true
        title: Citizen Cabin
        description:
          id: 14611
          name: description
          body: |-
            <div class="trix-content">
              <div>Amazing pre-built homes and cabins that can operate off the grid.</div>
            </div>
          record_type: Product
          record_id: 63
          created_at: '2024-01-17T18:22:04.997Z'
          updated_at: '2024-01-17T18:22:04.997Z'
          locale: en
        stripped: |2-

            Amazing pre-built homes and cabins that can operate off the grid.
        price: '87.56'
        display_price: $87.56 (USD)
        subscription_price: '87.56'
        display_subscription_price: $87.56 (USD)
        wholesale_price: '0.0'
        display_wholesale_price: $0.00 (USD)
        wholesale_subscription_price: '0.0'
        display_wholesale_subscription_price: $0.00 (USD)
        shipping: '1.0'
        image:
          mini: >-
            https://ik.imagekit.io/fluid/s3/jfuOhC2QRN6wyFalig9A_fJs9JlVXQhmoSCe3AtE8_undefined.jpg
          detail: >-
            https://ik.imagekit.io/fluid/s3/jfuOhC2QRN6wyFalig9A_fJs9JlVXQhmoSCe3AtE8_undefined.jpg
          full: >-
            https://ik.imagekit.io/fluid/s3/jfuOhC2QRN6wyFalig9A_fJs9JlVXQhmoSCe3AtE8_undefined.jpg
        image_url: >-
          https://ik.imagekit.io/fluid/s3/jfuOhC2QRN6wyFalig9A_fJs9JlVXQhmoSCe3AtE8_undefined.jpg
        sku: CTZHOME
        country_code: us
        country_id: 214
        views: 0
        leads: 0
        share_link: null
        commission: '10.0'
        public: true
        shopify_id: null
        shopify_handle: null
        in_stock: true
        vendor: null
        price_range:
          - $0.00
          - $87.56
        price_range_formatted: $0.00 - $87.56
        unlimited_inventory: false
        default_variant:
          id: 2698
          product_id: 63
          shopify_id: null
          title: ''
          sku: CTZHOME
          position: 2469
          inventory_policy: none
          taxable: true
          inventory_quantity: 1
          created_at: '2022-06-17T12:52:26.495Z'
          updated_at: '2023-05-10T19:39:42.757Z'
          external_id: null
          variant_country_id: null
          image_url: null
          image_path: null
          is_master: true
          discarded_at: null
          price: null
          weight: null
          size: null
          physical: null
          unit_of_weight: null
          height: 0
          width: 0
          length: 0
          unit_of_size: null
          hs_code: null
          country_of_origin: null
          customs_information_shipping: null
          active: true
          bar_code: null
          track_quantity: null
          keep_selling: null
          option_attrs: []
          allow_subscription: true
          subscription_only: false
          limit_subscription: false
          subscription_max_qty: null
          shipping_included_in_price: false
          subscription_interval: 1
        currency_symbol: $
        currency_code: USD
        average_rating: 0
        option_values: {}
        publish_to_retail_store: true
        publish_to_rep_store: true
        publish_to_share_tab: true
        hide_rating?: true
        hide_reviews?: true
        prompts_enabled: false
        label: null
        display_tag: null
        images:
          - id: 29
            image:
              mini: >-
                https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/jfuOhC2QRN6wyFalig9A_fJs9JlVXQhmoSCe3AtE8_undefined.jpg
              detail: >-
                https://ik.imagekit.io/fluid/s3/tr:n-video_poster/jfuOhC2QRN6wyFalig9A_fJs9JlVXQhmoSCe3AtE8_undefined.jpg
              full: >-
                https://ik.imagekit.io/fluid/s3/jfuOhC2QRN6wyFalig9A_fJs9JlVXQhmoSCe3AtE8_undefined.jpg
            image_url: >-
              https://ik.imagekit.io/fluid/s3/jfuOhC2QRN6wyFalig9A_fJs9JlVXQhmoSCe3AtE8_undefined.jpg
            position: null
            shopify_id: null
        countries:
          - id: 214
            iso_name: UNITED STATES
            iso: US
            iso3: USA
            name: United States
            numcode: 840
            active: true
            currency_code: USD
            currency_symbol: $
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 216
            iso_name: UZBEKISTAN
            iso: UZ
            iso3: UZB
            name: Uzbekistan
            numcode: 860
            active: true
            currency_code: UZS
            currency_symbol: so'm
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 217
            iso_name: VANUATU
            iso: VU
            iso3: VUT
            name: Vanuatu
            numcode: 548
            active: true
            currency_code: VUV
            currency_symbol: Vt
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 218
            iso_name: VENEZUELA
            iso: VE
            iso3: VEN
            name: Venezuela
            numcode: 862
            active: true
            currency_code: VES
            currency_symbol: Bs
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 219
            iso_name: VIET NAM
            iso: VN
            iso3: VNM
            name: Viet Nam
            numcode: 704
            active: true
            currency_code: VND
            currency_symbol: ₫
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 12
            iso_name: AUSTRALIA
            iso: AU
            iso3: AUS
            name: Australia
            numcode: 36
            active: true
            currency_code: AUD
            currency_symbol: $
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 222
            iso_name: WALLIS AND FUTUNA
            iso: WF
            iso3: WLF
            name: Wallis and Futuna
            numcode: 876
            active: true
            currency_code: XPF
            currency_symbol: Fr
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
        variants:
          - id: 2698
            title: ''
            image_url: null
            buyable: true
            option_value_ids: []
            allow_subscription: true
            subscription_only: false
            shipping_included_in_price: false
            variant_countries:
              - id: 5042
                price: '87.56'
                shipping: '1.0'
                tax: '0.0'
                currency_code: USD
                currency_symbol: $
                display_price: $87.56
                country_iso: US
                subscription_price: '87.56'
                display_wholesale_price: $0.00
                display_wholesale_subscription_price: $0.00
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 214
                  iso: US
                  iso_name: UNITED STATES
                  iso3: USA
                  name: United States
                  tax_rate: 0
        options: []
        prompts: []
        enroll_products: []
        enrollment_packs: []
    Description27:
      title: Description27
      required:
        - id
        - name
        - body
        - record_type
        - record_id
        - created_at
        - updated_at
        - locale
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        body:
          type: string
        record_type:
          type: string
        record_id:
          type: integer
          format: int32
        created_at:
          type: string
        updated_at:
          type: string
        locale:
          type: string
      example:
        id: 14611
        name: description
        body: |-
          <div class="trix-content">
            <div>Amazing pre-built homes and cabins that can operate off the grid.</div>
          </div>
        record_type: Product
        record_id: 63
        created_at: '2024-01-17T18:22:04.997Z'
        updated_at: '2024-01-17T18:22:04.997Z'
        locale: en
    DefaultVariant23:
      title: DefaultVariant23
      required:
        - id
        - product_id
        - shopify_id
        - title
        - sku
        - position
        - inventory_policy
        - taxable
        - inventory_quantity
        - created_at
        - updated_at
        - external_id
        - variant_country_id
        - image_url
        - image_path
        - is_master
        - discarded_at
        - price
        - weight
        - size
        - physical
        - unit_of_weight
        - height
        - width
        - length
        - unit_of_size
        - hs_code
        - country_of_origin
        - customs_information_shipping
        - active
        - bar_code
        - track_quantity
        - keep_selling
        - option_attrs
        - allow_subscription
        - subscription_only
        - limit_subscription
        - subscription_max_qty
        - shipping_included_in_price
        - subscription_interval
      type: object
      properties:
        id:
          type: integer
          format: int32
        product_id:
          type: integer
          format: int32
        shopify_id:
          type: string
        title:
          type: string
        sku:
          type: string
        position:
          type: integer
          format: int32
        inventory_policy:
          type: string
        taxable:
          type: boolean
        inventory_quantity:
          type: integer
          format: int32
        created_at:
          type: string
        updated_at:
          type: string
        external_id:
          type: string
        variant_country_id:
          type: string
        image_url:
          type: string
        image_path:
          type: string
        is_master:
          type: boolean
        discarded_at:
          type: string
        price:
          type: string
        weight:
          type: string
        size:
          type: string
        physical:
          type: string
        unit_of_weight:
          type: string
        height:
          type: integer
          format: int32
        width:
          type: integer
          format: int32
        length:
          type: integer
          format: int32
        unit_of_size:
          type: string
        hs_code:
          type: string
        country_of_origin:
          type: string
        customs_information_shipping:
          type: string
        active:
          type: boolean
        bar_code:
          type: string
        track_quantity:
          type: string
        keep_selling:
          type: string
        option_attrs:
          type: array
          items:
            type: string
          description: ''
        allow_subscription:
          type: boolean
        subscription_only:
          type: boolean
        limit_subscription:
          type: boolean
        subscription_max_qty:
          type: string
        shipping_included_in_price:
          type: boolean
        subscription_interval:
          type: integer
          format: int32
      example:
        id: 2698
        product_id: 63
        shopify_id: null
        title: ''
        sku: CTZHOME
        position: 2469
        inventory_policy: none
        taxable: true
        inventory_quantity: 1
        created_at: '2022-06-17T12:52:26.495Z'
        updated_at: '2023-05-10T19:39:42.757Z'
        external_id: null
        variant_country_id: null
        image_url: null
        image_path: null
        is_master: true
        discarded_at: null
        price: null
        weight: null
        size: null
        physical: null
        unit_of_weight: null
        height: 0
        width: 0
        length: 0
        unit_of_size: null
        hs_code: null
        country_of_origin: null
        customs_information_shipping: null
        active: true
        bar_code: null
        track_quantity: null
        keep_selling: null
        option_attrs: []
        allow_subscription: true
        subscription_only: false
        limit_subscription: false
        subscription_max_qty: null
        shipping_included_in_price: false
        subscription_interval: 1
    Variant31:
      title: Variant31
      required:
        - id
        - title
        - image_url
        - buyable
        - option_value_ids
        - allow_subscription
        - subscription_only
        - shipping_included_in_price
        - variant_countries
      type: object
      properties:
        id:
          type: integer
          format: int32
        title:
          type: string
        image_url:
          type: string
        buyable:
          type: boolean
        option_value_ids:
          type: array
          items:
            type: string
          description: ''
        allow_subscription:
          type: boolean
        subscription_only:
          type: boolean
        shipping_included_in_price:
          type: boolean
        variant_countries:
          type: array
          items:
            $ref: '#/components/schemas/VariantCountries5'
          description: ''
      example:
        id: 2698
        title: ''
        image_url: null
        buyable: true
        option_value_ids: []
        allow_subscription: true
        subscription_only: false
        shipping_included_in_price: false
        variant_countries:
          - id: 5042
            price: '87.56'
            shipping: '1.0'
            tax: '0.0'
            currency_code: USD
            currency_symbol: $
            display_price: $87.56
            country_iso: US
            subscription_price: '87.56'
            display_wholesale_price: $0.00
            display_wholesale_subscription_price: $0.00
            wholesale_price: '0.0'
            wholesale_subscription_price: '0.0'
            country:
              id: 214
              iso: US
              iso_name: UNITED STATES
              iso3: USA
              name: United States
              tax_rate: 0
    AttachedShareable1:
      title: AttachedShareable1
      required:
        - id
        - kind
        - timestamp
        - attachment
        - content
        - position
        - style
        - share_link
        - attachment_type
      type: object
      properties:
        id:
          type: integer
          format: int32
        kind:
          type: string
        timestamp:
          type: string
        attachment:
          allOf:
            - $ref: '#/components/schemas/Attachment1'
            - {}
        content:
          type: string
        position:
          type: string
        style:
          type: string
        share_link:
          type: string
        attachment_type:
          type: string
      example:
        id: 96
        kind: video_shopping
        timestamp: '2'
        attachment:
          id: 63
          active: true
          title: Citizen Cabin
          description:
            id: 14611
            name: description
            body: |-
              <div class="trix-content">
                <div>Amazing pre-built homes and cabins that can operate off the grid.</div>
              </div>
            record_type: Product
            record_id: 63
            created_at: '2024-01-17T18:22:04.997Z'
            updated_at: '2024-01-17T18:22:04.997Z'
            locale: en
          stripped: |2-

              Amazing pre-built homes and cabins that can operate off the grid.
          price: '87.56'
          display_price: $87.56 (USD)
          subscription_price: '87.56'
          display_subscription_price: $87.56 (USD)
          wholesale_price: '0.0'
          display_wholesale_price: $0.00 (USD)
          wholesale_subscription_price: '0.0'
          display_wholesale_subscription_price: $0.00 (USD)
          shipping: '1.0'
          image:
            mini: >-
              https://ik.imagekit.io/fluid/s3/jfuOhC2QRN6wyFalig9A_fJs9JlVXQhmoSCe3AtE8_undefined.jpg
            detail: >-
              https://ik.imagekit.io/fluid/s3/jfuOhC2QRN6wyFalig9A_fJs9JlVXQhmoSCe3AtE8_undefined.jpg
            full: >-
              https://ik.imagekit.io/fluid/s3/jfuOhC2QRN6wyFalig9A_fJs9JlVXQhmoSCe3AtE8_undefined.jpg
          image_url: >-
            https://ik.imagekit.io/fluid/s3/jfuOhC2QRN6wyFalig9A_fJs9JlVXQhmoSCe3AtE8_undefined.jpg
          sku: CTZHOME
          country_code: us
          country_id: 214
          views: 0
          leads: 0
          share_link: null
          commission: '10.0'
          public: true
          shopify_id: null
          shopify_handle: null
          in_stock: true
          vendor: null
          price_range:
            - $0.00
            - $87.56
          price_range_formatted: $0.00 - $87.56
          unlimited_inventory: false
          default_variant:
            id: 2698
            product_id: 63
            shopify_id: null
            title: ''
            sku: CTZHOME
            position: 2469
            inventory_policy: none
            taxable: true
            inventory_quantity: 1
            created_at: '2022-06-17T12:52:26.495Z'
            updated_at: '2023-05-10T19:39:42.757Z'
            external_id: null
            variant_country_id: null
            image_url: null
            image_path: null
            is_master: true
            discarded_at: null
            price: null
            weight: null
            size: null
            physical: null
            unit_of_weight: null
            height: 0
            width: 0
            length: 0
            unit_of_size: null
            hs_code: null
            country_of_origin: null
            customs_information_shipping: null
            active: true
            bar_code: null
            track_quantity: null
            keep_selling: null
            option_attrs: []
            allow_subscription: true
            subscription_only: false
            limit_subscription: false
            subscription_max_qty: null
            shipping_included_in_price: false
            subscription_interval: 1
          currency_symbol: $
          currency_code: USD
          average_rating: 0
          option_values: {}
          publish_to_retail_store: true
          publish_to_rep_store: true
          publish_to_share_tab: true
          hide_rating?: true
          hide_reviews?: true
          prompts_enabled: false
          label: null
          display_tag: null
          images:
            - id: 29
              image:
                mini: >-
                  https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/jfuOhC2QRN6wyFalig9A_fJs9JlVXQhmoSCe3AtE8_undefined.jpg
                detail: >-
                  https://ik.imagekit.io/fluid/s3/tr:n-video_poster/jfuOhC2QRN6wyFalig9A_fJs9JlVXQhmoSCe3AtE8_undefined.jpg
                full: >-
                  https://ik.imagekit.io/fluid/s3/jfuOhC2QRN6wyFalig9A_fJs9JlVXQhmoSCe3AtE8_undefined.jpg
              image_url: >-
                https://ik.imagekit.io/fluid/s3/jfuOhC2QRN6wyFalig9A_fJs9JlVXQhmoSCe3AtE8_undefined.jpg
              position: null
              shopify_id: null
          countries:
            - id: 214
              iso_name: UNITED STATES
              iso: US
              iso3: USA
              name: United States
              numcode: 840
              active: true
              currency_code: USD
              currency_symbol: $
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 216
              iso_name: UZBEKISTAN
              iso: UZ
              iso3: UZB
              name: Uzbekistan
              numcode: 860
              active: true
              currency_code: UZS
              currency_symbol: so'm
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 217
              iso_name: VANUATU
              iso: VU
              iso3: VUT
              name: Vanuatu
              numcode: 548
              active: true
              currency_code: VUV
              currency_symbol: Vt
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 218
              iso_name: VENEZUELA
              iso: VE
              iso3: VEN
              name: Venezuela
              numcode: 862
              active: true
              currency_code: VES
              currency_symbol: Bs
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 219
              iso_name: VIET NAM
              iso: VN
              iso3: VNM
              name: Viet Nam
              numcode: 704
              active: true
              currency_code: VND
              currency_symbol: ₫
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 12
              iso_name: AUSTRALIA
              iso: AU
              iso3: AUS
              name: Australia
              numcode: 36
              active: true
              currency_code: AUD
              currency_symbol: $
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
            - id: 222
              iso_name: WALLIS AND FUTUNA
              iso: WF
              iso3: WLF
              name: Wallis and Futuna
              numcode: 876
              active: true
              currency_code: XPF
              currency_symbol: Fr
              separator: .
              delimiter: ','
              address3: false
              state: true
              passport: false
              itn: false
              tax_rate: 0
          variants:
            - id: 2698
              title: ''
              image_url: null
              buyable: true
              option_value_ids: []
              allow_subscription: true
              subscription_only: false
              shipping_included_in_price: false
              variant_countries:
                - id: 5042
                  price: '87.56'
                  shipping: '1.0'
                  tax: '0.0'
                  currency_code: USD
                  currency_symbol: $
                  display_price: $87.56
                  country_iso: US
                  subscription_price: '87.56'
                  display_wholesale_price: $0.00
                  display_wholesale_subscription_price: $0.00
                  wholesale_price: '0.0'
                  wholesale_subscription_price: '0.0'
                  country:
                    id: 214
                    iso: US
                    iso_name: UNITED STATES
                    iso3: USA
                    name: United States
                    tax_rate: 0
          options: []
          prompts: []
          enroll_products: []
          enrollment_packs: []
        content: null
        position: null
        style: null
        share_link: null
        attachment_type: Product
    Attachment1:
      title: Attachment1
      required:
        - id
        - active
        - title
        - description
        - stripped
        - price
        - display_price
        - subscription_price
        - display_subscription_price
        - wholesale_price
        - display_wholesale_price
        - wholesale_subscription_price
        - display_wholesale_subscription_price
        - shipping
        - image
        - image_url
        - sku
        - country_code
        - country_id
        - views
        - leads
        - share_link
        - commission
        - public
        - shopify_id
        - shopify_handle
        - in_stock
        - vendor
        - price_range
        - price_range_formatted
        - unlimited_inventory
        - default_variant
        - currency_symbol
        - currency_code
        - average_rating
        - option_values
        - publish_to_retail_store
        - publish_to_rep_store
        - publish_to_share_tab
        - hide_rating?
        - hide_reviews?
        - prompts_enabled
        - label
        - display_tag
        - images
        - countries
        - variants
        - options
        - prompts
        - enroll_products
        - enrollment_packs
      type: object
      properties:
        id:
          type: integer
          format: int32
        active:
          type: boolean
        title:
          type: string
        description:
          allOf:
            - $ref: '#/components/schemas/Description27'
            - {}
        stripped:
          type: string
        price:
          type: string
        display_price:
          type: string
        subscription_price:
          type: string
        display_subscription_price:
          type: string
        wholesale_price:
          type: string
        display_wholesale_price:
          type: string
        wholesale_subscription_price:
          type: string
        display_wholesale_subscription_price:
          type: string
        shipping:
          type: string
        image:
          allOf:
            - $ref: '#/components/schemas/Image3'
            - {}
        image_url:
          type: string
        sku:
          type: string
        country_code:
          type: string
        country_id:
          type: integer
          format: int32
        views:
          type: integer
          format: int32
        leads:
          type: integer
          format: int32
        share_link:
          type: string
        commission:
          type: string
        public:
          type: boolean
        shopify_id:
          type: string
        shopify_handle:
          type: string
        in_stock:
          type: boolean
        vendor:
          type: string
        price_range:
          type: array
          items:
            type: string
          description: ''
        price_range_formatted:
          type: string
        unlimited_inventory:
          type: boolean
        default_variant:
          allOf:
            - $ref: '#/components/schemas/DefaultVariant24'
            - {}
        currency_symbol:
          type: string
        currency_code:
          type: string
        average_rating:
          type: integer
          format: int32
        option_values:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/m39'
        publish_to_retail_store:
          type: boolean
        publish_to_rep_store:
          type: boolean
        publish_to_share_tab:
          type: boolean
        hide_rating?:
          type: boolean
        hide_reviews?:
          type: boolean
        prompts_enabled:
          type: boolean
        label:
          type: string
        display_tag:
          type: string
        images:
          type: array
          items:
            $ref: '#/components/schemas/Image9'
          description: ''
        countries:
          type: array
          items:
            $ref: '#/components/schemas/Country7'
          description: ''
        variants:
          type: array
          items:
            $ref: '#/components/schemas/Variant22'
          description: ''
        options:
          type: array
          items:
            $ref: '#/components/schemas/Option3'
          description: ''
        prompts:
          type: array
          items:
            $ref: '#/components/schemas/Prompt'
          description: ''
        enroll_products:
          type: array
          items:
            type: string
          description: ''
        enrollment_packs:
          type: array
          items:
            type: string
          description: ''
      example:
        id: 63
        active: true
        title: Citizen Cabin
        description:
          id: 14611
          name: description
          body: |-
            <div class="trix-content">
              <div>Amazing pre-built homes and cabins that can operate off the grid.</div>
            </div>
          record_type: Product
          record_id: 63
          created_at: '2024-01-17T18:22:04.997Z'
          updated_at: '2024-01-17T18:22:04.997Z'
          locale: en
        stripped: |2-

            Amazing pre-built homes and cabins that can operate off the grid.
        price: '87.56'
        display_price: $87.56 (USD)
        subscription_price: '87.56'
        display_subscription_price: $87.56 (USD)
        wholesale_price: '0.0'
        display_wholesale_price: $0.00 (USD)
        wholesale_subscription_price: '0.0'
        display_wholesale_subscription_price: $0.00 (USD)
        shipping: '1.0'
        image:
          mini: >-
            https://ik.imagekit.io/fluid/s3/jfuOhC2QRN6wyFalig9A_fJs9JlVXQhmoSCe3AtE8_undefined.jpg
          detail: >-
            https://ik.imagekit.io/fluid/s3/jfuOhC2QRN6wyFalig9A_fJs9JlVXQhmoSCe3AtE8_undefined.jpg
          full: >-
            https://ik.imagekit.io/fluid/s3/jfuOhC2QRN6wyFalig9A_fJs9JlVXQhmoSCe3AtE8_undefined.jpg
        image_url: >-
          https://ik.imagekit.io/fluid/s3/jfuOhC2QRN6wyFalig9A_fJs9JlVXQhmoSCe3AtE8_undefined.jpg
        sku: CTZHOME
        country_code: us
        country_id: 214
        views: 0
        leads: 0
        share_link: null
        commission: '10.0'
        public: true
        shopify_id: null
        shopify_handle: null
        in_stock: true
        vendor: null
        price_range:
          - $0.00
          - $87.56
        price_range_formatted: $0.00 - $87.56
        unlimited_inventory: false
        default_variant:
          id: 2698
          product_id: 63
          shopify_id: null
          title: ''
          sku: CTZHOME
          position: 2469
          inventory_policy: none
          taxable: true
          inventory_quantity: 1
          created_at: '2022-06-17T12:52:26.495Z'
          updated_at: '2023-05-10T19:39:42.757Z'
          external_id: null
          variant_country_id: null
          image_url: null
          image_path: null
          is_master: true
          discarded_at: null
          price: null
          weight: null
          size: null
          physical: null
          unit_of_weight: null
          height: 0
          width: 0
          length: 0
          unit_of_size: null
          hs_code: null
          country_of_origin: null
          customs_information_shipping: null
          active: true
          bar_code: null
          track_quantity: null
          keep_selling: null
          option_attrs: []
          allow_subscription: true
          subscription_only: false
          limit_subscription: false
          subscription_max_qty: null
          shipping_included_in_price: false
          subscription_interval: 1
        currency_symbol: $
        currency_code: USD
        average_rating: 0
        option_values: {}
        publish_to_retail_store: true
        publish_to_rep_store: true
        publish_to_share_tab: true
        hide_rating?: true
        hide_reviews?: true
        prompts_enabled: false
        label: null
        display_tag: null
        images:
          - id: 29
            image:
              mini: >-
                https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/jfuOhC2QRN6wyFalig9A_fJs9JlVXQhmoSCe3AtE8_undefined.jpg
              detail: >-
                https://ik.imagekit.io/fluid/s3/tr:n-video_poster/jfuOhC2QRN6wyFalig9A_fJs9JlVXQhmoSCe3AtE8_undefined.jpg
              full: >-
                https://ik.imagekit.io/fluid/s3/jfuOhC2QRN6wyFalig9A_fJs9JlVXQhmoSCe3AtE8_undefined.jpg
            image_url: >-
              https://ik.imagekit.io/fluid/s3/jfuOhC2QRN6wyFalig9A_fJs9JlVXQhmoSCe3AtE8_undefined.jpg
            position: null
            shopify_id: null
        countries:
          - id: 214
            iso_name: UNITED STATES
            iso: US
            iso3: USA
            name: United States
            numcode: 840
            active: true
            currency_code: USD
            currency_symbol: $
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 216
            iso_name: UZBEKISTAN
            iso: UZ
            iso3: UZB
            name: Uzbekistan
            numcode: 860
            active: true
            currency_code: UZS
            currency_symbol: so'm
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 217
            iso_name: VANUATU
            iso: VU
            iso3: VUT
            name: Vanuatu
            numcode: 548
            active: true
            currency_code: VUV
            currency_symbol: Vt
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 218
            iso_name: VENEZUELA
            iso: VE
            iso3: VEN
            name: Venezuela
            numcode: 862
            active: true
            currency_code: VES
            currency_symbol: Bs
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 219
            iso_name: VIET NAM
            iso: VN
            iso3: VNM
            name: Viet Nam
            numcode: 704
            active: true
            currency_code: VND
            currency_symbol: ₫
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 12
            iso_name: AUSTRALIA
            iso: AU
            iso3: AUS
            name: Australia
            numcode: 36
            active: true
            currency_code: AUD
            currency_symbol: $
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
          - id: 222
            iso_name: WALLIS AND FUTUNA
            iso: WF
            iso3: WLF
            name: Wallis and Futuna
            numcode: 876
            active: true
            currency_code: XPF
            currency_symbol: Fr
            separator: .
            delimiter: ','
            address3: false
            state: true
            passport: false
            itn: false
            tax_rate: 0
        variants:
          - id: 2698
            title: ''
            image_url: null
            buyable: true
            option_value_ids: []
            allow_subscription: true
            subscription_only: false
            shipping_included_in_price: false
            variant_countries:
              - id: 5042
                price: '87.56'
                shipping: '1.0'
                tax: '0.0'
                currency_code: USD
                currency_symbol: $
                display_price: $87.56
                country_iso: US
                subscription_price: '87.56'
                display_wholesale_price: $0.00
                display_wholesale_subscription_price: $0.00
                wholesale_price: '0.0'
                wholesale_subscription_price: '0.0'
                country:
                  id: 214
                  iso: US
                  iso_name: UNITED STATES
                  iso3: USA
                  name: United States
                  tax_rate: 0
        options: []
        prompts: []
        enroll_products: []
        enrollment_packs: []
    DefaultVariant24:
      title: DefaultVariant24
      required:
        - id
        - product_id
        - shopify_id
        - title
        - sku
        - position
        - inventory_policy
        - taxable
        - inventory_quantity
        - created_at
        - updated_at
        - external_id
        - variant_country_id
        - image_url
        - image_path
        - is_master
        - discarded_at
        - price
        - weight
        - size
        - physical
        - unit_of_weight
        - height
        - width
        - length
        - unit_of_size
        - hs_code
        - country_of_origin
        - customs_information_shipping
        - active
        - bar_code
        - track_quantity
        - keep_selling
        - option_attrs
        - allow_subscription
        - subscription_only
        - limit_subscription
        - subscription_max_qty
        - shipping_included_in_price
        - subscription_interval
      type: object
      properties:
        id:
          type: integer
          format: int32
        product_id:
          type: integer
          format: int32
        shopify_id:
          type: string
        title:
          type: string
        sku:
          type: string
        position:
          type: integer
          format: int32
        inventory_policy:
          type: string
        taxable:
          type: boolean
        inventory_quantity:
          type: integer
          format: int32
        created_at:
          type: string
        updated_at:
          type: string
        external_id:
          type: string
        variant_country_id:
          type: string
        image_url:
          type: string
        image_path:
          type: string
        is_master:
          type: boolean
        discarded_at:
          type: string
        price:
          type: string
        weight:
          type: string
        size:
          type: string
        physical:
          type: string
        unit_of_weight:
          type: string
        height:
          type: integer
          format: int32
        width:
          type: integer
          format: int32
        length:
          type: integer
          format: int32
        unit_of_size:
          type: string
        hs_code:
          type: string
        country_of_origin:
          type: string
        customs_information_shipping:
          type: string
        active:
          type: boolean
        bar_code:
          type: string
        track_quantity:
          type: string
        keep_selling:
          type: string
        option_attrs:
          type: array
          items:
            type: string
          description: ''
        allow_subscription:
          type: boolean
        subscription_only:
          type: boolean
        limit_subscription:
          type: boolean
        subscription_max_qty:
          type: string
        shipping_included_in_price:
          type: boolean
        subscription_interval:
          type: integer
          format: int32
      example:
        id: 2698
        product_id: 63
        shopify_id: null
        title: ''
        sku: CTZHOME
        position: 2469
        inventory_policy: none
        taxable: true
        inventory_quantity: 1
        created_at: '2022-06-17T12:52:26.495Z'
        updated_at: '2023-05-10T19:39:42.757Z'
        external_id: null
        variant_country_id: null
        image_url: null
        image_path: null
        is_master: true
        discarded_at: null
        price: null
        weight: null
        size: null
        physical: null
        unit_of_weight: null
        height: 0
        width: 0
        length: 0
        unit_of_size: null
        hs_code: null
        country_of_origin: null
        customs_information_shipping: null
        active: true
        bar_code: null
        track_quantity: null
        keep_selling: null
        option_attrs: []
        allow_subscription: true
        subscription_only: false
        limit_subscription: false
        subscription_max_qty: null
        shipping_included_in_price: false
        subscription_interval: 1
    Prompt:
      title: Prompt
      type: object
      properties:
        id:
          type: integer
          format: int32
        title:
          type: string
        content:
          type: string
    Subtitles:
      title: Subtitles
      type: object
      properties:
        es:
          type: string
        en:
          type: string
      example:
        es: ''
        en: https://cdn.filestackcontent.com/kkhH61mFQbSVSh4s2bU4
    Comment:
      title: Comment
      required:
        - id
        - body
        - deleted_at
        - full_name
        - first_name
        - last_name
        - image_url
        - relateable_id
        - relateable_type
        - likes
        - liked
        - replies
        - created_at
        - contact_id
        - user_id
        - user
      type: object
      properties:
        id:
          type: integer
          format: int32
        body:
          type: string
        deleted_at:
          type: string
        full_name:
          type: string
        first_name:
          type: string
        last_name:
          type: string
        image_url:
          type: string
        relateable_id:
          type: integer
          format: int32
        relateable_type:
          type: string
        likes:
          type: integer
          format: int32
        liked:
          type: boolean
        replies:
          type: array
          items:
            type: string
          description: ''
        created_at:
          type: string
        contact_id:
          type: integer
          format: int32
        user_id:
          type: string
        user:
          type: object
      example:
        id: 7646
        body: 8v3ov0
        deleted_at: null
        full_name: null
        first_name: null
        last_name: null
        image_url: null
        relateable_id: 773
        relateable_type: Medium
        likes: 0
        liked: false
        replies: []
        created_at: '2024-04-29T10:26:28.784Z'
        contact_id: 2470520
        user_id: null
        user: {}
    show9:
      title: show9
      required:
        - id
        - user_id
        - media_type
        - media_format
        - image_url
        - video_url
        - pdf_url
        - title
        - description
        - stripped
        - kind
        - active
        - visibility
        - share_link
        - views
        - leads
        - language_id
        - watch
        - video_status
        - duration
        - cta_url
        - cta_button_text
        - cta_enabled
        - cta_action_type
        - video_shopping_enabled
        - prompts_enabled
        - subtitles
        - label
        - display_tag
        - attached_shareables
      type: object
      properties:
        id:
          type: integer
          format: int32
        user_id:
          type: string
        media_type:
          type: string
        media_format:
          type: string
        image_url:
          type: string
        video_url:
          type: string
        pdf_url:
          type: string
        title:
          type: string
        description:
          allOf:
            - $ref: '#/components/schemas/Description19'
            - {}
        stripped:
          type: string
        kind:
          type: string
        active:
          type: boolean
        visibility:
          type: string
        share_link:
          type: string
        views:
          type: integer
          format: int32
        leads:
          type: integer
          format: int32
        language_id:
          type: integer
          format: int32
        watch:
          type: string
        video_status:
          type: string
        duration:
          type: integer
          format: int32
        cta_url:
          type: string
        cta_button_text:
          type: string
        cta_enabled:
          type: boolean
        cta_action_type:
          type: string
        video_shopping_enabled:
          type: boolean
        prompts_enabled:
          type: boolean
        subtitles:
          type: object
        label:
          type: string
        display_tag:
          type: string
        attached_shareables:
          type: array
          items:
            type: string
          description: ''
      example:
        id: 6
        user_id: null
        media_type: training
        media_format: mp4
        image_url: >-
          https://ik.imagekit.io/fluid/s3/tr:n-video_poster/e8phkIMDRVywwuq67sPb_AzTQlNIQw6rTejzR2Fig_lotion_bottles.jpg
        video_url: https://cdn.filestackcontent.com/Tj1fbDRtQ7uXT0FynG0s
        pdf_url: ''
        title: Go Time Product Training
        description:
          id: 20
          name: description
          body: >-
            GO time provides healthy energy! It supports weight loss, energy,
            and hydration. Click on the attachment link to download the PDF
            version
          record_type: Medium
          record_id: 6
          created_at: '2021-06-08T04:23:35.771Z'
          updated_at: '2021-06-08T04:23:35.771Z'
          locale: null
        stripped: >-
          GO time provides healthy energy! It supports weight loss, energy, and
          hydration. Click on the attachment link to download the PDF version
        kind: null
        active: true
        visibility: null
        share_link: null
        views: 0
        leads: 0
        language_id: 980190962
        watch: null
        video_status: null
        duration: 556
        cta_url: null
        cta_button_text: null
        cta_enabled: false
        cta_action_type: visit_on_click
        video_shopping_enabled: false
        prompts_enabled: false
        subtitles: {}
        label: null
        display_tag: null
        attached_shareables: []
    createrequest15:
      title: createrequest15
      required:
        - medium
      type: object
      properties:
        medium:
          allOf:
            - $ref: '#/components/schemas/Medium'
            - {}
      example:
        medium:
          title: Subtitles Test
          language: en
          media_type: share
          description: This is the body text of the medium
          video_url: >-
            https://videos.pexels.com/video-files/20576968/20576968-hd_1920_1080_25fps.mp4
          available_countries:
            - npl
            - us
            - ind
            - fi
          tags_attributes:
            - name: meds
          label:
            title: AD
          category: media_category
          cta_enabled: true
          cta_action_type: visit_on_click
          cta_button_text: Learn More
          cta_url: https://google.com
          display_shop: true
          video_shopping_enabled: true
          attached_shareables_attributes:
            - attachment_type: Product
              timestamp: '00:00:05'
            - attachment_type: Product
              attachment_id: 7
          subtitles:
            - lang: en
            - lang: de
              src: >-
                https://raw.githubusercontent.com/andreyvit/subtitle-tools/master/sample.srt
          prompts_attributes:
            - title: This is a Prompt
              content: This is an example content of a prompt.
    Medium:
      title: Medium
      required:
        - title
        - language
        - media_type
        - description
        - video_url
        - available_countries
        - tags_attributes
        - label
        - category
        - cta_enabled
        - cta_action_type
        - cta_button_text
        - cta_url
        - display_shop
        - video_shopping_enabled
        - attached_shareables_attributes
        - subtitles
        - prompts_attributes
      type: object
      properties:
        title:
          type: string
        language:
          type: string
        media_type:
          type: string
        description:
          type: string
        video_url:
          type: string
        available_countries:
          type: array
          items:
            type: string
          description: ''
        tags_attributes:
          type: array
          items:
            $ref: '#/components/schemas/TagsAttribute'
          description: ''
        label:
          allOf:
            - $ref: '#/components/schemas/Label2'
            - {}
        category:
          type: string
        cta_enabled:
          type: boolean
        cta_action_type:
          type: string
        cta_button_text:
          type: string
        cta_url:
          type: string
        display_shop:
          type: boolean
        video_shopping_enabled:
          type: boolean
        attached_shareables_attributes:
          type: array
          items:
            $ref: '#/components/schemas/AttachedShareablesAttribute'
          description: ''
        subtitles:
          type: array
          items:
            $ref: '#/components/schemas/Subtitles1'
          description: ''
        prompts_attributes:
          type: array
          items:
            $ref: '#/components/schemas/PromptsAttribute'
          description: ''
      example:
        title: Subtitles Test
        language: en
        media_type: share
        description: This is the body text of the medium
        video_url: >-
          https://videos.pexels.com/video-files/20576968/20576968-hd_1920_1080_25fps.mp4
        available_countries:
          - npl
          - us
          - ind
          - fi
        tags_attributes:
          - name: meds
        label:
          title: AD
        category: media_category
        cta_enabled: true
        cta_action_type: visit_on_click
        cta_button_text: Learn More
        cta_url: https://google.com
        display_shop: true
        video_shopping_enabled: true
        attached_shareables_attributes:
          - attachment_type: Product
            timestamp: '00:00:05'
          - attachment_type: Product
            attachment_id: 7
        subtitles:
          - lang: en
          - lang: de
            src: >-
              https://raw.githubusercontent.com/andreyvit/subtitle-tools/master/sample.srt
        prompts_attributes:
          - title: This is a Prompt
            content: This is an example content of a prompt.
    TagsAttribute:
      title: TagsAttribute
      required:
        - name
      type: object
      properties:
        name:
          type: string
      example:
        name: meds
    Label2:
      title: Label2
      required:
        - title
      type: object
      properties:
        title:
          type: string
      example:
        title: AD
    AttachedShareablesAttribute:
      title: AttachedShareablesAttribute
      required:
        - attachment_type
      type: object
      properties:
        attachment_type:
          type: string
        timestamp:
          type: string
        attachment_id:
          type: integer
          format: int32
      example:
        attachment_type: Product
        timestamp: '00:00:05'
    Subtitles1:
      title: Subtitles1
      required:
        - lang
      type: object
      properties:
        lang:
          type: string
        src:
          type: string
      example:
        lang: en
    PromptsAttribute:
      title: PromptsAttribute
      required:
        - title
        - content
      type: object
      properties:
        title:
          type: string
        content:
          type: string
      example:
        title: This is a Prompt
        content: This is an example content of a prompt.
    updaterequest14:
      title: updaterequest14
      required:
        - medium
      type: object
      properties:
        medium:
          allOf:
            - $ref: '#/components/schemas/Medium1'
            - {}
      example:
        medium:
          video_shopping_enabled: true
          attached_shareables_attributes:
            - attachment_type: Product
              attachment_id: 27
              timestamp: '00:00:05'
            - attachment_type: Product
              attachment_id: 4
              timestamp: '00:00:15'
          subtitles:
            - lang: en
              src: >-
                https://raw.githubusercontent.com/andreyvit/subtitle-tools/master/sample.srt
            - lang: de
              src: ''
    Medium1:
      title: Medium1
      required:
        - video_shopping_enabled
        - attached_shareables_attributes
        - subtitles
      type: object
      properties:
        video_shopping_enabled:
          type: boolean
        attached_shareables_attributes:
          type: array
          items:
            $ref: '#/components/schemas/AttachedShareablesAttribute1'
          description: ''
        subtitles:
          type: array
          items:
            $ref: '#/components/schemas/Subtitles2'
          description: ''
      example:
        video_shopping_enabled: true
        attached_shareables_attributes:
          - attachment_type: Product
            attachment_id: 27
            timestamp: '00:00:05'
          - attachment_type: Product
            attachment_id: 4
            timestamp: '00:00:15'
        subtitles:
          - lang: en
            src: >-
              https://raw.githubusercontent.com/andreyvit/subtitle-tools/master/sample.srt
          - lang: de
            src: ''
    AttachedShareablesAttribute1:
      title: AttachedShareablesAttribute1
      required:
        - attachment_type
        - attachment_id
        - timestamp
      type: object
      properties:
        attachment_type:
          type: string
        attachment_id:
          type: integer
          format: int32
        timestamp:
          type: string
      example:
        attachment_type: Product
        attachment_id: 27
        timestamp: '00:00:05'
    Subtitles2:
      title: Subtitles2
      required:
        - lang
        - src
      type: object
      properties:
        lang:
          type: string
        src:
          type: string
      example:
        lang: en
        src: >-
          https://raw.githubusercontent.com/andreyvit/subtitle-tools/master/sample.srt
    index11:
      title: index11
      required:
        - team_directs
        - team_groups
        - channels
        - customers
      type: object
      properties:
        team_directs:
          type: array
          items:
            $ref: '#/components/schemas/TeamDirect'
          description: ''
        team_groups:
          type: array
          items:
            $ref: '#/components/schemas/TeamGroup'
          description: ''
        channels:
          type: array
          items:
            $ref: '#/components/schemas/Channel'
          description: ''
        customers:
          type: array
          items:
            $ref: '#/components/schemas/Customer2'
          description: ''
      example:
        team_directs:
          - pagination:
              current: 1
              previous: null
              next: null
              per_page: 5
              pages: 1
              count: 1
          - items:
              - id: 3
                name: Britta Padberg
                description: null
                kind: direct
                type: DirectConversation
                status: open
                created_at: '2024-08-19T04:52:05.030Z'
                pinned: false
                unread_messages_count: 0
                sms_enabled?: false
                draft_message: null
                email_enabled?: false
                conversation_type: internal
                messaging_enabled?: true
                broadcasting: null
                total_recipients: 2
                unread: false
                image_url: null
                auto_add_recipients: true
                muted: false
                announcing: false
                scheduled_messages_count: 0
                avatar_background_color: null
                avatar_emoji: null
                avatar_url: null
                recipients:
                  - id: 34
                    first_name: Britta
                    last_name: Padberg
                    avatar_url: null
                    image_url: null
                    receivable_id: 34
                    receivable_type: UserCompany
                    discarded_at: null
                    left_conversation_at: null
                    blocked: false
                    status: online
                    last_online: '2024-08-19T15:02:44.873Z'
                    country_name: null
                  - id: 1
                    first_name: John
                    last_name: Admin
                    avatar_url: null
                    image_url: null
                    receivable_id: 1
                    receivable_type: UserCompany
                    discarded_at: null
                    left_conversation_at: null
                    blocked: false
                    status: online
                    last_online: '2024-08-19T15:02:44.914Z'
                    country_name: United States
                creator:
                  id: 1
                  first_name: John
                  last_name: Admin
                  image_url: null
                  discarded_at: null
                  blocked: false
                  blocker: false
        team_groups:
          - pagination:
              current: 1
              previous: null
              next: null
              per_page: 5
              pages: 1
              count: 1
          - items:
              - id: 5
                name: Britta & 1 other
                description: null
                kind: group
                type: GroupConversation
                status: open
                created_at: '2024-08-19T04:53:19.442Z'
                pinned: false
                unread_messages_count: 0
                sms_enabled?: false
                draft_message: null
                email_enabled?: false
                conversation_type: internal
                messaging_enabled?: true
                broadcasting: null
                total_recipients: 3
                unread: false
                image_url: null
                auto_add_recipients: true
                muted: false
                announcing: false
                scheduled_messages_count: 0
                avatar_background_color: null
                avatar_emoji: null
                avatar_url: null
                recipients:
                  - id: 34
                    first_name: Britta
                    last_name: Padberg
                    avatar_url: null
                    image_url: null
                    receivable_id: 34
                    receivable_type: UserCompany
                    discarded_at: null
                    left_conversation_at: null
                    blocked: false
                    status: online
                    last_online: '2024-08-19T15:02:44.873Z'
                    country_name: null
                  - id: 56
                    first_name: Ed
                    last_name: Rau
                    avatar_url: null
                    image_url: null
                    receivable_id: 56
                    receivable_type: UserCompany
                    discarded_at: null
                    left_conversation_at: null
                    blocked: false
                    status: online
                    last_online: '2024-08-19T15:02:44.903Z'
                    country_name: null
                  - id: 1
                    first_name: John
                    last_name: Admin
                    avatar_url: null
                    image_url: null
                    receivable_id: 1
                    receivable_type: UserCompany
                    discarded_at: null
                    left_conversation_at: null
                    blocked: false
                    status: online
                    last_online: '2024-08-19T15:02:44.914Z'
                    country_name: United States
                creator:
                  id: 34
                  first_name: Britta
                  last_name: Padberg
                  image_url: null
                  discarded_at: null
                  blocked: false
                  blocker: false
        channels:
          - pagination:
              current: 1
              previous: null
              next: null
              per_page: 5
              pages: 1
              count: 1
          - items:
              - id: 6
                name: all people
                description: null
                kind: channel
                type: ChannelConversation
                status: open
                created_at: '2024-08-19T04:59:27.361Z'
                pinned: false
                unread_messages_count: 0
                sms_enabled?: false
                draft_message: null
                email_enabled?: false
                conversation_type: internal
                messaging_enabled?: true
                broadcasting: false
                total_recipients: 61
                unread: false
                image_url: null
                auto_add_recipients: true
                muted: true
                announcing: false
                scheduled_messages_count: 0
                avatar_background_color: null
                avatar_emoji: null
                avatar_url: null
                recipients:
                  - id: 1
                    first_name: John
                    last_name: Admin
                    avatar_url: null
                    image_url: null
                    receivable_id: 1
                    receivable_type: UserCompany
                    discarded_at: null
                    left_conversation_at: null
                    blocked: false
                    status: online
                    last_online: '2024-08-19T15:02:44.914Z'
                    country_name: United States
                  - id: 3
                    first_name: Berry
                    last_name: Schaefer
                    avatar_url: null
                    image_url: null
                    receivable_id: 3
                    receivable_type: UserCompany
                    discarded_at: null
                    left_conversation_at: null
                    blocked: false
                    status: offline
                    last_online: null
                    country_name: null
                  - id: 4
                    first_name: Debbra
                    last_name: Parker
                    avatar_url: null
                    image_url: null
                    receivable_id: 4
                    receivable_type: UserCompany
                    discarded_at: null
                    left_conversation_at: null
                    blocked: false
                    status: offline
                    last_online: null
                    country_name: null
                  - id: 5
                    first_name: Marcelino
                    last_name: Olson
                    avatar_url: null
                    image_url: null
                    receivable_id: 5
                    receivable_type: UserCompany
                    discarded_at: null
                    left_conversation_at: null
                    blocked: false
                    status: offline
                    last_online: null
                    country_name: null
                  - id: 6
                    first_name: Doug
                    last_name: Feeney
                    avatar_url: null
                    image_url: null
                    receivable_id: 6
                    receivable_type: UserCompany
                    discarded_at: null
                    left_conversation_at: null
                    blocked: false
                    status: offline
                    last_online: null
                    country_name: null
                  - id: 7
                    first_name: Karlene
                    last_name: Treutel
                    avatar_url: null
                    image_url: null
                    receivable_id: 7
                    receivable_type: UserCompany
                    discarded_at: null
                    left_conversation_at: null
                    blocked: false
                    status: offline
                    last_online: null
                    country_name: null
                creator:
                  id: 1
                  first_name: John
                  last_name: Admin
                  image_url: null
                  discarded_at: null
                  blocked: false
                  blocker: false
        customers:
          - pagination:
              current: 1
              previous: null
              next: null
              per_page: 5
              pages: 0
              count: 0
          - items: []
    TeamDirect:
      title: TeamDirect
      type: object
      properties:
        pagination:
          allOf:
            - $ref: '#/components/schemas/Pagination'
            - {}
        items:
          type: array
          items:
            $ref: '#/components/schemas/Item13'
          description: ''
      example:
        pagination:
          current: 1
          previous: null
          next: null
          per_page: 5
          pages: 1
          count: 1
    Pagination:
      title: Pagination
      required:
        - current
        - previous
        - next
        - per_page
        - pages
        - count
      type: object
      properties:
        current:
          type: integer
          format: int32
        previous:
          type: string
        next:
          type: string
        per_page:
          type: integer
          format: int32
        pages:
          type: integer
          format: int32
        count:
          type: integer
          format: int32
      example:
        current: 1
        previous: null
        next: null
        per_page: 5
        pages: 1
        count: 1
    Item13:
      title: Item13
      required:
        - id
        - name
        - description
        - kind
        - type
        - status
        - created_at
        - pinned
        - unread_messages_count
        - sms_enabled?
        - draft_message
        - email_enabled?
        - conversation_type
        - messaging_enabled?
        - broadcasting
        - total_recipients
        - unread
        - image_url
        - auto_add_recipients
        - muted
        - announcing
        - scheduled_messages_count
        - avatar_background_color
        - avatar_emoji
        - avatar_url
        - recipients
        - creator
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        description:
          type: string
        kind:
          type: string
        type:
          type: string
        status:
          type: string
        created_at:
          type: string
        pinned:
          type: boolean
        unread_messages_count:
          type: integer
          format: int32
        sms_enabled?:
          type: boolean
        draft_message:
          type: string
        email_enabled?:
          type: boolean
        conversation_type:
          type: string
        messaging_enabled?:
          type: boolean
        broadcasting:
          type: string
        total_recipients:
          type: integer
          format: int32
        unread:
          type: boolean
        image_url:
          type: string
        auto_add_recipients:
          type: boolean
        muted:
          type: boolean
        announcing:
          type: boolean
        scheduled_messages_count:
          type: integer
          format: int32
        avatar_background_color:
          type: string
        avatar_emoji:
          type: string
        avatar_url:
          type: string
        recipients:
          type: array
          items:
            $ref: '#/components/schemas/Recipient'
          description: ''
        creator:
          allOf:
            - $ref: '#/components/schemas/Creator'
            - {}
      example:
        id: 3
        name: Britta Padberg
        description: null
        kind: direct
        type: DirectConversation
        status: open
        created_at: '2024-08-19T04:52:05.030Z'
        pinned: false
        unread_messages_count: 0
        sms_enabled?: false
        draft_message: null
        email_enabled?: false
        conversation_type: internal
        messaging_enabled?: true
        broadcasting: null
        total_recipients: 2
        unread: false
        image_url: null
        auto_add_recipients: true
        muted: false
        announcing: false
        scheduled_messages_count: 0
        avatar_background_color: null
        avatar_emoji: null
        avatar_url: null
        recipients:
          - id: 34
            first_name: Britta
            last_name: Padberg
            avatar_url: null
            image_url: null
            receivable_id: 34
            receivable_type: UserCompany
            discarded_at: null
            left_conversation_at: null
            blocked: false
            status: online
            last_online: '2024-08-19T15:02:44.873Z'
            country_name: null
          - id: 1
            first_name: John
            last_name: Admin
            avatar_url: null
            image_url: null
            receivable_id: 1
            receivable_type: UserCompany
            discarded_at: null
            left_conversation_at: null
            blocked: false
            status: online
            last_online: '2024-08-19T15:02:44.914Z'
            country_name: United States
        creator:
          id: 1
          first_name: John
          last_name: Admin
          image_url: null
          discarded_at: null
          blocked: false
          blocker: false
    Recipient:
      title: Recipient
      required:
        - id
        - first_name
        - last_name
        - avatar_url
        - image_url
        - receivable_id
        - receivable_type
        - discarded_at
        - left_conversation_at
        - blocked
        - status
        - last_online
        - country_name
      type: object
      properties:
        id:
          type: integer
          format: int32
        first_name:
          type: string
        last_name:
          type: string
        avatar_url:
          type: string
        image_url:
          type: string
        receivable_id:
          type: integer
          format: int32
        receivable_type:
          type: string
        discarded_at:
          type: string
        left_conversation_at:
          type: string
        blocked:
          type: boolean
        status:
          type: string
        last_online:
          type: string
        country_name:
          type: string
      example:
        id: 34
        first_name: Britta
        last_name: Padberg
        avatar_url: null
        image_url: null
        receivable_id: 34
        receivable_type: UserCompany
        discarded_at: null
        left_conversation_at: null
        blocked: false
        status: online
        last_online: '2024-08-19T15:02:44.873Z'
        country_name: null
    Creator:
      title: Creator
      required:
        - id
        - first_name
        - last_name
        - image_url
        - discarded_at
        - blocked
        - blocker
      type: object
      properties:
        id:
          type: integer
          format: int32
        first_name:
          type: string
        last_name:
          type: string
        image_url:
          type: string
        discarded_at:
          type: string
        blocked:
          type: boolean
        blocker:
          type: boolean
      example:
        id: 1
        first_name: John
        last_name: Admin
        image_url: null
        discarded_at: null
        blocked: false
        blocker: false
    TeamGroup:
      title: TeamGroup
      type: object
      properties:
        pagination:
          allOf:
            - $ref: '#/components/schemas/Pagination'
            - {}
        items:
          type: array
          items:
            $ref: '#/components/schemas/Item13'
          description: ''
      example:
        pagination:
          current: 1
          previous: null
          next: null
          per_page: 5
          pages: 1
          count: 1
    Channel:
      title: Channel
      type: object
      properties:
        pagination:
          allOf:
            - $ref: '#/components/schemas/Pagination'
            - {}
        items:
          type: array
          items:
            $ref: '#/components/schemas/Item15'
          description: ''
      example:
        pagination:
          current: 1
          previous: null
          next: null
          per_page: 5
          pages: 1
          count: 1
    Item15:
      title: Item15
      required:
        - id
        - name
        - description
        - kind
        - type
        - status
        - created_at
        - pinned
        - unread_messages_count
        - sms_enabled?
        - draft_message
        - email_enabled?
        - conversation_type
        - messaging_enabled?
        - broadcasting
        - total_recipients
        - unread
        - image_url
        - auto_add_recipients
        - muted
        - announcing
        - scheduled_messages_count
        - avatar_background_color
        - avatar_emoji
        - avatar_url
        - recipients
        - creator
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        description:
          type: string
        kind:
          type: string
        type:
          type: string
        status:
          type: string
        created_at:
          type: string
        pinned:
          type: boolean
        unread_messages_count:
          type: integer
          format: int32
        sms_enabled?:
          type: boolean
        draft_message:
          type: string
        email_enabled?:
          type: boolean
        conversation_type:
          type: string
        messaging_enabled?:
          type: boolean
        broadcasting:
          type: boolean
        total_recipients:
          type: integer
          format: int32
        unread:
          type: boolean
        image_url:
          type: string
        auto_add_recipients:
          type: boolean
        muted:
          type: boolean
        announcing:
          type: boolean
        scheduled_messages_count:
          type: integer
          format: int32
        avatar_background_color:
          type: string
        avatar_emoji:
          type: string
        avatar_url:
          type: string
        recipients:
          type: array
          items:
            $ref: '#/components/schemas/Recipient2'
          description: ''
        creator:
          allOf:
            - $ref: '#/components/schemas/Creator'
            - {}
      example:
        id: 6
        name: all people
        description: null
        kind: channel
        type: ChannelConversation
        status: open
        created_at: '2024-08-19T04:59:27.361Z'
        pinned: false
        unread_messages_count: 0
        sms_enabled?: false
        draft_message: null
        email_enabled?: false
        conversation_type: internal
        messaging_enabled?: true
        broadcasting: false
        total_recipients: 61
        unread: false
        image_url: null
        auto_add_recipients: true
        muted: true
        announcing: false
        scheduled_messages_count: 0
        avatar_background_color: null
        avatar_emoji: null
        avatar_url: null
        recipients:
          - id: 1
            first_name: John
            last_name: Admin
            avatar_url: null
            image_url: null
            receivable_id: 1
            receivable_type: UserCompany
            discarded_at: null
            left_conversation_at: null
            blocked: false
            status: online
            last_online: '2024-08-19T15:02:44.914Z'
            country_name: United States
          - id: 3
            first_name: Berry
            last_name: Schaefer
            avatar_url: null
            image_url: null
            receivable_id: 3
            receivable_type: UserCompany
            discarded_at: null
            left_conversation_at: null
            blocked: false
            status: offline
            last_online: null
            country_name: null
          - id: 4
            first_name: Debbra
            last_name: Parker
            avatar_url: null
            image_url: null
            receivable_id: 4
            receivable_type: UserCompany
            discarded_at: null
            left_conversation_at: null
            blocked: false
            status: offline
            last_online: null
            country_name: null
          - id: 5
            first_name: Marcelino
            last_name: Olson
            avatar_url: null
            image_url: null
            receivable_id: 5
            receivable_type: UserCompany
            discarded_at: null
            left_conversation_at: null
            blocked: false
            status: offline
            last_online: null
            country_name: null
          - id: 6
            first_name: Doug
            last_name: Feeney
            avatar_url: null
            image_url: null
            receivable_id: 6
            receivable_type: UserCompany
            discarded_at: null
            left_conversation_at: null
            blocked: false
            status: offline
            last_online: null
            country_name: null
          - id: 7
            first_name: Karlene
            last_name: Treutel
            avatar_url: null
            image_url: null
            receivable_id: 7
            receivable_type: UserCompany
            discarded_at: null
            left_conversation_at: null
            blocked: false
            status: offline
            last_online: null
            country_name: null
        creator:
          id: 1
          first_name: John
          last_name: Admin
          image_url: null
          discarded_at: null
          blocked: false
          blocker: false
    Recipient2:
      title: Recipient2
      required:
        - id
        - first_name
        - last_name
        - avatar_url
        - image_url
        - receivable_id
        - receivable_type
        - discarded_at
        - left_conversation_at
        - blocked
        - status
        - last_online
        - country_name
      type: object
      properties:
        id:
          type: integer
          format: int32
        first_name:
          type: string
        last_name:
          type: string
        avatar_url:
          type: string
        image_url:
          type: string
        receivable_id:
          type: integer
          format: int32
        receivable_type:
          type: string
        discarded_at:
          type: string
        left_conversation_at:
          type: string
        blocked:
          type: boolean
        status:
          type: string
        last_online:
          type: string
        country_name:
          type: string
      example:
        id: 1
        first_name: John
        last_name: Admin
        avatar_url: null
        image_url: null
        receivable_id: 1
        receivable_type: UserCompany
        discarded_at: null
        left_conversation_at: null
        blocked: false
        status: online
        last_online: '2024-08-19T15:02:44.914Z'
        country_name: United States
    Customer2:
      title: Customer2
      type: object
      properties:
        pagination:
          allOf:
            - $ref: '#/components/schemas/Pagination'
            - {}
        items:
          type: array
          items:
            type: string
          description: ''
      example:
        pagination:
          current: 1
          previous: null
          next: null
          per_page: 5
          pages: 0
          count: 0
    CreateRequest16:
      title: CreateRequest16
      required:
        - conversation
        - recipients
        - user
      type: object
      properties:
        conversation:
          allOf:
            - $ref: '#/components/schemas/Conversation'
            - {}
        recipients:
          type: array
          items:
            $ref: '#/components/schemas/Recipient3'
          description: ''
        user:
          allOf:
            - $ref: '#/components/schemas/User11'
            - {}
      example:
        conversation:
          type: DirectConversation
        recipients:
          - uid: 12
        user:
          email: admin@fluid.app
    Conversation:
      title: Conversation
      required:
        - type
      type: object
      properties:
        type:
          type: string
      example:
        type: DirectConversation
    Recipient3:
      title: Recipient3
      required:
        - uid
      type: object
      properties:
        uid:
          type: integer
          format: int32
      example:
        uid: 12
    User11:
      title: User11
      required:
        - email
      type: object
      properties:
        email:
          type: string
      example:
        email: admin@fluid.app
    Create10:
      title: Create10
      required:
        - id
        - name
        - description
        - kind
        - type
        - status
        - created_at
        - pinned
        - unread_messages_count
        - sms_enabled?
        - draft_message
        - email_enabled?
        - conversation_type
        - messaging_enabled?
        - broadcasting
        - total_recipients
        - unread
        - image_url
        - auto_add_recipients
        - muted
        - announcing
        - scheduled_messages_count
        - avatar_background_color
        - avatar_emoji
        - avatar_url
        - recipients
        - creator
      type: object
      properties:
        id:
          type: integer
          format: int32
        name:
          type: string
        description:
          type: string
        kind:
          type: string
        type:
          type: string
        status:
          type: string
        created_at:
          type: string
        pinned:
          type: boolean
        unread_messages_count:
          type: integer
          format: int32
        sms_enabled?:
          type: boolean
        draft_message:
          type: string
        email_enabled?:
          type: boolean
        conversation_type:
          type: string
        messaging_enabled?:
          type: boolean
        broadcasting:
          type: string
        total_recipients:
          type: integer
          format: int32
        unread:
          type: boolean
        image_url:
          type: string
        auto_add_recipients:
          type: boolean
        muted:
          type: boolean
        announcing:
          type: boolean
        scheduled_messages_count:
          type: integer
          format: int32
        avatar_background_color:
          type: string
        avatar_emoji:
          type: string
        avatar_url:
          type: string
        recipients:
          type: array
          items:
            $ref: '#/components/schemas/Recipient2'
          description: ''
        creator:
          allOf:
            - $ref: '#/components/schemas/Creator'
            - {}
      example:
        id: 8
        name: Ada Stracke
        description: null
        kind: direct
        type: DirectConversation
        status: initiated
        created_at: '2024-08-19T16:58:59.023Z'
        pinned: false
        unread_messages_count: 0
        sms_enabled?: false
        draft_message: null
        email_enabled?: false
        conversation_type: internal
        messaging_enabled?: true
        broadcasting: null
        total_recipients: 2
        unread: false
        image_url: null
        auto_add_recipients: true
        muted: false
        announcing: false
        scheduled_messages_count: 0
        avatar_background_color: null
        avatar_emoji: null
        avatar_url: null
        recipients:
          - id: 12
            first_name: Ada
            last_name: Stracke
            avatar_url: null
            image_url: null
            receivable_id: 12
            receivable_type: UserCompany
            discarded_at: null
            left_conversation_at: null
            blocked: false
            status: offline
            last_online: null
            country_name: null
          - id: 1
            first_name: John
            last_name: Admin
            avatar_url: null
            image_url: null
            receivable_id: 1
            receivable_type: UserCompany
            discarded_at: null
            left_conversation_at: null
            blocked: false
            status: online
            last_online: '2024-08-19T15:02:44.914Z'
            country_name: United States
        creator:
          id: 1
          first_name: John
          last_name: Admin
          image_url: null
          discarded_at: null
          blocked: false
          blocker: false
    CreateRequest17:
      title: CreateRequest17
      required:
        - message
        - user
      type: object
      properties:
        message:
          allOf:
            - $ref: '#/components/schemas/Message'
            - {}
        user:
          allOf:
            - $ref: '#/components/schemas/User11'
            - {}
      example:
        message:
          body: How is it going?
          theme: inquiry
          type: DirectMessage
          sent_at: '2022-02-21T11:46:42.379Z'
          attachments_attributes:
            - filename: test.jpg
              url: https://picsum.photos/id/237/200/300
              kind: image
        user:
          email: admin@fluid.app
    Message:
      title: Message
      required:
        - body
        - theme
        - type
        - sent_at
        - attachments_attributes
      type: object
      properties:
        body:
          type: string
        theme:
          type: string
        type:
          type: string
        sent_at:
          type: string
        attachments_attributes:
          type: array
          items:
            $ref: '#/components/schemas/AttachmentsAttribute'
          description: ''
      example:
        body: How is it going?
        theme: inquiry
        type: DirectMessage
        sent_at: '2022-02-21T11:46:42.379Z'
        attachments_attributes:
          - filename: test.jpg
            url: https://picsum.photos/id/237/200/300
            kind: image
    AttachmentsAttribute:
      title: AttachmentsAttribute
      required:
        - filename
        - url
        - kind
      type: object
      properties:
        filename:
          type: string
        url:
          type: string
        kind:
          type: string
      example:
        filename: test.jpg
        url: https://picsum.photos/id/237/200/300
        kind: image
    Create11:
      title: Create11
      required:
        - id
        - body
        - type
        - created_at
        - updated_at
        - deleted_at
        - edited_at
        - conversation_id
        - seen_by
        - attachments
        - reaction_stats
        - reaction
        - metadata
        - seen_by_count
        - emoji_only_count
        - mentioned_recipients
        - sent_at
        - replied_to_message
        - sender_recipient
      type: object
      properties:
        id:
          type: integer
          format: int32
        body:
          type: string
        type:
          type: string
        created_at:
          type: string
        updated_at:
          type: string
        deleted_at:
          type: string
        edited_at:
          type: string
        conversation_id:
          type: integer
          format: int32
        seen_by:
          type: array
          items:
            $ref: '#/components/schemas/SeenBy'
          description: ''
        attachments:
          type: array
          items:
            $ref: '#/components/schemas/Attachment2'
          description: ''
        reaction_stats:
          type: string
        reaction:
          type: string
        metadata:
          type: string
        seen_by_count:
          type: integer
          format: int32
        emoji_only_count:
          type: integer
          format: int32
        mentioned_recipients:
          type: array
          items:
            type: string
          description: ''
        sent_at:
          type: string
        replied_to_message:
          type: string
        sender_recipient:
          allOf:
            - $ref: '#/components/schemas/SenderRecipient'
            - {}
      example:
        id: 34
        body: How is it going?
        type: DirectMessage
        created_at: '2024-08-19T17:04:58.312Z'
        updated_at: '2024-08-19T17:04:58.702Z'
        deleted_at: null
        edited_at: null
        conversation_id: 8
        seen_by:
          - id: 1
            first_name: John
            last_name: Admin
            image_url: null
            seen_at: '2024-08-19T17:04:58.562Z'
        attachments:
          - id: 2
            url: https://picsum.photos/id/237/200/300
            filename: test.jpg
            kind: image
            image_url: https://picsum.photos/id/237/200/300
            image_path: null
            content_type: null
            attachable_type: Message
            attachable_id: 34
            thumbnail_url: https://picsum.photos/id/237/200/300
            metadata: null
            content_size: null
        reaction_stats: null
        reaction: null
        metadata: null
        seen_by_count: 1
        emoji_only_count: 0
        mentioned_recipients: []
        sent_at: '2024-08-19T17:04:58.701Z'
        replied_to_message: null
        sender_recipient:
          id: 1
          first_name: John
          last_name: Admin
          image_url: null
          discarded_at: null
          blocked: false
          blocker: false
    SeenBy:
      title: SeenBy
      required:
        - id
        - first_name
        - last_name
        - image_url
        - seen_at
      type: object
      properties:
        id:
          type: integer
          format: int32
        first_name:
          type: string
        last_name:
          type: string
        image_url:
          type: string
        seen_at:
          type: string
      example:
        id: 1
        first_name: John
        last_name: Admin
        image_url: null
        seen_at: '2024-08-19T17:04:58.562Z'
    Attachment2:
      title: Attachment2
      required:
        - id
        - url
        - filename
        - kind
        - image_url
        - image_path
        - content_type
        - attachable_type
        - attachable_id
        - thumbnail_url
        - metadata
        - content_size
      type: object
      properties:
        id:
          type: integer
          format: int32
        url:
          type: string
        filename:
          type: string
        kind:
          type: string
        image_url:
          type: string
        image_path:
          type: string
        content_type:
          type: string
        attachable_type:
          type: string
        attachable_id:
          type: integer
          format: int32
        thumbnail_url:
          type: string
        metadata:
          type: string
        content_size:
          type: string
      example:
        id: 2
        url: https://picsum.photos/id/237/200/300
        filename: test.jpg
        kind: image
        image_url: https://picsum.photos/id/237/200/300
        image_path: null
        content_type: null
        attachable_type: Message
        attachable_id: 34
        thumbnail_url: https://picsum.photos/id/237/200/300
        metadata: null
        content_size: null
    SenderRecipient:
      title: SenderRecipient
      required:
        - id
        - first_name
        - last_name
        - image_url
        - discarded_at
        - blocked
        - blocker
      type: object
      properties:
        id:
          type: integer
          format: int32
        first_name:
          type: string
        last_name:
          type: string
        image_url:
          type: string
        discarded_at:
          type: string
        blocked:
          type: boolean
        blocker:
          type: boolean
      example:
        id: 1
        first_name: John
        last_name: Admin
        image_url: null
        discarded_at: null
        blocked: false
        blocker: false
    Index12:
      title: Index12
      type: object
      properties:
        pagination:
          allOf:
            - $ref: '#/components/schemas/Pagination'
            - {}
        items:
          type: array
          items:
            $ref: '#/components/schemas/Item16'
          description: ''
      example:
        pagination:
          current: 1
          previous: null
          next: null
          per_page: 20
          pages: 1
          count: 1
    Item16:
      title: Item16
      required:
        - id
        - body
        - type
        - created_at
        - updated_at
        - deleted_at
        - edited_at
        - conversation_id
        - seen_by
        - attachments
        - reaction_stats
        - reaction
        - metadata
        - seen_by_count
        - emoji_only_count
        - mentioned_recipients
        - sent_at
        - replied_to_message
        - sender_recipient
      type: object
      properties:
        id:
          type: integer
          format: int32
        body:
          type: string
        type:
          type: string
        created_at:
          type: string
        updated_at:
          type: string
        deleted_at:
          type: string
        edited_at:
          type: string
        conversation_id:
          type: integer
          format: int32
        seen_by:
          type: array
          items:
            $ref: '#/components/schemas/SeenBy'
          description: ''
        attachments:
          type: array
          items:
            $ref: '#/components/schemas/Attachment2'
          description: ''
        reaction_stats:
          type: string
        reaction:
          type: string
        metadata:
          allOf:
            - $ref: '#/components/schemas/Metadata'
            - {}
        seen_by_count:
          type: integer
          format: int32
        emoji_only_count:
          type: integer
          format: int32
        mentioned_recipients:
          type: array
          items:
            type: string
          description: ''
        sent_at:
          type: string
        replied_to_message:
          type: string
        sender_recipient:
          allOf:
            - $ref: '#/components/schemas/SenderRecipient'
            - {}
      example:
        id: 34
        body: How is it going?
        type: DirectMessage
        created_at: '2024-08-19T17:04:58.312Z'
        updated_at: '2024-08-19T17:04:58.702Z'
        deleted_at: null
        edited_at: null
        conversation_id: 8
        seen_by:
          - id: 1
            first_name: John
            last_name: Admin
            image_url: null
            seen_at: '2024-08-19T17:04:58.562Z'
        attachments:
          - id: 2
            url: https://picsum.photos/id/237/200/300
            filename: test.jpg
            kind: image
            image_url: https://picsum.photos/id/237/200/300
            image_path: null
            content_type: null
            attachable_type: Message
            attachable_id: 34
            thumbnail_url: https://picsum.photos/id/237/200/300
            metadata: null
            content_size: null
        reaction_stats: null
        reaction: null
        metadata:
          links: []
        seen_by_count: 1
        emoji_only_count: 0
        mentioned_recipients: []
        sent_at: '2024-08-19T17:04:58.701Z'
        replied_to_message: null
        sender_recipient:
          id: 1
          first_name: John
          last_name: Admin
          image_url: null
          discarded_at: null
          blocked: false
          blocker: false
    Metadata:
      title: Metadata
      required:
        - links
      type: object
      properties:
        links:
          type: array
          items:
            type: string
          description: ''
      example:
        links: []
    search:
      title: search
      type: object
      properties:
        pagination:
          allOf:
            - $ref: '#/components/schemas/Pagination5'
            - {}
        items:
          type: array
          items:
            $ref: '#/components/schemas/Item17'
          description: ''
      example:
        pagination:
          current: 1
          previous: null
          next: 2
          per_page: 20
          pages: 3
          count: 60
    Pagination5:
      title: Pagination5
      required:
        - current
        - previous
        - next
        - per_page
        - pages
        - count
      type: object
      properties:
        current:
          type: integer
          format: int32
        previous:
          type: string
        next:
          type: integer
          format: int32
        per_page:
          type: integer
          format: int32
        pages:
          type: integer
          format: int32
        count:
          type: integer
          format: int32
      example:
        current: 1
        previous: null
        next: 2
        per_page: 20
        pages: 3
        count: 60
    Item17:
      title: Item17
      required:
        - id
        - first_name
        - last_name
        - avatar_url
        - image_url
        - receivable_id
        - receivable_type
        - discarded_at
        - left_conversation_at
        - blocked
        - status
        - last_online
        - country_name
      type: object
      properties:
        id:
          type: integer
          format: int32
        first_name:
          type: string
        last_name:
          type: string
        avatar_url:
          type: string
        image_url:
          type: string
        receivable_id:
          type: integer
          format: int32
        receivable_type:
          type: string
        discarded_at:
          type: string
        left_conversation_at:
          type: string
        blocked:
          type: string
        status:
          type: string
        last_online:
          type: string
        country_name:
          type: string
      example:
        id: 12
        first_name: Ada
        last_name: Stracke
        avatar_url: null
        image_url: null
        receivable_id: 12
        receivable_type: UserCompany
        discarded_at: null
        left_conversation_at: null
        blocked: null
        status: offline
        last_online: null
        country_name: null
    Index13:
      title: Index13
      type: object
      properties:
        pagination:
          allOf:
            - $ref: '#/components/schemas/Pagination'
            - {}
        items:
          type: array
          items:
            $ref: '#/components/schemas/Item17'
          description: ''
      example:
        pagination:
          current: 1
          previous: null
          next: null
          per_page: 20
          pages: 1
          count: 2
    Show10:
      title: Show10
      required:
        - email
        - first_name
        - last_name
        - phone
      type: object
      properties:
        email:
          type: string
        first_name:
          type: string
        last_name:
          type: string
        phone:
          type: string
      example:
        email: fluid_editor_the_4th@fluid.app
        first_name: Ada
        last_name: Stracke
        phone: '+821066871736'
    ContactUpdateRequest:
      title: updaterequest
      required:
        - contact
      type: object
      properties:
        contact:
          allOf:
            - $ref: '#/components/schemas/Contact7'
            - {}
      example:
        contact:
          first_name: contact_first_name
          last_name: contact_last_name
          language_code: en
          country_code: US
          status: cold
          email: contact_email@gmail.com
          email2: contact_email_2@gmail.com
          phone: '+00198338838838'
          phone2: '+0019485858758'
          address: N Main Street
          address2: Apt No. 010
          city: N Main
          state: GA
          postal_code: '3884'
          avatar_url: https://cdn.contact_image_url.com/image.jpg
          lead_type: null
          best_time: null
          time_zone: null
          reason: null
          income: null
          hours: null
          invest: null
          interest: null
          affiliate:
            id: null
            external_id: null
            username: null
            email: tingeym2@gmail.com
    Contact7:
      title: Contact7
      required:
        - first_name
        - last_name
        - language_code
        - country_code
        - status
        - email
        - email2
        - phone
        - phone2
        - address
        - address2
        - city
        - state
        - postal_code
        - avatar_url
        - lead_type
        - best_time
        - time_zone
        - reason
        - income
        - hours
        - invest
        - interest
        - affiliate
      type: object
      properties:
        first_name:
          type: string
        last_name:
          type: string
        language_code:
          type: string
        country_code:
          type: string
        status:
          type: string
        email:
          type: string
        email2:
          type: string
        phone:
          type: string
        phone2:
          type: string
        address:
          type: string
        address2:
          type: string
        city:
          type: string
        state:
          type: string
        postal_code:
          type: string
        avatar_url:
          type: string
        lead_type:
          type: string
        best_time:
          type: string
        time_zone:
          type: string
        reason:
          type: string
        income:
          type: string
        hours:
          type: string
        invest:
          type: string
        interest:
          type: string
        affiliate:
          allOf:
            - $ref: '#/components/schemas/Affiliate4'
            - {}
      example:
        first_name: contact_first_name
        last_name: contact_last_name
        language_code: en
        country_code: US
        status: cold
        email: contact_email@gmail.com
        email2: contact_email_2@gmail.com
        phone: '+00198338838838'
        phone2: '+0019485858758'
        address: N Main Street
        address2: Apt No. 010
        city: N Main
        state: GA
        postal_code: '3884'
        avatar_url: https://cdn.contact_image_url.com/image.jpg
        lead_type: null
        best_time: null
        time_zone: null
        reason: null
        income: null
        hours: null
        invest: null
        interest: null
        affiliate:
          id: null
          external_id: null
          username: null
          email: tingeym2@gmail.com
    responseUpdate:
      title: responseUpdate
      required:
        - id
        - token
        - first_name
        - last_name
        - avatar_url
        - status
        - email
        - email2
        - phone
        - phone2
        - phone_id
        - address
        - address2
        - city
        - state
        - postal_code
        - language_id
        - country_id
        - lead_type
        - ip
        - requested_at
        - best_time
        - time_zone
        - reason
        - income
        - hours
        - invest
        - interest
        - full_name
        - activities
      type: object
      properties:
        id:
          type: integer
          format: int32
        token:
          type: string
        first_name:
          type: string
        last_name:
          type: string
        avatar_url:
          type: string
        status:
          type: string
        email:
          type: string
        email2:
          type: string
        phone:
          type: string
        phone2:
          type: string
        phone_id:
          type: string
        address:
          type: string
        address2:
          type: string
        city:
          type: string
        state:
          type: string
        postal_code:
          type: string
        language_id:
          type: integer
          format: int32
        country_id:
          type: integer
          format: int32
        lead_type:
          type: string
        ip:
          type: string
        requested_at:
          type: string
        best_time:
          type: string
        time_zone:
          type: string
        reason:
          type: string
        income:
          type: string
        hours:
          type: string
        invest:
          type: string
        interest:
          type: string
        full_name:
          type: string
    ContactResponse:
      type: object
      properties:
        contact:
          $ref: '#/components/schemas/Contact'
        meta:
          $ref: '#/components/schemas/Meta'
      example:
        contact:
          id: 984
          address: N Main Street
          address2: null
          avatar_url: null
          best_time: null
          city: N Main
          country_id: null
          discarded_at: null
          email: contact_email@gmail.com
          email2: null
          first_name: first_name
          full_name: first_name last_name
          hours: null
          income: null
          interest: null
          invest: null
          ip: null
          language_id: null
          last_name: last_name
          lead_type: null
          phone: null
          phone2: null
          phone_id: null
          postal_code: '3884'
          reason: null
          requested_at: null
          state: GA
          status: cold
          time_zone: null
          token: f5F6p5bM7PQPqpvcoefXyrYV
        meta:
          request_id: 1c3002d0-269b-4ac5-99c3-849704ccc307
          timestamp: '2025-01-13T15:57:02Z'
    ErrorResponse:
      type: object
      properties:
        error_message:
          type: string
        errors:
          type: object
          properties:
            id:
              type: array
              items:
                type: string
        meta:
          $ref: '#/components/schemas/Meta'
    Webhook:
      type: object
      properties:
        id:
          type: integer
        resource:
          type: string
          example: order
        url:
          type: string
          example: https://api.example.com/webhook
        active:
          type: boolean
        auth_token:
          type: string
        event:
          type: string
          example: created
        http_method:
          type: string
          example: POST
    ApiResponse:
      type: object
      properties:
        status:
          type: number
          example: 201
        metadata:
          $ref: '#/components/schemas/ResponseMetadata'
      required:
        - status
        - metadata
    ApiErrorResponse:
      type: object
      properties:
        status:
          type: number
          example: 201
        errors:
          $ref: '#/components/schemas/ResponseErrors'
          nullable: true
        metadata:
          $ref: '#/components/schemas/ResponseMetadata'
      required:
        - status
        - errors
        - metadata
    Attribution:
      anyOf:
        - $ref: '#/components/schemas/AttributionEmail'
        - $ref: '#/components/schemas/AttributionUsername'
        - $ref: '#/components/schemas/AttributionSharedGuid'
        - $ref: '#/components/schemas/AttributionFluidRepId'
        - $ref: '#/components/schemas/AttributionExternalId'
    AttributionEmail:
      type: object
      properties:
        email:
          type: string
          format: email
          example: salesrep@example.com
      required:
        - email
    AttributionUsername:
      type: object
      properties:
        username:
          type: string
          example: salesrep
      required:
        - username
    AttributionSharedGuid:
      type: object
      properties:
        share_guid:
          type: string
          example: abc123
      required:
        - share_guid
    AttributionFluidRepId:
      type: object
      properties:
        fluid_rep_id:
          type: number
          example: 123456
      required:
        - fluid_rep_id
    AttributionExternalId:
      type: object
      properties:
        external_id:
          type: string
          example: U-1234567890
      required:
        - external_id
    Address:
      type: object
      properties:
        id:
          type: integer
          example: 1
        name:
          type:
            - string
            - 'null'
          example: John Doe
        first_name:
          type:
            - string
            - 'null'
          example: John
        last_name:
          type:
            - string
            - 'null'
          example: Doe
        address1:
          type: string
          example: 123 Main St
        address2:
          type:
            - string
            - 'null'
          example: Apt 4B
        address3:
          type:
            - string
            - 'null'
          example: Building 5
        city:
          type: string
          example: New York
        state:
          type: string
          example: NY
        postal_code:
          type: string
          example: '10001'
        country_code:
          type: string
          example: US
        subdivision_code:
          type:
            - string
            - 'null'
          example: NY
        default:
          type: boolean
          example: true
    EnrollmentPack:
      type:
        - object
        - 'null'
      properties:
        enrollment_pack_id:
          type: integer
          example: 1
        slug:
          type: string
          example: test-enrollment-pack
        additional_volume:
          type:
            - integer
            - 'null'
          example: 10
        description:
          type:
            - object
            - 'null'
          properties:
            id:
              type: integer
              example: 111
            name:
              type: string
              example: description
            body:
              type: string
              example: >-
                <div>Try the latest and greatest of our sugar zip packs.
                Guaranteed to make you skinner and cure cancer.</div>
            record_type:
              type: string
              example: EnrollmentPack
            record_id:
              type: integer
              example: 1
            created_at:
              type: string
              format: date_time
              example: '2025-01-16T04:22:43.809Z'
            updated_at:
              type: string
              format: date_time
              example: '2025-01-22T10:23:52.941Z'
            locale:
              type: string
              example: en
        enrollment_fee:
          type:
            - number
            - string
          example: 10
        enrollment_fee_in_currency:
          type: string
          example: $10.00
        images:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
                example: 2
              relateable_type:
                type: string
                example: EnrollmentPack
              relateable_id:
                type: integer
                example: 1
              image_url:
                type: string
                example: https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
              image_path:
                type: string
                example: jITWaU14QGe0y5AFgY7P_00179.svg
              position:
                type: integer
                example: 1
              shopify_id:
                type:
                  - integer
                  - 'null'
                example: null
              created_at:
                type: string
                format: date_time
                example: '2025-01-16T04:22:44.870Z'
              updated_at:
                type: string
                format: date_time
                example: '2025-01-16T04:22:44.870Z'
              external_id:
                type:
                  - integer
                  - 'null'
                example: null
        items:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
                example: 625
              allow_subscription:
                type: boolean
                example: true
              cv:
                type:
                  - number
                  - string
                example: 0
              cv_total:
                type: integer
                example: 15
              cv_in_currency:
                type: string
                example: $0.00
              enrollment:
                type: boolean
                example: true
              enrollment_pack_id:
                type: integer
                example: 1
              price:
                type: string
                example: '11.13'
              price_in_currency:
                type: string
                example: $11.13
              product_title:
                type: string
                example: Zip Pack Sample Pack (30)
              quantity:
                type: integer
                example: 1
              metadata:
                type: object
                example: {}
                description: A JSON object that can store any custom data structure
              qv:
                type:
                  - number
                  - string
                example: 0
              qv_in_currency:
                type: string
                example: $0.00
              qv_total:
                type: integer
                example: 21
              subscribe_and_save:
                type:
                  - string
                  - 'null'
                example: '-1988.87'
              subscribe_and_save_for_display:
                type:
                  - string
                  - 'null'
                example: Subscribe and save $-1,988.87
              subscribe_and_save_in_currency:
                type:
                  - string
                  - 'null'
                example: $-1,988.87
              subscription:
                type: boolean
                example: false
              subscription_interval:
                type:
                  - integer
                  - 'null'
                example: 1
              subscription_interval_unit:
                type:
                  - string
                  - 'null'
                example: month
              subscription_only:
                type: boolean
                example: false
              subscription_plan_id:
                type:
                  - integer
                  - 'null'
                example: 1
              subscription_plans:
                oneOf:
                  - type: array
                    items:
                      type:
                        - object
                        - 'null'
                      properties:
                        id:
                          type: integer
                          example: 1
                        name:
                          type: string
                          example: Subscription Plan 1
                        billing_frequency_in_words:
                          type: string
                          example: 1 month
                        billing_interval:
                          type: integer
                          example: 1
                        billing_interval_unit:
                          type: string
                          example: month
                        volume_interval:
                          type: integer
                          example: 1
                        volume_interval_unit:
                          type: string
                          example: month
                        company_default:
                          type: boolean
                          example: true
                        shipping_interval:
                          type: integer
                          example: 1
                        shipping_interval_unit:
                          type: string
                          example: month
                        trial_period:
                          type:
                            - integer
                            - 'null'
                          example: 1
                        trial_period_unit:
                          type:
                            - string
                            - 'null'
                          example: month
                        split_volume:
                          type: boolean
                          example: true
                        allow_max_billing_cycles:
                          type: boolean
                          example: false
                        max_billing_cycles:
                          type:
                            - integer
                            - 'null'
                          example: 3
                        products_count:
                          type:
                            - integer
                            - 'null'
                          example: 10
                        subscribers_count:
                          type:
                            - integer
                            - 'null'
                          example: 10
                        price:
                          type: string
                          example: '10.5'
                        price_in_currency:
                          type: string
                          example: $10.50
                        subscribe_and_save:
                          type:
                            - string
                            - 'null'
                          example: '2.99'
                        subscribe_and_save_in_currency:
                          type:
                            - string
                            - 'null'
                          example: $2.99
                        subscribe_and_save_for_display:
                          type:
                            - string
                            - 'null'
                          example: Subscribe and save $2.99
                        subscription_start:
                          type: string
                          example: '2025-02-12'
              subscription_price:
                type: string
                example: '2000.0'
              subscription_price_in_currency:
                type: string
                example: $2,000.00
              subscription_start:
                type:
                  - string
                  - 'null'
                format: date
                example: '2025-02-28'
              tax:
                type: string
                example: '0.0'
              tax_in_currency:
                type: string
                example: $0.00
              total_after_discounts:
                type: string
                example: '90.00'
              title:
                type:
                  - string
                  - 'null'
                example: Surcharge
              display_to_customer:
                type:
                  - boolean
                  - 'null'
                example: false
              errors:
                type:
                  - array
                  - 'null'
                example:
                  - country:
                      - >-
                        This product is not available for this country. Please
                        change your country
        price:
          type: string
          example: '11.13'
        price_in_currency:
          type: string
          example: $11.13
        subscription_price:
          type: string
          example: '2000.0'
        subscription_price_in_currency:
          type: string
          example: $2,000.00
        title:
          type: string
          example: enroll product
        token:
          type: string
          example: NxL22AqLRRisfyF9LqxxWRak
    CartMetadata:
      type: object
      properties:
        request_id:
          type: string
          example: 123e4567-e89b-12d3-a456-426614174000
        timestamp:
          type: string
          example: '2021-01-01T00:00:00Z'
    CartShopMetadata:
      type: object
      properties:
        request_id:
          type: string
          example: 123e4567-e89b-12d3-a456-426614174000
        shop_url:
          type: string
          example: https://myco.fluid.app
        timestamp:
          type: string
          example: '2021-01-01T00:00:00Z'
    CartCheckoutMetadata:
      type: object
      properties:
        request_id:
          type: string
          example: 123e4567-e89b-12d3-a456-426614174000
        timestamp:
          type: string
          example: '2021-01-01T00:00:00Z'
        checkout_url:
          type: string
          example: https://checkout.fluid.com/checkout?jwt=abc123
        shop_url:
          type: string
          example: https://myco.fluid.app
    CheckoutOrder:
      type: object
      properties:
        id:
          type: integer
        first_name:
          type:
            - string
            - 'null'
        last_name:
          type:
            - string
            - 'null'
        email:
          type: string
        phone:
          type:
            - string
            - 'null'
        order_number:
          type: string
        token:
          type: string
        status:
          type: string
        order_status:
          type: string
        financial_status:
          type: string
        fulfillment_status:
          type: string
        warehouse_id:
          type:
            - integer
            - 'null'
        order_type:
          type:
            - string
            - 'null'
        amount:
          type: string
        amount_in_base:
          type: string
        base_to_currency_rate:
          type:
            - string
            - 'null'
        refundable_amount:
          type:
            - number
            - string
            - 'null'
        note:
          type:
            - string
            - 'null'
        recurring:
          oneOf:
            - type: array
              items:
                properties:
                  subtotal:
                    type:
                      - number
                      - string
                    example: 10
                  subtotal_in_currency:
                    type: string
                    example: $10.0
                  interval:
                    type: integer
                    example: 1
                  interval_unit:
                    type: string
                    example: month
                  subtotal_for_display:
                    type: string
                    example: $10.00 every 1 month
                  start_date:
                    type:
                      - string
                      - 'null'
                    example: '2025-05-27'
          default:
            - subtotal: '10.0'
              subtotal_in_currency: $10.0
              interval: 1
              interval_unit: month
              subtotal_for_display: $10.00 every 1 month
              start_date: '2025-05-27'
        order_confirmation_url:
          type:
            - string
            - 'null'
          example: https://myco.fluid.app/pages/order-confirmation?token={order_token}
        currency_code:
          type: string
        created_at:
          type: string
        updated_at:
          type: string
        metadata:
          type:
            - object
            - 'null'
        external_id:
          type:
            - string
            - 'null'
        enrollment_pack:
          $ref: '#/components/schemas/EnrollmentPack'
        source:
          type: string
          example: web
          enum:
            - mobile
            - web
            - admin
            - backoffice
            - subscription
        split_payment:
          type:
            - object
            - 'null'
          description: Details about split payment if points were used
        points_applied:
          type: integer
          example: 500
          description: Number of points applied to the order
        points_applied_amount_in_currency:
          type: number
          example: 5
          description: Currency value of applied points
        order_total_after_points_redemption:
          type: number
          example: 95
          description: Order total after points redemption
        free_shipping:
          type: boolean
          example: false
          description: Whether the order has free shipping
        discount_codes:
          type: array
          items:
            type: string
          example:
            - DISCOUNT1
            - DISCOUNT2
          description: Discount codes applied to the order
    Fingerprint:
      type: object
      properties:
        user_agent:
          type: string
          example: >-
            Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36
            (KHTML, like Gecko) Chrome/88.0.4324.192 Safari/537.36
        language:
          type: string
          example: en-US
        platform:
          type: string
          example: MacIntel
        hardware_concurrency:
          type:
            - number
            - string
          example: 8
        color_depth:
          type:
            - number
            - string
          example: 24
        screen_resolution:
          type: string
          example: 1920x1080
        time_zone:
          type: string
          example: Europe/London
        session_storage:
          type: boolean
          example: true
        local_storage:
          type: boolean
          example: true
        indexed_db:
          type: boolean
          example: true
        do_not_track:
          type: boolean
          example: false
        cookies_enabled:
          type: boolean
          example: true
        canvas:
          type: string
          example: '0'
        webgl:
          type: object
          properties:
            vendor:
              type: string
              example: Google Inc.
            renderer:
              type: string
              example: ANGLE (Intel(R) UHD Graphics 630 Direct3D11 vs_5_0 ps_5_0)
            version:
              type: string
              example: WebGL 1.0
        installed_fonts:
          type: array
          items:
            type: string
            example: Helvetica
        plugins:
          type: string
          example: Chrome PDF Plugin
        touch_support:
          type: object
          properties:
            max_touch_points:
              type:
                - number
                - string
              example: 10
            touch_event:
              type: boolean
              example: true
            touch_points:
              type:
                - number
                - string
              example: 10
    ContactEmail:
      type: object
      properties:
        name:
          type: string
          example: John Doe
        email:
          type: string
          format: email
          example: john@example.com
        phone:
          type: string
          format: phone
          example: +1 (800) 555-1234
      required:
        - name
        - email
    ContactPhone:
      type: object
      properties:
        name:
          type: string
          example: John Doe
        email:
          type: string
          format: email
          example: john@example.com
        phone:
          type: string
          format: phone
          example: +1 (800) 555-1234
      required:
        - name
        - phone
    Lead:
      type: object
      properties:
        message:
          type: string
          example: How are you?
        contact:
          $ref: '#/components/schemas/Contact'
      required:
        - message
        - contact
    UrlPage:
      type: object
      properties:
        url:
          type: string
          format: uri
          example: https://www.example.com/page
        title:
          type: string
          example: Example Page
        description:
          type: string
          example: This is an example page
        image:
          type: string
          format: uri
          example: https://www.example.com/page.jpg
      required:
        - url
    UrlPageSettings:
      type: object
      properties:
        shop:
          $ref: '#/components/schemas/UrlPageShopSettings'
        cart:
          $ref: '#/components/schemas/UrlPageCartSettings'
          nullable: true
        scripts:
          type: array
          items:
            $ref: '#/components/schemas/UrlPageScriptSettings'
        affiliate:
          $ref: '#/components/schemas/Affiliate'
          nullable: true
        attribution:
          $ref: '#/components/schemas/Attribution'
          nullable: true
    UrlPageShopSettings:
      type: object
      properties:
        name:
          type: string
          example: My Shop
        primary_color:
          type:
            - string
            - 'null'
          example: '#000000'
        secondary_color:
          type:
            - string
            - 'null'
          example: '#FFFFFF'
        logo_url:
          type:
            - string
            - 'null'
          format: uri
          example: https://www.example.com/logo.png
        icon_url:
          type:
            - string
            - 'null'
          format: uri
          example: https://www.example.com/icon.png
        countries:
          type:
            - array
            - 'null'
          items:
            type:
              - string
            example: US
        languages:
          type:
            - array
            - 'null'
          items:
            type:
              - string
            example: en
    UrlPageCartSettings:
      type: object
      properties:
        token:
          type:
            - string
            - 'null'
          example: wDMAF8CKHyYpQn3RfUdtA3N28
    UrlPageScriptSettings:
      type: object
      properties:
        id:
          type: string
          example: example-script
        src:
          type: string
          example: https://www.example.com/script.js
        data:
          type: object
    UrlPageSettingsResponse:
      type: object
      properties:
        status:
          type: number
          example: 201
        settings:
          $ref: '#/components/schemas/UrlPageSettings'
        metadata:
          $ref: '#/components/schemas/ResponseMetadata'
    CartWidget:
      type: object
      description: A cart widget
      properties:
        placement:
          type: string
          enum:
            - right
            - left
          description: Which side of the screen the cart slides out from
        content:
          type: object
        styles:
          type: object
        trigger:
          type: object
      required:
        - placement
        - content
        - styles
        - trigger
    ChatWidget:
      type: object
      description: A chat widget
      properties:
        content:
          type: object
        styles:
          type: object
        trigger:
          type: object
        lead_capture:
          type: object
      required:
        - content
        - styles
        - trigger
        - lead_capture
    BannerWidget:
      type: object
      description: A banner widget
      properties:
        placement:
          type: string
          enum:
            - top
            - bottom
          description: Where the banner appears on the page
        behavior:
          type: string
          enum:
            - persistent
            - dismissible
            - sticky
          description: How the banner behaves on the page
        content:
          type: object
          properties:
            banner_text:
              type: string
              example: Welcome to our site!
            button_text:
              type: string
              example: Learn More
            button_url:
              type: string
              format: uri
              example: https://example.com/learn
        styles:
          type: object
          properties:
            background_color:
              type: string
              example: '#ffffff'
            text_color:
              type: string
              example: '#000000'
            border_radius:
              type: string
              example: 8px
      required:
        - placement
        - behavior
        - content
        - styles
    RequestMetadata:
      type: object
      properties:
        fluid_shop:
          type: string
          example: myshop
        fluid_session:
          type: string
          format: /\Afs_[0-9A-Za-z&&[^0OIl]]{22}\z/
          example: fs_szwdDuRbqEe7AV7sXk7vVq
        fluid_locale:
          type: string
          format: /\A[a-z]{2}_[A-Z]{2}\z/
          example: en_US
        fluid_journey:
          type: string
        attribution:
          $ref: '#/components/schemas/Attribution'
      required:
        - fluid_shop
        - fluid_session
    RequestMetadataOptional:
      type: object
      properties:
        fluid_shop:
          type: string
          example: myshop
        fluid_session:
          type: string
          format: /\Afs_[0-9A-Za-z&&[^0OIl]]{22}\z/
          example: fs_szwdDuRbqEe7AV7sXk7vVq
        fluid_locale:
          type: string
          example: en_US
        attribution:
          $ref: '#/components/schemas/Attribution'
    ResponseErrors:
      type:
        - array
        - 'null'
      items:
        type: object
        properties:
          message:
            type: string
            example: Invalid input data
        required:
          - message
    ResponseMetadata:
      type: object
      properties:
        fluid_shop:
          type: string
        fluid_session:
          type: string
        fluid_locale:
          type:
            - string
            - 'null'
          format: /\A[a-z]{2}_[A-Z]{2}\z/
          example: en_US
        request_uuid:
          type: string
          format: uuid
        timestamp:
          type: string
      required:
        - fluid_shop
        - fluid_session
        - request_uuid
        - timestamp
    PopupWidget:
      type: object
      description: A popup widget
      properties:
        placement:
          type: string
          enum:
            - modal
          description: Where the popup should be displayed
        content:
          type: object
        styles:
          type: object
        behavior:
          type: string
          enum:
            - timer
          description: When the popup should be displayed
        lead_capture:
          type: object
          description: Lead capture configuration for the popup
      required:
        - behavior
        - placement
        - content
        - styles
        - lead_capture
    Media:
      title: Medium
      type: object
      properties:
        id:
          type: integer
        slug:
          type:
            - string
            - 'null'
        custom_slug:
          type: boolean
          default: false
        title:
          type: string
        kind:
          type:
            - string
            - 'null'
        media_type:
          type: string
        media_format:
          type: string
        image_url:
          type:
            - string
            - 'null'
        video_url:
          type:
            - string
            - 'null'
        pdf_url:
          type:
            - string
            - 'null'
        powerpoint_url:
          type:
            - string
            - 'null'
        duration:
          type:
            - integer
            - 'null'
          default: 0
        active:
          type:
            - boolean
            - 'null'
          default: true
        description:
          type: string
        subtitles:
          type:
            - object
            - 'null'
          default: '{}'
        comments_count:
          type: integer
        settings:
          type:
            - object
            - 'null'
        products:
          type: array
          items:
            title: Product
            type: object
            properties:
              id:
                type: integer
              title:
                type: string
              image_url:
                type:
                  - string
                  - 'null'
              image_path:
                type:
                  - string
                  - 'null'
              cv:
                type:
                  - integer
                  - 'null'
                default: 0
              tax:
                type:
                  - number
                  - string
                  - 'null'
                default: '0.0'
              sku:
                type:
                  - string
                  - 'null'
              metadata:
                type: object
                default: '{}'
              external_id:
                type:
                  - string
                  - 'null'
              price:
                type:
                  - number
                  - string
                  - 'null'
                default: '0.0'
                minimum: 0
                maximum: 99999999
              introduction:
                type:
                  - string
                  - 'null'
              price_in_currency:
                type: string
              tax_in_currency:
                type: string
              cv_in_currency:
                type: string
              metafields:
                type: array
                items:
                  title: LegacyMetafield
                  type: object
                  properties:
                    id:
                      type: integer
                    namespace:
                      description: >-
                        A container for related metafields. Commonly used to
                        group metafields by app or functionality.
                      example: custom
                      type: string
                      maxLength: 20
                      pattern: ^[a-zA-Z0-9_]+$
                    key:
                      description: >-
                        The unique identifier for the metafield within its
                        namespace. Must be unique per namespace and owner.
                      example: material
                      type: string
                      maxLength: 30
                      pattern: ^[a-zA-Z0-9_]+$
                    value:
                      description: >-
                        The actual data stored in the metafield. Type depends on
                        value_type.
                      example: cotton
                      type:
                        - string
                        - object
                    value_type:
                      description: >-
                        The data type that defines how the value should be
                        interpreted and validated.
                      example: single_line_text_field
                      type: string
                    description:
                      description: >-
                        Optional human-readable description explaining the
                        purpose of this metafield.
                      example: The primary material used in this product
                      type:
                        - string
                        - 'null'
                    owner_type:
                      description: >-
                        The type of resource that this metafield belongs to
                        (polymorphic association).
                      example: Product
                      type: string
                    owner_id:
                      description: >-
                        The ID of the specific resource that this metafield
                        belongs to.
                      example: 12345
                      type: integer
                    created_at:
                      description: Timestamp when the metafield was created.
                      example: '2021-01-01T00:00:00Z'
                      type: string
                      format: date-time
                    updated_at:
                      description: Timestamp when the metafield was last updated.
                      example: '2021-01-01T00:00:00Z'
                      type: string
                      format: date-time
                    metafield_definition:
                      title: MetafieldDefinition
                      type:
                        - object
                        - 'null'
                      properties:
                        id:
                          type: integer
                        company_id:
                          description: >-
                            The ID of the company that owns this metafield
                            definition.
                          example: 1
                          type: integer
                        namespace:
                          description: >-
                            A container for related metafield definitions. Used
                            to group definitions by app or functionality. Must
                            be unique within company and owner_resource.
                          example: product_details
                          type: string
                          maxLength: 20
                          pattern: ^[a-zA-Z0-9_]+$
                        key:
                          description: >-
                            The unique identifier for the metafield definition
                            within its namespace and owner_resource. Combined
                            with namespace and owner_resource, this must be
                            unique per company.
                          example: material_type
                          type: string
                          maxLength: 30
                          pattern: ^[a-zA-Z0-9_]+$
                        name:
                          description: >-
                            Human-readable display name for the metafield
                            definition, shown in admin interfaces and forms.
                          example: Material Type
                          type: string
                          maxLength: 100
                        description:
                          description: >-
                            Detailed explanation of what this metafield
                            definition represents, how it should be used, and
                            any special instructions for content creators.
                          example: >-
                            Specify the primary material composition of the
                            product (e.g., cotton, polyester, silk). This will
                            be displayed on the product detail page.
                          type:
                            - string
                            - 'null'
                        value_type:
                          description: >-
                            The data type that defines how metafield values
                            should be validated, stored, and displayed.
                            Determines which validation rules are available.
                          example: single_line_text_field
                          type: string
                        validation_rules:
                          description: >-
                            JSON object containing validation constraints that
                            will be applied to metafield values. Available rules
                            depend on the value_type.
                          example:
                            choices:
                              - cotton
                              - polyester
                              - silk
                              - wool
                              - linen
                              - bamboo
                            max: 50
                            min: 2
                          type:
                            - object
                            - 'null'
                        owner_resource:
                          description: >-
                            The type of resource (model class name) that
                            metafields using this definition can be attached to.
                            Must match the polymorphic owner_type.
                          example: Product
                          type: string
                        pinned:
                          description: >-
                            Whether this definition should be prominently
                            displayed or prioritized in admin interfaces and
                            forms.
                          example: false
                          type:
                            - boolean
                            - 'null'
                          default: false
                        position:
                          default: 0
                          description: >-
                            Sort order for displaying this definition relative
                            to others in the same category and owner_resource.
                            Lower numbers appear first.
                          example: 1
                          type:
                            - integer
                            - 'null'
                        locked:
                          description: >-
                            Whether this metafield definition is locked,
                            preventing direct updates or deletions of metafields
                            using this definition.
                          example: false
                          type:
                            - boolean
                            - 'null'
                          default: false
                        created_at:
                          description: Timestamp when the metafield definition was created.
                          example: '2024-01-15T10:30:00Z'
                          type: string
                          format: date-time
                        updated_at:
                          description: >-
                            Timestamp when the metafield definition was last
                            updated.
                          example: '2024-02-20T14:45:00Z'
                          type: string
                          format: date-time
                        list_type:
                          description: >-
                            Whether this definition is for list-type metafields
                            that store arrays of values.
                          example: false
                          type: boolean
                        reference_type:
                          description: >-
                            Whether this definition is for reference-type
                            metafields that store references to other resources.
                          example: false
                          type: boolean
                        supported_validations:
                          description: >-
                            Array of validation rule names that are supported
                            for this value_type.
                          example:
                            - min
                            - max
                            - choices
                            - regex
                          type: array
                        validation_description:
                          description: >-
                            Human-readable description of what the value_type
                            represents and its constraints.
                          example: Single line text up to 5000 characters
                          type: string
                        category_ids:
                          description: >-
                            Array of category IDs that this metafield definition
                            is associated with for organizational purposes.
                          example:
                            - 1
                            - 2
                            - 3
                          items:
                            type: integer
                          type: array
                      required:
                        - id
                        - company_id
                        - namespace
                        - key
                        - name
                        - value_type
                        - owner_resource
                        - created_at
                        - updated_at
                        - list_type
                        - reference_type
                        - supported_validations
                        - validation_description
                        - category_ids
                  required:
                    - id
                    - namespace
                    - key
                    - value
                    - value_type
                    - owner_type
                    - owner_id
                    - created_at
                    - updated_at
              variants:
                items:
                  title: Variant
                  properties:
                    id:
                      type: integer
                    title:
                      example: Variant 1
                      type:
                        - string
                        - 'null'
                    image_url:
                      example: https://via.placeholder.com/150
                      type:
                        - string
                        - 'null'
                    image_path:
                      example: https://via.placeholder.com/150
                      type:
                        - string
                        - 'null'
                    sku:
                      example: SKU-123456
                      type:
                        - string
                        - 'null'
                    primary_image:
                      example: https://via.placeholder.com/150
                      type:
                        - string
                        - 'null'
                    price:
                      example: 100
                      type:
                        - number
                        - string
                        - 'null'
                    price_in_currency:
                      example: USD 100.00
                      type: string
                    options:
                      items:
                        type: object
                        properties:
                          title:
                            type: string
                            example: Size
                          value:
                            type: string
                            example: XL
                      type: array
                  required:
                    - id
                    - price_in_currency
                    - options
                type: array
            required:
              - id
              - title
              - metadata
              - price_in_currency
              - tax_in_currency
              - cv_in_currency
              - metafields
              - variants
        enrollment_packs:
          type: array
          items:
            title: EnrollmentPack
            type: object
            properties:
              id:
                type: integer
              title:
                type: string
              status:
                type: string
              image_url:
                type: string
            required:
              - id
              - title
              - status
              - image_url
      required:
        - id
        - custom_slug
        - title
        - media_type
        - media_format
        - description
        - comments_count
        - products
        - enrollment_packs
    VideoAnalyticsCreate:
      type: object
      properties:
        video_analytics:
          type: object
          properties:
            event_type:
              type: string
              enum:
                - video.started
                - video.paused
                - video.resumed
                - video.completed
                - video.dismissed
            media_id:
              type: integer
            occurred_at:
              type: number
            position_in_seconds:
              type: number
            screenshot:
              type: string
          required:
            - event_type
            - media_id
            - occurred_at
        metadata:
          type: object
      required:
        - video_analytics
    ShareStats:
      type: object
      description: Share statistics for a resource
      properties:
        total_shares:
          type: integer
          description: Total lifetime share count
          example: 150
        shares_last_30_days:
          type: integer
          description: Shares created in the last 30 days
          example: 42
        percent_change:
          type:
            - number
            - 'null'
          description: Percentage change vs prior 30 days (null if no prior shares)
          example: 23.5
        unique_sharers:
          type: integer
          description: Count of unique users who created shares
          example: 28
        total_visits:
          type: integer
          description: Total visits across all shares
          example: 1250
      required:
        - total_shares
        - shares_last_30_days
        - unique_sharers
        - total_visits
  headers:
    ContentType:
      description: The content type of the response
      schema:
        type: string
      example: application/json
    ContentLength:
      description: The length of the response content in bytes
      schema:
        type: string
      example: '981'
    X-Request-Id:
      description: A unique identifier for the request
      schema:
        type: string
      example: b1b7bf86-146e-4c66-b4c6-ac6f0f9ddafa
paths:
  /api/company/activities:
    post:
      tags:
        - Activities
      summary: create
      operationId: Postcreate6
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/createrequest7'
                - example:
                    activity:
                      title: hello activity
                      description: hello activity description here.
                      affiliate:
                        id: null
                        external_id: sammysample12
                        username: null
                        email: null
                        legacy_number: '150010'
            example:
              activity:
                title: hello activity
                description: hello activity description here.
                affiliate:
                  id: null
                  external_id: sammysample12
                  username: null
                  email: null
                  legacy_number: '150010'
        required: true
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/create7'
                  - example:
                      id: 17
                      user_id: 1
                      title: hello world
                      description: happy new year.
                      read_at: null
                      created_at: '2024-01-04T08:06:12.267Z'
                      relation_type: null
                      company_id: 980190962
                      relation: null
                      contact: null
                      visitor: null
              example:
                id: 17
                user_id: 1
                title: hello world
                description: happy new year.
                read_at: null
                created_at: '2024-01-04T08:06:12.267Z'
                relation_type: null
                company_id: 980190962
                relation: null
                contact: null
                visitor: null
      deprecated: false
      security:
        - bearer: []
  /api/company_admins:
    post:
      summary: Add current user as admin to a company
      tags:
        - Admins
      security:
        - bearer_auth: []
      operationId: addUserAsAdmin
      description: >-
        Add current user as admin to specified company. Accessible only by root
        admins.
      parameters:
        - name: Authorization
          in: header
          required: true
          description: Bearer token for authentication
          schema:
            type: string
      responses:
        '201':
          description: Successfully added as admin
          content:
            application/json:
              schema:
                type: object
                properties:
                  user_company:
                    type: object
                    properties:
                      id:
                        type: integer
                      active:
                        type: boolean
                      company_id:
                        type: integer
                      company_name:
                        type: string
                      roles:
                        type: array
                        items:
                          type: string
                      user_type:
                        type: string
                    required:
                      - id
                      - active
                      - company_id
                      - company_name
                      - roles
                      - user_type
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - user_company
                  - meta
        '401':
          description: Unauthorized - Invalid credentials
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '403':
          description: Forbidden - User is not authorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not authorized.
                required:
                  - error
        '404':
          description: Company not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Company not found
                  errors:
                    type: object
                    properties:
                      company:
                        type: array
                        items:
                          type: string
                        example:
                          - Company not found.
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - error_message
                  - errors
                  - meta
        '422':
          description: Unprocessable Entity - Record invalid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Validation failed
                  errors:
                    type: object
                    properties:
                      company_id:
                        type: array
                        items:
                          type: string
                        example:
                          - is required
                      admin:
                        type: array
                        items:
                          type: string
                        example:
                          - Record invalid
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                company_id:
                  type: integer
                  description: Company ID to add admin access to
              required:
                - company_id
    delete:
      summary: Remove current user's admin access from a company
      tags:
        - Admins
      security:
        - bearer_auth: []
      operationId: removeUserAsAdmin
      description: >-
        Remove current user's admin access from specified company. Accessible
        only by root admins.
      parameters:
        - name: Authorization
          in: header
          required: true
          description: Bearer token for authentication
          schema:
            type: string
      responses:
        '200':
          description: Successfully removed admin access
          content:
            application/json:
              schema:
                type: object
                properties:
                  company_id:
                    type: integer
                  user_company_id:
                    type: integer
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - company_id
                  - user_company_id
                  - meta
        '401':
          description: Unauthorized - Invalid credentials
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '403':
          description: Forbidden - User is not authorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not authorized.
                required:
                  - error
        '404':
          description: Admin access not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Admin not found
                  errors:
                    type: object
                    properties:
                      company:
                        type: array
                        items:
                          type: string
                        example:
                          - Admin not found.
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - error_message
                  - errors
                  - meta
        '422':
          description: Unprocessable Entity - Validation errors
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Validation failed
                  errors:
                    type: object
                    properties:
                      company_id:
                        type: array
                        items:
                          type: string
                        example:
                          - is required
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                company_id:
                  type: integer
                  description: Company ID to remove admin access from
              required:
                - company_id
  /api/v2/admins:
    get:
      summary: List all admins
      tags:
        - Admins
      security:
        - bearer_auth: []
      parameters:
        - name: pagination
          in: query
          schema:
            type: object
            properties:
              page:
                type: integer
                exclusiveMinimum: 0
              per_page:
                type: integer
                exclusiveMinimum: 0
                maximum: 100
              search_query:
                type: string
              sorted_by:
                type: string
              active:
                type: boolean
            required: []
      responses:
        '200':
          description: admins found
          content:
            application/json:
              schema:
                type: object
                properties:
                  admins:
                    type: array
                    items:
                      title: UserCompany
                      type: object
                      properties:
                        id:
                          type: integer
                        active:
                          type:
                            - boolean
                            - 'null'
                          default: true
                        external_id:
                          type:
                            - string
                            - 'null'
                        username:
                          type:
                            - string
                            - 'null'
                        first_name:
                          type: string
                        last_name:
                          type: string
                        created_at:
                          type: string
                          format: date-time
                        image_url:
                          type:
                            - string
                            - 'null'
                        share_guid:
                          type: string
                          pattern: ^[a-z0-9\-_]+$
                          minLength: 2
                        country:
                          type:
                            - object
                            - 'null'
                        language:
                          type:
                            - object
                            - 'null'
                        roles:
                          type:
                            - array
                            - 'null'
                        computed_full_name:
                          type:
                            - string
                            - 'null'
                        computed_email:
                          type:
                            - string
                            - 'null'
                        phone:
                          type:
                            - string
                            - 'null'
                      required:
                        - id
                        - first_name
                        - last_name
                        - created_at
                        - share_guid
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      pagination:
                        type: object
                        properties:
                          current_page:
                            type: integer
                            example: 1
                          total_pages:
                            type: integer
                            example: 10
                          total_count:
                            type: integer
                            example: 100
                          per_page:
                            type: integer
                            example: 10
                required:
                  - admins
                  - meta
    post:
      summary: Create an admin
      tags:
        - Admins
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: admin created
          content:
            application/json:
              schema:
                type: object
                properties:
                  admin:
                    title: UserCompany
                    type: object
                    properties:
                      id:
                        type: integer
                      active:
                        type:
                          - boolean
                          - 'null'
                        default: true
                      external_id:
                        type:
                          - string
                          - 'null'
                      username:
                        type:
                          - string
                          - 'null'
                      first_name:
                        type: string
                      last_name:
                        type: string
                      created_at:
                        type: string
                        format: date-time
                      image_url:
                        type:
                          - string
                          - 'null'
                      share_guid:
                        type: string
                        pattern: ^[a-z0-9\-_]+$
                        minLength: 2
                      country:
                        type:
                          - object
                          - 'null'
                      language:
                        type:
                          - object
                          - 'null'
                      roles:
                        type:
                          - array
                          - 'null'
                      computed_full_name:
                        type:
                          - string
                          - 'null'
                      computed_email:
                        type:
                          - string
                          - 'null'
                      phone:
                        type:
                          - string
                          - 'null'
                    required:
                      - id
                      - first_name
                      - last_name
                      - created_at
                      - share_guid
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - admin
                  - meta
        '422':
          description: invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                admin:
                  type: object
                  properties:
                    first_name:
                      type: string
                    last_name:
                      type: string
                    email:
                      type: string
                    phone:
                      type: string
                    active:
                      type: boolean
                    external_id:
                      type: string
                    username:
                      type: string
                    roles:
                      type: array
                    admin_roles:
                      type: array
                      items:
                        type: integer
                    language_code:
                      type: string
                  required:
                    - email
              required:
                - admin
  /api/v2/admins/{id}:
    get:
      summary: Retrieve an admin
      tags:
        - Admins
      security:
        - bearer_auth: []
      responses:
        '200':
          description: admin found
          content:
            application/json:
              schema:
                type: object
                properties:
                  admin:
                    title: UserCompany
                    type: object
                    properties:
                      id:
                        type: integer
                      active:
                        type:
                          - boolean
                          - 'null'
                        default: true
                      external_id:
                        type:
                          - string
                          - 'null'
                      username:
                        type:
                          - string
                          - 'null'
                      first_name:
                        type: string
                      last_name:
                        type: string
                      created_at:
                        type: string
                        format: date-time
                      image_url:
                        type:
                          - string
                          - 'null'
                      share_guid:
                        type: string
                        pattern: ^[a-z0-9\-_]+$
                        minLength: 2
                      country:
                        type:
                          - object
                          - 'null'
                      language:
                        type:
                          - object
                          - 'null'
                      roles:
                        type:
                          - array
                          - 'null'
                      computed_full_name:
                        type:
                          - string
                          - 'null'
                      computed_email:
                        type:
                          - string
                          - 'null'
                      phone:
                        type:
                          - string
                          - 'null'
                    required:
                      - id
                      - first_name
                      - last_name
                      - created_at
                      - share_guid
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - admin
                  - meta
        '404':
          description: admin not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
    patch:
      summary: Update an admin
      tags:
        - Admins
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: admin updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  admin:
                    title: UserCompany
                    type: object
                    properties:
                      id:
                        type: integer
                      active:
                        type:
                          - boolean
                          - 'null'
                        default: true
                      external_id:
                        type:
                          - string
                          - 'null'
                      username:
                        type:
                          - string
                          - 'null'
                      first_name:
                        type: string
                      last_name:
                        type: string
                      created_at:
                        type: string
                        format: date-time
                      image_url:
                        type:
                          - string
                          - 'null'
                      share_guid:
                        type: string
                        pattern: ^[a-z0-9\-_]+$
                        minLength: 2
                      country:
                        type:
                          - object
                          - 'null'
                      language:
                        type:
                          - object
                          - 'null'
                      roles:
                        type:
                          - array
                          - 'null'
                      computed_full_name:
                        type:
                          - string
                          - 'null'
                      computed_email:
                        type:
                          - string
                          - 'null'
                      phone:
                        type:
                          - string
                          - 'null'
                    required:
                      - id
                      - first_name
                      - last_name
                      - created_at
                      - share_guid
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - admin
                  - meta
        '404':
          description: admin not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: integer
                admin:
                  type: object
                  properties:
                    first_name:
                      type: string
                    last_name:
                      type: string
                    email:
                      type: string
                    phone:
                      type: string
                    active:
                      type: boolean
                    external_id:
                      type: string
                    username:
                      type: string
                    roles:
                      type: array
                    admin_roles:
                      type: array
                      items:
                        type: integer
                    language_code:
                      type: string
                    country_code:
                      type: string
                  required: []
              required:
                - id
                - admin
    delete:
      summary: Delete an admin
      tags:
        - Admins
      security:
        - bearer_auth: []
      responses:
        '200':
          description: admin deleted
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - id
                  - meta
        '404':
          description: admin not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
  /api/agreements/{id}:
    get:
      summary: Retrieves an agreement
      tags:
        - Agreements
      operationId: getAgreement
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
        - name: language_iso
          in: query
          required: false
          schema:
            type: string
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  agreement:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 101
                      title:
                        type: string
                        example: Terms and conditions
                      active:
                        type: boolean
                        example: true
                      required_on_checkout:
                        type: boolean
                        example: false
                      company_country_ids:
                        type: array
                        example:
                          - '1'
                          - '2'
                      description:
                        type: string
                        example: This is the description/body of the agreement
                      show_path:
                        type: string
                        example: /agreements/101
                      language_iso:
                        type: string
                        example: en
                      required:
                        type: boolean
                        example: true
                      enrollment_pack_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      created_at:
                        type: string
                        format: date_time
                        example: '2025-06-02T12:34:56Z'
                      updated_at:
                        type: string
                        format: date_time
                        example: '2025-06-02T12:34:56Z'
                      company_logo:
                        type: string
                        example: https://example.com/logo.png
                      attachments:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            url:
                              type: string
                            filename:
                              type: string
                            content_type:
                              type: string
                            content_size:
                              type: integer
                            kind:
                              type: string
                            metadata:
                              type:
                                - object
                                - 'null'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Agreement not found.
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                        example:
                          - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
    put:
      summary: Updates an agreement
      tags:
        - Agreements
      operationId: updateAgreement
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
        - name: language_iso
          in: query
          required: false
          schema:
            type: string
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  agreement:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 101
                      title:
                        type: string
                        example: Terms and conditions
                      active:
                        type: boolean
                        example: true
                      required_on_checkout:
                        type: boolean
                        example: false
                      company_country_ids:
                        type: array
                        example:
                          - '1'
                          - '2'
                      description:
                        type: string
                        example: This is the description/body of the agreement
                      show_path:
                        type: string
                        example: /agreements/101
                      language_iso:
                        type: string
                        example: en
                      required:
                        type: boolean
                        example: true
                      enrollment_pack_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      created_at:
                        type: string
                        format: date_time
                        example: '2025-06-02T12:34:56Z'
                      updated_at:
                        type: string
                        format: date_time
                        example: '2025-06-02T12:34:56Z'
                      company_logo:
                        type: string
                        example: https://example.com/logo.png
                      attachments:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            url:
                              type: string
                            filename:
                              type: string
                            content_type:
                              type: string
                            content_size:
                              type: integer
                            kind:
                              type: string
                            metadata:
                              type:
                                - object
                                - 'null'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: fail
                  data:
                    type: object
                    properties:
                      error:
                        type: string
                        example: Couldn't find Agreement
                    required:
                      - error
                required:
                  - status
                  - data
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameters
                  errors:
                    type: object
                    properties:
                      enrollment_pack_agreements:
                        type: string
                        example: Enrollment Pack not found.
                      agreement:
                        type: object
                        properties:
                          title:
                            type: array
                            items:
                              type: string
                            example:
                              - must be filled
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                    required:
                      - request_id
                      - timestamp
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                agreement:
                  type: object
                  properties:
                    title:
                      type: string
                      example: New Agreement
                    description:
                      type: string
                      example: This is a new agreement.
                    enrollment_pack_id:
                      type: integer
                      example: 1
                      description: >-
                        ID of the enrollment pack to associate with this
                        agreement
                    attachments_attributes:
                      type: array
                      items:
                        type: object
                        properties:
                          url:
                            type: string
                            example: http://example.com/file.png
                          filename:
                            type: string
                            example: file.png
                          kind:
                            type: string
                            example: image
                          content_type:
                            type: string
                            example: image/png
                          content_size:
                            type: integer
                            example: 1024
                          metadata:
                            type: object
                        required:
                          - url
                          - filename
                  required:
                    - title
                    - description
              required:
                - agreement
    delete:
      summary: Deletes an agreement
      tags:
        - Agreements
      operationId: deleteAgreement
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                    example: 101
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Agreement not found.
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                        example:
                          - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Failed to delete.
                  errors:
                    type: object
                    properties:
                      agreement:
                        type: object
                        properties:
                          base:
                            type: array
                            items:
                              type: string
                            example:
                              - Cannot delete agreement
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
  /api/agreements:
    get:
      summary: Lists agreements
      tags:
        - Agreements
      operationId: listAgreements
      security:
        - bearer_auth: []
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
        - name: per_page
          in: query
          required: false
          schema:
            type: integer
        - name: language_iso
          in: query
          required: false
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
        - name: sorted_by
          in: query
          required: false
          example: title_asc
          description: >
            Sort the records by one of the supported attributes:
              - title
              - active
              - required_on_checkout
              - created_at
              - updated_at
            The sort attribute should be followed by one of the order
            directives: '_asc', '_desc'
          schema:
            type: string
        - name: search_query
          in: query
          required: false
          description: Filter agreements with their title
          schema:
            type: string
        - name: status
          in: query
          schema:
            type: string
            enum:
              - active
              - inactive
          required: false
          description: Filter by status
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  agreements:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 101
                        title:
                          type: string
                          example: Terms and conditions
                        active:
                          type: boolean
                          example: true
                        required_on_checkout:
                          type: boolean
                          example: false
                        company_country_ids:
                          type: array
                          example:
                            - '1'
                            - '2'
                        description:
                          type: string
                          example: This is the description/body of the agreement
                        show_path:
                          type: string
                          example: /agreements/101
                        language_iso:
                          type: string
                          example: en
                        required:
                          type: boolean
                          example: true
                        enrollment_pack_id:
                          type:
                            - integer
                            - 'null'
                          example: 1
                        created_at:
                          type: string
                          format: date_time
                          example: '2025-06-02T12:34:56Z'
                        updated_at:
                          type: string
                          format: date_time
                          example: '2025-06-02T12:34:56Z'
                        company_logo:
                          type: string
                          example: https://example.com/logo.png
                        attachments:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                              url:
                                type: string
                              filename:
                                type: string
                              content_type:
                                type: string
                              content_size:
                                type: integer
                              kind:
                                type: string
                              metadata:
                                type:
                                  - object
                                  - 'null'
                  meta:
                    oneOf:
                      - type: object
                        properties:
                          request_id:
                            type: string
                          timestamp:
                            type: string
                          pagination:
                            type: object
                            properties:
                              current_page:
                                type: integer
                              total_pages:
                                type: integer
                              total_count:
                                type: integer
                              per_page:
                                type: integer
                        required:
                          - request_id
                          - timestamp
                          - pagination
                      - type: object
                        properties:
                          request_id:
                            type: string
                            example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                          timestamp:
                            type: string
                            example: '2024-12-10T08:04:10Z'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '422':
          description: invalid status filter param
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameters
                  errors:
                    type: object
                    properties:
                      status:
                        type: array
                        items:
                          type: string
                        example:
                          - 'must be one of: active, inactive'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
                  - meta
    post:
      summary: Creates an agreement
      tags:
        - Agreements
      operationId: createAgreement
      description: >-
        Only allows creating agreements in english. Use update api to add
        contents in other languages
      security:
        - bearer_auth: []
      parameters:
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
        - name: language_iso
          in: query
          required: false
          schema:
            type: string
      responses:
        '201':
          description: >-
            creating agreements in a different language defaults to english
            automatically
          content:
            application/json:
              schema:
                type: object
                properties:
                  agreement:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 101
                      title:
                        type: string
                        example: Terms and conditions
                      active:
                        type: boolean
                        example: true
                      required_on_checkout:
                        type: boolean
                        example: false
                      company_country_ids:
                        type: array
                        example:
                          - '1'
                          - '2'
                      description:
                        type: string
                        example: This is the description/body of the agreement
                      show_path:
                        type: string
                        example: /agreements/101
                      language_iso:
                        type: string
                        example: en
                      required:
                        type: boolean
                        example: true
                      enrollment_pack_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      created_at:
                        type: string
                        format: date_time
                        example: '2025-06-02T12:34:56Z'
                      updated_at:
                        type: string
                        format: date_time
                        example: '2025-06-02T12:34:56Z'
                      company_logo:
                        type: string
                        example: https://example.com/logo.png
                      attachments:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            url:
                              type: string
                            filename:
                              type: string
                            content_type:
                              type: string
                            content_size:
                              type: integer
                            kind:
                              type: string
                            metadata:
                              type:
                                - object
                                - 'null'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '422':
          description: when enrollment pack does not exist
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameters.
                  errors:
                    type: object
                    properties:
                      enrollment_pack_agreements:
                        type: string
                        example: Enrollment Pack not found.
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                agreement:
                  type: object
                  properties:
                    title:
                      type: string
                      example: New Agreement
                    description:
                      type: string
                      example: This is a new agreement.
                    enrollment_pack_id:
                      type: integer
                      example: 1
                      description: >-
                        ID of the enrollment pack to associate with this
                        agreement
                    attachments_attributes:
                      type: array
                      items:
                        type: object
                        properties:
                          url:
                            type: string
                            example: http://example.com/file.png
                          filename:
                            type: string
                            example: file.png
                          kind:
                            type: string
                            example: image
                          content_type:
                            type: string
                            example: image/png
                          content_size:
                            type: integer
                            example: 1024
                          metadata:
                            type: object
                        required:
                          - url
                          - filename
                  required:
                    - title
                    - description
              required:
                - agreement
  /api/agreements/{id}/clone:
    post:
      summary: Clones an agreement
      tags:
        - Agreements
      operationId: cloneAgreement
      security:
        - bearer_auth: []
      parameters:
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  agreement:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 101
                      title:
                        type: string
                        example: Terms and conditions
                      active:
                        type: boolean
                        example: true
                      required_on_checkout:
                        type: boolean
                        example: false
                      company_country_ids:
                        type: array
                        example:
                          - '1'
                          - '2'
                      description:
                        type: string
                        example: This is the description/body of the agreement
                      show_path:
                        type: string
                        example: /agreements/101
                      language_iso:
                        type: string
                        example: en
                      required:
                        type: boolean
                        example: true
                      enrollment_pack_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      created_at:
                        type: string
                        format: date_time
                        example: '2025-06-02T12:34:56Z'
                      updated_at:
                        type: string
                        format: date_time
                        example: '2025-06-02T12:34:56Z'
                      company_logo:
                        type: string
                        example: https://example.com/logo.png
                      attachments:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            url:
                              type: string
                            filename:
                              type: string
                            content_type:
                              type: string
                            content_size:
                              type: integer
                            kind:
                              type: string
                            metadata:
                              type:
                                - object
                                - 'null'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Agreement not Found
                  errors:
                    type: object
                    example:
                      id:
                        - Error
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Could not Clone
                  errors:
                    type: object
                    example:
                      title:
                        - Exists
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
  /api/agreements/bulk_delete:
    delete:
      summary: Bulk deletes agreements
      tags:
        - Agreements
      operationId: bulkDeleteAgreements
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  agreement_ids:
                    type: array
                    items:
                      type: integer
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                example:
                  agreement_ids:
                    - 1
                    - 2
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Not Found
                  errors:
                    type: object
                    example:
                      agreement_ids:
                        - Not Found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Failed to delete.
                  errors:
                    type: object
                    example:
                      agreement_ids:
                        - Failed to delete.
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                agreement_ids:
                  type: array
                  items:
                    type: integer
              example:
                agreement_ids:
                  - 1
                  - 2
              required:
                - agreement_ids
        required: true
  /api/agreements/bulk_clone:
    post:
      summary: Clones multiple agreement
      tags:
        - Agreements
      operationId: bulkCloneAgreement
      security:
        - bearer_auth: []
      parameters:
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  agreements:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 101
                        title:
                          type: string
                          example: Terms and conditions
                        active:
                          type: boolean
                          example: true
                        required_on_checkout:
                          type: boolean
                          example: false
                        company_country_ids:
                          type: array
                          example:
                            - '1'
                            - '2'
                        description:
                          type: string
                          example: This is the description/body of the agreement
                        show_path:
                          type: string
                          example: /agreements/101
                        language_iso:
                          type: string
                          example: en
                        required:
                          type: boolean
                          example: true
                        enrollment_pack_id:
                          type:
                            - integer
                            - 'null'
                          example: 1
                        created_at:
                          type: string
                          format: date_time
                          example: '2025-06-02T12:34:56Z'
                        updated_at:
                          type: string
                          format: date_time
                          example: '2025-06-02T12:34:56Z'
                        company_logo:
                          type: string
                          example: https://example.com/logo.png
                        attachments:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                              url:
                                type: string
                              filename:
                                type: string
                              content_type:
                                type: string
                              content_size:
                                type: integer
                              kind:
                                type: string
                              metadata:
                                type:
                                  - object
                                  - 'null'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Could not Clone
                  errors:
                    type: object
                    example:
                      agreement_ids:
                        - Not Found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Could not Clone
                  errors:
                    type: object
                    example:
                      agreement_ids:
                        - Could Not Clone
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                agreement_ids:
                  type: array
                  items:
                    type: integer
              example:
                agreement_ids:
                  - 1
                  - 2
        required: true
  /api/company/announcements:
    get:
      summary: List announcements
      tags:
        - Announcements
      security:
        - bearer_auth: []
      parameters:
        - name: page
          in: query
          required: false
          description: Page number
          schema:
            type: integer
        - name: per_page
          in: query
          required: false
          description: Items per page
          schema:
            type: integer
        - name: search_query
          in: query
          required: false
          description: Search query
          schema:
            type: string
        - name: sorted_by
          in: query
          required: false
          description: Sort order
          schema:
            type: string
        - name: status
          in: query
          required: false
          description: Filter by status
          schema:
            type: string
      responses:
        '200':
          description: announcements retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  announcements:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 48
                        active:
                          type: boolean
                          example: true
                        application_theme_template_id:
                          type: integer
                          example: 8
                        country_ids:
                          type: array
                          items:
                            type: string
                            example: US
                        description:
                          type: string
                          example: A sample description
                        display_comments:
                          type: boolean
                          example: false
                        image_url:
                          type: string
                          example: https://example.com/sample-image.jpg
                        kind:
                          type: string
                          example: image
                        media_type:
                          type: string
                          example: update
                        no_index:
                          type: boolean
                          example: false
                        pdf_url:
                          type: string
                          example: https://example.com/sample-pdf.pdf
                        powerpoint_url:
                          type: string
                          example: https://example.com/sample-powerpoint.ppt
                        rank_ids:
                          type: array
                          items:
                            type: integer
                            example: 980190962
                        title:
                          type: string
                          example: Example Title
                        video_url:
                          type: string
                          example: https://example.com/sample-video.mp4
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: fcca8c13-a8de-4632-a3ef-4374f0dee632
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-05-19T20:01:35Z'
                      total_count:
                        type: integer
                        example: 1
                      total_pages:
                        type: integer
                        example: 1
                      current_page:
                        type: integer
                        example: 1
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Unauthorized
    post:
      summary: Create announcement
      tags:
        - Announcements
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: announcement created
          content:
            application/json:
              schema:
                type: object
                properties:
                  announcement:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 48
                      active:
                        type: boolean
                        example: true
                      application_theme_template_id:
                        type: integer
                        example: 8
                      country_ids:
                        type: array
                        items:
                          type: string
                          example: US
                      description:
                        type: string
                        example: A sample description
                      display_comments:
                        type: boolean
                        example: false
                      image_url:
                        type: string
                        example: https://example.com/sample-image.jpg
                      kind:
                        type: string
                        example: image
                      media_type:
                        type: string
                        example: update
                      no_index:
                        type: boolean
                        example: false
                      pdf_url:
                        type: string
                        example: https://example.com/sample-pdf.pdf
                      powerpoint_url:
                        type: string
                        example: https://example.com/sample-powerpoint.ppt
                      rank_ids:
                        type: array
                        items:
                          type: integer
                          example: 980190962
                      title:
                        type: string
                        example: Example Title
                      video_url:
                        type: string
                        example: https://example.com/sample-video.mp4
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Unauthorized
        '422':
          description: unprocessable content
          content:
            application/json:
              schema:
                type: object
                properties:
                  resource:
                    type: object
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                  example: New Announcement
                description:
                  type: string
                  example: Announcement description
                active:
                  type: boolean
                  example: true
                application_theme_template_id:
                  type: integer
                  example: 1
                available_countries:
                  type: array
                  items:
                    type: string
                  example:
                    - US
                    - CA
                display_comments:
                  type: boolean
                  example: false
                image_url:
                  type: string
                  example: https://example.com/image.jpg
                video_url:
                  type: string
                  example: https://example.com/video.mp4
                pdf_url:
                  type: string
                  example: https://example.com/document.pdf
                powerpoint_url:
                  type: string
                  example: https://example.com/presentation.ppt
                no_index:
                  type: boolean
                  example: false
                media_type:
                  type: string
                  example: update
                rank_ids:
                  type: array
                  items:
                    type: integer
                  example:
                    - 1
                    - 2
              required:
                - title
    delete:
      summary: Bulk destroy announcements
      tags:
        - Announcements
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: announcements deleted
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Success
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Unauthorized
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                ids:
                  type: array
                  items:
                    type: integer
                  example:
                    - 1
                    - 2
                    - 3
              required:
                - ids
  /api/company/announcements/{id}:
    get:
      summary: Get announcement
      tags:
        - Announcements
      security:
        - bearer_auth: []
      responses:
        '200':
          description: announcement found
          content:
            application/json:
              schema:
                type: object
                properties:
                  announcement:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 48
                      active:
                        type: boolean
                        example: true
                      application_theme_template_id:
                        type: integer
                        example: 8
                      country_ids:
                        type: array
                        items:
                          type: string
                          example: US
                      description:
                        type: string
                        example: A sample description
                      display_comments:
                        type: boolean
                        example: false
                      image_url:
                        type: string
                        example: https://example.com/sample-image.jpg
                      kind:
                        type: string
                        example: image
                      media_type:
                        type: string
                        example: update
                      no_index:
                        type: boolean
                        example: false
                      pdf_url:
                        type: string
                        example: https://example.com/sample-pdf.pdf
                      powerpoint_url:
                        type: string
                        example: https://example.com/sample-powerpoint.ppt
                      rank_ids:
                        type: array
                        items:
                          type: integer
                          example: 980190962
                      title:
                        type: string
                        example: Example Title
                      video_url:
                        type: string
                        example: https://example.com/sample-video.mp4
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Unauthorized
        '404':
          description: announcement not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Announcement not found
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                        example:
                          - not found
    put:
      summary: Update announcement
      tags:
        - Announcements
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: announcement updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  announcement:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 48
                      active:
                        type: boolean
                        example: true
                      application_theme_template_id:
                        type: integer
                        example: 8
                      country_ids:
                        type: array
                        items:
                          type: string
                          example: US
                      description:
                        type: string
                        example: A sample description
                      display_comments:
                        type: boolean
                        example: false
                      image_url:
                        type: string
                        example: https://example.com/sample-image.jpg
                      kind:
                        type: string
                        example: image
                      media_type:
                        type: string
                        example: update
                      no_index:
                        type: boolean
                        example: false
                      pdf_url:
                        type: string
                        example: https://example.com/sample-pdf.pdf
                      powerpoint_url:
                        type: string
                        example: https://example.com/sample-powerpoint.ppt
                      rank_ids:
                        type: array
                        items:
                          type: integer
                          example: 980190962
                      title:
                        type: string
                        example: Example Title
                      video_url:
                        type: string
                        example: https://example.com/sample-video.mp4
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Unauthorized
        '404':
          description: announcement not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Announcement not found
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                        example:
                          - not found
        '422':
          description: unprocessable content
          content:
            application/json:
              schema:
                type: object
                properties:
                  resource:
                    type: object
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                  example: Updated Announcement
                description:
                  type: string
                  example: Updated description
                active:
                  type: boolean
                  example: true
                application_theme_template_id:
                  type: integer
                  example: 1
                available_countries:
                  type: array
                  items:
                    type: string
                  example:
                    - US
                    - CA
                display_comments:
                  type: boolean
                  example: false
                image_url:
                  type: string
                  example: https://example.com/image.jpg
                video_url:
                  type: string
                  example: https://example.com/video.mp4
                pdf_url:
                  type: string
                  example: https://example.com/document.pdf
                powerpoint_url:
                  type: string
                  example: https://example.com/presentation.ppt
                no_index:
                  type: boolean
                  example: false
                media_type:
                  type: string
                  example: update
                rank_ids:
                  type: array
                  items:
                    type: integer
                  example:
                    - 1
                    - 2
    delete:
      summary: Delete announcement
      tags:
        - Announcements
      security:
        - bearer_auth: []
      responses:
        '200':
          description: announcement deleted
          content:
            application/json:
              schema:
                type: object
                properties:
                  announcement:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 48
                      active:
                        type: boolean
                        example: true
                      application_theme_template_id:
                        type: integer
                        example: 8
                      country_ids:
                        type: array
                        items:
                          type: string
                          example: US
                      description:
                        type: string
                        example: A sample description
                      display_comments:
                        type: boolean
                        example: false
                      image_url:
                        type: string
                        example: https://example.com/sample-image.jpg
                      kind:
                        type: string
                        example: image
                      media_type:
                        type: string
                        example: update
                      no_index:
                        type: boolean
                        example: false
                      pdf_url:
                        type: string
                        example: https://example.com/sample-pdf.pdf
                      powerpoint_url:
                        type: string
                        example: https://example.com/sample-powerpoint.ppt
                      rank_ids:
                        type: array
                        items:
                          type: integer
                          example: 980190962
                      title:
                        type: string
                        example: Example Title
                      video_url:
                        type: string
                        example: https://example.com/sample-video.mp4
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Unauthorized
        '404':
          description: announcement not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Announcement not found
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                        example:
                          - not found
    parameters:
      - name: id
        in: path
        required: true
        description: Announcement ID
        schema:
          type: integer
  /api/payments/apple_pay_session:
    post:
      summary: Creates an Apple Pay session
      tags:
        - Apple Pay
      description: Initialize an Apple Pay session for client-side Apple Pay integration
      operationId: createApplePaySession
      parameters: []
      responses:
        '200':
          description: Apple Pay session created
          content:
            application/json:
              schema:
                type: object
                properties:
                  apple_pay:
                    type: object
                    description: Apple Pay session data
                    example:
                      epochTimestamp: 1742464455114
                      expiresAt: 1742468055114
                      merchantSessionIdentifier: >-
                        SSHB9FDFEBF1A5C40C598D66F4E81C36136_916523AAED1343F5BC5815E12BEE9250AFFDC1A17C46B0DE5A943F0F94927C24
                      nonce: 649819fa
                      merchantIdentifier: >-
                        997088D3D0066273673AB74ADBB9F3B4F0ADAC2531EC26C424930C0BE0BA3924
                      domainName: www.example.com
                      displayName: Example Merchant
                      signature: >-
                        308006092a864886f70d010702a0803080020101310d300b0609608648016503040201308006092a864886f70d0107010000a080308203e43082038ba003020102020859d8a1bcaaf4e3cd300a06082a8648ce3d040302307a312e302c06035504030c254170706c65204170706c69636174696f6e20496e746567726174696f6e204341202d20473331263024060355040b0c1d4170706c652043657274696669636174696f6e20417574686f7269747931133011060355040a0c0a4170706c6520496e632e310b3009060355040613025553301e170d3231303432303139333730305a170d3236303431393139333635395a30623128302606035504030c1f6563632d736d702d62726f6b65722d7369676e5f5543342d53414e44424f5831143012060355040b0c0b694f532053797374656d7331133011060355040a0c0a4170706c6520496e632e310b30090603550406130255533059301306072a8648ce3d020106082a8648ce3d030107034200048230fdabc39cf75e202c50d99b4512e637e2a901dd6cb3e0b1cd4b526798f8cf4ebde81a25a8c21e4c33ddce8e2a96c2f6afa1930345c4e87a4426ce951b1295a38202113082020d300c0603551d130101ff04023000301f0603551d2304183016801423f249c44f93e4ef27e6c4f6286c3fa2bbfd2e4b304506082b0601050507010104393037303506082b060105050730018629687474703a2f2f6f6373702e6170706c652e636f6d2f6f63737030342d6170706c65616963613330323082011d0603551d2004820114308201103082010c06092a864886f7636405013081fe3081c306082b060105050702023081b60c81b352656c69616e6365206f6e207468697320636572746966696361746520627920616e7920706172747920617373756d657320616363657074616e6365206f6620746865207468656e206170706c696361626c65207374616e64617264207465726d7320616e6420636f6e646974696f6e73206f66207573652c20636572746966696361746520706f6c69637920616e642063657274696669636174696f6e2070726163746963652073746174656d656e74732e303606082b06010505070201162a687474703a2f2f7777772e6170706c652e636f6d2f6365727469666963617465617574686f726974792f30340603551d1f042d302b3029a027a0258623687474703a2f2f63726c2e6170706c652e636f6d2f6170706c6561696361332e63726c301d0603551d0e041604140224300b9aeeed463197a4a65a299e4271821c45300e0603551d0f0101ff040403020780300f06092a864886f76364061d04020500300a06082a8648ce3d0403020347003044022074a1b324db4249430dd3274c5074c4808d9a1f480e3a85c5c1362566325fbca3022069369053abf50b5a52f9f6004dc58aad6c50a7d608683790e0a73ad01e4ad981308202ee30820275a0030201020208496d2fbf3a98da97300a06082a8648ce3d0403023067311b301906035504030c124170706c6520526f6f74204341202d20473331263024060355040b0c1d4170706c652043657274696669636174696f6e20417574686f7269747931133011060355040a0c0a4170706c6520496e632e310b3009060355040613025553301e170d3134303530363233343633305a170d3239303530363233343633305a307a312e302c06035504030c254170706c65204170706c69636174696f6e20496e746567726174696f6e204341202d20473331263024060355040b0c1d4170706c652043657274696669636174696f6e20417574686f7269747931133011060355040a0c0a4170706c6520496e632e310b30090603550406130255533059301306072a8648ce3d020106082a8648ce3d03010703420004f017118419d76485d51a5e25810776e880a2efde7bae4de08dfc4b93e13356d5665b35ae22d097760d224e7bba08fd7617ce88cb76bb6670bec8e82984ff5445a381f73081f4304606082b06010505070101043a3038303606082b06010505073001862a687474703a2f2f6f6373702e6170706c652e636f6d2f6f63737030342d6170706c65726f6f7463616733301d0603551d0e0416041423f249c44f93e4ef27e6c4f6286c3fa2bbfd2e4b300f0603551d130101ff040530030101ff301f0603551d23041830168014bbb0dea15833889aa48a99debebdebafdacb24ab30370603551d1f0430302e302ca02aa0288626687474703a2f2f63726c2e6170706c652e636f6d2f6170706c65726f6f74636167332e63726c300e0603551d0f0101ff0404030201063010060a2a864886f7636406020e04020500300a06082a8648ce3d040302036700306402303acf7283511699b186fb35c356ca62bff417edd90f754da28ebef19c815e42b789f898f79b599f98d5410d8f9de9c2fe0230322dd54421b0a305776c5df3383b9067fd177c2c216d964fc6726982126f54f87a7d1b99cb9b0989216106990f09921d00003182018730820183020101308186307a312e302c06035504030c254170706c65204170706c69636174696f6e20496e746567726174696f6e204341202d20473331263024060355040b0c1d4170706c652043657274696669636174696f6e20417574686f7269747931133011060355040a0c0a4170706c6520496e632e310b3009060355040613025553020859d8a1bcaaf4e3cd300b0609608648016503040201a08193301806092a864886f70d010903310b06092a864886f70d010701301c06092a864886f70d010905310f170d3235303332303039353431355a302806092a864886f70d010934311b3019300b0609608648016503040201a10a06082a8648ce3d040302302f06092a864886f70d0109043122042058f90b3d8336b18d344ef98894765a47d2680e8e442c67b816100121b36598a7300a06082a8648ce3d04030204463044022018afc2313938becc90964454c5787ee61769c905721e9f68942f5f7a9b633e9702201dd385fd2c9c8a5ae3a44fdd82948a6a5ad63094af2755c9516824afaba3cf48000000000000
                      operationalAnalyticsIdentifier: >-
                        Example
                        Merchant:997088D3D0066273673AB74ADBB9F3B4F0ADAC2531EC26C424930C0BE0BA3924
                      retries: 0
                      pspId: >-
                        997088D3D0066273673AB74ADBB9F3B4F0ADAC2531EC26C424930C0BE0BA3924
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Company not found
                  errors:
                    type: object
                    example:
                      company:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: Apple Pay not configured properly
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Apple Pay is not configured properly
                  errors:
                    type: object
                    example:
                      apple_pay:
                        - is not configured properly
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - company_id
                - country_id
                - apple_session_url
              properties:
                company_id:
                  type: integer
                  description: Company ID
                  example: 123
                country_id:
                  type: integer
                  description: Country ID
                  example: 1
                apple_session_url:
                  type: string
                  description: Apple Pay session URL
                  example: >-
                    https://apple-pay-gateway.apple.com/paymentservices/startSession
        description: Session parameters
  /api/payments/apple_pay_authorize:
    post:
      summary: Processes an Apple Pay payment
      tags:
        - Apple Pay
      description: Process an Apple Pay payment for a cart
      operationId: processApplePayPayment
      parameters: []
      responses:
        '201':
          description: Payment processed successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: Approved
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '404':
          description: Cart not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Cart not found
                  errors:
                    type: object
                    example:
                      cart:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: Payment processing failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Payment authorization failed
                  errors:
                    type: object
                    example:
                      apple_pay:
                        - Payment authorization failed
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - cart_token
                - apple_pay_payload
              properties:
                cart_token:
                  type: string
                  description: Cart token
                  example: ct_7UUUXZP7QLl1NRZZuHQN3
                apple_pay_payload:
                  type: object
                  description: >-
                    Apple Pay payment payload, which can be derived from Apple
                    Pay payment response;
                    https://developer.apple.com/documentation/apple_pay_on_the_web/applepaypayment
                  required:
                    - token
                  properties:
                    token:
                      type: object
                      required:
                        - paymentData
                      properties:
                        paymentData:
                          type: object
                          required:
                            - data
                            - signature
                            - version
                            - header
                          properties:
                            data:
                              type: string
                              example: >-
                                G4kP5IrX+PZLAZUOPWbve3XXrsqdfMWkRSnRAfxVpXIpOZCQEJ
                            signature:
                              type: string
                              example: >-
                                MIAGCSqGSIb3DQEHAqCAMIACAQExDTALBglghkgBZQMEAgEwgAYJK
                            version:
                              type: string
                              example: EC_v1
                            header:
                              type: object
                              required:
                                - ephemeralPublicKey
                                - publicKeyHash
                                - transactionId
                              properties:
                                publicKeyHash:
                                  type: string
                                  example: ufHTw1HBjGwgkC023My0DcsTyZxXJT0sA2VnmSwe4ss=
                                ephemeralPublicKey:
                                  type: string
                                  example: >-
                                    MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEGQpUf5fW7pvUKQmw+
                                transactionId:
                                  type: string
                                  example: >-
                                    3d688a5c36e35abccdf21ed124fad00426abc4e49b1f0cf95701400717408122
        description: Payment parameters
  /api/public/v2025-06/apple_pay_domain/{hostname}:
    get:
      summary: Retrieves an Apple Pay domain verification file
      tags:
        - Apple Pay
      description: Fetches the Apple Pay domain verification file for the given hostname
      operationId: GetApplePayDomainVerificationFile
      parameters:
        - name: hostname
          in: path
          required: true
          description: The hostname for which to retrieve the verification file
          schema:
            type: string
      responses:
        '200':
          description: Apple Pay domain verification file found
          content:
            application/json:
              schema:
                type: object
                properties:
                  domain_verification_file:
                    type: string
                    description: Apple Pay Domain Verification File content
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '404':
          description: Domain not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Domain with the hostname not found
                  errors:
                    type: object
                    properties:
                      hostname:
                        type: array
                        items:
                          type: string
                        example:
                          - with the hostname not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: No Apple Pay payment account
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: >-
                      Hostname is not configured properly with an Apple Pay
                      Payment Account
                  errors:
                    type: object
                    properties:
                      hostname:
                        type: array
                        items:
                          type: string
                        example:
                          - >-
                            is not configured properly with an Apple Pay Payment
                            Account
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/application_themes/{application_theme_id}/resources:
    get:
      summary: Lists all theme resources
      tags:
        - Application Theme Resources
      security:
        - bearer_auth: []
      responses:
        '200':
          description: resources found
          content:
            application/json:
              schema:
                type: object
                properties:
                  application_theme_resources:
                    type: array
                    items:
                      type: object
                      properties:
                        resource_type:
                          type: string
                          example: ApplicationTheme
                          description: Type of the resource
                        resource_id:
                          type: integer
                          example: 1
                          description: ID of the resource
                        key:
                          type: string
                          example: styles.css
                          description: The path to the resource within the theme
                        content:
                          type: string
                          example: 'body { background-color: #fff; }'
                          description: The content of the resource
                        checksum:
                          type: string
                          example: 5d41402abc4b2a76b9719d911017c592
                          description: MD5 checksum of the resource content
                        url:
                          type:
                            - string
                            - 'null'
                          example: https://example.com/assets/styles.css
                          description: URL of the resource if resource is FileResource
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: aec35efe-1cdc-48ac-94e6-616831786625
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-05-03T04:58:11Z'
        '404':
          description: application theme not found
    put:
      summary: Updates a theme resource
      tags:
        - Application Theme Resources
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: resource updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  application_theme_resource:
                    type: object
                    properties:
                      resource_type:
                        type: string
                        example: ApplicationTheme
                        description: Type of the resource
                      resource_id:
                        type: integer
                        example: 1
                        description: ID of the resource
                      key:
                        type: string
                        example: styles.css
                        description: The path to the resource within the theme
                      content:
                        type: string
                        example: 'body { background-color: #fff; }'
                        description: The content of the resource
                      checksum:
                        type: string
                        example: 5d41402abc4b2a76b9719d911017c592
                        description: MD5 checksum of the resource content
                      url:
                        type:
                          - string
                          - 'null'
                        example: https://example.com/assets/styles.css
                        description: URL of the resource if resource is FileResource
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: aec35efe-1cdc-48ac-94e6-616831786625
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-05-03T04:58:11Z'
        '404':
          description: resource or application theme not found
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                key:
                  type: string
                  example: styles.css
                  description: The path to the resource within the theme
                content:
                  type: string
                  example: 'body { background-color: #000; }'
                  description: The new content of the resource
              required:
                - key
                - content
    delete:
      summary: Deletes a theme resource
      tags:
        - Application Theme Resources
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: resource deleted
        '404':
          description: resource or application theme not found
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                key:
                  type: string
                  example: styles.css
                  description: The path to the resource within the theme
              required:
                - key
    parameters:
      - name: application_theme_id
        in: path
        description: ID of the application theme
        required: true
        schema:
          type: integer
  /api/application_theme_templates:
    get:
      summary: Lists all theme templates
      tags:
        - Application Theme Templates
      security:
        - bearer_auth: []
      responses:
        '200':
          description: templates found with themeable_type filter
          content:
            application/json:
              schema:
                type: object
                properties:
                  templates:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 1
                        application_theme_id:
                          type: integer
                          example: 1
                        company_id:
                          type:
                            - integer
                            - 'null'
                          example: 1
                        global:
                          type: boolean
                          example: false
                        name:
                          type: string
                          example: Default Theme Template
                        default:
                          type: boolean
                          example: false
                        content:
                          type: string
                          example: <html><body>This is a default template</body></html>
                        stylesheet:
                          type: string
                          example: 'body { background-color: #fff; }'
                        variables:
                          type: object
                          example: {}
                        translations:
                          type: object
                          example: {}
                        hide_navbar:
                          type: boolean
                          example: false
                        use_active_application_theme:
                          type: boolean
                          example: false
                        themeable_type:
                          type: string
                          example: product
                          enum:
                            - product
                            - medium
                            - enrollment_pack
                            - shop_page
                            - navbar
                            - library
                            - page
                            - components
                            - library_navbar
                            - sections
                            - locales
                            - footer
                            - layouts
                            - category_page
                            - collection_page
                            - cart_page
                            - config
                            - home_page
                            - mysite
                            - join_page
                        status:
                          type: string
                          example: draft
                        created_at:
                          type:
                            - string
                            - 'null'
                          format: date-time
                          example: '2025-05-03T04:58:11Z'
                        updated_at:
                          type:
                            - string
                            - 'null'
                          format: date-time
                          example: '2025-05-03T04:58:11Z'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: aec35efe-1cdc-48ac-94e6-616831786625
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-05-03T04:58:11Z'
    post:
      summary: Creates a theme template
      tags:
        - Application Theme Templates
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '422':
          description: invalid request
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                application_theme_template:
                  type: object
                  properties:
                    name:
                      type: string
                    themeable_type:
                      type: string
                      enum:
                        - product
                        - medium
                        - enrollment_pack
                        - shop_page
                        - navbar
                        - library
                        - page
                        - components
                        - library_navbar
                        - sections
                        - locales
                        - footer
                        - layouts
                        - category_page
                        - collection_page
                        - cart_page
                        - config
                        - home_page
                        - mysite
                        - join_page
                    content:
                      type:
                        - string
                        - 'null'
                    stylesheet:
                      type:
                        - string
                        - 'null'
                    variables:
                      type:
                        - string
                        - 'null'
                    translations:
                      type:
                        - string
                        - 'null'
                    hide_navbar:
                      type:
                        - boolean
                        - 'null'
                    use_active_application_theme:
                      type:
                        - boolean
                        - 'null'
                  required:
                    - name
                    - themeable_type
                    - content
                    - stylesheet
                    - variables
    parameters:
      - name: application_theme_id
        in: query
        description: ID of the application theme
        required: true
        schema:
          type: string
      - name: themeable_type
        in: query
        description: Filter templates by themeable type
        required: false
        schema:
          type: string
          enum:
            - product
            - medium
            - enrollment_pack
            - shop_page
            - navbar
            - library
            - page
            - components
            - library_navbar
            - sections
            - locales
            - footer
            - layouts
            - category_page
            - collection_page
            - cart_page
            - config
            - home_page
            - mysite
            - join_page
  /api/application_theme_templates/{id}:
    get:
      summary: Retrieves a theme template
      tags:
        - Application Theme Templates
      security:
        - bearer_auth: []
      responses:
        '200':
          description: versioned template found
          content:
            application/json:
              schema:
                type: object
                properties:
                  application_theme_template:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      application_theme_id:
                        type: integer
                        example: 1
                      company_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      global:
                        type: boolean
                        example: false
                      name:
                        type: string
                        example: Default Theme Template
                      default:
                        type: boolean
                        example: false
                      content:
                        type: string
                        example: <html><body>This is a default template</body></html>
                      stylesheet:
                        type: string
                        example: 'body { background-color: #fff; }'
                      variables:
                        type: object
                        example: {}
                      translations:
                        type: object
                        example: {}
                      hide_navbar:
                        type: boolean
                        example: false
                      use_active_application_theme:
                        type: boolean
                        example: false
                      themeable_type:
                        type: string
                        example: product
                        enum:
                          - product
                          - medium
                          - enrollment_pack
                          - shop_page
                          - navbar
                          - library
                          - page
                          - components
                          - library_navbar
                          - sections
                          - locales
                          - footer
                          - layouts
                          - category_page
                          - collection_page
                          - cart_page
                          - config
                          - home_page
                          - mysite
                          - join_page
                      status:
                        type: string
                        example: draft
                      created_at:
                        type:
                          - string
                          - 'null'
                        format: date-time
                        example: '2025-05-03T04:58:11Z'
                      updated_at:
                        type:
                          - string
                          - 'null'
                        format: date-time
                        example: '2025-05-03T04:58:11Z'
                      versions:
                        type:
                          - array
                          - 'null'
                        items:
                          type: object
                        description: History of page versions
                      navbar_template_id:
                        type:
                          - integer
                          - 'null'
                        description: >-
                          ID of the navbar template associated with this theme
                          template
                      footer_template_id:
                        type:
                          - integer
                          - 'null'
                        description: >-
                          ID of the footer template associated with this theme
                          template
                      assigned_themeable_ids:
                        type:
                          - array
                          - 'null'
                        items:
                          type: integer
                        example:
                          - 1
                          - 2
                          - 3
                      url:
                        type:
                          - string
                          - 'null'
                        example: >-
                          https://test.example.com/home?preview=true&theme_template_id=1
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: aec35efe-1cdc-48ac-94e6-616831786625
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-05-03T04:58:11Z'
        '404':
          description: template not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: not_found
                  data:
                    type: object
                    properties:
                      error:
                        type: string
    patch:
      summary: Updates a theme template
      tags:
        - Application Theme Templates
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: template updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  application_theme_template:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      application_theme_id:
                        type: integer
                        example: 1
                      company_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      global:
                        type: boolean
                        example: false
                      name:
                        type: string
                        example: Default Theme Template
                      default:
                        type: boolean
                        example: false
                      content:
                        type: string
                        example: <html><body>This is a default template</body></html>
                      stylesheet:
                        type: string
                        example: 'body { background-color: #fff; }'
                      variables:
                        type: object
                        example: {}
                      translations:
                        type: object
                        example: {}
                      hide_navbar:
                        type: boolean
                        example: false
                      use_active_application_theme:
                        type: boolean
                        example: false
                      themeable_type:
                        type: string
                        example: product
                        enum:
                          - product
                          - medium
                          - enrollment_pack
                          - shop_page
                          - navbar
                          - library
                          - page
                          - components
                          - library_navbar
                          - sections
                          - locales
                          - footer
                          - layouts
                          - category_page
                          - collection_page
                          - cart_page
                          - config
                          - home_page
                          - mysite
                          - join_page
                      status:
                        type: string
                        example: draft
                      created_at:
                        type:
                          - string
                          - 'null'
                        format: date-time
                        example: '2025-05-03T04:58:11Z'
                      updated_at:
                        type:
                          - string
                          - 'null'
                        format: date-time
                        example: '2025-05-03T04:58:11Z'
                      versions:
                        type:
                          - array
                          - 'null'
                        items:
                          type: object
                        description: History of page versions
                      navbar_template_id:
                        type:
                          - integer
                          - 'null'
                        description: >-
                          ID of the navbar template associated with this theme
                          template
                      footer_template_id:
                        type:
                          - integer
                          - 'null'
                        description: >-
                          ID of the footer template associated with this theme
                          template
                      assigned_themeable_ids:
                        type:
                          - array
                          - 'null'
                        items:
                          type: integer
                        example:
                          - 1
                          - 2
                          - 3
                      url:
                        type:
                          - string
                          - 'null'
                        example: >-
                          https://test.example.com/home?preview=true&theme_template_id=1
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: aec35efe-1cdc-48ac-94e6-616831786625
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-05-03T04:58:11Z'
        '422':
          description: invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: aec35efe-1cdc-48ac-94e6-616831786625
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-05-03T04:58:11Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                application_theme_template:
                  type: object
                  properties:
                    name:
                      type: string
                    content:
                      type: string
                    themeable_type:
                      type: string
                    stylesheet:
                      type: string
                    variables:
                      type: string
                    translations:
                      type: string
                    hide_navbar:
                      type: boolean
                    use_active_application_theme:
                      type:
                        - boolean
                        - 'null'
                publish:
                  type: boolean
    delete:
      summary: Deletes a theme template
      tags:
        - Application Theme Templates
      security:
        - bearer_auth: []
      responses:
        '200':
          description: template deleted
    parameters:
      - name: id
        in: path
        description: ID of the theme template
        required: true
        schema:
          type: string
      - name: version
        in: query
        required: false
        description: Version of the theme template to retrieve
        schema:
          type: string
  /api/application_theme_templates/{id}/clone:
    post:
      summary: Clones a theme template
      tags:
        - Application Theme Templates
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: template cloned
          content:
            application/json:
              schema:
                type: object
                properties:
                  application_theme_template:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      application_theme_id:
                        type: integer
                        example: 1
                      company_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      global:
                        type: boolean
                        example: false
                      name:
                        type: string
                        example: Default Theme Template
                      default:
                        type: boolean
                        example: false
                      content:
                        type: string
                        example: <html><body>This is a default template</body></html>
                      stylesheet:
                        type: string
                        example: 'body { background-color: #fff; }'
                      variables:
                        type: object
                        example: {}
                      translations:
                        type: object
                        example: {}
                      hide_navbar:
                        type: boolean
                        example: false
                      use_active_application_theme:
                        type: boolean
                        example: false
                      themeable_type:
                        type: string
                        example: product
                        enum:
                          - product
                          - medium
                          - enrollment_pack
                          - shop_page
                          - navbar
                          - library
                          - page
                          - components
                          - library_navbar
                          - sections
                          - locales
                          - footer
                          - layouts
                          - category_page
                          - collection_page
                          - cart_page
                          - config
                          - home_page
                          - mysite
                          - join_page
                      status:
                        type: string
                        example: draft
                      created_at:
                        type:
                          - string
                          - 'null'
                        format: date-time
                        example: '2025-05-03T04:58:11Z'
                      updated_at:
                        type:
                          - string
                          - 'null'
                        format: date-time
                        example: '2025-05-03T04:58:11Z'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: aec35efe-1cdc-48ac-94e6-616831786625
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-05-03T04:58:11Z'
    parameters:
      - name: id
        in: path
        description: ID of the theme template to clone
        required: true
        schema:
          type: string
  /api/application_theme_templates/{id}/set_default:
    post:
      summary: Sets a theme template as default
      tags:
        - Application Theme Templates
      security:
        - bearer_auth: []
      responses:
        '200':
          description: template set as default
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                    example: 1
                  application_theme_id:
                    type: integer
                    example: 1
                  company_id:
                    type:
                      - integer
                      - 'null'
                    example: 1
                  global:
                    type: boolean
                    example: false
                  name:
                    type: string
                    example: Default Theme Template
                  default:
                    type: boolean
                    example: false
                  content:
                    type: string
                    example: <html><body>This is a default template</body></html>
                  stylesheet:
                    type: string
                    example: 'body { background-color: #fff; }'
                  variables:
                    type: object
                    example: {}
                  translations:
                    type: object
                    example: {}
                  hide_navbar:
                    type: boolean
                    example: false
                  use_active_application_theme:
                    type: boolean
                    example: false
                  themeable_type:
                    type: string
                    example: product
                    enum:
                      - product
                      - medium
                      - enrollment_pack
                      - shop_page
                      - navbar
                      - library
                      - page
                      - components
                      - library_navbar
                      - sections
                      - locales
                      - footer
                      - layouts
                      - category_page
                      - collection_page
                      - cart_page
                      - config
                      - home_page
                      - mysite
                      - join_page
                  status:
                    type: string
                    example: draft
                  created_at:
                    type:
                      - string
                      - 'null'
                    format: date-time
                    example: '2025-05-03T04:58:11Z'
                  updated_at:
                    type:
                      - string
                      - 'null'
                    format: date-time
                    example: '2025-05-03T04:58:11Z'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: aec35efe-1cdc-48ac-94e6-616831786625
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-05-03T04:58:11Z'
        '404':
          description: template not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: not_found
                  data:
                    type: object
                    properties:
                      error:
                        type: string
    parameters:
      - name: id
        in: path
        description: ID of the theme template to set as default
        required: true
        schema:
          type: string
  /api/application_theme_templates/{id}/version_diff:
    get:
      summary: Gets version diff information
      tags:
        - Application Theme Templates
      security:
        - bearer_auth: []
      responses:
        '200':
          description: version diff found
          content:
            application/json:
              schema:
                type: object
                properties:
                  audit:
                    type: object
                    properties:
                      version:
                        type: integer
                      created_at:
                        type: string
                        format: date-time
                      user_id:
                        type:
                          - string
                          - 'null'
                      user_name:
                        type:
                          - string
                          - 'null'
                      changes:
                        type: object
                  application_theme_template:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      application_theme_id:
                        type: integer
                        example: 1
                      company_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      global:
                        type: boolean
                        example: false
                      name:
                        type: string
                        example: Default Theme Template
                      default:
                        type: boolean
                        example: false
                      content:
                        type: string
                        example: <html><body>This is a default template</body></html>
                      stylesheet:
                        type: string
                        example: 'body { background-color: #fff; }'
                      variables:
                        type: object
                        example: {}
                      translations:
                        type: object
                        example: {}
                      hide_navbar:
                        type: boolean
                        example: false
                      use_active_application_theme:
                        type: boolean
                        example: false
                      themeable_type:
                        type: string
                        example: product
                        enum:
                          - product
                          - medium
                          - enrollment_pack
                          - shop_page
                          - navbar
                          - library
                          - page
                          - components
                          - library_navbar
                          - sections
                          - locales
                          - footer
                          - layouts
                          - category_page
                          - collection_page
                          - cart_page
                          - config
                          - home_page
                          - mysite
                          - join_page
                      status:
                        type: string
                        example: draft
                      created_at:
                        type:
                          - string
                          - 'null'
                        format: date-time
                        example: '2025-05-03T04:58:11Z'
                      updated_at:
                        type:
                          - string
                          - 'null'
                        format: date-time
                        example: '2025-05-03T04:58:11Z'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: aec35efe-1cdc-48ac-94e6-616831786625
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-05-03T04:58:11Z'
        '404':
          description: version not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: aec35efe-1cdc-48ac-94e6-616831786625
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-05-03T04:58:11Z'
    parameters:
      - name: id
        in: path
        description: ID of the theme template
        required: true
        schema:
          type: string
      - name: version
        in: query
        description: Version number to compare with
        schema:
          type: integer
  /api/application_theme_templates/{id}/render_page:
    post:
      summary: Renders a page for a theme template
      tags:
        - Application Theme Templates
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: page rendered with provided template attributes
          content:
            application/json:
              schema:
                type: object
                properties:
                  liquid_content:
                    type: string
                  html_content:
                    type: string
                  page_stylesheet:
                    type: string
                    description: >-
                      Stylesheet for the rendered page. Includes all the css
                      needed by the page.
                  template_stylesheet:
                    type: string
                    description: Stylesheet for the template itself.
                  preview_url:
                    type:
                      - string
                      - 'null'
                    description: Preview URL for the rendered resource.
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: aec35efe-1cdc-48ac-94e6-616831786625
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-05-03T04:58:11Z'
        '404':
          description: template not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: not_found
                  data:
                    type: object
                    properties:
                      error:
                        type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                resources:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        type: integer
                        description: ID of the resource to render
                      type:
                        type: string
                        description: Type of the resource to render
                        enum:
                          - product
                          - medium
                          - enrollment_pack
                          - library
                          - page
                          - collection
                          - post
                    required:
                      - id
                application_theme_template:
                  type: object
                  properties:
                    content:
                      type: string
                    stylesheet:
                      type: string
                    variables:
                      type: string
    parameters:
      - name: id
        in: path
        description: ID of the theme template
        required: true
        schema:
          type: string
      - name: version
        in: query
        required: false
        description: Version of the theme template to retrieve
        schema:
          type: string
  /api/application_theme_templates/{id}/render_section:
    post:
      summary: Renders a section template
      tags:
        - Application Theme Templates
      security:
        - bearer_auth: []
      responses:
        '200':
          description: section rendered
          content:
            application/json:
              schema:
                type: object
                properties:
                  html_content:
                    type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: aec35efe-1cdc-48ac-94e6-616831786625
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-05-03T04:58:11Z'
        '404':
          description: template not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: not_found
                  data:
                    type: object
                    properties:
                      error:
                        type: string
    parameters:
      - name: id
        in: path
        description: ID of the theme template
        required: true
        schema:
          type: string
  /api/application_theme_templates/{id}/available_variables:
    get:
      summary: Get available variables for a theme template
      description: Get available variables that can be used in the theme template
      tags:
        - Application Theme Templates
      operationId: getThemeTemplateAvailableVariablesApi
      security:
        - bearer_auth: []
      responses:
        '200':
          description: available variables found
          content:
            application/json:
              schema:
                type: object
                properties:
                  available_variables:
                    type: object
                    example:
                      company:
                        name: ACME Inc.
                        subdomain: acme
                      template:
                        company_name: ACME Inc.
                        site_url: https://example.com
                    description: Object containing available template variables
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        description: Unique identifier for the request
                      timestamp:
                        type: string
                        description: Time when the request was processed
                    required:
                      - request_id
                      - timestamp
                    description: Metadata about the request and response
                description: Successful response with available variables and metadata
        '404':
          description: template not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Template not found
                    description: Error message
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                        example:
                          - Template not found
                        description: List of error messages for the id field
                    description: Detailed error information
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        description: Unique identifier for the request
                      timestamp:
                        type: string
                        description: Time when the request was processed
                    required:
                      - request_id
                      - timestamp
                    description: Metadata about the request and response
                description: Error response when template is not found
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
  /api/application_theme_templates/{id}/publish:
    post:
      summary: Publishes the template
      tags:
        - Application Theme Templates
      security:
        - bearer_auth: []
      responses:
        '200':
          description: versioned template published
          content:
            application/json:
              schema:
                type: object
                properties:
                  application_theme_template:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      application_theme_id:
                        type: integer
                        example: 1
                      company_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      global:
                        type: boolean
                        example: false
                      name:
                        type: string
                        example: Default Theme Template
                      default:
                        type: boolean
                        example: false
                      content:
                        type: string
                        example: <html><body>This is a default template</body></html>
                      stylesheet:
                        type: string
                        example: 'body { background-color: #fff; }'
                      variables:
                        type: object
                        example: {}
                      translations:
                        type: object
                        example: {}
                      hide_navbar:
                        type: boolean
                        example: false
                      use_active_application_theme:
                        type: boolean
                        example: false
                      themeable_type:
                        type: string
                        example: product
                        enum:
                          - product
                          - medium
                          - enrollment_pack
                          - shop_page
                          - navbar
                          - library
                          - page
                          - components
                          - library_navbar
                          - sections
                          - locales
                          - footer
                          - layouts
                          - category_page
                          - collection_page
                          - cart_page
                          - config
                          - home_page
                          - mysite
                          - join_page
                      status:
                        type: string
                        example: draft
                      created_at:
                        type:
                          - string
                          - 'null'
                        format: date-time
                        example: '2025-05-03T04:58:11Z'
                      updated_at:
                        type:
                          - string
                          - 'null'
                        format: date-time
                        example: '2025-05-03T04:58:11Z'
                      versions:
                        type:
                          - array
                          - 'null'
                        items:
                          type: object
                        description: History of page versions
                      navbar_template_id:
                        type:
                          - integer
                          - 'null'
                        description: >-
                          ID of the navbar template associated with this theme
                          template
                      footer_template_id:
                        type:
                          - integer
                          - 'null'
                        description: >-
                          ID of the footer template associated with this theme
                          template
                      assigned_themeable_ids:
                        type:
                          - array
                          - 'null'
                        items:
                          type: integer
                        example:
                          - 1
                          - 2
                          - 3
                      url:
                        type:
                          - string
                          - 'null'
                        example: >-
                          https://test.example.com/home?preview=true&theme_template_id=1
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: aec35efe-1cdc-48ac-94e6-616831786625
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-05-03T04:58:11Z'
        '404':
          description: template not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: not_found
                  data:
                    type: object
                    properties:
                      error:
                        type: string
    parameters:
      - name: id
        in: path
        description: ID of the theme template
        required: true
        schema:
          type: string
      - name: version
        in: query
        required: false
        description: >-
          Version of the theme template to publish. If not specified, the latest
          version will be published.
        schema:
          type: string
  /api/application_theme_templates/{id}/available_themeables:
    get:
      summary: Returns all available themeables for theme template
      tags:
        - Application Theme Templates
      security:
        - bearer_auth: []
      responses:
        '200':
          description: returns only draft themeables
          content:
            application/json:
              schema:
                type: object
                properties:
                  available_themeables:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          description: ID of the themeable
                        title:
                          type: string
                          description: Title of the themeable
                        image:
                          type:
                            - string
                            - 'null'
                          description: Image URL for the themeable
                        themeable_type:
                          type: string
                          description: Type of the themeable
                        application_theme_template_id:
                          type:
                            - integer
                            - 'null'
                          description: ID of the template that the themeable is assigned to
                    description: List of themeables that use the specified template
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        description: Unique identifier for the request
                      timestamp:
                        type: string
                        description: Time when the request was processed
                      pagination:
                        type: object
                        properties:
                          current_page:
                            type: integer
                            description: Current page number in the pagination
                          total_pages:
                            type: integer
                            description: Total number of pages available
                          total_count:
                            type: integer
                            description: Total number of items across all pages
                          per_page:
                            type: integer
                            description: Number of items per page
                        description: Pagination information for the response
                    description: Metadata about the request and response
        '404':
          description: template not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Template not found
                    description: Error message
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                        example:
                          - Template not found
                        description: List of error messages for the id field
                    description: Detailed error information
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        description: Unique identifier for the request
                      timestamp:
                        type: string
                        description: Time when the request was processed
                    required:
                      - request_id
                      - timestamp
                    description: Metadata about the request and response
                description: Error response when template is not found
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: selected
        in: query
        required: false
        description: Filter themeables that are already assigned to this template
        schema:
          type: boolean
      - name: status
        in: query
        required: false
        description: Filter themeables by status (active, draft, archived)
        schema:
          type: string
  /api/application_theme_templates/{id}/themeables_update:
    put:
      summary: Updates themeable records to be used by the specified template
      tags:
        - Application Theme Templates
      security:
        - bearer_auth: []
      responses:
        '200':
          description: themeables updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  removed_count:
                    type: integer
                    description: Number of themeables unassigned from this template
                  updated_count:
                    type: integer
                    description: Number of themeables assigned to this template
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: aec35efe-1cdc-48ac-94e6-616831786625
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-05-03T04:58:11Z'
        '404':
          description: template not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: not_found
                  data:
                    type: object
                    properties:
                      error:
                        type: string
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: query_params
        in: query
        schema:
          type: object
          properties:
            added_ids:
              type: array
              items:
                type: integer
              example:
                - 1
                - 2
            removed_ids:
              type: array
              items:
                type: integer
              example:
                - 3
          required:
            - added_ids
            - removed_ids
  /api/application_theme_templates/mysite_themes:
    get:
      summary: List all mysite themes
      description: List all mysite themes
      tags:
        - Application Theme Templates
      operationId: getMysiteThemes
      security:
        - bearer_auth: []
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  templates:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 1
                        application_theme_id:
                          type: integer
                          example: 1
                        company_id:
                          type:
                            - integer
                            - 'null'
                          example: 1
                        global:
                          type: boolean
                          example: false
                        name:
                          type: string
                          example: Default Theme Template
                        default:
                          type: boolean
                          example: false
                        content:
                          type: string
                          example: <html><body>This is a default template</body></html>
                        stylesheet:
                          type: string
                          example: 'body { background-color: #fff; }'
                        variables:
                          type: object
                          example: {}
                        translations:
                          type: object
                          example: {}
                        hide_navbar:
                          type: boolean
                          example: false
                        use_active_application_theme:
                          type: boolean
                          example: false
                        themeable_type:
                          type: string
                          example: product
                          enum:
                            - product
                            - medium
                            - enrollment_pack
                            - shop_page
                            - navbar
                            - library
                            - page
                            - components
                            - library_navbar
                            - sections
                            - locales
                            - footer
                            - layouts
                            - category_page
                            - collection_page
                            - cart_page
                            - config
                            - home_page
                            - mysite
                            - join_page
                        status:
                          type: string
                          example: draft
                        created_at:
                          type:
                            - string
                            - 'null'
                          format: date-time
                          example: '2025-05-03T04:58:11Z'
                        updated_at:
                          type:
                            - string
                            - 'null'
                          format: date-time
                          example: '2025-05-03T04:58:11Z'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: aec35efe-1cdc-48ac-94e6-616831786625
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-05-03T04:58:11Z'
  /api/application_themes:
    get:
      summary: List application themes
      description: Get all application themes with optional filters
      tags:
        - Application Themes
      operationId: listApplicationThemes
      security:
        - bearer_auth: []
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            default: 1
          required: false
          description: Page number for pagination
        - name: per_page
          in: query
          schema:
            type: integer
            default: 10
          required: false
          description: Number of records per page
        - name: root_themes
          in: query
          schema:
            type: boolean
            default: false
          required: false
          description: If true, returns root themes instead of company-specific themes
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  application_themes:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 1
                        company_id:
                          type:
                            - integer
                            - 'null'
                          example: 123
                        name:
                          type: string
                          example: Modern Theme
                        description:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            name:
                              type: string
                              example: description
                            body:
                              type: string
                              example: >-
                                This is a sample description for an application
                                theme.
                            record_type:
                              type: string
                              example: ApplicationTheme
                            record_id:
                              type: integer
                              example: 1
                            created_at:
                              type: string
                              format: date_time
                              example: '2023-07-24T10:00:00.000Z'
                            updated_at:
                              type: string
                              format: date_time
                              example: '2023-07-24T10:00:00.000Z'
                            locale:
                              type:
                                - string
                                - 'null'
                              example: null
                          example:
                            id:
                              type: integer
                              example: 1
                            name:
                              type: string
                              example: description
                            body:
                              type: string
                              example: >-
                                This is a sample description for an application
                                theme.
                            record_type:
                              type: string
                              example: ApplicationTheme
                            record_id:
                              type: integer
                              example: 1
                            created_at:
                              type: string
                              format: date_time
                              example: '2023-07-24T10:00:00.000Z'
                            updated_at:
                              type: string
                              format: date_time
                              example: '2023-07-24T10:00:00.000Z'
                            locale:
                              type:
                                - string
                                - 'null'
                              example: null
                        cover_image:
                          type:
                            - string
                            - 'null'
                          example: >-
                            https://ik.imagekit.io/fluid/s3/83yozdmzQ1qLeKn89ffS_unnamed_file
                        status:
                          type: string
                          example: draft
                        variables:
                          type:
                            - string
                            - 'null'
                          example: >-
                            {"primary_color": "#ff0000", "secondary_color":
                            "#00ff00"}
                        custom_stylesheet:
                          type:
                            - string
                            - 'null'
                          example: 'body { background-color: #fff; }'
                        global_stylesheet:
                          type:
                            - string
                            - 'null'
                          example: 'h1 { color: #333; }'
                        created_at:
                          type: string
                          format: date_time
                          example: '2023-07-24T10:00:00.000Z'
                        updated_at:
                          type:
                            - string
                            - 'null'
                          format: date_time
                          example: '2023-07-24T10:00:00.000Z'
                        version:
                          type: string
                          example: '1.0'
                        outdated:
                          type: boolean
                          example: false
                      required:
                        - id
                        - company_id
                        - name
                        - status
                        - created_at
                        - updated_at
                      additionalProperties: true
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                      total_count:
                        type: integer
                        example: 42
                      total_pages:
                        type: integer
                        example: 3
                      current_page:
                        type: integer
                        example: 1
                      per_page:
                        type: integer
                        example: 10
    post:
      summary: Create an application theme
      tags:
        - Application Themes
      operationId: createApplicationTheme
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: created
          content:
            application/json:
              schema:
                type: object
                properties:
                  application_theme:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      company_id:
                        type:
                          - integer
                          - 'null'
                        example: 123
                      name:
                        type: string
                        example: Modern Theme
                      description:
                        type:
                          - object
                          - 'null'
                        example: null
                      cover_image:
                        type:
                          - string
                          - 'null'
                        example: >-
                          https://ik.imagekit.io/fluid/s3/83yozdmzQ1qLeKn89ffS_unnamed_file
                      status:
                        type: string
                        example: draft
                      variables:
                        type:
                          - string
                          - 'null'
                        example: >-
                          {"primary_color": "#ff0000", "secondary_color":
                          "#00ff00"}
                      custom_stylesheet:
                        type:
                          - string
                          - 'null'
                        example: 'body { background-color: #fff; }'
                      global_stylesheet:
                        type:
                          - string
                          - 'null'
                        example: 'h1 { color: #333; }'
                      created_at:
                        type:
                          - string
                          - 'null'
                        format: date_time
                        example: '2023-07-24T10:00:00.000Z'
                      updated_at:
                        type:
                          - string
                          - 'null'
                        format: date_time
                        example: '2023-07-24T10:00:00.000Z'
                      version:
                        type: string
                        example: '1.0'
                      outdated:
                        type: boolean
                        example: false
                      versions:
                        type: array
                        items:
                          type: object
                        example: []
                      application_theme_templates:
                        type: array
                        items:
                          type: object
                        example: []
                      images:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            url:
                              type: string
                              example: https://example.com/image.jpg
                            position:
                              type: integer
                              example: 1
                        example: []
                    required:
                      - id
                      - company_id
                      - name
                      - status
                      - created_at
                      - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameters
                  errors:
                    type: object
                    properties:
                      application_theme:
                        type: object
                        properties:
                          name:
                            type: array
                            items:
                              type: string
                            example:
                              - must be filled
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                application_theme:
                  type: object
                  properties:
                    name:
                      type: string
                      example: Modern Theme
                      description: Name of the application theme
                    description:
                      type: string
                      example: A clean modern theme
                      description: Description of the application theme
                    status:
                      type: string
                      example: draft
                      description: Status of the application theme
                    variables:
                      type: string
                      description: Theme variables in JSON format
                    custom_stylesheet:
                      type: string
                      description: Custom CSS for the theme
                    global_stylesheet:
                      type: string
                      description: Global CSS for the theme
                    cover_image_url:
                      type: string
                      example: https://example.com/image.jpg
                      description: URL for the cover image
                  required:
                    - name
              required:
                - application_theme
  /api/application_themes/{id}:
    get:
      summary: Get an application theme
      tags:
        - Application Themes
      operationId: getApplicationTheme
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Application Theme ID
          schema:
            type: integer
        - name: version
          in: query
          required: false
          description: Version of the theme to retrieve
          schema:
            type: integer
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  application_theme:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      company_id:
                        type:
                          - integer
                          - 'null'
                        example: 123
                      name:
                        type: string
                        example: Modern Theme
                      description:
                        type:
                          - object
                          - 'null'
                        example: null
                      cover_image:
                        type:
                          - string
                          - 'null'
                        example: >-
                          https://ik.imagekit.io/fluid/s3/83yozdmzQ1qLeKn89ffS_unnamed_file
                      status:
                        type: string
                        example: draft
                      variables:
                        type:
                          - string
                          - 'null'
                        example: >-
                          {"primary_color": "#ff0000", "secondary_color":
                          "#00ff00"}
                      custom_stylesheet:
                        type:
                          - string
                          - 'null'
                        example: 'body { background-color: #fff; }'
                      global_stylesheet:
                        type:
                          - string
                          - 'null'
                        example: 'h1 { color: #333; }'
                      created_at:
                        type:
                          - string
                          - 'null'
                        format: date_time
                        example: '2023-07-24T10:00:00.000Z'
                      updated_at:
                        type:
                          - string
                          - 'null'
                        format: date_time
                        example: '2023-07-24T10:00:00.000Z'
                      version:
                        type: string
                        example: '1.0'
                      outdated:
                        type: boolean
                        example: false
                      versions:
                        type: array
                        items:
                          type: object
                        example: []
                      application_theme_templates:
                        type: array
                        items:
                          type: object
                        example: []
                      images:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            url:
                              type: string
                              example: https://example.com/image.jpg
                            position:
                              type: integer
                              example: 1
                        example: []
                    required:
                      - id
                      - company_id
                      - name
                      - status
                      - created_at
                      - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: ApplicationTheme not found.
                  errors:
                    type: object
                    properties:
                      application_theme:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 'ApplicationTheme not found.. id: 999999'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
                  - meta
    patch:
      summary: Update an application theme
      tags:
        - Application Themes
      operationId: updateApplicationTheme
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Application Theme ID
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  application_theme:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      company_id:
                        type:
                          - integer
                          - 'null'
                        example: 123
                      name:
                        type: string
                        example: Modern Theme
                      description:
                        type:
                          - object
                          - 'null'
                        example: null
                      cover_image:
                        type:
                          - string
                          - 'null'
                        example: >-
                          https://ik.imagekit.io/fluid/s3/83yozdmzQ1qLeKn89ffS_unnamed_file
                      status:
                        type: string
                        example: draft
                      variables:
                        type:
                          - string
                          - 'null'
                        example: >-
                          {"primary_color": "#ff0000", "secondary_color":
                          "#00ff00"}
                      custom_stylesheet:
                        type:
                          - string
                          - 'null'
                        example: 'body { background-color: #fff; }'
                      global_stylesheet:
                        type:
                          - string
                          - 'null'
                        example: 'h1 { color: #333; }'
                      created_at:
                        type:
                          - string
                          - 'null'
                        format: date_time
                        example: '2023-07-24T10:00:00.000Z'
                      updated_at:
                        type:
                          - string
                          - 'null'
                        format: date_time
                        example: '2023-07-24T10:00:00.000Z'
                      version:
                        type: string
                        example: '1.0'
                      outdated:
                        type: boolean
                        example: false
                      versions:
                        type: array
                        items:
                          type: object
                        example: []
                      application_theme_templates:
                        type: array
                        items:
                          type: object
                        example: []
                      images:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            url:
                              type: string
                              example: https://example.com/image.jpg
                            position:
                              type: integer
                              example: 1
                        example: []
                    required:
                      - id
                      - company_id
                      - name
                      - status
                      - created_at
                      - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: ApplicationTheme not found.
                  errors:
                    type: object
                    properties:
                      application_theme:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 'ApplicationTheme not found.. id: 999999'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                application_theme:
                  type: object
                  properties:
                    name:
                      type: string
                      example: Updated Theme Name
                      description: Name of the application theme
                    description:
                      type: string
                      example: Updated description
                      description: Description of the application theme
                    status:
                      type: string
                      example: draft
                      description: Status of the application theme
                    variables:
                      type: string
                      description: Theme variables in JSON format
                    custom_stylesheet:
                      type: string
                      description: Custom CSS for the theme
                    global_stylesheet:
                      type: string
                      description: Global CSS for the theme
                    cover_image_url:
                      type: string
                      example: https://example.com/updated-image.jpg
                      description: URL for the cover image
              required:
                - application_theme
    delete:
      summary: Delete an application theme
      tags:
        - Application Themes
      operationId: deleteApplicationTheme
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Application Theme ID
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Theme was successfully destroyed.
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: ApplicationTheme not found.
                  errors:
                    type: object
                    properties:
                      application_theme:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 'ApplicationTheme not found.. id: 999999'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
                  - meta
        '422':
          description: cannot delete last theme
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameters
                  errors:
                    type: object
                    properties:
                      base:
                        type: array
                        items:
                          type: string
                        example:
                          - is missing
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
  /api/application_themes/{id}/clone:
    post:
      summary: Clone an application theme
      tags:
        - Application Themes
      operationId: cloneApplicationTheme
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Application Theme ID to clone
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  application_theme:
                    type: object
                    properties:
                      id:
                        type: integer
                      company_id:
                        type: integer
                      name:
                        type: string
                      description:
                        type: 'null'
                      cover_image:
                        type:
                          - string
                          - 'null'
                      status:
                        type: string
                      variables:
                        type:
                          - string
                          - 'null'
                      custom_stylesheet:
                        type:
                          - string
                          - 'null'
                      global_stylesheet:
                        type:
                          - string
                          - 'null'
                      created_at:
                        type: string
                        format: date_time
                      updated_at:
                        type: string
                        format: date_time
                      version:
                        type:
                          - string
                          - 'null'
                      outdated:
                        type: boolean
                      versions:
                        type: array
                        items:
                          type: object
                      application_theme_templates:
                        type: array
                        items:
                          type: object
                      images:
                        type: array
                        items:
                          type: object
                    required:
                      - id
                      - company_id
                      - name
                      - status
                      - created_at
                      - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: ApplicationTheme not found.
                  errors:
                    type: object
                    properties:
                      application_theme:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 'ApplicationTheme not found.. id: 999999'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
                  - meta
  /api/application_themes/{id}/theme_assets:
    get:
      summary: Get theme assets
      tags:
        - Application Themes
      operationId: getThemeAssets
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Application Theme ID
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  file_resources:
                    type: array
                    items:
                      title: FileResource
                      type: object
                      properties:
                        id:
                          type: integer
                        url:
                          example: https://example.com/file.jpg
                          type: string
                        preview_image_url:
                          example: https://example.com/preview.jpg
                          type:
                            - string
                            - 'null'
                        alt_text:
                          type:
                            - string
                            - 'null'
                        handle:
                          type:
                            - string
                            - 'null'
                        content_type:
                          type: string
                        content_size:
                          type: integer
                          minimum: 1
                          maximum: 2147483647
                        content:
                          type:
                            - string
                            - 'null'
                        relateable_id:
                          type:
                            - integer
                            - 'null'
                        relateable_type:
                          type:
                            - string
                            - 'null'
                        metadata:
                          type:
                            - object
                            - 'null'
                          default: '{}'
                        created_at:
                          type: string
                          format: date-time
                        updated_at:
                          type: string
                          format: date-time
                        filename:
                          type: string
                          pattern: ^[^/\0]+$
                        version:
                          example: '1'
                          type:
                            - string
                            - 'null'
                        non_binary:
                          example: true
                          type: boolean
                        references_count:
                          example:
                            ApplicationThemeTemplate: 2
                          type: object
                        dam_ready:
                          example: true
                          type: boolean
                        dam_processing_status:
                          example: ready
                          type:
                            - string
                            - 'null'
                        dam_tags:
                          example:
                            - en-us
                            - web
                          type:
                            - array
                            - 'null'
                        dam_upload_queued:
                          example: false
                          type: boolean
                      required:
                        - id
                        - url
                        - content_type
                        - content_size
                        - created_at
                        - updated_at
                        - filename
                        - non_binary
                        - references_count
                        - dam_ready
                        - dam_upload_queued
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: ApplicationTheme not found.
                  errors:
                    type: object
                    properties:
                      application_theme:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 'ApplicationTheme not found.. id: 999999'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
                  - meta
  /api/application_themes/active:
    get:
      summary: Get current active application theme
      tags:
        - Application Themes
      operationId: getActiveApplicationTheme
      security:
        - bearer_auth: []
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  application_theme:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      company_id:
                        type:
                          - integer
                          - 'null'
                        example: 123
                      name:
                        type: string
                        example: Modern Theme
                      description:
                        type:
                          - object
                          - 'null'
                        example: null
                      cover_image:
                        type:
                          - string
                          - 'null'
                        example: >-
                          https://ik.imagekit.io/fluid/s3/83yozdmzQ1qLeKn89ffS_unnamed_file
                      status:
                        type: string
                        example: draft
                      variables:
                        type:
                          - string
                          - 'null'
                        example: >-
                          {"primary_color": "#ff0000", "secondary_color":
                          "#00ff00"}
                      custom_stylesheet:
                        type:
                          - string
                          - 'null'
                        example: 'body { background-color: #fff; }'
                      global_stylesheet:
                        type:
                          - string
                          - 'null'
                        example: 'h1 { color: #333; }'
                      created_at:
                        type:
                          - string
                          - 'null'
                        format: date_time
                        example: '2023-07-24T10:00:00.000Z'
                      updated_at:
                        type:
                          - string
                          - 'null'
                        format: date_time
                        example: '2023-07-24T10:00:00.000Z'
                      version:
                        type: string
                        example: '1.0'
                      outdated:
                        type: boolean
                        example: false
                      versions:
                        type: array
                        items:
                          type: object
                        example: []
                      application_theme_templates:
                        type: array
                        items:
                          type: object
                        example: []
                      images:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            url:
                              type: string
                              example: https://example.com/image.jpg
                            position:
                              type: integer
                              example: 1
                        example: []
                    required:
                      - id
                      - company_id
                      - name
                      - status
                      - created_at
                      - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: ApplicationTheme not found.
                  errors:
                    type: object
                    properties:
                      application_theme:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 'ApplicationTheme not found.. id: 999999'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
                  - meta
  /api/application_themes/{id}/import:
    post:
      summary: Import an application theme
      tags:
        - Application Themes
      operationId: importApplicationTheme
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Application Theme ID to import
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  application_theme:
                    type: object
                    properties:
                      id:
                        type: integer
                      company_id:
                        type: integer
                      name:
                        type: string
                      description:
                        type: 'null'
                      cover_image:
                        type:
                          - string
                          - 'null'
                      status:
                        type: string
                      variables:
                        type:
                          - string
                          - 'null'
                      custom_stylesheet:
                        type:
                          - string
                          - 'null'
                      global_stylesheet:
                        type:
                          - string
                          - 'null'
                      created_at:
                        type: string
                        format: date_time
                      updated_at:
                        type: string
                        format: date_time
                      version:
                        type:
                          - string
                          - 'null'
                      outdated:
                        type: boolean
                    required:
                      - id
                      - company_id
                      - name
                      - status
                      - created_at
                      - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: ApplicationTheme not found.
                  errors:
                    type: object
                    properties:
                      application_theme:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 'ApplicationTheme not found.. id: 999999'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
                  - meta
  /api/application_themes/{id}/export:
    get:
      summary: Export an application theme
      tags:
        - Application Themes
      operationId: exportApplicationTheme
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Application Theme ID to export
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  url:
                    type: string
                    example: https://storage.example.com/theme-export.zip
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: ApplicationTheme not found.
                  errors:
                    type: object
                    properties:
                      application_theme:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 'ApplicationTheme not found.. id: 999999'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
                  - meta
  /api/application_themes/import_zip:
    post:
      summary: Import an application theme from zip file
      tags:
        - Application Themes
      operationId: importApplicationThemeFromZip
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  application_theme:
                    type: object
                    properties:
                      id:
                        type: integer
                      company_id:
                        type: integer
                      name:
                        type: string
                      description:
                        type: 'null'
                      cover_image:
                        type:
                          - string
                          - 'null'
                      status:
                        type: string
                      variables:
                        type:
                          - string
                          - 'null'
                      custom_stylesheet:
                        type:
                          - string
                          - 'null'
                      global_stylesheet:
                        type:
                          - string
                          - 'null'
                      created_at:
                        type: string
                        format: date_time
                      updated_at:
                        type: string
                        format: date_time
                      application_theme_templates:
                        type: array
                        items:
                          type: object
                      images:
                        type: array
                        items:
                          type: object
                    required:
                      - id
                      - company_id
                      - name
                      - status
                      - created_at
                      - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameters
                  errors:
                    type: object
                    properties:
                      zip_file_url:
                        type: array
                        items:
                          type: string
                        example:
                          - is missing
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                zip_file_url:
                  type: string
                  example: https://storage.example.com/theme-import.zip
                  description: URL to a zip file containing a theme
              required:
                - zip_file_url
  /api/application_themes/{id}/version_diff:
    get:
      summary: Gets version diff information
      tags:
        - Application Themes
      security:
        - bearer_auth: []
      responses:
        '200':
          description: version diff found
          content:
            application/json:
              schema:
                type: object
                properties:
                  audit:
                    type: object
                    properties:
                      version:
                        type: integer
                      created_at:
                        type: string
                        format: date-time
                      user_id:
                        type:
                          - string
                          - 'null'
                      user_name:
                        type:
                          - string
                          - 'null'
                      changes:
                        type: object
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: version not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
    parameters:
      - name: id
        in: path
        description: ID of the theme
        required: true
        schema:
          type: string
      - name: version
        in: query
        description: Version number to compare with
        schema:
          type: integer
  /api/application_themes/{id}/publish:
    post:
      summary: Publishes the theme
      tags:
        - Application Themes
      security:
        - bearer_auth: []
      responses:
        '200':
          description: versioned template published
          content:
            application/json:
              schema:
                type: object
                properties:
                  application_theme:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      company_id:
                        type:
                          - integer
                          - 'null'
                        example: 123
                      name:
                        type: string
                        example: Modern Theme
                      description:
                        type:
                          - object
                          - 'null'
                        example: null
                      cover_image:
                        type:
                          - string
                          - 'null'
                        example: >-
                          https://ik.imagekit.io/fluid/s3/83yozdmzQ1qLeKn89ffS_unnamed_file
                      status:
                        type: string
                        example: draft
                      variables:
                        type:
                          - string
                          - 'null'
                        example: >-
                          {"primary_color": "#ff0000", "secondary_color":
                          "#00ff00"}
                      custom_stylesheet:
                        type:
                          - string
                          - 'null'
                        example: 'body { background-color: #fff; }'
                      global_stylesheet:
                        type:
                          - string
                          - 'null'
                        example: 'h1 { color: #333; }'
                      created_at:
                        type:
                          - string
                          - 'null'
                        format: date_time
                        example: '2023-07-24T10:00:00.000Z'
                      updated_at:
                        type:
                          - string
                          - 'null'
                        format: date_time
                        example: '2023-07-24T10:00:00.000Z'
                      version:
                        type: string
                        example: '1.0'
                      outdated:
                        type: boolean
                        example: false
                      versions:
                        type: array
                        items:
                          type: object
                        example: []
                      application_theme_templates:
                        type: array
                        items:
                          type: object
                        example: []
                      images:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            url:
                              type: string
                              example: https://example.com/image.jpg
                            position:
                              type: integer
                              example: 1
                        example: []
                    required:
                      - id
                      - company_id
                      - name
                      - status
                      - created_at
                      - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: theme not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: not_found
                  data:
                    type: object
                    properties:
                      error:
                        type: string
    parameters:
      - name: id
        in: path
        description: ID of the theme
        required: true
        schema:
          type: string
      - name: version
        in: query
        required: false
        description: >-
          Version of the theme template to publish. If not specified, the latest
          version will be published.
        schema:
          type: string
  /api/application_themes/{id}/upgrade:
    post:
      summary: Upgrade an application theme
      tags:
        - Application Themes
      operationId: upgradeApplicationTheme
      security:
        - bearer_auth: []
      responses:
        '200':
          description: theme upgraded successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  application_theme:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      company_id:
                        type:
                          - integer
                          - 'null'
                        example: 123
                      name:
                        type: string
                        example: Modern Theme
                      description:
                        type:
                          - object
                          - 'null'
                        example: null
                      cover_image:
                        type:
                          - string
                          - 'null'
                        example: >-
                          https://ik.imagekit.io/fluid/s3/83yozdmzQ1qLeKn89ffS_unnamed_file
                      status:
                        type: string
                        example: draft
                      variables:
                        type:
                          - string
                          - 'null'
                        example: >-
                          {"primary_color": "#ff0000", "secondary_color":
                          "#00ff00"}
                      custom_stylesheet:
                        type:
                          - string
                          - 'null'
                        example: 'body { background-color: #fff; }'
                      global_stylesheet:
                        type:
                          - string
                          - 'null'
                        example: 'h1 { color: #333; }'
                      created_at:
                        type:
                          - string
                          - 'null'
                        format: date_time
                        example: '2023-07-24T10:00:00.000Z'
                      updated_at:
                        type:
                          - string
                          - 'null'
                        format: date_time
                        example: '2023-07-24T10:00:00.000Z'
                      version:
                        type: string
                        example: '1.0'
                      outdated:
                        type: boolean
                        example: false
                      versions:
                        type: array
                        items:
                          type: object
                        example: []
                      application_theme_templates:
                        type: array
                        items:
                          type: object
                        example: []
                      images:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            url:
                              type: string
                              example: https://example.com/image.jpg
                            position:
                              type: integer
                              example: 1
                        example: []
                    required:
                      - id
                      - company_id
                      - name
                      - status
                      - created_at
                      - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: theme not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: ApplicationTheme not found.
                  errors:
                    type: object
                    properties:
                      application_theme:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 'ApplicationTheme not found.. id: 999999'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
                  - meta
        '422':
          description: upgrade failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: 'Failed to upgrade theme: Upgrade error'
                  errors:
                    type: object
                    properties:
                      application_theme:
                        type: object
                        properties:
                          upgrade:
                            type: string
                            example: Upgrade error
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
    parameters:
      - name: id
        in: path
        description: ID of the theme to upgrade
        required: true
        schema:
          type: integer
  /api/authentication/send_mfa:
    post:
      summary: Send MFA Passcode
      description: Send MFA Passcode via email
      tags:
        - Authentication
      operationId: sendMultiFactorAuthentication
      parameters:
        - name: email
          in: query
          required: true
          description: Email address of the user
          schema:
            type: string
        - name: fluid_shop
          in: query
          required: false
          description: 'Shop name, eg: company.fluid.app'
          schema:
            type: string
      responses:
        '201':
          description: generic success response
          content:
            application/json:
              schema:
                type: object
                properties:
                  multi_factor_authentication:
                    title: MultiFactorAuthentication
                    type: object
                    properties:
                      uuid:
                        type: string
                      authenticated:
                        type: boolean
                      verification_channel:
                        type: string
                      verification_code_expires_at:
                        type: string
                    required:
                      - uuid
                      - verification_channel
                      - authenticated
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - multi_factor_authentication
  /api/authentication/confirm_mfa:
    post:
      summary: Confirm MFA passcode
      description: Confirm MFA Passcode
      tags:
        - Authentication
      operationId: confirmMultiFactorAuthentication
      parameters: []
      responses:
        '200':
          description: MFA code confirmed
          content:
            application/json:
              schema:
                type: object
                properties:
                  authenticated:
                    type: boolean
                    example: true
                  auth_type:
                    type: string
                    example: rep
                  companies:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 1
                        name:
                          type: string
                          example: John Doe
                        shop_name:
                          type: string
                          example: myco.fluid.app
                        logo_url:
                          type:
                            - string
                            - 'null'
                          example: https://example.com/logo.png
                        jwt:
                          type: string
                          example: eyJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJjdX...
                        primary_domain_hostname:
                          type: string
                          example: myco.fluid.app
                      required:
                        - id
                        - name
                        - shop_name
                        - jwt
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2025-02-03T08:04:10Z'
                required:
                  - authenticated
                  - auth_type
                  - companies
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                uuid:
                  type: string
                  example: drp_p4r9jsl305iduqrsl0ujdth35jhuy2al
                multi_factor_authentication:
                  type: object
                  properties:
                    verification_code:
                      type: string
                      example: '543432'
                  required:
                    - verification_code
              required:
                - uuid
                - multi_factor_authentication
  /api/authentication/me:
    get:
      summary: Fetch user details from JWT
      tags:
        - Authentication
      operationId: userDetailsViaMultiFactorAuthentication
      parameters:
        - name: jwt
          in: query
          required: true
          schema:
            type: string
      responses:
        '200':
          description: user details given
          content:
            application/json:
              schema:
                type: object
                properties:
                  user:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      first_name:
                        type:
                          - string
                          - 'null'
                        example: Mike
                      last_name:
                        type:
                          - string
                          - 'null'
                        example: Tingey
                      email:
                        type: string
                        example: mike@example.com
                      avatar_url:
                        type:
                          - string
                          - 'null'
                        example: >-
                          https://d1r16g5m5p3ba7.cloudfront.net/uploads/user/avatar/980190962/avatar.png
                      root_admin:
                        type: boolean
                        example: true
                  user_company:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      company_id:
                        type: integer
                        example: 226157151
                      company_name:
                        type: string
                        example: Fluid
                      roles:
                        type:
                          - array
                          - 'null'
                        example: '["admin", "developer"]'
                      user_type:
                        type:
                          - string
                          - 'null'
                        example: admin
                      logo_url:
                        type:
                          - string
                          - 'null'
                        example: https://cdn.filestackcontent.com/1Rnqia44T2mLcXuFZCTV
                      icon_url:
                        type:
                          - string
                          - 'null'
                        example: https://cdn.filestackcontent.com/1Rnqia44T2mLcXuFZCTV
                      fluid_shop:
                        type:
                          - string
                          - 'null'
                        example: myco.fluid.app
                      company_colors:
                        type:
                          - object
                          - 'null'
                        properties:
                          primary_color:
                            type:
                              - string
                              - 'null'
                            example: 0C7CF6
                          secondary_color:
                            type:
                              - string
                              - 'null'
                            example: 0C7CF6
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 72591788-c981-47d1-8dd5-1cc0e1612815
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-05-08T06:18:09Z'
        '404':
          description: user not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: object
                    properties:
                      user:
                        type: array
                  error_message:
                    type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2025-02-03T08:04:10Z'
  /api/authentication/resend_mfa:
    post:
      summary: Resend code via email
      tags:
        - Authentication
      operationId: resendMultiFactorAuthentication
      parameters:
        - name: uuid
          in: query
          required: true
          description: Current MFA uuid
          schema:
            type: string
      responses:
        '201':
          description: verification code resent
          content:
            application/json:
              schema:
                type: object
                properties:
                  multi_factor_authentication:
                    title: MultiFactorAuthentication
                    type: object
                    properties:
                      uuid:
                        type: string
                      verification_channel:
                        example: test@example.com
                        type: string
                      verification_code_expires_at:
                        example: '2025-02-17T08:00:01Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      authenticated:
                        example: 'false'
                        type: boolean
                        default: false
                    required:
                      - uuid
                      - verification_channel
                      - authenticated
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - multi_factor_authentication
        '422':
          description: resend before 30 seconds
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: object
                    properties:
                      multi_factor_authentication:
                        type: array
                  error_message:
                    type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2025-02-03T08:04:10Z'
  /api/authentication/company/{fluid_shop}:
    get:
      summary: Fetch company details from Fluid Shop name
      tags:
        - Authentication
      operationId: companyDetailsViaMultiFactorAuthentication
      parameters:
        - name: fluid_shop
          in: path
          required: true
          description: Fluid shop name
          example: myco
          schema:
            type: string
      responses:
        '200':
          description: company details given
          content:
            application/json:
              schema:
                type: object
                properties:
                  company:
                    type: object
                    properties:
                      name:
                        type: string
                      logo_url:
                        type:
                          - string
                          - 'null'
                        example: https://example.com/logo.png
                      color:
                        type: string
                        example: '#000000'
                      fluid_shop:
                        type: string
                        example: myco.fluid.app
                      primary_domain_hostname:
                        type: string
                        example: myco.com
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2025-02-03T08:04:10Z'
  /api/authentication/company/{company_id}/switch:
    put:
      summary: Switch company
      tags:
        - Authentication
      security:
        - bearer_auth: []
      operationId: switchCompany
      parameters:
        - name: company_id
          in: path
          required: true
          description: Company id
          example: '980190965'
          schema:
            type: integer
      responses:
        '200':
          description: New company details with jwt given
          content:
            application/json:
              schema:
                type: object
                properties:
                  company:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      name:
                        type: string
                        example: fluid
                      fluid_shop:
                        type: string
                        example: myco.fluid.app
                      logo_url:
                        type:
                          - string
                          - 'null'
                        example: https://example.com/logo.png
                      jwt:
                        type: string
                        example: eyJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJjdX...
                      redirect_path:
                        type: string
                        example: /admin/dashboard
                    required:
                      - id
                      - name
                      - fluid_shop
                      - logo_url
                      - jwt
                      - redirect_path
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2025-02-03T08:04:10Z'
                required:
                  - company
                  - meta
        '404':
          description: Company not found or not associated with current user
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: object
                    properties:
                      company:
                        type: array
                  error_message:
                    type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2025-02-03T08:04:10Z'
  /api/v2025-06/tokens/partner:
    get:
      summary: authenticates with partner token
      tags:
        - Authentication
      security:
        - bearer_auth: []
      operationId: testPartnerTokenAuth
      responses:
        '200':
          description: partner token authentication successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  tokens:
                    type: array
                    items:
                      title: PartnerToken
                      type: object
                      properties:
                        id:
                          type: integer
                        label:
                          type: string
                        token:
                          type: string
                        created_at:
                          type: string
                          format: date-time
                        expires_at:
                          type:
                            - string
                            - 'null'
                          format: date-time
                      required:
                        - id
                        - label
                        - token
                        - created_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
  /api/v2025-06/partner_tokens:
    get:
      summary: authenticates with partner token (deprecated)
      tags:
        - Authentication
      security:
        - bearer_auth: []
      operationId: testPartnerTokenAuthDeprecated
      deprecated: true
      responses:
        '200':
          description: partner token authentication successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  tokens:
                    type: array
                    items:
                      title: PartnerToken
                      type: object
                      properties:
                        id:
                          type: integer
                        label:
                          type: string
                        token:
                          type: string
                        created_at:
                          type: string
                          format: date-time
                        expires_at:
                          type:
                            - string
                            - 'null'
                          format: date-time
                      required:
                        - id
                        - label
                        - token
                        - created_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
  /api/user_companies/customer_token_exchange:
    put:
      summary: Exchange user company token for customer JWT
      tags:
        - Authentication
      description: Exchange user_company_token for customer JWT
      parameters: []
      responses:
        '200':
          description: Exchange successful with valid user_company_token and email
          content:
            application/json:
              schema:
                type: object
                properties:
                  jwt:
                    type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - jwt
                  - meta
        '401':
          description: Invalid user company token
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: unauthorized
                  errors:
                    type: object
                    properties:
                      token:
                        type: array
                        items:
                          type: string
                        example:
                          - is invalid
                    required:
                      - token
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                user_company_token:
                  type: string
                  minLength: 1
              required:
                - user_company_token
  /api/user_companies/jwt_exchange:
    put:
      summary: Exchange JWT for user company token
      tags:
        - Authentication
      description: Exchange JWT for user_company_token
      parameters: []
      responses:
        '200':
          description: Exchange successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  user_company_token:
                    type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - user_company_token
                  - meta
        '401':
          description: Invalid JWT token
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: unauthorized
                  errors:
                    type: object
                    properties:
                      jwt:
                        type: array
                        items:
                          type: string
                        example:
                          - is invalid
                    required:
                      - jwt
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                jwt:
                  type: string
                  minLength: 1
              required:
                - jwt
  /api/user_companies/jwt_refresh:
    put:
      summary: Refresh JWT token
      tags:
        - Authentication
      description: Refresh an existing JWT token to extend its validity
      parameters: []
      responses:
        '200':
          description: JWT refresh successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  jwt:
                    type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - jwt
                  - meta
        '401':
          description: Invalid JWT token
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: unauthorized
                  errors:
                    type: object
                    properties:
                      jwt:
                        type: array
                        items:
                          type: string
                        example:
                          - is invalid
                    required:
                      - jwt
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                jwt:
                  type: string
                  minLength: 1
              required:
                - jwt
  /api/user_companies/token_exchange:
    put:
      summary: Exchange user company token for JWT
      tags:
        - Authentication
      description: Exchange user_company_token for JWT
      parameters: []
      responses:
        '200':
          description: Exchange successful with user_company_token input
          content:
            application/json:
              schema:
                type: object
                properties:
                  jwt:
                    type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - jwt
                  - meta
        '401':
          description: Invalid user company token
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: unauthorized
                  errors:
                    type: object
                    properties:
                      user_company_token:
                        type: array
                        items:
                          type: string
                        example:
                          - is invalid
                    required:
                      - user_company_token
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                user_company_token:
                  type: string
                  minLength: 1
              required:
                - user_company_token
  /api/companies/{company_id}/bank_accounts:
    get:
      summary: List company bank accounts
      tags:
        - Bank Accounts
      operationId: listCompanyBankAccounts
      security:
        - bearer_auth: []
      parameters:
        - name: company_id
          in: path
          required: true
          example: 1
          schema:
            type: integer
      responses:
        '200':
          description: bank accounts retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  bank_accounts:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 1
                        entity_id:
                          type: integer
                          example: 1
                        bank_name:
                          type: string
                          example: Chase Bank
                        holder_name:
                          type: string
                          example: John Doe
                        account_number:
                          type: string
                          example: '1234567890'
                        routing_number:
                          type:
                            - string
                            - 'null'
                          example: '021000021'
                        swift_bic:
                          type:
                            - string
                            - 'null'
                          example: CHASUSUS33
                        country_iso:
                          type:
                            - string
                            - 'null'
                          example: US
                        currency_iso:
                          type:
                            - string
                            - 'null'
                          example: USD
                        city:
                          type:
                            - string
                            - 'null'
                          example: New York
                        primary:
                          type: boolean
                          example: false
                        status:
                          type: string
                          example: active
                          enum:
                            - active
                            - inactive
                        last_3_months_bank_statements_file_url:
                          type:
                            - string
                            - 'null'
                          example: https://example.com/bank-statements.pdf
                        last_3_months_bank_statements_file_name:
                          type:
                            - string
                            - 'null'
                          example: bank-statements.pdf
                        bank_letter_or_voided_check_file_url:
                          type:
                            - string
                            - 'null'
                          example: https://example.com/bank-letter.pdf
                        bank_letter_or_voided_check_file_name:
                          type:
                            - string
                            - 'null'
                          example: bank-letter.pdf
                        created_at:
                          type: string
                          example: '2025-01-15T10:30:00Z'
                        updated_at:
                          type: string
                          example: '2025-01-15T10:30:00Z'
                      required: []
                  meta:
                    type: object
                required:
                  - bank_accounts
                  - meta
        '401':
          description: unauthorized - company access denied
    post:
      summary: Create company bank account
      tags:
        - Bank Accounts
      operationId: createCompanyBankAccount
      security:
        - bearer_auth: []
      parameters:
        - name: company_id
          in: path
          required: true
          example: 1
          schema:
            type: integer
      responses:
        '201':
          description: bank account created
          content:
            application/json:
              schema:
                type: object
                properties:
                  bank_account:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      entity_id:
                        type: integer
                        example: 1
                      bank_name:
                        type: string
                        example: Chase Bank
                      holder_name:
                        type: string
                        example: John Doe
                      account_number:
                        type: string
                        example: '1234567890'
                      routing_number:
                        type:
                          - string
                          - 'null'
                        example: '021000021'
                      swift_bic:
                        type:
                          - string
                          - 'null'
                        example: CHASUSUS33
                      country_iso:
                        type:
                          - string
                          - 'null'
                        example: US
                      currency_iso:
                        type:
                          - string
                          - 'null'
                        example: USD
                      city:
                        type:
                          - string
                          - 'null'
                        example: New York
                      primary:
                        type: boolean
                        example: false
                      status:
                        type: string
                        example: active
                        enum:
                          - active
                          - inactive
                      last_3_months_bank_statements_file_url:
                        type:
                          - string
                          - 'null'
                        example: https://example.com/bank-statements.pdf
                      last_3_months_bank_statements_file_name:
                        type:
                          - string
                          - 'null'
                        example: bank-statements.pdf
                      bank_letter_or_voided_check_file_url:
                        type:
                          - string
                          - 'null'
                        example: https://example.com/bank-letter.pdf
                      bank_letter_or_voided_check_file_name:
                        type:
                          - string
                          - 'null'
                        example: bank-letter.pdf
                      created_at:
                        type: string
                        example: '2025-01-15T10:30:00Z'
                      updated_at:
                        type: string
                        example: '2025-01-15T10:30:00Z'
                    required: []
                  meta:
                    type: object
                required:
                  - bank_account
                  - meta
        '401':
          description: unauthorized - company access denied
        '422':
          description: validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Bank account could not be created
                  errors:
                    type: object
                    example:
                      bank_account:
                        account_number:
                          - can't be blank
                  meta:
                    type: object
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                bank_account:
                  type: object
                  properties:
                    entity_id:
                      type: integer
                      example: 1
                      description: Associated entity ID
                    bank_name:
                      type: string
                      example: Chase Bank
                      description: Bank name
                    holder_name:
                      type: string
                      example: John Doe
                      description: Account holder name
                    account_number:
                      type: string
                      example: '1234567890'
                      description: Bank account number
                    routing_number:
                      type:
                        - string
                        - 'null'
                      example: '021000021'
                      description: Bank routing number
                    swift_bic:
                      type:
                        - string
                        - 'null'
                      example: CHASUSUS33
                      description: SWIFT/BIC code
                    country_iso:
                      type:
                        - string
                        - 'null'
                      example: US
                      description: Country ISO code
                    currency_iso:
                      type:
                        - string
                        - 'null'
                      example: USD
                      description: Currency ISO code
                    city:
                      type:
                        - string
                        - 'null'
                      example: New York
                      description: City
                    primary:
                      type: boolean
                      example: false
                      description: Whether this is the primary bank account
                    status:
                      type: string
                      example: active
                      description: Bank account status (active or inactive)
                      enum:
                        - active
                        - inactive
                    last_3_months_bank_statements_file_url:
                      type:
                        - string
                        - 'null'
                      example: https://example.com/bank-statements.pdf
                      description: Last 3 months bank statements document file URL
                    last_3_months_bank_statements_file_name:
                      type:
                        - string
                        - 'null'
                      example: bank-statements.pdf
                      description: Last 3 months bank statements document file name
                    bank_letter_or_voided_check_file_url:
                      type:
                        - string
                        - 'null'
                      example: https://example.com/bank-letter.pdf
                      description: Bank letter or voided check document file URL
                    bank_letter_or_voided_check_file_name:
                      type:
                        - string
                        - 'null'
                      example: bank-letter.pdf
                      description: Bank letter or voided check document file name
                  required:
                    - entity_id
                    - bank_name
                    - holder_name
                    - account_number
              required:
                - bank_account
  /api/companies/{company_id}/bank_accounts/{id}:
    get:
      summary: Get company bank account
      tags:
        - Bank Accounts
      operationId: getCompanyBankAccount
      security:
        - bearer_auth: []
      parameters:
        - name: company_id
          in: path
          required: true
          example: 1
          schema:
            type: integer
        - name: id
          in: path
          required: true
          example: 1
          schema:
            type: integer
      responses:
        '200':
          description: bank account retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  bank_account:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      entity_id:
                        type: integer
                        example: 1
                      bank_name:
                        type: string
                        example: Chase Bank
                      holder_name:
                        type: string
                        example: John Doe
                      account_number:
                        type: string
                        example: '1234567890'
                      routing_number:
                        type:
                          - string
                          - 'null'
                        example: '021000021'
                      swift_bic:
                        type:
                          - string
                          - 'null'
                        example: CHASUSUS33
                      country_iso:
                        type:
                          - string
                          - 'null'
                        example: US
                      currency_iso:
                        type:
                          - string
                          - 'null'
                        example: USD
                      city:
                        type:
                          - string
                          - 'null'
                        example: New York
                      primary:
                        type: boolean
                        example: false
                      status:
                        type: string
                        example: active
                        enum:
                          - active
                          - inactive
                      last_3_months_bank_statements_file_url:
                        type:
                          - string
                          - 'null'
                        example: https://example.com/bank-statements.pdf
                      last_3_months_bank_statements_file_name:
                        type:
                          - string
                          - 'null'
                        example: bank-statements.pdf
                      bank_letter_or_voided_check_file_url:
                        type:
                          - string
                          - 'null'
                        example: https://example.com/bank-letter.pdf
                      bank_letter_or_voided_check_file_name:
                        type:
                          - string
                          - 'null'
                        example: bank-letter.pdf
                      created_at:
                        type: string
                        example: '2025-01-15T10:30:00Z'
                      updated_at:
                        type: string
                        example: '2025-01-15T10:30:00Z'
                    required: []
                  meta:
                    type: object
                required:
                  - bank_account
                  - meta
        '401':
          description: unauthorized - company access denied
        '404':
          description: bank account not found
    put:
      summary: Update company bank account
      tags:
        - Bank Accounts
      operationId: updateCompanyBankAccount
      security:
        - bearer_auth: []
      parameters:
        - name: company_id
          in: path
          required: true
          example: 1
          schema:
            type: integer
        - name: id
          in: path
          required: true
          example: 1
          schema:
            type: integer
      responses:
        '200':
          description: bank account updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  bank_account:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      entity_id:
                        type: integer
                        example: 1
                      bank_name:
                        type: string
                        example: Chase Bank
                      holder_name:
                        type: string
                        example: John Doe
                      account_number:
                        type: string
                        example: '1234567890'
                      routing_number:
                        type:
                          - string
                          - 'null'
                        example: '021000021'
                      swift_bic:
                        type:
                          - string
                          - 'null'
                        example: CHASUSUS33
                      country_iso:
                        type:
                          - string
                          - 'null'
                        example: US
                      currency_iso:
                        type:
                          - string
                          - 'null'
                        example: USD
                      city:
                        type:
                          - string
                          - 'null'
                        example: New York
                      primary:
                        type: boolean
                        example: false
                      status:
                        type: string
                        example: active
                        enum:
                          - active
                          - inactive
                      last_3_months_bank_statements_file_url:
                        type:
                          - string
                          - 'null'
                        example: https://example.com/bank-statements.pdf
                      last_3_months_bank_statements_file_name:
                        type:
                          - string
                          - 'null'
                        example: bank-statements.pdf
                      bank_letter_or_voided_check_file_url:
                        type:
                          - string
                          - 'null'
                        example: https://example.com/bank-letter.pdf
                      bank_letter_or_voided_check_file_name:
                        type:
                          - string
                          - 'null'
                        example: bank-letter.pdf
                      created_at:
                        type: string
                        example: '2025-01-15T10:30:00Z'
                      updated_at:
                        type: string
                        example: '2025-01-15T10:30:00Z'
                    required: []
                  meta:
                    type: object
                required:
                  - bank_account
                  - meta
        '401':
          description: unauthorized - company access denied
        '404':
          description: bank account not found
        '422':
          description: validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Bank account could not be created
                  errors:
                    type: object
                    example:
                      bank_account:
                        account_number:
                          - can't be blank
                  meta:
                    type: object
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                bank_account:
                  type: object
                  properties:
                    entity_id:
                      type:
                        - integer
                        - 'null'
                      example: 1
                      description: Associated entity ID
                    bank_name:
                      type:
                        - string
                        - 'null'
                      example: Chase Bank
                      description: Bank name
                    holder_name:
                      type:
                        - string
                        - 'null'
                      example: John Doe
                      description: Account holder name
                    account_number:
                      type:
                        - string
                        - 'null'
                      example: '1234567890'
                      description: Bank account number
                    routing_number:
                      type:
                        - string
                        - 'null'
                      example: '021000021'
                      description: Bank routing number
                    swift_bic:
                      type:
                        - string
                        - 'null'
                      example: CHASUSUS33
                      description: SWIFT/BIC code
                    country_iso:
                      type:
                        - string
                        - 'null'
                      example: US
                      description: Country ISO code
                    currency_iso:
                      type:
                        - string
                        - 'null'
                      example: USD
                      description: Currency ISO code
                    city:
                      type:
                        - string
                        - 'null'
                      example: New York
                      description: City
                    primary:
                      type: boolean
                      example: false
                      description: Whether this is the primary bank account
                    status:
                      type: string
                      example: active
                      description: Bank account status (active or inactive)
                      enum:
                        - active
                        - inactive
                    last_3_months_bank_statements_file_url:
                      type:
                        - string
                        - 'null'
                      example: https://example.com/bank-statements.pdf
                      description: Last 3 months bank statements document file URL
                    last_3_months_bank_statements_file_name:
                      type:
                        - string
                        - 'null'
                      example: bank-statements.pdf
                      description: Last 3 months bank statements document file name
                    bank_letter_or_voided_check_file_url:
                      type:
                        - string
                        - 'null'
                      example: https://example.com/bank-letter.pdf
                      description: Bank letter or voided check document file URL
                    bank_letter_or_voided_check_file_name:
                      type:
                        - string
                        - 'null'
                      example: bank-letter.pdf
                      description: Bank letter or voided check document file name
              required:
                - bank_account
    delete:
      summary: Delete company bank account
      tags:
        - Bank Accounts
      operationId: deleteCompanyBankAccount
      security:
        - bearer_auth: []
      parameters:
        - name: company_id
          in: path
          required: true
          example: 1
          schema:
            type: integer
        - name: id
          in: path
          required: true
          example: 1
          schema:
            type: integer
      responses:
        '204':
          description: bank account deleted
        '401':
          description: unauthorized - company access denied
        '404':
          description: bank account not found
  /api/settings/brand_guidelines:
    get:
      summary: Show brand guidelines settings
      tags:
        - Brand Guidelines
      operationId: getBrandGuidelines
      security:
        - bearer_auth: []
      responses:
        '200':
          description: Brand guidelines settings found
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  name:
                    example: Acme, Inc.
                    type: string
                  logo_url:
                    example: https://acme.com/logo.png
                    type:
                      - string
                      - 'null'
                  icon_url:
                    example: https://acme.com/icon.png
                    type:
                      - string
                      - 'null'
                  favicon_url:
                    example: https://acme.com/favicon.ico
                    type:
                      - string
                      - 'null'
                  color:
                    example: '#000000'
                    type:
                      - string
                      - 'null'
                  secondary_color:
                    example: '#666666'
                    type:
                      - string
                      - 'null'
                  default_og_image:
                    example: https://acme.com/og-image.png
                    type:
                      - string
                      - 'null'
                  default_fallback_image:
                    example: https://acme.com/fallback-image.png
                    type:
                      - string
                      - 'null'
                  default_og_description:
                    example: Acme, Inc.
                    type:
                      - string
                      - 'null'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - id
                  - meta
    patch:
      summary: Update brand guidelines settings with null values (clear operation)
      tags:
        - Brand Guidelines
      operationId: clearBrandGuidelines
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: Brand guidelines settings updated with null values (clear operation)
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  name:
                    example: Acme, Inc.
                    type: string
                  logo_url:
                    example: https://acme.com/logo.png
                    type:
                      - string
                      - 'null'
                  icon_url:
                    example: https://acme.com/icon.png
                    type:
                      - string
                      - 'null'
                  favicon_url:
                    example: https://acme.com/favicon.ico
                    type:
                      - string
                      - 'null'
                  color:
                    example: '#000000'
                    type:
                      - string
                      - 'null'
                  secondary_color:
                    example: '#666666'
                    type:
                      - string
                      - 'null'
                  default_og_image:
                    example: https://acme.com/og-image.png
                    type:
                      - string
                      - 'null'
                  default_fallback_image:
                    example: https://acme.com/fallback-image.png
                    type:
                      - string
                      - 'null'
                  default_og_description:
                    example: Acme, Inc.
                    type:
                      - string
                      - 'null'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - id
                  - meta
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                brand_guidelines:
                  type: object
                  properties:
                    id:
                      type:
                        - integer
                        - 'null'
                    name:
                      example: Acme, Inc.
                      type:
                        - string
                        - 'null'
                    logo_url:
                      example: https://acme.com/logo.png
                      type:
                        - string
                        - 'null'
                    icon_url:
                      example: https://acme.com/icon.png
                      type:
                        - string
                        - 'null'
                    favicon_url:
                      example: https://acme.com/favicon.ico
                      type:
                        - string
                        - 'null'
                    color:
                      example: '#000000'
                      type:
                        - string
                        - 'null'
                    secondary_color:
                      example: '#666666'
                      type:
                        - string
                        - 'null'
                    default_og_image:
                      example: https://acme.com/og-image.png
                      type:
                        - string
                        - 'null'
                    default_fallback_image:
                      example: https://acme.com/fallback-image.png
                      type:
                        - string
                        - 'null'
                    default_og_description:
                      example: Acme, Inc.
                      type:
                        - string
                        - 'null'
              required:
                - brand_guidelines
  /api/business_types:
    get:
      summary: List business types
      tags:
        - Business Types
      operationId: listCommerceBusinessTypes
      description: >-
        Get list of supported business types for company registration.
        Optionally filter by country code.
      security:
        - bearer_auth: []
      parameters:
        - name: country_code
          in: query
          required: false
          description: ISO 3166-1 alpha-2 country code (e.g., GB, US, CA, AU, MX, PH)
          example: GB
          schema:
            type: string
      responses:
        '200':
          description: Business types retrieved for specific country
          content:
            application/json:
              schema:
                type: object
                properties:
                  business_types:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                          example: CORPORATION
                        name:
                          type: string
                          example: The corporation
                        slug:
                          type: string
                          example: default_corporation
                      required:
                        - value
                        - name
                        - slug
                  meta:
                    type: object
                    properties:
                      request_id:
                        type:
                          - string
                          - 'null'
                        example: c8e25ea4-c230-47f2-9dd3-67320518efb7
                      timestamp:
                        type: string
                        example: '2025-09-16T04:01:05Z'
                    required:
                      - request_id
                      - timestamp
                required:
                  - business_types
                  - meta
        '422':
          description: Invalid country code format
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid country code format
                  errors:
                    type: object
                    example:
                      country_code:
                        - must be a valid ISO 3166-1 alpha-2 country code
                  meta:
                    type: object
                required:
                  - error_message
                  - errors
                  - meta
  /api/callback/definitions:
    get:
      summary: returns a list of callback definitions
      tags:
        - Callback Definitions
      security:
        - bearer_auth: []
      responses:
        '200':
          description: returns a list of callback definitions
          content:
            application/json:
              schema:
                type: object
                properties:
                  definitions:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                        description:
                          type: string
                        example_response:
                          type: object
                        request_schema:
                          type: object
                        response_schema:
                          type: object
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/callback/registrations:
    get:
      summary: List all registered callbacks
      tags:
        - Callback Registrations
      operationId: indexCallbackRegistrations
      security:
        - bearer_auth: []
      parameters:
        - name: filters
          in: query
          schema:
            type: object
            properties:
              page:
                type: integer
                exclusiveMinimum: 0
              per_page:
                type: integer
                exclusiveMinimum: 0
                maximum: 100
              company_id:
                type: integer
                not:
                  type: 'null'
              definition_name:
                type: string
                minLength: 1
              sorted_by:
                type: string
                minLength: 1
              active:
                type: boolean
                not:
                  type: 'null'
            required: []
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  callback_registrations:
                    type: array
                    items:
                      title: Callback::Registration
                      type: object
                      properties:
                        uuid:
                          example: cbr_wmo5nhb52xniux5pddignpwui1mgox1a
                          type: string
                        company_id:
                          example: 1
                          type:
                            - integer
                            - 'null'
                        company_name:
                          example: Acme
                          type: string
                        definition_name:
                          example: test_callback_system
                          type: string
                        url:
                          example: https://example.com/callback
                          type: string
                        verification_token:
                          example: cvt_fJwDMNVRvmstQY0EcztaBL2zivN5vnmP
                          type:
                            - string
                            - 'null'
                        active:
                          example: true
                          type:
                            - boolean
                            - 'null'
                          default: true
                        created_at:
                          example: '2021-01-01T00:00:00Z'
                          type: string
                          format: date-time
                        owner_type:
                          example: Droplet
                          type:
                            - string
                            - 'null'
                        owner_id:
                          example: 1
                          type:
                            - integer
                            - 'null'
                        owner_name:
                          example: Acme
                          type: string
                      required:
                        - uuid
                        - company_name
                        - definition_name
                        - url
                        - created_at
                        - owner_name
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      pagination:
                        type: object
                        properties:
                          current_page:
                            type: integer
                            example: 1
                          total_pages:
                            type: integer
                            example: 10
                          total_count:
                            type: integer
                            example: 100
                          per_page:
                            type: integer
                            example: 10
    post:
      summary: Create a new registered callback
      tags:
        - Callback Registrations
      operationId: createCallbackRegistration
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: created
          content:
            application/json:
              schema:
                type: object
                properties:
                  callback_registration:
                    title: Callback::Registration
                    type: object
                    properties:
                      uuid:
                        type: string
                      definition_name:
                        example: test_callback_system
                        type: string
                      url:
                        example: https://example.com/callback
                        type: string
                        pattern: ^https://
                      active:
                        example: true
                        type:
                          - boolean
                          - 'null'
                        default: true
                      verification_token:
                        example: cvt_1DbieBewYJ0VkIqQzsD1iWtnSrp6nPXTa
                        type:
                          - string
                          - 'null'
                      created_at:
                        example: '2021-01-01T00:00:00Z'
                        type: string
                        format: date-time
                    required:
                      - uuid
                      - definition_name
                      - url
                      - created_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: unprocessable entity
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                callback_registration:
                  type: object
                  properties:
                    definition_name:
                      type: string
                    url:
                      type: string
                    active:
                      type: boolean
                      not:
                        type: 'null'
                  required:
                    - definition_name
                    - url
              required:
                - callback_registration
  /api/callback/registrations/{uuid}:
    get:
      summary: Show a registered callback
      tags:
        - Callback Registrations
      operationId: showCallbackRegistration
      security:
        - bearer_auth: []
      parameters:
        - name: uuid
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  callback_registration:
                    title: Callback::Registration
                    type: object
                    properties:
                      uuid:
                        example: cbr_wmo5nhb52xniux5pddignpwui1mgox1a
                        type: string
                      company_id:
                        example: 1
                        type:
                          - integer
                          - 'null'
                      company_name:
                        example: Acme
                        type: string
                      definition_name:
                        example: test_callback_system
                        type: string
                      url:
                        example: https://example.com/callback
                        type: string
                      verification_token:
                        example: cvt_fJwDMNVRvmstQY0EcztaBL2zivN5vnmP
                        type:
                          - string
                          - 'null'
                      active:
                        example: true
                        type:
                          - boolean
                          - 'null'
                        default: true
                      created_at:
                        example: '2021-01-01T00:00:00Z'
                        type: string
                        format: date-time
                      owner_type:
                        example: Droplet
                        type:
                          - string
                          - 'null'
                      owner_id:
                        example: 1
                        type:
                          - integer
                          - 'null'
                      owner_name:
                        example: Acme
                        type: string
                    required:
                      - uuid
                      - company_name
                      - definition_name
                      - url
                      - created_at
                      - owner_name
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '404':
          description: not found
    put:
      summary: Update a registered callback
      tags:
        - Callback Registrations
      operationId: updateCallbackRegistration
      security:
        - bearer_auth: []
      parameters:
        - name: uuid
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  callback_registration:
                    title: Callback::Registration
                    type: object
                    properties:
                      uuid:
                        example: cbr_wmo5nhb52xniux5pddignpwui1mgox1a
                        type: string
                      definition_name:
                        example: test_callback_system
                        type: string
                      url:
                        example: https://example.com/callback
                        type: string
                        pattern: ^https://
                      active:
                        example: true
                        type:
                          - boolean
                          - 'null'
                        default: true
                      updated_at:
                        example: '2021-01-01T00:00:00Z'
                        type: string
                        format: date-time
                    required:
                      - uuid
                      - definition_name
                      - url
                      - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '404':
          description: not found
        '422':
          description: unprocessable entity
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                uuid:
                  type: string
                  minLength: 1
                callback_registration:
                  type: object
                  properties:
                    definition_name:
                      type: string
                      minLength: 1
                    url:
                      type: string
                      minLength: 1
                    active:
                      type: boolean
                      not:
                        type: 'null'
                  required: []
              required:
                - uuid
                - callback_registration
    delete:
      summary: Delete a registered callback
      tags:
        - Callback Registrations
      operationId: destroyCallbackRegistration
      security:
        - bearer_auth: []
      parameters:
        - name: uuid
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: deleted
        '404':
          description: not found
  /api/callback/schemas:
    get:
      summary: returns a list of callback schemas
      tags:
        - Callback Schemas
      security:
        - bearer_auth: []
      responses:
        '200':
          description: returns a list of callback schemas
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                        version:
                          type:
                            - string
                            - 'null'
                        schema_hash:
                          type:
                            - string
                            - 'null'
                        description:
                          type: string
                        request_schema:
                          type: object
                        response_schema:
                          type: object
                        example_response:
                          type: object
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
  /api/callback/schemas/{definition_name}:
    get:
      summary: returns the schema for a specific callback definition
      tags:
        - Callback Schemas
      security:
        - bearer_auth: []
      parameters:
        - name: definition_name
          in: path
          required: true
          description: The name of the callback definition to get the schema for
          schema:
            type: string
      responses:
        '200':
          description: returns the schema for the callback definition
          content:
            application/json:
              schema:
                type: object
                properties:
                  schema:
                    type: object
                    properties:
                      name:
                        type: string
                      version:
                        type:
                          - string
                          - 'null'
                      schema_hash:
                        type:
                          - string
                          - 'null'
                      description:
                        type: string
                      request_schema:
                        type: object
                      response_schema:
                        type: object
                      example_response:
                        type: object
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
        '404':
          description: definition name not found
  /api/carts/{cart_token}/append_metadata:
    patch:
      summary: Append metadata field
      tags:
        - Carts
      operationId: cartAppendMetadata
      description: Append metadata field(s) to a cart.
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      state:
                        type: string
                        example: start
                      processed:
                        type: boolean
                        example: false
                        description: >-
                          Determines if a cart payment has been processed or
                          not.
                      valid_for_checkout:
                        type: boolean
                        example: true
                      buyer_rep_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      buyer_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: buyer.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                              external_id:
                                type:
                                  - string
                                  - 'null'
                                example: '123241'
                            required:
                              - id
                          - type: 'null'
                      volume_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: volume.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                            required:
                              - id
                          - type: 'null'
                      currency_symbol:
                        type: string
                        example: $
                      currency_code:
                        type: string
                        example: USD
                      shipping_total_for_display:
                        type: string
                        example: Free
                      phone:
                        type:
                          - string
                          - 'null'
                        example: '4035551212'
                      payment_method_auto_assignable:
                        type: boolean
                        example: true
                        description: >-
                          Determines if a payment method can be auto-assigned to
                          the cart.
                      attribution:
                        oneOf:
                          - type: object
                            oneOf:
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  share_guid:
                                    type: string
                                    example: james-bond007
                                required:
                                  - id
                                  - share_guid
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  email:
                                    type: string
                                    example: james.bond@gmail.com
                                required:
                                  - id
                                  - email
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  username:
                                    type: string
                                    example: jaamball234
                                required:
                                  - id
                                  - username
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  fluid_rep_id:
                                    type: integer
                                    example: 23493
                                required:
                                  - id
                                  - fluid_rep_id
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: w3sdf92
                                required:
                                  - id
                          - type: 'null'
                        default:
                          id: 456
                          share_guid: james-bond007
                      agreements:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            required:
                              type: boolean
                              example: true
                            title:
                              type: string
                              example: Terms and Conditions
                            show_path:
                              type: string
                              example: /terms
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                      amount_total:
                        type: string
                        example: '121.65'
                      amount_total_in_currency:
                        type: string
                        example: $121.65 (USD)
                      sub_total:
                        type: string
                        example: '100.00'
                      sub_total_in_currency:
                        type: string
                        example: $100.00 (USD)
                      subtotal_after_discounts:
                        type: string
                        example: '90.00'
                      tax_total:
                        type: string
                        example: '20.00'
                      tax_total_in_currency:
                        type: string
                        example: $20.00 (USD)
                      shipping_total:
                        type:
                          - string
                          - 'null'
                        example: '1.65'
                      shipping_total_in_currency:
                        type: string
                        example: $1.65 (USD)
                      shipping_discount:
                        type: number
                        example: 10.25
                      discount_total:
                        type: string
                        example: '2.99'
                      discount_total_in_currency:
                        type: string
                        example: $2.99 (USD)
                      discount_breakdown:
                        type: object
                        properties:
                          internal_discounts:
                            type: number
                            example: 15
                          external_discounts:
                            type: number
                            example: 10
                          total_discounts:
                            type: number
                            example: 25
                      external_discount:
                        type: object
                        properties:
                          total:
                            type: number
                            example: 10
                          calculated_at:
                            type:
                              - string
                              - 'null'
                            format: date-time
                            example: '2024-01-10T15:30:00Z'
                          sources:
                            type: object
                            additionalProperties:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 6
                                description:
                                  type: string
                                  example: Gold tier discount
                                metadata:
                                  type: object
                              required:
                                - amount
                                - description
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: '1.90'
                      transaction_fee_in_currency:
                        type: string
                        example: $1.90 (USD)
                      cv_total:
                        type: integer
                        example: 10
                      qv_total:
                        type: integer
                        example: 15
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      payment_account:
                        type:
                          - string
                          - 'null'
                        example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                      payment_method:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: CreditCard
                              payment_method_type:
                                type: string
                                example: visa
                              last_four:
                                type: string
                                example: '1234'
                              exp_month:
                                type: string
                                example: '12'
                              exp_year:
                                type: string
                                example: '2025'
                              logo_url:
                                type: string
                                example: https://example.com/image.svg
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Paypal
                              status:
                                type: string
                                example: active
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Affirm
                              affirm_id:
                                type: string
                                example: affirm_123
                              status:
                                type: string
                                example: authorized
                              checkout_id:
                                type: string
                                example: checkout_456
                              created:
                                type: string
                                example: '2025-01-01T00:00:00Z'
                              auth_expiration:
                                type: string
                                example: '2025-01-02T00:00:00Z'
                              currency:
                                type: string
                                example: USD
                              amount:
                                type: string
                                example: '100.00'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Klarna
                              session_id:
                                type: string
                                example: klarna_session_789
                              intent:
                                type: string
                                example: buy
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Droplet
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: SomeCitcon
                      email:
                        type:
                          - string
                          - 'null'
                        example: user@example.com
                      enrollment_fee:
                        type:
                          - number
                          - string
                        example: '10.45'
                      enrollment_fee_in_currency:
                        type: string
                        example: $10.45
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT10
                          - DISCOUNT11
                      language_iso:
                        type:
                          - string
                          - 'null'
                        example: en
                      cart_token:
                        type: string
                        example: abc123
                      immutable_items:
                        type: boolean
                        example: false
                      digital_only:
                        type: boolean
                        example: false
                      requires_3ds:
                        type: boolean
                        example: false
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 101
                            price:
                              type: string
                              example: '43.41'
                            price_in_currency:
                              type: string
                              example: $43.41
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            cv:
                              type: integer
                              example: 5
                            cv_total:
                              type: integer
                              example: 15
                            qv:
                              type: integer
                              example: 7
                            qv_total:
                              type: integer
                              example: 21
                            discount_amount:
                              type: string
                              example: '10'
                            free_item:
                              type: boolean
                              example: false
                            discount_amount_in_currency:
                              type: string
                              example: $10.00
                            total_after_discounts:
                              type: string
                              example: '90.00'
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            product_title:
                              type:
                                - string
                                - 'null'
                              example: Sample Product
                            quantity:
                              type: integer
                              example: 3
                            subscription:
                              type: boolean
                              example: true
                            enrollment:
                              type: boolean
                              example: false
                            allow_subscription:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_plan_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_plans:
                              oneOf:
                                - type: array
                                  items:
                                    title: Commerce::SubscriptionPlan
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        example: Test Subscription Plan
                                        type: string
                                      billing_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      billing_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      billing_frequency_in_words:
                                        example: 2 Months
                                        type: string
                                      shipping_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      shipping_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      volume_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      volume_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      trial_period:
                                        example: 1
                                        type:
                                          - integer
                                          - 'null'
                                        minimum: 1
                                      trial_period_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type:
                                          - string
                                          - 'null'
                                      split_volume:
                                        example: true
                                        type: boolean
                                        default: false
                                      allow_max_billing_cycles:
                                        example: true
                                        type: boolean
                                        default: false
                                      max_billing_cycles:
                                        example: 3
                                        type:
                                          - integer
                                          - 'null'
                                      company_default:
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                        default: false
                                      products_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      subscribers_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      price:
                                        type: string
                                      price_in_currency:
                                        type: string
                                      subscription_start:
                                        type: string
                                      subscribe_and_save:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_in_currency:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_for_display:
                                        type:
                                          - string
                                          - 'null'
                                    required:
                                      - id
                                      - name
                                      - billing_interval
                                      - billing_interval_unit
                                      - billing_frequency_in_words
                                      - shipping_interval
                                      - shipping_interval_unit
                                      - volume_interval
                                      - volume_interval_unit
                                      - split_volume
                                      - allow_max_billing_cycles
                                      - price
                                      - price_in_currency
                                      - subscription_start
                                      - subscribe_and_save
                                      - subscribe_and_save_in_currency
                                      - subscribe_and_save_for_display
                                - type: 'null'
                            subscription_only:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_interval:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_interval_unit:
                              type:
                                - string
                                - 'null'
                              example: month
                            subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 10.5
                            subscription_price_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $10.50
                            subscription_start:
                              type:
                                - string
                                - 'null'
                              example: '2025-02-12'
                            subscribe_and_save:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 2.99
                            subscribe_and_save_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $2.99
                            subscribe_and_save_for_display:
                              type:
                                - string
                                - 'null'
                              example: Subscribe and save $2.99
                            title:
                              type:
                                - string
                                - 'null'
                              example: Surcharge
                            metadata:
                              type: object
                              description: >-
                                A JSON object that can store any custom data
                                structure
                              example: {}
                            product:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type: string
                                      example: Sample Product
                                    introduction:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Product Description
                                    cv:
                                      type: integer
                                      example: 10
                                    external_id:
                                      type:
                                        - string
                                        - 'null'
                                      example: ext-prod-123
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/product.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/product.png
                                    price:
                                      type: string
                                      example: '29.99'
                                    price_in_currency:
                                      type: string
                                      example: $29.99
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    tax:
                                      type: string
                                      example: '2.99'
                                    tax_in_currency:
                                      type: string
                                      example: $2.99
                                    metadata:
                                      type: object
                                      example:
                                        shopify_product_id: 9876054868270
                                    metafields:
                                      type: array
                                      items:
                                        title: LegacyMetafield
                                        type: object
                                        properties:
                                          namespace:
                                            description: >-
                                              A container for related metafields.
                                              Commonly used to group metafields by app
                                              or functionality.
                                            example: custom
                                            type: string
                                            maxLength: 20
                                            pattern: ^[a-zA-Z0-9_]+$
                                          key:
                                            description: >-
                                              The unique identifier for the metafield
                                              within its namespace. Must be unique per
                                              namespace and owner.
                                            example: material
                                            type: string
                                            maxLength: 30
                                            pattern: ^[a-zA-Z0-9_]+$
                                          value:
                                            description: >-
                                              The actual data stored in the metafield.
                                              Type depends on value_type.
                                            example: cotton
                                            type:
                                              - string
                                              - integer
                                              - object
                                              - boolean
                                              - number
                                          value_type:
                                            description: >-
                                              The data type that defines how the value
                                              should be interpreted and validated.
                                            example: single_line_text_field
                                            type: string
                                          description:
                                            description: >-
                                              Optional human-readable description
                                              explaining the purpose of this
                                              metafield.
                                            example: >-
                                              The primary material used in this
                                              product
                                            type:
                                              - string
                                              - 'null'
                                          created_at:
                                            description: >-
                                              Timestamp when the metafield was
                                              created.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          updated_at:
                                            description: >-
                                              Timestamp when the metafield was last
                                              updated.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          locked:
                                            description: >-
                                              Whether this metafield is locked and
                                              cannot be updated or deleted directly.
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                              - 'null'
                                          metafield_definition:
                                            description: >-
                                              The definition that defines validation
                                              rules and structure for this metafield
                                            type:
                                              - 'null'
                                              - object
                                        required:
                                          - namespace
                                          - key
                                          - value
                                          - value_type
                                          - description
                                          - created_at
                                          - updated_at
                                          - metafield_definition
                                - type: 'null'
                            variant:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Variant
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/sample.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/sample.png
                                    primary_image:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/primary.png
                                    price:
                                      type:
                                        - string
                                        - 'null'
                                      example: '34.44'
                                    price_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $34.44
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    options:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          title:
                                            type: string
                                            example: Size
                                          value:
                                            type: string
                                            example: XL
                                    physical:
                                      type:
                                        - boolean
                                        - 'null'
                                      example: true
                                    unit_of_size:
                                      type:
                                        - string
                                        - 'null'
                                      example: cm
                                    height:
                                      type:
                                        - number
                                        - 'null'
                                      example: 13
                                    width:
                                      type:
                                        - number
                                        - 'null'
                                      example: 6
                                    length:
                                      type:
                                        - number
                                        - 'null'
                                      example: 12
                                    unit_of_weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: kg
                                    weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                    hs_code:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                - type: 'null'
                            errors:
                              oneOf:
                                - type: 'null'
                                - type: array
                                  items:
                                    type: object
                                  example:
                                    - country:
                                        - >-
                                          This product is not available for this
                                          country. Please change your country
                            bundled_items:
                              type: array
                              items:
                                type: object
                                description: Bundled items for bundle products
                                properties:
                                  variant_id:
                                    type: integer
                                    example: 1
                                  product_id:
                                    type: integer
                                    example: 1
                                  product_title:
                                    type: string
                                    example: Product Title
                                  variant_title:
                                    type: string
                                    example: Variant Title
                                  option_titles:
                                    type: array
                                    example:
                                      - Option 1
                                      - Option 2
                                  quantity:
                                    type: integer
                                    example: 1
                                  display_to_customer:
                                    type: boolean
                                    example: true
                      ship_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      bill_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      shipping_method:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: string
                            example: standard-shipping
                          name:
                            type: string
                            example: Standard Shipping
                      available_shipping_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: standard-shipping
                            title:
                              type: string
                              example: Standard Shipping
                            price:
                              type:
                                - number
                                - string
                              example: 5.99
                            price_label:
                              type: string
                              example: $5.99
                            delivery_time_estimate:
                              type: string
                              example: 3-5 business days
                      available_payment_methods:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - credit_card
                                name:
                                  type: string
                                  example: Credit Card
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                apple_pay:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method supports
                                    ApplePay or not 
                                bogus_gateway:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is a Bogus
                                    instance or not.
                                tokenize_path:
                                  type:
                                    - string
                                    - 'null'
                                  description: Path to tokenize, if applicable.
                                token_provider:
                                  type: string
                                  enum:
                                    - spreedly
                                    - vgs
                                  description: >-
                                    Determines if payment tokenization is via
                                    spreedly or VGS
                                apple_pay_merchant_identifier:
                                  type:
                                    - string
                                    - 'null'
                                  example: merchant.mycompany.com
                                  description: >-
                                    If ApplePay is supported, returns the
                                    merchant identifier registered with Apple,
                                    else returns nil
                                supported_brands:
                                  type: array
                                  items:
                                    type: string
                                  example:
                                    - visa
                                    - master
                                    - american_express
                                    - discover
                                publishable_key:
                                  type:
                                    - string
                                    - 'null'
                                  example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                  description: >-
                                    If publishable key is set for Hyperswitch,
                                    returns the publishable key, else returns
                                    nil
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                              required:
                                - id
                                - type
                                - name
                                - supported_brands
                                - test
                                - sandbox
                                - apple_pay
                                - apple_pay_merchant_identifier
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - klarna
                                name:
                                  type: string
                                  example: Klarna
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                      country:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          iso:
                            type: string
                            example: US
                          name:
                            type: string
                            example: United States
                          iso_name:
                            type: string
                            example: UNITED STATES
                          iso3:
                            type: string
                            example: USA
                          currency_code:
                            type: string
                            example: USD
                          currency_symbol:
                            type: string
                            example: $
                          province_required:
                            type: boolean
                            example: false
                          tax_enabled:
                            type:
                              - boolean
                              - 'null'
                            example: true
                          price_inclusive_of_tax:
                            type: boolean
                            example: false
                          price_inclusive_tax_name:
                            type:
                              - string
                              - 'null'
                            example: VAT
                      type:
                        type: string
                        enum:
                          - regular
                          - enrollment
                        example: regular
                      enrollment_pack_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      enrollment_pack:
                        type:
                          - object
                          - 'null'
                        properties:
                          enrollment_pack_id:
                            type: integer
                            example: 1
                          additional_volume:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          slug:
                            type: string
                            example: test-enrollment-pack
                          description:
                            type:
                              - object
                              - 'null'
                              - string
                            properties:
                              id:
                                type: integer
                                example: 111
                              name:
                                type: string
                                example: description
                              body:
                                type: string
                                example: >-
                                  <div>Try the latest and greatest of our sugar
                                  zip packs. Guaranteed to make you skinner and
                                  cure cancer.</div>
                              record_type:
                                type: string
                                example: EnrollmentPack
                              record_id:
                                type: integer
                                example: 1
                              created_at:
                                type: string
                                format: date_time
                                example: '2025-01-16T04:22:43.809Z'
                              updated_at:
                                type: string
                                format: date_time
                                example: '2025-01-22T10:23:52.941Z'
                              locale:
                                type: string
                                example: en
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: 10
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.00
                          images:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2
                                relateable_type:
                                  type: string
                                  example: EnrollmentPack
                                relateable_id:
                                  type: integer
                                  example: 1
                                image_url:
                                  type: string
                                  example: >-
                                    https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                image_path:
                                  type: string
                                  example: jITWaU14QGe0y5AFgY7P_00179.svg
                                position:
                                  type: integer
                                  example: 1
                                shopify_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                                created_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                updated_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                external_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 625
                                allow_subscription:
                                  type: boolean
                                  example: true
                                cv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                cv_in_currency:
                                  type: string
                                  example: $0.00
                                cv_total:
                                  type: integer
                                  example: 0
                                enrollment:
                                  type: boolean
                                  example: true
                                enrollment_pack_id:
                                  type: integer
                                  example: 1
                                price:
                                  type: string
                                  example: '11.13'
                                price_in_currency:
                                  type: string
                                  example: $11.13
                                product_title:
                                  type: string
                                  example: Zip Pack Sample Pack (30)
                                quantity:
                                  type: integer
                                  example: 1
                                qv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                qv_in_currency:
                                  type: string
                                  example: $0.00
                                qv_total:
                                  type: integer
                                  example: 0
                                subscribe_and_save:
                                  type:
                                    - string
                                    - 'null'
                                  example: '-1988.87'
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $-1,988.87
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $-1,988.87
                                subscription:
                                  type: boolean
                                  example: false
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_only:
                                  type: boolean
                                  example: false
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_price:
                                  type: string
                                  example: '2000.0'
                                subscription_price_in_currency:
                                  type: string
                                  example: $2,000.00
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  format: date
                                  example: '2025-02-28'
                                tax:
                                  type: string
                                  example: '0.0'
                                tax_in_currency:
                                  type: string
                                  example: $0.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: null
                                display_to_customer:
                                  type: boolean
                                  example: false
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                          price:
                            type: string
                            example: '11.13'
                          price_in_currency:
                            type: string
                            example: $11.13
                          subscription_price:
                            type:
                              - string
                              - integer
                            example: 2000
                          subscription_price_in_currency:
                            type: string
                            example: $2,000.00
                          title:
                            type: string
                            example: enroll product
                          token:
                            type: string
                            example: NxL22AqLRRisfyF9LqxxWRak
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      recurring:
                        oneOf:
                          - type: array
                            items:
                              type: object
                              properties:
                                subtotal:
                                  type: string
                                  example: '10.0'
                                subtotal_in_currency:
                                  type: string
                                  example: $10.0
                                interval:
                                  type: integer
                                  example: 1
                                interval_unit:
                                  type: string
                                  example: month
                                subtotal_for_display:
                                  type: string
                                  example: $10.00 every 1 month
                                start_date:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-05-27'
                          - type: 'null'
                        default:
                          - subtotal: '10.0'
                            subtotal_in_currency: $10.0
                            interval: 1
                            interval_unit: month
                            subtotal_for_display: $10.00 every 1 month
                            start_date: '2025-05-27'
                      messages:
                        type: object
                        additionalProperties: true
                        example:
                          errors:
                            - Insufficient inventory
                            - Product no longer available
                          warnings:
                            - Low stock warning
                            - Shipping delays expected
                          info:
                            - Free shipping available
                            - Volume discount applied
                      points_enabled:
                        type: boolean
                        example: true
                      points_applied:
                        type: integer
                        example: 500
                        description: Number of points applied to the cart
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Currency value of applied points
                      customer_total_points:
                        type: integer
                        example: 1000
                        description: Customer's total available points balance
                      customer_total_points_in_currency:
                        type: number
                        example: 10
                        description: Currency value of available points
                      remaining_customer_points:
                        type: integer
                        example: 500
                        description: Customer's remaining points after cart redemption
                      remaining_customer_points_amount_in_currency:
                        type: number
                        example: 5
                        description: >-
                          Currency value of remaining points after cart
                          redemption
                      remaining_cart_amount_after_points:
                        type: number
                        example: 95
                        description: Amount to charge to card after points redemption
                      remaining_cart_amount_after_points_in_currency:
                        type:
                          - string
                        example: $95.00
                        description: >-
                          Amount in currency to charge to card after points
                          redemption
                      max_applicable_points:
                        type: integer
                        example: 500
                        description: Maximum points that can be applied to this cart
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      checkout_url:
                        type: string
                        example: https://checkout.fluid.com/checkout?jwt=abc123
                      shop_url:
                        type: string
                        example: https://myco.fluid.app
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    properties:
                      cart:
                        type: array
                        items:
                          type: string
                        example:
                          - Cart not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                metadata:
                  type: object
                  description: >-
                    A JSON object that can store any custom data structure. When
                    provided, merges with existing metadata data.
              required:
                - metadata
  /api/carts/{cart_token}/remove_metadata:
    patch:
      summary: Remove metadata fields
      tags:
        - Carts
      operationId: cartRemoveMetadata
      description: Remove metadata field(s) from a cart
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      state:
                        type: string
                        example: start
                      processed:
                        type: boolean
                        example: false
                        description: >-
                          Determines if a cart payment has been processed or
                          not.
                      valid_for_checkout:
                        type: boolean
                        example: true
                      buyer_rep_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      buyer_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: buyer.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                              external_id:
                                type:
                                  - string
                                  - 'null'
                                example: '123241'
                            required:
                              - id
                          - type: 'null'
                      volume_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: volume.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                            required:
                              - id
                          - type: 'null'
                      currency_symbol:
                        type: string
                        example: $
                      currency_code:
                        type: string
                        example: USD
                      shipping_total_for_display:
                        type: string
                        example: Free
                      phone:
                        type:
                          - string
                          - 'null'
                        example: '4035551212'
                      payment_method_auto_assignable:
                        type: boolean
                        example: true
                        description: >-
                          Determines if a payment method can be auto-assigned to
                          the cart.
                      attribution:
                        oneOf:
                          - type: object
                            oneOf:
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  share_guid:
                                    type: string
                                    example: james-bond007
                                required:
                                  - id
                                  - share_guid
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  email:
                                    type: string
                                    example: james.bond@gmail.com
                                required:
                                  - id
                                  - email
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  username:
                                    type: string
                                    example: jaamball234
                                required:
                                  - id
                                  - username
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  fluid_rep_id:
                                    type: integer
                                    example: 23493
                                required:
                                  - id
                                  - fluid_rep_id
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: w3sdf92
                                required:
                                  - id
                          - type: 'null'
                        default:
                          id: 456
                          share_guid: james-bond007
                      agreements:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            required:
                              type: boolean
                              example: true
                            title:
                              type: string
                              example: Terms and Conditions
                            show_path:
                              type: string
                              example: /terms
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                      amount_total:
                        type: string
                        example: '121.65'
                      amount_total_in_currency:
                        type: string
                        example: $121.65 (USD)
                      sub_total:
                        type: string
                        example: '100.00'
                      sub_total_in_currency:
                        type: string
                        example: $100.00 (USD)
                      subtotal_after_discounts:
                        type: string
                        example: '90.00'
                      tax_total:
                        type: string
                        example: '20.00'
                      tax_total_in_currency:
                        type: string
                        example: $20.00 (USD)
                      shipping_total:
                        type:
                          - string
                          - 'null'
                        example: '1.65'
                      shipping_total_in_currency:
                        type: string
                        example: $1.65 (USD)
                      shipping_discount:
                        type: number
                        example: 10.25
                      discount_total:
                        type: string
                        example: '2.99'
                      discount_total_in_currency:
                        type: string
                        example: $2.99 (USD)
                      discount_breakdown:
                        type: object
                        properties:
                          internal_discounts:
                            type: number
                            example: 15
                          external_discounts:
                            type: number
                            example: 10
                          total_discounts:
                            type: number
                            example: 25
                      external_discount:
                        type: object
                        properties:
                          total:
                            type: number
                            example: 10
                          calculated_at:
                            type:
                              - string
                              - 'null'
                            format: date-time
                            example: '2024-01-10T15:30:00Z'
                          sources:
                            type: object
                            additionalProperties:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 6
                                description:
                                  type: string
                                  example: Gold tier discount
                                metadata:
                                  type: object
                              required:
                                - amount
                                - description
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: '1.90'
                      transaction_fee_in_currency:
                        type: string
                        example: $1.90 (USD)
                      cv_total:
                        type: integer
                        example: 10
                      qv_total:
                        type: integer
                        example: 15
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      payment_account:
                        type:
                          - string
                          - 'null'
                        example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                      payment_method:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: CreditCard
                              payment_method_type:
                                type: string
                                example: visa
                              last_four:
                                type: string
                                example: '1234'
                              exp_month:
                                type: string
                                example: '12'
                              exp_year:
                                type: string
                                example: '2025'
                              logo_url:
                                type: string
                                example: https://example.com/image.svg
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Paypal
                              status:
                                type: string
                                example: active
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Affirm
                              affirm_id:
                                type: string
                                example: affirm_123
                              status:
                                type: string
                                example: authorized
                              checkout_id:
                                type: string
                                example: checkout_456
                              created:
                                type: string
                                example: '2025-01-01T00:00:00Z'
                              auth_expiration:
                                type: string
                                example: '2025-01-02T00:00:00Z'
                              currency:
                                type: string
                                example: USD
                              amount:
                                type: string
                                example: '100.00'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Klarna
                              session_id:
                                type: string
                                example: klarna_session_789
                              intent:
                                type: string
                                example: buy
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Droplet
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: SomeCitcon
                      email:
                        type:
                          - string
                          - 'null'
                        example: user@example.com
                      enrollment_fee:
                        type:
                          - number
                          - string
                        example: '10.45'
                      enrollment_fee_in_currency:
                        type: string
                        example: $10.45
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT10
                          - DISCOUNT11
                      language_iso:
                        type:
                          - string
                          - 'null'
                        example: en
                      cart_token:
                        type: string
                        example: abc123
                      immutable_items:
                        type: boolean
                        example: false
                      digital_only:
                        type: boolean
                        example: false
                      requires_3ds:
                        type: boolean
                        example: false
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 101
                            price:
                              type: string
                              example: '43.41'
                            price_in_currency:
                              type: string
                              example: $43.41
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            cv:
                              type: integer
                              example: 5
                            cv_total:
                              type: integer
                              example: 15
                            qv:
                              type: integer
                              example: 7
                            qv_total:
                              type: integer
                              example: 21
                            discount_amount:
                              type: string
                              example: '10'
                            free_item:
                              type: boolean
                              example: false
                            discount_amount_in_currency:
                              type: string
                              example: $10.00
                            total_after_discounts:
                              type: string
                              example: '90.00'
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            product_title:
                              type:
                                - string
                                - 'null'
                              example: Sample Product
                            quantity:
                              type: integer
                              example: 3
                            subscription:
                              type: boolean
                              example: true
                            enrollment:
                              type: boolean
                              example: false
                            allow_subscription:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_plan_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_plans:
                              oneOf:
                                - type: array
                                  items:
                                    title: Commerce::SubscriptionPlan
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        example: Test Subscription Plan
                                        type: string
                                      billing_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      billing_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      billing_frequency_in_words:
                                        example: 2 Months
                                        type: string
                                      shipping_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      shipping_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      volume_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      volume_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      trial_period:
                                        example: 1
                                        type:
                                          - integer
                                          - 'null'
                                        minimum: 1
                                      trial_period_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type:
                                          - string
                                          - 'null'
                                      split_volume:
                                        example: true
                                        type: boolean
                                        default: false
                                      allow_max_billing_cycles:
                                        example: true
                                        type: boolean
                                        default: false
                                      max_billing_cycles:
                                        example: 3
                                        type:
                                          - integer
                                          - 'null'
                                      company_default:
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                        default: false
                                      products_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      subscribers_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      price:
                                        type: string
                                      price_in_currency:
                                        type: string
                                      subscription_start:
                                        type: string
                                      subscribe_and_save:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_in_currency:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_for_display:
                                        type:
                                          - string
                                          - 'null'
                                    required:
                                      - id
                                      - name
                                      - billing_interval
                                      - billing_interval_unit
                                      - billing_frequency_in_words
                                      - shipping_interval
                                      - shipping_interval_unit
                                      - volume_interval
                                      - volume_interval_unit
                                      - split_volume
                                      - allow_max_billing_cycles
                                      - price
                                      - price_in_currency
                                      - subscription_start
                                      - subscribe_and_save
                                      - subscribe_and_save_in_currency
                                      - subscribe_and_save_for_display
                                - type: 'null'
                            subscription_only:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_interval:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_interval_unit:
                              type:
                                - string
                                - 'null'
                              example: month
                            subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 10.5
                            subscription_price_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $10.50
                            subscription_start:
                              type:
                                - string
                                - 'null'
                              example: '2025-02-12'
                            subscribe_and_save:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 2.99
                            subscribe_and_save_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $2.99
                            subscribe_and_save_for_display:
                              type:
                                - string
                                - 'null'
                              example: Subscribe and save $2.99
                            title:
                              type:
                                - string
                                - 'null'
                              example: Surcharge
                            metadata:
                              type: object
                              description: >-
                                A JSON object that can store any custom data
                                structure
                              example: {}
                            product:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type: string
                                      example: Sample Product
                                    introduction:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Product Description
                                    cv:
                                      type: integer
                                      example: 10
                                    external_id:
                                      type:
                                        - string
                                        - 'null'
                                      example: ext-prod-123
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/product.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/product.png
                                    price:
                                      type: string
                                      example: '29.99'
                                    price_in_currency:
                                      type: string
                                      example: $29.99
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    tax:
                                      type: string
                                      example: '2.99'
                                    tax_in_currency:
                                      type: string
                                      example: $2.99
                                    metadata:
                                      type: object
                                      example:
                                        shopify_product_id: 9876054868270
                                    metafields:
                                      type: array
                                      items:
                                        title: LegacyMetafield
                                        type: object
                                        properties:
                                          namespace:
                                            description: >-
                                              A container for related metafields.
                                              Commonly used to group metafields by app
                                              or functionality.
                                            example: custom
                                            type: string
                                            maxLength: 20
                                            pattern: ^[a-zA-Z0-9_]+$
                                          key:
                                            description: >-
                                              The unique identifier for the metafield
                                              within its namespace. Must be unique per
                                              namespace and owner.
                                            example: material
                                            type: string
                                            maxLength: 30
                                            pattern: ^[a-zA-Z0-9_]+$
                                          value:
                                            description: >-
                                              The actual data stored in the metafield.
                                              Type depends on value_type.
                                            example: cotton
                                            type:
                                              - string
                                              - integer
                                              - object
                                              - boolean
                                              - number
                                          value_type:
                                            description: >-
                                              The data type that defines how the value
                                              should be interpreted and validated.
                                            example: single_line_text_field
                                            type: string
                                          description:
                                            description: >-
                                              Optional human-readable description
                                              explaining the purpose of this
                                              metafield.
                                            example: >-
                                              The primary material used in this
                                              product
                                            type:
                                              - string
                                              - 'null'
                                          created_at:
                                            description: >-
                                              Timestamp when the metafield was
                                              created.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          updated_at:
                                            description: >-
                                              Timestamp when the metafield was last
                                              updated.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          locked:
                                            description: >-
                                              Whether this metafield is locked and
                                              cannot be updated or deleted directly.
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                              - 'null'
                                          metafield_definition:
                                            description: >-
                                              The definition that defines validation
                                              rules and structure for this metafield
                                            type:
                                              - 'null'
                                              - object
                                        required:
                                          - namespace
                                          - key
                                          - value
                                          - value_type
                                          - description
                                          - created_at
                                          - updated_at
                                          - metafield_definition
                                - type: 'null'
                            variant:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Variant
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/sample.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/sample.png
                                    primary_image:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/primary.png
                                    price:
                                      type:
                                        - string
                                        - 'null'
                                      example: '34.44'
                                    price_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $34.44
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    options:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          title:
                                            type: string
                                            example: Size
                                          value:
                                            type: string
                                            example: XL
                                    physical:
                                      type:
                                        - boolean
                                        - 'null'
                                      example: true
                                    unit_of_size:
                                      type:
                                        - string
                                        - 'null'
                                      example: cm
                                    height:
                                      type:
                                        - number
                                        - 'null'
                                      example: 13
                                    width:
                                      type:
                                        - number
                                        - 'null'
                                      example: 6
                                    length:
                                      type:
                                        - number
                                        - 'null'
                                      example: 12
                                    unit_of_weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: kg
                                    weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                    hs_code:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                - type: 'null'
                            errors:
                              oneOf:
                                - type: 'null'
                                - type: array
                                  items:
                                    type: object
                                  example:
                                    - country:
                                        - >-
                                          This product is not available for this
                                          country. Please change your country
                            bundled_items:
                              type: array
                              items:
                                type: object
                                description: Bundled items for bundle products
                                properties:
                                  variant_id:
                                    type: integer
                                    example: 1
                                  product_id:
                                    type: integer
                                    example: 1
                                  product_title:
                                    type: string
                                    example: Product Title
                                  variant_title:
                                    type: string
                                    example: Variant Title
                                  option_titles:
                                    type: array
                                    example:
                                      - Option 1
                                      - Option 2
                                  quantity:
                                    type: integer
                                    example: 1
                                  display_to_customer:
                                    type: boolean
                                    example: true
                      ship_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      bill_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      shipping_method:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: string
                            example: standard-shipping
                          name:
                            type: string
                            example: Standard Shipping
                      available_shipping_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: standard-shipping
                            title:
                              type: string
                              example: Standard Shipping
                            price:
                              type:
                                - number
                                - string
                              example: 5.99
                            price_label:
                              type: string
                              example: $5.99
                            delivery_time_estimate:
                              type: string
                              example: 3-5 business days
                      available_payment_methods:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - credit_card
                                name:
                                  type: string
                                  example: Credit Card
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                apple_pay:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method supports
                                    ApplePay or not 
                                bogus_gateway:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is a Bogus
                                    instance or not.
                                tokenize_path:
                                  type:
                                    - string
                                    - 'null'
                                  description: Path to tokenize, if applicable.
                                token_provider:
                                  type: string
                                  enum:
                                    - spreedly
                                    - vgs
                                  description: >-
                                    Determines if payment tokenization is via
                                    spreedly or VGS
                                apple_pay_merchant_identifier:
                                  type:
                                    - string
                                    - 'null'
                                  example: merchant.mycompany.com
                                  description: >-
                                    If ApplePay is supported, returns the
                                    merchant identifier registered with Apple,
                                    else returns nil
                                supported_brands:
                                  type: array
                                  items:
                                    type: string
                                  example:
                                    - visa
                                    - master
                                    - american_express
                                    - discover
                                publishable_key:
                                  type:
                                    - string
                                    - 'null'
                                  example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                  description: >-
                                    If publishable key is set for Hyperswitch,
                                    returns the publishable key, else returns
                                    nil
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                              required:
                                - id
                                - type
                                - name
                                - supported_brands
                                - test
                                - sandbox
                                - apple_pay
                                - apple_pay_merchant_identifier
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - klarna
                                name:
                                  type: string
                                  example: Klarna
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                      country:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          iso:
                            type: string
                            example: US
                          name:
                            type: string
                            example: United States
                          iso_name:
                            type: string
                            example: UNITED STATES
                          iso3:
                            type: string
                            example: USA
                          currency_code:
                            type: string
                            example: USD
                          currency_symbol:
                            type: string
                            example: $
                          province_required:
                            type: boolean
                            example: false
                          tax_enabled:
                            type:
                              - boolean
                              - 'null'
                            example: true
                          price_inclusive_of_tax:
                            type: boolean
                            example: false
                          price_inclusive_tax_name:
                            type:
                              - string
                              - 'null'
                            example: VAT
                      type:
                        type: string
                        enum:
                          - regular
                          - enrollment
                        example: regular
                      enrollment_pack_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      enrollment_pack:
                        type:
                          - object
                          - 'null'
                        properties:
                          enrollment_pack_id:
                            type: integer
                            example: 1
                          additional_volume:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          slug:
                            type: string
                            example: test-enrollment-pack
                          description:
                            type:
                              - object
                              - 'null'
                              - string
                            properties:
                              id:
                                type: integer
                                example: 111
                              name:
                                type: string
                                example: description
                              body:
                                type: string
                                example: >-
                                  <div>Try the latest and greatest of our sugar
                                  zip packs. Guaranteed to make you skinner and
                                  cure cancer.</div>
                              record_type:
                                type: string
                                example: EnrollmentPack
                              record_id:
                                type: integer
                                example: 1
                              created_at:
                                type: string
                                format: date_time
                                example: '2025-01-16T04:22:43.809Z'
                              updated_at:
                                type: string
                                format: date_time
                                example: '2025-01-22T10:23:52.941Z'
                              locale:
                                type: string
                                example: en
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: 10
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.00
                          images:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2
                                relateable_type:
                                  type: string
                                  example: EnrollmentPack
                                relateable_id:
                                  type: integer
                                  example: 1
                                image_url:
                                  type: string
                                  example: >-
                                    https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                image_path:
                                  type: string
                                  example: jITWaU14QGe0y5AFgY7P_00179.svg
                                position:
                                  type: integer
                                  example: 1
                                shopify_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                                created_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                updated_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                external_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 625
                                allow_subscription:
                                  type: boolean
                                  example: true
                                cv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                cv_in_currency:
                                  type: string
                                  example: $0.00
                                cv_total:
                                  type: integer
                                  example: 0
                                enrollment:
                                  type: boolean
                                  example: true
                                enrollment_pack_id:
                                  type: integer
                                  example: 1
                                price:
                                  type: string
                                  example: '11.13'
                                price_in_currency:
                                  type: string
                                  example: $11.13
                                product_title:
                                  type: string
                                  example: Zip Pack Sample Pack (30)
                                quantity:
                                  type: integer
                                  example: 1
                                qv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                qv_in_currency:
                                  type: string
                                  example: $0.00
                                qv_total:
                                  type: integer
                                  example: 0
                                subscribe_and_save:
                                  type:
                                    - string
                                    - 'null'
                                  example: '-1988.87'
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $-1,988.87
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $-1,988.87
                                subscription:
                                  type: boolean
                                  example: false
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_only:
                                  type: boolean
                                  example: false
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_price:
                                  type: string
                                  example: '2000.0'
                                subscription_price_in_currency:
                                  type: string
                                  example: $2,000.00
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  format: date
                                  example: '2025-02-28'
                                tax:
                                  type: string
                                  example: '0.0'
                                tax_in_currency:
                                  type: string
                                  example: $0.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: null
                                display_to_customer:
                                  type: boolean
                                  example: false
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                          price:
                            type: string
                            example: '11.13'
                          price_in_currency:
                            type: string
                            example: $11.13
                          subscription_price:
                            type:
                              - string
                              - integer
                            example: 2000
                          subscription_price_in_currency:
                            type: string
                            example: $2,000.00
                          title:
                            type: string
                            example: enroll product
                          token:
                            type: string
                            example: NxL22AqLRRisfyF9LqxxWRak
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      recurring:
                        oneOf:
                          - type: array
                            items:
                              type: object
                              properties:
                                subtotal:
                                  type: string
                                  example: '10.0'
                                subtotal_in_currency:
                                  type: string
                                  example: $10.0
                                interval:
                                  type: integer
                                  example: 1
                                interval_unit:
                                  type: string
                                  example: month
                                subtotal_for_display:
                                  type: string
                                  example: $10.00 every 1 month
                                start_date:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-05-27'
                          - type: 'null'
                        default:
                          - subtotal: '10.0'
                            subtotal_in_currency: $10.0
                            interval: 1
                            interval_unit: month
                            subtotal_for_display: $10.00 every 1 month
                            start_date: '2025-05-27'
                      messages:
                        type: object
                        additionalProperties: true
                        example:
                          errors:
                            - Insufficient inventory
                            - Product no longer available
                          warnings:
                            - Low stock warning
                            - Shipping delays expected
                          info:
                            - Free shipping available
                            - Volume discount applied
                      points_enabled:
                        type: boolean
                        example: true
                      points_applied:
                        type: integer
                        example: 500
                        description: Number of points applied to the cart
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Currency value of applied points
                      customer_total_points:
                        type: integer
                        example: 1000
                        description: Customer's total available points balance
                      customer_total_points_in_currency:
                        type: number
                        example: 10
                        description: Currency value of available points
                      remaining_customer_points:
                        type: integer
                        example: 500
                        description: Customer's remaining points after cart redemption
                      remaining_customer_points_amount_in_currency:
                        type: number
                        example: 5
                        description: >-
                          Currency value of remaining points after cart
                          redemption
                      remaining_cart_amount_after_points:
                        type: number
                        example: 95
                        description: Amount to charge to card after points redemption
                      remaining_cart_amount_after_points_in_currency:
                        type:
                          - string
                        example: $95.00
                        description: >-
                          Amount in currency to charge to card after points
                          redemption
                      max_applicable_points:
                        type: integer
                        example: 500
                        description: Maximum points that can be applied to this cart
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      checkout_url:
                        type: string
                        example: https://checkout.fluid.com/checkout?jwt=abc123
                      shop_url:
                        type: string
                        example: https://myco.fluid.app
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    properties:
                      cart:
                        type: array
                        items:
                          type: string
                        example:
                          - Cart not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                cart:
                  type: object
                  properties:
                    metadata:
                      type: array
                      items:
                        type: string
                      description: >-
                        Array of metadata keys to remove. Supports dot notation
                        for nested keys.
                      example:
                        - level
                        - referred_by.user.id
                        - location_ids
                  required:
                    - metadata
              required:
                - cart
  /api/carts:
    post:
      summary: Creates a cart
      tags:
        - Carts
      description: >-
        Create a cart. Items, attribution, immutable_items,
        order_confirmation_url, order_failure_url, and enrollment_pack_id are
        optional. Buyer rep assignment follows this priority: 1. If JWT is
        provided, extracts user from JWT and assigns as the rep. 2. If session
        cookie is present, extracts user from session and assigns it as the rep.
        3. If no authentication is provided, cart is created without a rep. When
        authenticated as a rep, the cart will include rep-specific pricing.
      operationId: createCart
      parameters:
        - name: Cookie
          in: header
          required: false
          description: Session cookie (_fluid_session)
          schema:
            type: string
        - name: jwt
          in: query
          required: false
          description: >-
            JWT token for user authentication. When provided, extracts user and
            assigns it as the rep to the cart.
          example: >-
            eyJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJ1c2VyX2NvbXBhbnkiLCJpZCI6MTIzfQ...
          schema:
            type: string
      responses:
        '200':
          description: cart created without email callback (no email)
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      state:
                        type: string
                        example: start
                      processed:
                        type: boolean
                        example: false
                        description: >-
                          Determines if a cart payment has been processed or
                          not.
                      valid_for_checkout:
                        type: boolean
                        example: true
                      buyer_rep_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      buyer_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: buyer.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                              external_id:
                                type:
                                  - string
                                  - 'null'
                                example: '123241'
                            required:
                              - id
                          - type: 'null'
                      volume_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: volume.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                            required:
                              - id
                          - type: 'null'
                      currency_symbol:
                        type: string
                        example: $
                      currency_code:
                        type: string
                        example: USD
                      shipping_total_for_display:
                        type: string
                        example: Free
                      phone:
                        type:
                          - string
                          - 'null'
                        example: '4035551212'
                      payment_method_auto_assignable:
                        type: boolean
                        example: true
                        description: >-
                          Determines if a payment method can be auto-assigned to
                          the cart.
                      attribution:
                        oneOf:
                          - type: object
                            oneOf:
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  share_guid:
                                    type: string
                                    example: james-bond007
                                required:
                                  - id
                                  - share_guid
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  email:
                                    type: string
                                    example: james.bond@gmail.com
                                required:
                                  - id
                                  - email
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  username:
                                    type: string
                                    example: jaamball234
                                required:
                                  - id
                                  - username
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  fluid_rep_id:
                                    type: integer
                                    example: 23493
                                required:
                                  - id
                                  - fluid_rep_id
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: w3sdf92
                                required:
                                  - id
                          - type: 'null'
                        default:
                          id: 456
                          share_guid: james-bond007
                      agreements:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            required:
                              type: boolean
                              example: true
                            title:
                              type: string
                              example: Terms and Conditions
                            show_path:
                              type: string
                              example: /terms
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                      amount_total:
                        type: string
                        example: '121.65'
                      amount_total_in_currency:
                        type: string
                        example: $121.65 (USD)
                      sub_total:
                        type: string
                        example: '100.00'
                      sub_total_in_currency:
                        type: string
                        example: $100.00 (USD)
                      subtotal_after_discounts:
                        type: string
                        example: '90.00'
                      tax_total:
                        type: string
                        example: '20.00'
                      tax_total_in_currency:
                        type: string
                        example: $20.00 (USD)
                      shipping_total:
                        type:
                          - string
                          - 'null'
                        example: '1.65'
                      shipping_total_in_currency:
                        type: string
                        example: $1.65 (USD)
                      shipping_discount:
                        type: number
                        example: 10.25
                      discount_total:
                        type: string
                        example: '2.99'
                      discount_total_in_currency:
                        type: string
                        example: $2.99 (USD)
                      discount_breakdown:
                        type: object
                        properties:
                          internal_discounts:
                            type: number
                            example: 15
                          external_discounts:
                            type: number
                            example: 10
                          total_discounts:
                            type: number
                            example: 25
                      external_discount:
                        type: object
                        properties:
                          total:
                            type: number
                            example: 10
                          calculated_at:
                            type:
                              - string
                              - 'null'
                            format: date-time
                            example: '2024-01-10T15:30:00Z'
                          sources:
                            type: object
                            additionalProperties:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 6
                                description:
                                  type: string
                                  example: Gold tier discount
                                metadata:
                                  type: object
                              required:
                                - amount
                                - description
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: '1.90'
                      transaction_fee_in_currency:
                        type: string
                        example: $1.90 (USD)
                      cv_total:
                        type: integer
                        example: 10
                      qv_total:
                        type: integer
                        example: 15
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      payment_account:
                        type:
                          - string
                          - 'null'
                        example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                      payment_method:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: CreditCard
                              payment_method_type:
                                type: string
                                example: visa
                              last_four:
                                type: string
                                example: '1234'
                              exp_month:
                                type: string
                                example: '12'
                              exp_year:
                                type: string
                                example: '2025'
                              logo_url:
                                type: string
                                example: https://example.com/image.svg
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Paypal
                              status:
                                type: string
                                example: active
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Affirm
                              affirm_id:
                                type: string
                                example: affirm_123
                              status:
                                type: string
                                example: authorized
                              checkout_id:
                                type: string
                                example: checkout_456
                              created:
                                type: string
                                example: '2025-01-01T00:00:00Z'
                              auth_expiration:
                                type: string
                                example: '2025-01-02T00:00:00Z'
                              currency:
                                type: string
                                example: USD
                              amount:
                                type: string
                                example: '100.00'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Klarna
                              session_id:
                                type: string
                                example: klarna_session_789
                              intent:
                                type: string
                                example: buy
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Droplet
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: SomeCitcon
                      email:
                        type:
                          - string
                          - 'null'
                        example: user@example.com
                      enrollment_fee:
                        type:
                          - number
                          - string
                        example: '10.45'
                      enrollment_fee_in_currency:
                        type: string
                        example: $10.45
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT10
                          - DISCOUNT11
                      language_iso:
                        type:
                          - string
                          - 'null'
                        example: en
                      cart_token:
                        type: string
                        example: abc123
                      immutable_items:
                        type: boolean
                        example: false
                      digital_only:
                        type: boolean
                        example: false
                      requires_3ds:
                        type: boolean
                        example: false
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 101
                            price:
                              type: string
                              example: '43.41'
                            price_in_currency:
                              type: string
                              example: $43.41
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            cv:
                              type: integer
                              example: 5
                            cv_total:
                              type: integer
                              example: 15
                            qv:
                              type: integer
                              example: 7
                            qv_total:
                              type: integer
                              example: 21
                            discount_amount:
                              type: string
                              example: '10'
                            free_item:
                              type: boolean
                              example: false
                            discount_amount_in_currency:
                              type: string
                              example: $10.00
                            total_after_discounts:
                              type: string
                              example: '90.00'
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            product_title:
                              type:
                                - string
                                - 'null'
                              example: Sample Product
                            quantity:
                              type: integer
                              example: 3
                            subscription:
                              type: boolean
                              example: true
                            enrollment:
                              type: boolean
                              example: false
                            allow_subscription:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_plan_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_plans:
                              oneOf:
                                - type: array
                                  items:
                                    title: Commerce::SubscriptionPlan
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        example: Test Subscription Plan
                                        type: string
                                      billing_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      billing_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      billing_frequency_in_words:
                                        example: 2 Months
                                        type: string
                                      shipping_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      shipping_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      volume_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      volume_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      trial_period:
                                        example: 1
                                        type:
                                          - integer
                                          - 'null'
                                        minimum: 1
                                      trial_period_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type:
                                          - string
                                          - 'null'
                                      split_volume:
                                        example: true
                                        type: boolean
                                        default: false
                                      allow_max_billing_cycles:
                                        example: true
                                        type: boolean
                                        default: false
                                      max_billing_cycles:
                                        example: 3
                                        type:
                                          - integer
                                          - 'null'
                                      company_default:
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                        default: false
                                      products_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      subscribers_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      price:
                                        type: string
                                      price_in_currency:
                                        type: string
                                      subscription_start:
                                        type: string
                                      subscribe_and_save:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_in_currency:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_for_display:
                                        type:
                                          - string
                                          - 'null'
                                    required:
                                      - id
                                      - name
                                      - billing_interval
                                      - billing_interval_unit
                                      - billing_frequency_in_words
                                      - shipping_interval
                                      - shipping_interval_unit
                                      - volume_interval
                                      - volume_interval_unit
                                      - split_volume
                                      - allow_max_billing_cycles
                                      - price
                                      - price_in_currency
                                      - subscription_start
                                      - subscribe_and_save
                                      - subscribe_and_save_in_currency
                                      - subscribe_and_save_for_display
                                - type: 'null'
                            subscription_only:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_interval:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_interval_unit:
                              type:
                                - string
                                - 'null'
                              example: month
                            subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 10.5
                            subscription_price_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $10.50
                            subscription_start:
                              type:
                                - string
                                - 'null'
                              example: '2025-02-12'
                            subscribe_and_save:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 2.99
                            subscribe_and_save_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $2.99
                            subscribe_and_save_for_display:
                              type:
                                - string
                                - 'null'
                              example: Subscribe and save $2.99
                            title:
                              type:
                                - string
                                - 'null'
                              example: Surcharge
                            metadata:
                              type: object
                              description: >-
                                A JSON object that can store any custom data
                                structure
                              example: {}
                            product:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type: string
                                      example: Sample Product
                                    introduction:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Product Description
                                    cv:
                                      type: integer
                                      example: 10
                                    external_id:
                                      type:
                                        - string
                                        - 'null'
                                      example: ext-prod-123
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/product.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/product.png
                                    price:
                                      type: string
                                      example: '29.99'
                                    price_in_currency:
                                      type: string
                                      example: $29.99
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    tax:
                                      type: string
                                      example: '2.99'
                                    tax_in_currency:
                                      type: string
                                      example: $2.99
                                    metadata:
                                      type: object
                                      example:
                                        shopify_product_id: 9876054868270
                                    metafields:
                                      type: array
                                      items:
                                        title: LegacyMetafield
                                        type: object
                                        properties:
                                          namespace:
                                            description: >-
                                              A container for related metafields.
                                              Commonly used to group metafields by app
                                              or functionality.
                                            example: custom
                                            type: string
                                            maxLength: 20
                                            pattern: ^[a-zA-Z0-9_]+$
                                          key:
                                            description: >-
                                              The unique identifier for the metafield
                                              within its namespace. Must be unique per
                                              namespace and owner.
                                            example: material
                                            type: string
                                            maxLength: 30
                                            pattern: ^[a-zA-Z0-9_]+$
                                          value:
                                            description: >-
                                              The actual data stored in the metafield.
                                              Type depends on value_type.
                                            example: cotton
                                            type:
                                              - string
                                              - integer
                                              - object
                                              - boolean
                                              - number
                                          value_type:
                                            description: >-
                                              The data type that defines how the value
                                              should be interpreted and validated.
                                            example: single_line_text_field
                                            type: string
                                          description:
                                            description: >-
                                              Optional human-readable description
                                              explaining the purpose of this
                                              metafield.
                                            example: >-
                                              The primary material used in this
                                              product
                                            type:
                                              - string
                                              - 'null'
                                          created_at:
                                            description: >-
                                              Timestamp when the metafield was
                                              created.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          updated_at:
                                            description: >-
                                              Timestamp when the metafield was last
                                              updated.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          locked:
                                            description: >-
                                              Whether this metafield is locked and
                                              cannot be updated or deleted directly.
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                              - 'null'
                                          metafield_definition:
                                            description: >-
                                              The definition that defines validation
                                              rules and structure for this metafield
                                            type:
                                              - 'null'
                                              - object
                                        required:
                                          - namespace
                                          - key
                                          - value
                                          - value_type
                                          - description
                                          - created_at
                                          - updated_at
                                          - metafield_definition
                                - type: 'null'
                            variant:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Variant
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/sample.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/sample.png
                                    primary_image:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/primary.png
                                    price:
                                      type:
                                        - string
                                        - 'null'
                                      example: '34.44'
                                    price_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $34.44
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    options:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          title:
                                            type: string
                                            example: Size
                                          value:
                                            type: string
                                            example: XL
                                    physical:
                                      type:
                                        - boolean
                                        - 'null'
                                      example: true
                                    unit_of_size:
                                      type:
                                        - string
                                        - 'null'
                                      example: cm
                                    height:
                                      type:
                                        - number
                                        - 'null'
                                      example: 13
                                    width:
                                      type:
                                        - number
                                        - 'null'
                                      example: 6
                                    length:
                                      type:
                                        - number
                                        - 'null'
                                      example: 12
                                    unit_of_weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: kg
                                    weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                    hs_code:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                - type: 'null'
                            errors:
                              oneOf:
                                - type: 'null'
                                - type: array
                                  items:
                                    type: object
                                  example:
                                    - country:
                                        - >-
                                          This product is not available for this
                                          country. Please change your country
                            bundled_items:
                              type: array
                              items:
                                type: object
                                description: Bundled items for bundle products
                                properties:
                                  variant_id:
                                    type: integer
                                    example: 1
                                  product_id:
                                    type: integer
                                    example: 1
                                  product_title:
                                    type: string
                                    example: Product Title
                                  variant_title:
                                    type: string
                                    example: Variant Title
                                  option_titles:
                                    type: array
                                    example:
                                      - Option 1
                                      - Option 2
                                  quantity:
                                    type: integer
                                    example: 1
                                  display_to_customer:
                                    type: boolean
                                    example: true
                      ship_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      bill_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      shipping_method:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: string
                            example: standard-shipping
                          name:
                            type: string
                            example: Standard Shipping
                      available_shipping_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: standard-shipping
                            title:
                              type: string
                              example: Standard Shipping
                            price:
                              type:
                                - number
                                - string
                              example: 5.99
                            price_label:
                              type: string
                              example: $5.99
                            delivery_time_estimate:
                              type: string
                              example: 3-5 business days
                      available_payment_methods:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - credit_card
                                name:
                                  type: string
                                  example: Credit Card
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                apple_pay:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method supports
                                    ApplePay or not 
                                bogus_gateway:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is a Bogus
                                    instance or not.
                                tokenize_path:
                                  type:
                                    - string
                                    - 'null'
                                  description: Path to tokenize, if applicable.
                                token_provider:
                                  type: string
                                  enum:
                                    - spreedly
                                    - vgs
                                  description: >-
                                    Determines if payment tokenization is via
                                    spreedly or VGS
                                apple_pay_merchant_identifier:
                                  type:
                                    - string
                                    - 'null'
                                  example: merchant.mycompany.com
                                  description: >-
                                    If ApplePay is supported, returns the
                                    merchant identifier registered with Apple,
                                    else returns nil
                                supported_brands:
                                  type: array
                                  items:
                                    type: string
                                  example:
                                    - visa
                                    - master
                                    - american_express
                                    - discover
                                publishable_key:
                                  type:
                                    - string
                                    - 'null'
                                  example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                  description: >-
                                    If publishable key is set for Hyperswitch,
                                    returns the publishable key, else returns
                                    nil
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                              required:
                                - id
                                - type
                                - name
                                - supported_brands
                                - test
                                - sandbox
                                - apple_pay
                                - apple_pay_merchant_identifier
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - klarna
                                name:
                                  type: string
                                  example: Klarna
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                      country:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          iso:
                            type: string
                            example: US
                          name:
                            type: string
                            example: United States
                          iso_name:
                            type: string
                            example: UNITED STATES
                          iso3:
                            type: string
                            example: USA
                          currency_code:
                            type: string
                            example: USD
                          currency_symbol:
                            type: string
                            example: $
                          province_required:
                            type: boolean
                            example: false
                          tax_enabled:
                            type:
                              - boolean
                              - 'null'
                            example: true
                          price_inclusive_of_tax:
                            type: boolean
                            example: false
                          price_inclusive_tax_name:
                            type:
                              - string
                              - 'null'
                            example: VAT
                      type:
                        type: string
                        enum:
                          - regular
                          - enrollment
                        example: regular
                      enrollment_pack_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      enrollment_pack:
                        type:
                          - object
                          - 'null'
                        properties:
                          enrollment_pack_id:
                            type: integer
                            example: 1
                          additional_volume:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          slug:
                            type: string
                            example: test-enrollment-pack
                          description:
                            type:
                              - object
                              - 'null'
                              - string
                            properties:
                              id:
                                type: integer
                                example: 111
                              name:
                                type: string
                                example: description
                              body:
                                type: string
                                example: >-
                                  <div>Try the latest and greatest of our sugar
                                  zip packs. Guaranteed to make you skinner and
                                  cure cancer.</div>
                              record_type:
                                type: string
                                example: EnrollmentPack
                              record_id:
                                type: integer
                                example: 1
                              created_at:
                                type: string
                                format: date_time
                                example: '2025-01-16T04:22:43.809Z'
                              updated_at:
                                type: string
                                format: date_time
                                example: '2025-01-22T10:23:52.941Z'
                              locale:
                                type: string
                                example: en
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: 10
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.00
                          images:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2
                                relateable_type:
                                  type: string
                                  example: EnrollmentPack
                                relateable_id:
                                  type: integer
                                  example: 1
                                image_url:
                                  type: string
                                  example: >-
                                    https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                image_path:
                                  type: string
                                  example: jITWaU14QGe0y5AFgY7P_00179.svg
                                position:
                                  type: integer
                                  example: 1
                                shopify_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                                created_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                updated_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                external_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 625
                                allow_subscription:
                                  type: boolean
                                  example: true
                                cv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                cv_in_currency:
                                  type: string
                                  example: $0.00
                                cv_total:
                                  type: integer
                                  example: 0
                                enrollment:
                                  type: boolean
                                  example: true
                                enrollment_pack_id:
                                  type: integer
                                  example: 1
                                price:
                                  type: string
                                  example: '11.13'
                                price_in_currency:
                                  type: string
                                  example: $11.13
                                product_title:
                                  type: string
                                  example: Zip Pack Sample Pack (30)
                                quantity:
                                  type: integer
                                  example: 1
                                qv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                qv_in_currency:
                                  type: string
                                  example: $0.00
                                qv_total:
                                  type: integer
                                  example: 0
                                subscribe_and_save:
                                  type:
                                    - string
                                    - 'null'
                                  example: '-1988.87'
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $-1,988.87
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $-1,988.87
                                subscription:
                                  type: boolean
                                  example: false
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_only:
                                  type: boolean
                                  example: false
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_price:
                                  type: string
                                  example: '2000.0'
                                subscription_price_in_currency:
                                  type: string
                                  example: $2,000.00
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  format: date
                                  example: '2025-02-28'
                                tax:
                                  type: string
                                  example: '0.0'
                                tax_in_currency:
                                  type: string
                                  example: $0.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: null
                                display_to_customer:
                                  type: boolean
                                  example: false
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                          price:
                            type: string
                            example: '11.13'
                          price_in_currency:
                            type: string
                            example: $11.13
                          subscription_price:
                            type:
                              - string
                              - integer
                            example: 2000
                          subscription_price_in_currency:
                            type: string
                            example: $2,000.00
                          title:
                            type: string
                            example: enroll product
                          token:
                            type: string
                            example: NxL22AqLRRisfyF9LqxxWRak
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      recurring:
                        oneOf:
                          - type: array
                            items:
                              type: object
                              properties:
                                subtotal:
                                  type: string
                                  example: '10.0'
                                subtotal_in_currency:
                                  type: string
                                  example: $10.0
                                interval:
                                  type: integer
                                  example: 1
                                interval_unit:
                                  type: string
                                  example: month
                                subtotal_for_display:
                                  type: string
                                  example: $10.00 every 1 month
                                start_date:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-05-27'
                          - type: 'null'
                        default:
                          - subtotal: '10.0'
                            subtotal_in_currency: $10.0
                            interval: 1
                            interval_unit: month
                            subtotal_for_display: $10.00 every 1 month
                            start_date: '2025-05-27'
                      messages:
                        type: object
                        additionalProperties: true
                        example:
                          errors:
                            - Insufficient inventory
                            - Product no longer available
                          warnings:
                            - Low stock warning
                            - Shipping delays expected
                          info:
                            - Free shipping available
                            - Volume discount applied
                      points_enabled:
                        type: boolean
                        example: true
                      points_applied:
                        type: integer
                        example: 500
                        description: Number of points applied to the cart
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Currency value of applied points
                      customer_total_points:
                        type: integer
                        example: 1000
                        description: Customer's total available points balance
                      customer_total_points_in_currency:
                        type: number
                        example: 10
                        description: Currency value of available points
                      remaining_customer_points:
                        type: integer
                        example: 500
                        description: Customer's remaining points after cart redemption
                      remaining_customer_points_amount_in_currency:
                        type: number
                        example: 5
                        description: >-
                          Currency value of remaining points after cart
                          redemption
                      remaining_cart_amount_after_points:
                        type: number
                        example: 95
                        description: Amount to charge to card after points redemption
                      remaining_cart_amount_after_points_in_currency:
                        type:
                          - string
                        example: $95.00
                        description: >-
                          Amount in currency to charge to card after points
                          redemption
                      max_applicable_points:
                        type: integer
                        example: 500
                        description: Maximum points that can be applied to this cart
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      checkout_url:
                        type: string
                        example: https://checkout.fluid.com/checkout?jwt=abc123
                      shop_url:
                        type: string
                        example: https://myco.fluid.app
        '400':
          description: variant not available in country
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: bad request
                  errors:
                    type: string
                    example: Commerce::CartsService::VariantNotFoundError
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                country_code:
                  type: string
                  description: ISO 2-letter country code
                  example: US
                visitor_token:
                  type: string
                  description: >-
                    Visitor token. DEPRECATED: Will be removed in a future
                    version; please use `session_uuid` instead
                  example: vt_2a3v3f9s8xRCN
                session_uuid:
                  type: string
                  description: Session UUID
                  example: 0195ff0f-9a6c-70e1-9037-f42bfd23b5fb
                items:
                  type: array
                  items:
                    type: object
                    properties:
                      variant_id:
                        type: integer
                        description: The ID of the variant to add to the cart
                        example: 90
                      quantity:
                        type: integer
                        description: The quantity of the variant to add to the cart
                        example: 2
                      display_to_customer:
                        type: boolean
                        description: Whether the item should be displayed to the customer
                        example: true
                        default: true
                      subscription:
                        type: boolean
                        description: Whether the item is subscribed
                        example: true
                        default: true
                      subscription_plan_id:
                        type: integer
                        description: The ID of the subscription plan to use for the item
                        example: 123
                      cv:
                        type: integer
                        description: CV value
                        example: 10
                      qv:
                        type: integer
                        description: QV value
                        example: 10
                      price:
                        type: integer
                        description: The price of the item
                        example: 100
                      parent_id:
                        type: integer
                        description: The ID of the parent bundle item
                        example: 1
                immutable_items:
                  type: boolean
                  description: Whether the cart is immutable
                  example: true
                  default: false
                fluid_shop:
                  type: string
                  description: The domain of your Fluid shop (excluding the scheme)
                  example: myco.fluid.app
                source:
                  type: string
                  enum:
                    - web
                    - mobile
                    - external
                    - admin
                  description: The source of the cart
                  example: admin
                attribution:
                  type: object
                  oneOf:
                    - properties:
                        share_guid:
                          type: string
                          example: james-bond007
                      required:
                        - share_guid
                    - properties:
                        email:
                          type: string
                          format: email
                          example: user@example.com
                      required:
                        - email
                    - properties:
                        external_id:
                          type:
                            - string
                            - 'null'
                          example: ext_12345
                    - properties:
                        username:
                          type: string
                          example: username123
                      required:
                        - username
                    - properties:
                        fluid_rep_id:
                          type:
                            - string
                            - integer
                          example: 456
                      required:
                        - fluid_rep_id
                  example:
                    share_guid: james-bond007
                order_confirmation_url:
                  type: string
                  description: >-
                    The URL of a custom Order Confirmation Page to send
                    customers to after the order is approved.
                  example: >-
                    https://myco.fluid.app/pages/order-confirmation?token={order_token}
                order_failure_url:
                  type: string
                  description: >-
                    The URL to redirect customers to when a payment fails on
                    external APM integrations. If not provided, defaults to the
                    checkout page.
                  example: https://myco.fluid.app/pages/payment-failed
                timezone:
                  type: string
                  description: User timezone. Defaults to 'UTC' if not provided.
                  example: America/New_York
              required:
                - country_code
                - fluid_shop
        description: Cart params
  /api/carts/{cart_token}/address:
    post:
      summary: Updates cart address
      tags:
        - Carts
      operationId: upsertCartAddress
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: address updated with address id
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      state:
                        type: string
                        example: start
                      processed:
                        type: boolean
                        example: false
                        description: >-
                          Determines if a cart payment has been processed or
                          not.
                      valid_for_checkout:
                        type: boolean
                        example: true
                      buyer_rep_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      buyer_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: buyer.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                              external_id:
                                type:
                                  - string
                                  - 'null'
                                example: '123241'
                            required:
                              - id
                          - type: 'null'
                      volume_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: volume.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                            required:
                              - id
                          - type: 'null'
                      currency_symbol:
                        type: string
                        example: $
                      currency_code:
                        type: string
                        example: USD
                      shipping_total_for_display:
                        type: string
                        example: Free
                      phone:
                        type:
                          - string
                          - 'null'
                        example: '4035551212'
                      payment_method_auto_assignable:
                        type: boolean
                        example: true
                        description: >-
                          Determines if a payment method can be auto-assigned to
                          the cart.
                      attribution:
                        oneOf:
                          - type: object
                            oneOf:
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  share_guid:
                                    type: string
                                    example: james-bond007
                                required:
                                  - id
                                  - share_guid
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  email:
                                    type: string
                                    example: james.bond@gmail.com
                                required:
                                  - id
                                  - email
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  username:
                                    type: string
                                    example: jaamball234
                                required:
                                  - id
                                  - username
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  fluid_rep_id:
                                    type: integer
                                    example: 23493
                                required:
                                  - id
                                  - fluid_rep_id
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: w3sdf92
                                required:
                                  - id
                          - type: 'null'
                        default:
                          id: 456
                          share_guid: james-bond007
                      agreements:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            required:
                              type: boolean
                              example: true
                            title:
                              type: string
                              example: Terms and Conditions
                            show_path:
                              type: string
                              example: /terms
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                      amount_total:
                        type: string
                        example: '121.65'
                      amount_total_in_currency:
                        type: string
                        example: $121.65 (USD)
                      sub_total:
                        type: string
                        example: '100.00'
                      sub_total_in_currency:
                        type: string
                        example: $100.00 (USD)
                      subtotal_after_discounts:
                        type: string
                        example: '90.00'
                      tax_total:
                        type: string
                        example: '20.00'
                      tax_total_in_currency:
                        type: string
                        example: $20.00 (USD)
                      shipping_total:
                        type:
                          - string
                          - 'null'
                        example: '1.65'
                      shipping_total_in_currency:
                        type: string
                        example: $1.65 (USD)
                      shipping_discount:
                        type: number
                        example: 10.25
                      discount_total:
                        type: string
                        example: '2.99'
                      discount_total_in_currency:
                        type: string
                        example: $2.99 (USD)
                      discount_breakdown:
                        type: object
                        properties:
                          internal_discounts:
                            type: number
                            example: 15
                          external_discounts:
                            type: number
                            example: 10
                          total_discounts:
                            type: number
                            example: 25
                      external_discount:
                        type: object
                        properties:
                          total:
                            type: number
                            example: 10
                          calculated_at:
                            type:
                              - string
                              - 'null'
                            format: date-time
                            example: '2024-01-10T15:30:00Z'
                          sources:
                            type: object
                            additionalProperties:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 6
                                description:
                                  type: string
                                  example: Gold tier discount
                                metadata:
                                  type: object
                              required:
                                - amount
                                - description
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: '1.90'
                      transaction_fee_in_currency:
                        type: string
                        example: $1.90 (USD)
                      cv_total:
                        type: integer
                        example: 10
                      qv_total:
                        type: integer
                        example: 15
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      payment_account:
                        type:
                          - string
                          - 'null'
                        example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                      payment_method:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: CreditCard
                              payment_method_type:
                                type: string
                                example: visa
                              last_four:
                                type: string
                                example: '1234'
                              exp_month:
                                type: string
                                example: '12'
                              exp_year:
                                type: string
                                example: '2025'
                              logo_url:
                                type: string
                                example: https://example.com/image.svg
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Paypal
                              status:
                                type: string
                                example: active
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Affirm
                              affirm_id:
                                type: string
                                example: affirm_123
                              status:
                                type: string
                                example: authorized
                              checkout_id:
                                type: string
                                example: checkout_456
                              created:
                                type: string
                                example: '2025-01-01T00:00:00Z'
                              auth_expiration:
                                type: string
                                example: '2025-01-02T00:00:00Z'
                              currency:
                                type: string
                                example: USD
                              amount:
                                type: string
                                example: '100.00'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Klarna
                              session_id:
                                type: string
                                example: klarna_session_789
                              intent:
                                type: string
                                example: buy
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Droplet
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: SomeCitcon
                      email:
                        type:
                          - string
                          - 'null'
                        example: user@example.com
                      enrollment_fee:
                        type:
                          - number
                          - string
                        example: '10.45'
                      enrollment_fee_in_currency:
                        type: string
                        example: $10.45
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT10
                          - DISCOUNT11
                      language_iso:
                        type:
                          - string
                          - 'null'
                        example: en
                      cart_token:
                        type: string
                        example: abc123
                      immutable_items:
                        type: boolean
                        example: false
                      digital_only:
                        type: boolean
                        example: false
                      requires_3ds:
                        type: boolean
                        example: false
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 101
                            price:
                              type: string
                              example: '43.41'
                            price_in_currency:
                              type: string
                              example: $43.41
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            cv:
                              type: integer
                              example: 5
                            cv_total:
                              type: integer
                              example: 15
                            qv:
                              type: integer
                              example: 7
                            qv_total:
                              type: integer
                              example: 21
                            discount_amount:
                              type: string
                              example: '10'
                            free_item:
                              type: boolean
                              example: false
                            discount_amount_in_currency:
                              type: string
                              example: $10.00
                            total_after_discounts:
                              type: string
                              example: '90.00'
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            product_title:
                              type:
                                - string
                                - 'null'
                              example: Sample Product
                            quantity:
                              type: integer
                              example: 3
                            subscription:
                              type: boolean
                              example: true
                            enrollment:
                              type: boolean
                              example: false
                            allow_subscription:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_plan_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_plans:
                              oneOf:
                                - type: array
                                  items:
                                    title: Commerce::SubscriptionPlan
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        example: Test Subscription Plan
                                        type: string
                                      billing_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      billing_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      billing_frequency_in_words:
                                        example: 2 Months
                                        type: string
                                      shipping_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      shipping_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      volume_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      volume_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      trial_period:
                                        example: 1
                                        type:
                                          - integer
                                          - 'null'
                                        minimum: 1
                                      trial_period_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type:
                                          - string
                                          - 'null'
                                      split_volume:
                                        example: true
                                        type: boolean
                                        default: false
                                      allow_max_billing_cycles:
                                        example: true
                                        type: boolean
                                        default: false
                                      max_billing_cycles:
                                        example: 3
                                        type:
                                          - integer
                                          - 'null'
                                      company_default:
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                        default: false
                                      products_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      subscribers_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      price:
                                        type: string
                                      price_in_currency:
                                        type: string
                                      subscription_start:
                                        type: string
                                      subscribe_and_save:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_in_currency:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_for_display:
                                        type:
                                          - string
                                          - 'null'
                                    required:
                                      - id
                                      - name
                                      - billing_interval
                                      - billing_interval_unit
                                      - billing_frequency_in_words
                                      - shipping_interval
                                      - shipping_interval_unit
                                      - volume_interval
                                      - volume_interval_unit
                                      - split_volume
                                      - allow_max_billing_cycles
                                      - price
                                      - price_in_currency
                                      - subscription_start
                                      - subscribe_and_save
                                      - subscribe_and_save_in_currency
                                      - subscribe_and_save_for_display
                                - type: 'null'
                            subscription_only:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_interval:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_interval_unit:
                              type:
                                - string
                                - 'null'
                              example: month
                            subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 10.5
                            subscription_price_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $10.50
                            subscription_start:
                              type:
                                - string
                                - 'null'
                              example: '2025-02-12'
                            subscribe_and_save:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 2.99
                            subscribe_and_save_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $2.99
                            subscribe_and_save_for_display:
                              type:
                                - string
                                - 'null'
                              example: Subscribe and save $2.99
                            title:
                              type:
                                - string
                                - 'null'
                              example: Surcharge
                            metadata:
                              type: object
                              description: >-
                                A JSON object that can store any custom data
                                structure
                              example: {}
                            product:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type: string
                                      example: Sample Product
                                    introduction:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Product Description
                                    cv:
                                      type: integer
                                      example: 10
                                    external_id:
                                      type:
                                        - string
                                        - 'null'
                                      example: ext-prod-123
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/product.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/product.png
                                    price:
                                      type: string
                                      example: '29.99'
                                    price_in_currency:
                                      type: string
                                      example: $29.99
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    tax:
                                      type: string
                                      example: '2.99'
                                    tax_in_currency:
                                      type: string
                                      example: $2.99
                                    metadata:
                                      type: object
                                      example:
                                        shopify_product_id: 9876054868270
                                    metafields:
                                      type: array
                                      items:
                                        title: LegacyMetafield
                                        type: object
                                        properties:
                                          namespace:
                                            description: >-
                                              A container for related metafields.
                                              Commonly used to group metafields by app
                                              or functionality.
                                            example: custom
                                            type: string
                                            maxLength: 20
                                            pattern: ^[a-zA-Z0-9_]+$
                                          key:
                                            description: >-
                                              The unique identifier for the metafield
                                              within its namespace. Must be unique per
                                              namespace and owner.
                                            example: material
                                            type: string
                                            maxLength: 30
                                            pattern: ^[a-zA-Z0-9_]+$
                                          value:
                                            description: >-
                                              The actual data stored in the metafield.
                                              Type depends on value_type.
                                            example: cotton
                                            type:
                                              - string
                                              - integer
                                              - object
                                              - boolean
                                              - number
                                          value_type:
                                            description: >-
                                              The data type that defines how the value
                                              should be interpreted and validated.
                                            example: single_line_text_field
                                            type: string
                                          description:
                                            description: >-
                                              Optional human-readable description
                                              explaining the purpose of this
                                              metafield.
                                            example: >-
                                              The primary material used in this
                                              product
                                            type:
                                              - string
                                              - 'null'
                                          created_at:
                                            description: >-
                                              Timestamp when the metafield was
                                              created.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          updated_at:
                                            description: >-
                                              Timestamp when the metafield was last
                                              updated.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          locked:
                                            description: >-
                                              Whether this metafield is locked and
                                              cannot be updated or deleted directly.
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                              - 'null'
                                          metafield_definition:
                                            description: >-
                                              The definition that defines validation
                                              rules and structure for this metafield
                                            type:
                                              - 'null'
                                              - object
                                        required:
                                          - namespace
                                          - key
                                          - value
                                          - value_type
                                          - description
                                          - created_at
                                          - updated_at
                                          - metafield_definition
                                - type: 'null'
                            variant:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Variant
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/sample.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/sample.png
                                    primary_image:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/primary.png
                                    price:
                                      type:
                                        - string
                                        - 'null'
                                      example: '34.44'
                                    price_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $34.44
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    options:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          title:
                                            type: string
                                            example: Size
                                          value:
                                            type: string
                                            example: XL
                                    physical:
                                      type:
                                        - boolean
                                        - 'null'
                                      example: true
                                    unit_of_size:
                                      type:
                                        - string
                                        - 'null'
                                      example: cm
                                    height:
                                      type:
                                        - number
                                        - 'null'
                                      example: 13
                                    width:
                                      type:
                                        - number
                                        - 'null'
                                      example: 6
                                    length:
                                      type:
                                        - number
                                        - 'null'
                                      example: 12
                                    unit_of_weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: kg
                                    weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                    hs_code:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                - type: 'null'
                            errors:
                              oneOf:
                                - type: 'null'
                                - type: array
                                  items:
                                    type: object
                                  example:
                                    - country:
                                        - >-
                                          This product is not available for this
                                          country. Please change your country
                            bundled_items:
                              type: array
                              items:
                                type: object
                                description: Bundled items for bundle products
                                properties:
                                  variant_id:
                                    type: integer
                                    example: 1
                                  product_id:
                                    type: integer
                                    example: 1
                                  product_title:
                                    type: string
                                    example: Product Title
                                  variant_title:
                                    type: string
                                    example: Variant Title
                                  option_titles:
                                    type: array
                                    example:
                                      - Option 1
                                      - Option 2
                                  quantity:
                                    type: integer
                                    example: 1
                                  display_to_customer:
                                    type: boolean
                                    example: true
                      ship_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      bill_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      shipping_method:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: string
                            example: standard-shipping
                          name:
                            type: string
                            example: Standard Shipping
                      available_shipping_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: standard-shipping
                            title:
                              type: string
                              example: Standard Shipping
                            price:
                              type:
                                - number
                                - string
                              example: 5.99
                            price_label:
                              type: string
                              example: $5.99
                            delivery_time_estimate:
                              type: string
                              example: 3-5 business days
                      available_payment_methods:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - credit_card
                                name:
                                  type: string
                                  example: Credit Card
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                apple_pay:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method supports
                                    ApplePay or not 
                                bogus_gateway:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is a Bogus
                                    instance or not.
                                tokenize_path:
                                  type:
                                    - string
                                    - 'null'
                                  description: Path to tokenize, if applicable.
                                token_provider:
                                  type: string
                                  enum:
                                    - spreedly
                                    - vgs
                                  description: >-
                                    Determines if payment tokenization is via
                                    spreedly or VGS
                                apple_pay_merchant_identifier:
                                  type:
                                    - string
                                    - 'null'
                                  example: merchant.mycompany.com
                                  description: >-
                                    If ApplePay is supported, returns the
                                    merchant identifier registered with Apple,
                                    else returns nil
                                supported_brands:
                                  type: array
                                  items:
                                    type: string
                                  example:
                                    - visa
                                    - master
                                    - american_express
                                    - discover
                                publishable_key:
                                  type:
                                    - string
                                    - 'null'
                                  example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                  description: >-
                                    If publishable key is set for Hyperswitch,
                                    returns the publishable key, else returns
                                    nil
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                              required:
                                - id
                                - type
                                - name
                                - supported_brands
                                - test
                                - sandbox
                                - apple_pay
                                - apple_pay_merchant_identifier
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - klarna
                                name:
                                  type: string
                                  example: Klarna
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                      country:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          iso:
                            type: string
                            example: US
                          name:
                            type: string
                            example: United States
                          iso_name:
                            type: string
                            example: UNITED STATES
                          iso3:
                            type: string
                            example: USA
                          currency_code:
                            type: string
                            example: USD
                          currency_symbol:
                            type: string
                            example: $
                          province_required:
                            type: boolean
                            example: false
                          tax_enabled:
                            type:
                              - boolean
                              - 'null'
                            example: true
                          price_inclusive_of_tax:
                            type: boolean
                            example: false
                          price_inclusive_tax_name:
                            type:
                              - string
                              - 'null'
                            example: VAT
                      type:
                        type: string
                        enum:
                          - regular
                          - enrollment
                        example: regular
                      enrollment_pack_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      enrollment_pack:
                        type:
                          - object
                          - 'null'
                        properties:
                          enrollment_pack_id:
                            type: integer
                            example: 1
                          additional_volume:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          slug:
                            type: string
                            example: test-enrollment-pack
                          description:
                            type:
                              - object
                              - 'null'
                              - string
                            properties:
                              id:
                                type: integer
                                example: 111
                              name:
                                type: string
                                example: description
                              body:
                                type: string
                                example: >-
                                  <div>Try the latest and greatest of our sugar
                                  zip packs. Guaranteed to make you skinner and
                                  cure cancer.</div>
                              record_type:
                                type: string
                                example: EnrollmentPack
                              record_id:
                                type: integer
                                example: 1
                              created_at:
                                type: string
                                format: date_time
                                example: '2025-01-16T04:22:43.809Z'
                              updated_at:
                                type: string
                                format: date_time
                                example: '2025-01-22T10:23:52.941Z'
                              locale:
                                type: string
                                example: en
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: 10
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.00
                          images:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2
                                relateable_type:
                                  type: string
                                  example: EnrollmentPack
                                relateable_id:
                                  type: integer
                                  example: 1
                                image_url:
                                  type: string
                                  example: >-
                                    https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                image_path:
                                  type: string
                                  example: jITWaU14QGe0y5AFgY7P_00179.svg
                                position:
                                  type: integer
                                  example: 1
                                shopify_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                                created_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                updated_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                external_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 625
                                allow_subscription:
                                  type: boolean
                                  example: true
                                cv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                cv_in_currency:
                                  type: string
                                  example: $0.00
                                cv_total:
                                  type: integer
                                  example: 0
                                enrollment:
                                  type: boolean
                                  example: true
                                enrollment_pack_id:
                                  type: integer
                                  example: 1
                                price:
                                  type: string
                                  example: '11.13'
                                price_in_currency:
                                  type: string
                                  example: $11.13
                                product_title:
                                  type: string
                                  example: Zip Pack Sample Pack (30)
                                quantity:
                                  type: integer
                                  example: 1
                                qv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                qv_in_currency:
                                  type: string
                                  example: $0.00
                                qv_total:
                                  type: integer
                                  example: 0
                                subscribe_and_save:
                                  type:
                                    - string
                                    - 'null'
                                  example: '-1988.87'
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $-1,988.87
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $-1,988.87
                                subscription:
                                  type: boolean
                                  example: false
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_only:
                                  type: boolean
                                  example: false
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_price:
                                  type: string
                                  example: '2000.0'
                                subscription_price_in_currency:
                                  type: string
                                  example: $2,000.00
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  format: date
                                  example: '2025-02-28'
                                tax:
                                  type: string
                                  example: '0.0'
                                tax_in_currency:
                                  type: string
                                  example: $0.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: null
                                display_to_customer:
                                  type: boolean
                                  example: false
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                          price:
                            type: string
                            example: '11.13'
                          price_in_currency:
                            type: string
                            example: $11.13
                          subscription_price:
                            type:
                              - string
                              - integer
                            example: 2000
                          subscription_price_in_currency:
                            type: string
                            example: $2,000.00
                          title:
                            type: string
                            example: enroll product
                          token:
                            type: string
                            example: NxL22AqLRRisfyF9LqxxWRak
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      recurring:
                        oneOf:
                          - type: array
                            items:
                              type: object
                              properties:
                                subtotal:
                                  type: string
                                  example: '10.0'
                                subtotal_in_currency:
                                  type: string
                                  example: $10.0
                                interval:
                                  type: integer
                                  example: 1
                                interval_unit:
                                  type: string
                                  example: month
                                subtotal_for_display:
                                  type: string
                                  example: $10.00 every 1 month
                                start_date:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-05-27'
                          - type: 'null'
                        default:
                          - subtotal: '10.0'
                            subtotal_in_currency: $10.0
                            interval: 1
                            interval_unit: month
                            subtotal_for_display: $10.00 every 1 month
                            start_date: '2025-05-27'
                      messages:
                        type: object
                        additionalProperties: true
                        example:
                          errors:
                            - Insufficient inventory
                            - Product no longer available
                          warnings:
                            - Low stock warning
                            - Shipping delays expected
                          info:
                            - Free shipping available
                            - Volume discount applied
                      points_enabled:
                        type: boolean
                        example: true
                      points_applied:
                        type: integer
                        example: 500
                        description: Number of points applied to the cart
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Currency value of applied points
                      customer_total_points:
                        type: integer
                        example: 1000
                        description: Customer's total available points balance
                      customer_total_points_in_currency:
                        type: number
                        example: 10
                        description: Currency value of available points
                      remaining_customer_points:
                        type: integer
                        example: 500
                        description: Customer's remaining points after cart redemption
                      remaining_customer_points_amount_in_currency:
                        type: number
                        example: 5
                        description: >-
                          Currency value of remaining points after cart
                          redemption
                      remaining_cart_amount_after_points:
                        type: number
                        example: 95
                        description: Amount to charge to card after points redemption
                      remaining_cart_amount_after_points_in_currency:
                        type:
                          - string
                        example: $95.00
                        description: >-
                          Amount in currency to charge to card after points
                          redemption
                      max_applicable_points:
                        type: integer
                        example: 500
                        description: Maximum points that can be applied to this cart
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      checkout_url:
                        type: string
                        example: https://checkout.fluid.com/checkout?jwt=abc123
                      shop_url:
                        type: string
                        example: https://myco.fluid.app
        '410':
          description: cart is in authorized enrollment state
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Cart is in authorized state and cannot be modified
                  errors:
                    type: object
                    example:
                      cart:
                        - is in authorized state and cannot be modified
                  meta:
                    type: object
                    properties:
                      shop_url:
                        type: string
                        example: https://example.myshopify.com
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      cart:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 123
                          state:
                            type: string
                            example: start
                          processed:
                            type: boolean
                            example: false
                            description: >-
                              Determines if a cart payment has been processed or
                              not.
                          valid_for_checkout:
                            type: boolean
                            example: true
                          buyer_rep_id:
                            type:
                              - integer
                              - 'null'
                            example: 1
                          buyer_rep:
                            oneOf:
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 2
                                  email:
                                    type:
                                      - string
                                      - 'null'
                                    example: buyer.rep@example.com
                                  full_name:
                                    type:
                                      - string
                                      - 'null'
                                    example: John Doe
                                  image_url:
                                    type:
                                      - string
                                      - 'null'
                                    example: https://example.com/image.png
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: '123241'
                                required:
                                  - id
                              - type: 'null'
                          volume_rep:
                            oneOf:
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 2
                                  email:
                                    type:
                                      - string
                                      - 'null'
                                    example: volume.rep@example.com
                                  full_name:
                                    type:
                                      - string
                                      - 'null'
                                    example: John Doe
                                  image_url:
                                    type:
                                      - string
                                      - 'null'
                                    example: https://example.com/image.png
                                required:
                                  - id
                              - type: 'null'
                          currency_symbol:
                            type: string
                            example: $
                          currency_code:
                            type: string
                            example: USD
                          shipping_total_for_display:
                            type: string
                            example: Free
                          phone:
                            type:
                              - string
                              - 'null'
                            example: '4035551212'
                          payment_method_auto_assignable:
                            type: boolean
                            example: true
                            description: >-
                              Determines if a payment method can be
                              auto-assigned to the cart.
                          attribution:
                            oneOf:
                              - type: object
                                oneOf:
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      share_guid:
                                        type: string
                                        example: james-bond007
                                    required:
                                      - id
                                      - share_guid
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      email:
                                        type: string
                                        example: james.bond@gmail.com
                                    required:
                                      - id
                                      - email
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      username:
                                        type: string
                                        example: jaamball234
                                    required:
                                      - id
                                      - username
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      fluid_rep_id:
                                        type: integer
                                        example: 23493
                                    required:
                                      - id
                                      - fluid_rep_id
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      external_id:
                                        type:
                                          - string
                                          - 'null'
                                        example: w3sdf92
                                    required:
                                      - id
                              - type: 'null'
                            default:
                              id: 456
                              share_guid: james-bond007
                          agreements:
                            type: array
                            items:
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                  example: 1
                                required:
                                  type: boolean
                                  example: true
                                title:
                                  type: string
                                  example: Terms and Conditions
                                show_path:
                                  type: string
                                  example: /terms
                                enrollment_pack_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                          amount_total:
                            type: string
                            example: '121.65'
                          amount_total_in_currency:
                            type: string
                            example: $121.65 (USD)
                          sub_total:
                            type: string
                            example: '100.00'
                          sub_total_in_currency:
                            type: string
                            example: $100.00 (USD)
                          subtotal_after_discounts:
                            type: string
                            example: '90.00'
                          tax_total:
                            type: string
                            example: '20.00'
                          tax_total_in_currency:
                            type: string
                            example: $20.00 (USD)
                          shipping_total:
                            type:
                              - string
                              - 'null'
                            example: '1.65'
                          shipping_total_in_currency:
                            type: string
                            example: $1.65 (USD)
                          shipping_discount:
                            type: number
                            example: 10.25
                          discount_total:
                            type: string
                            example: '2.99'
                          discount_total_in_currency:
                            type: string
                            example: $2.99 (USD)
                          discount_breakdown:
                            type: object
                            properties:
                              internal_discounts:
                                type: number
                                example: 15
                              external_discounts:
                                type: number
                                example: 10
                              total_discounts:
                                type: number
                                example: 25
                          external_discount:
                            type: object
                            properties:
                              total:
                                type: number
                                example: 10
                              calculated_at:
                                type:
                                  - string
                                  - 'null'
                                format: date-time
                                example: '2024-01-10T15:30:00Z'
                              sources:
                                type: object
                                additionalProperties:
                                  type: object
                                  properties:
                                    amount:
                                      type: number
                                      example: 6
                                    description:
                                      type: string
                                      example: Gold tier discount
                                    metadata:
                                      type: object
                                  required:
                                    - amount
                                    - description
                          transaction_fee:
                            type:
                              - number
                              - string
                            example: '1.90'
                          transaction_fee_in_currency:
                            type: string
                            example: $1.90 (USD)
                          cv_total:
                            type: integer
                            example: 10
                          qv_total:
                            type: integer
                            example: 15
                          company:
                            type: object
                            properties:
                              id:
                                type: integer
                              name:
                                type: string
                              primary_domain_hostname:
                                type:
                                  - string
                                  - 'null'
                                example: fluid.com
                              subdomain:
                                type:
                                  - string
                                  - 'null'
                                example: myco
                              logo_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/logo.png
                              fluid_shop:
                                type:
                                  - string
                                  - 'null'
                                example: https://fluid-sample-shop.fluid.com
                              collect_phone:
                                type: boolean
                                example: true
                              require_phone:
                                type: boolean
                                example: false
                              require_billing_zip:
                                type: boolean
                                example: false
                              checkout_primary_button_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#000000'
                              checkout_primary_text_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#FFFFFF'
                              checkout_secondary_button_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#FFFFFF'
                              checkout_secondary_text_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#000000'
                              favicon_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/favicon.ico
                              order_on_behalf:
                                type: boolean
                                example: false
                              use_juspay_gateway:
                                type: boolean
                                example: false
                              reward_points_enabled:
                                type: boolean
                                example: false
                          payment_account:
                            type:
                              - string
                              - 'null'
                            example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                          payment_method:
                            oneOf:
                              - type: 'null'
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: CreditCard
                                  payment_method_type:
                                    type: string
                                    example: visa
                                  last_four:
                                    type: string
                                    example: '1234'
                                  exp_month:
                                    type: string
                                    example: '12'
                                  exp_year:
                                    type: string
                                    example: '2025'
                                  logo_url:
                                    type: string
                                    example: https://example.com/image.svg
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Paypal
                                  status:
                                    type: string
                                    example: active
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Affirm
                                  affirm_id:
                                    type: string
                                    example: affirm_123
                                  status:
                                    type: string
                                    example: authorized
                                  checkout_id:
                                    type: string
                                    example: checkout_456
                                  created:
                                    type: string
                                    example: '2025-01-01T00:00:00Z'
                                  auth_expiration:
                                    type: string
                                    example: '2025-01-02T00:00:00Z'
                                  currency:
                                    type: string
                                    example: USD
                                  amount:
                                    type: string
                                    example: '100.00'
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Klarna
                                  session_id:
                                    type: string
                                    example: klarna_session_789
                                  intent:
                                    type: string
                                    example: buy
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Droplet
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: SomeCitcon
                          email:
                            type:
                              - string
                              - 'null'
                            example: user@example.com
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: '10.45'
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.45
                          discount_codes:
                            type: array
                            items:
                              type: string
                            example:
                              - DISCOUNT10
                              - DISCOUNT11
                          language_iso:
                            type:
                              - string
                              - 'null'
                            example: en
                          cart_token:
                            type: string
                            example: abc123
                          immutable_items:
                            type: boolean
                            example: false
                          digital_only:
                            type: boolean
                            example: false
                          requires_3ds:
                            type: boolean
                            example: false
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 101
                                price:
                                  type: string
                                  example: '43.41'
                                price_in_currency:
                                  type: string
                                  example: $43.41
                                tax:
                                  type: string
                                  example: '2.99'
                                tax_in_currency:
                                  type: string
                                  example: $2.99
                                cv:
                                  type: integer
                                  example: 5
                                cv_total:
                                  type: integer
                                  example: 15
                                qv:
                                  type: integer
                                  example: 7
                                qv_total:
                                  type: integer
                                  example: 21
                                discount_amount:
                                  type: string
                                  example: '10'
                                free_item:
                                  type: boolean
                                  example: false
                                discount_amount_in_currency:
                                  type: string
                                  example: $10.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                enrollment_pack_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                display_to_customer:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                product_title:
                                  type:
                                    - string
                                    - 'null'
                                  example: Sample Product
                                quantity:
                                  type: integer
                                  example: 3
                                subscription:
                                  type: boolean
                                  example: true
                                enrollment:
                                  type: boolean
                                  example: false
                                allow_subscription:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_only:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_price:
                                  type:
                                    - number
                                    - string
                                    - 'null'
                                  example: 10.5
                                subscription_price_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $10.50
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-02-12'
                                subscribe_and_save:
                                  type:
                                    - number
                                    - string
                                    - 'null'
                                  example: 2.99
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $2.99
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $2.99
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: Surcharge
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                product:
                                  oneOf:
                                    - type: object
                                      properties:
                                        id:
                                          type: integer
                                          example: 1
                                        title:
                                          type: string
                                          example: Sample Product
                                        introduction:
                                          type:
                                            - string
                                            - 'null'
                                          example: Sample Product Description
                                        cv:
                                          type: integer
                                          example: 10
                                        external_id:
                                          type:
                                            - string
                                            - 'null'
                                          example: ext-prod-123
                                        image_path:
                                          type:
                                            - string
                                            - 'null'
                                          example: /images/product.png
                                        image_url:
                                          type:
                                            - string
                                            - 'null'
                                          example: https://example.com/images/product.png
                                        price:
                                          type: string
                                          example: '29.99'
                                        price_in_currency:
                                          type: string
                                          example: $29.99
                                        sku:
                                          type:
                                            - string
                                            - 'null'
                                          example: SKU12345
                                        tax:
                                          type: string
                                          example: '2.99'
                                        tax_in_currency:
                                          type: string
                                          example: $2.99
                                        metadata:
                                          type: object
                                          example:
                                            shopify_product_id: 9876054868270
                                        metafields:
                                          type: array
                                          items:
                                            title: LegacyMetafield
                                            type: object
                                            properties:
                                              namespace:
                                                description: >-
                                                  A container for related metafields.
                                                  Commonly used to group metafields by app
                                                  or functionality.
                                                example: custom
                                                type: string
                                                maxLength: 20
                                                pattern: ^[a-zA-Z0-9_]+$
                                              key:
                                                description: >-
                                                  The unique identifier for the metafield
                                                  within its namespace. Must be unique per
                                                  namespace and owner.
                                                example: material
                                                type: string
                                                maxLength: 30
                                                pattern: ^[a-zA-Z0-9_]+$
                                              value:
                                                description: >-
                                                  The actual data stored in the metafield.
                                                  Type depends on value_type.
                                                example: cotton
                                                type:
                                                  - string
                                                  - integer
                                                  - object
                                                  - boolean
                                                  - number
                                              value_type:
                                                description: >-
                                                  The data type that defines how the value
                                                  should be interpreted and validated.
                                                example: single_line_text_field
                                                type: string
                                              description:
                                                description: >-
                                                  Optional human-readable description
                                                  explaining the purpose of this
                                                  metafield.
                                                example: >-
                                                  The primary material used in this
                                                  product
                                                type:
                                                  - string
                                                  - 'null'
                                              created_at:
                                                description: >-
                                                  Timestamp when the metafield was
                                                  created.
                                                example: '2021-01-01T00:00:00Z'
                                                type: string
                                                format: date-time
                                              updated_at:
                                                description: >-
                                                  Timestamp when the metafield was last
                                                  updated.
                                                example: '2021-01-01T00:00:00Z'
                                                type: string
                                                format: date-time
                                              locked:
                                                description: >-
                                                  Whether this metafield is locked and
                                                  cannot be updated or deleted directly.
                                                example: false
                                                type:
                                                  - boolean
                                                  - 'null'
                                                  - 'null'
                                              metafield_definition:
                                                description: >-
                                                  The definition that defines validation
                                                  rules and structure for this metafield
                                                type:
                                                  - 'null'
                                                  - object
                                            required:
                                              - namespace
                                              - key
                                              - value
                                              - value_type
                                              - description
                                              - created_at
                                              - updated_at
                                              - metafield_definition
                                    - type: 'null'
                                variant:
                                  oneOf:
                                    - type: object
                                      properties:
                                        id:
                                          type: integer
                                          example: 1
                                        title:
                                          type:
                                            - string
                                            - 'null'
                                          example: Sample Variant
                                        image_path:
                                          type:
                                            - string
                                            - 'null'
                                          example: /images/sample.png
                                        image_url:
                                          type:
                                            - string
                                            - 'null'
                                          example: https://example.com/images/sample.png
                                        primary_image:
                                          type:
                                            - string
                                            - 'null'
                                          example: https://example.com/images/primary.png
                                        price:
                                          type:
                                            - string
                                            - 'null'
                                          example: '34.44'
                                        price_in_currency:
                                          type:
                                            - string
                                            - 'null'
                                          example: $34.44
                                        sku:
                                          type:
                                            - string
                                            - 'null'
                                          example: SKU12345
                                        options:
                                          type: array
                                          items:
                                            type: object
                                            properties:
                                              title:
                                                type: string
                                                example: Size
                                              value:
                                                type: string
                                                example: XL
                                        physical:
                                          type:
                                            - boolean
                                            - 'null'
                                          example: true
                                        unit_of_size:
                                          type:
                                            - string
                                            - 'null'
                                          example: cm
                                        height:
                                          type:
                                            - number
                                            - 'null'
                                          example: 13
                                        width:
                                          type:
                                            - number
                                            - 'null'
                                          example: 6
                                        length:
                                          type:
                                            - number
                                            - 'null'
                                          example: 12
                                        unit_of_weight:
                                          type:
                                            - string
                                            - 'null'
                                          example: kg
                                        weight:
                                          type:
                                            - string
                                            - 'null'
                                          example: '3.2'
                                        hs_code:
                                          type:
                                            - string
                                            - 'null'
                                          example: '3.2'
                                    - type: 'null'
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                                bundled_items:
                                  type: array
                                  items:
                                    type: object
                                    description: Bundled items for bundle products
                                    properties:
                                      variant_id:
                                        type: integer
                                        example: 1
                                      product_id:
                                        type: integer
                                        example: 1
                                      product_title:
                                        type: string
                                        example: Product Title
                                      variant_title:
                                        type: string
                                        example: Variant Title
                                      option_titles:
                                        type: array
                                        example:
                                          - Option 1
                                          - Option 2
                                      quantity:
                                        type: integer
                                        example: 1
                                      display_to_customer:
                                        type: boolean
                                        example: true
                          ship_to:
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                                example: 1
                              name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              first_name:
                                type:
                                  - string
                                  - 'null'
                                example: John
                              last_name:
                                type:
                                  - string
                                  - 'null'
                                example: Doe
                              address1:
                                type: string
                                example: 123 Main St
                              address2:
                                type:
                                  - string
                                  - 'null'
                                example: Apt 4B
                              address3:
                                type:
                                  - string
                                  - 'null'
                                example: Building 5
                              city:
                                type: string
                                example: New York
                              state:
                                type: string
                                example: NY
                              postal_code:
                                type: string
                                example: '10001'
                              country_code:
                                type: string
                                example: US
                                description: >-
                                  country_id takes precedence if both country_id
                                  and country_code provided.
                              subdivision_code:
                                type:
                                  - string
                                  - 'null'
                                example: NY
                              default:
                                type: boolean
                                example: true
                          bill_to:
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                                example: 1
                              name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              first_name:
                                type:
                                  - string
                                  - 'null'
                                example: John
                              last_name:
                                type:
                                  - string
                                  - 'null'
                                example: Doe
                              address1:
                                type: string
                                example: 123 Main St
                              address2:
                                type:
                                  - string
                                  - 'null'
                                example: Apt 4B
                              address3:
                                type:
                                  - string
                                  - 'null'
                                example: Building 5
                              city:
                                type: string
                                example: New York
                              state:
                                type: string
                                example: NY
                              postal_code:
                                type: string
                                example: '10001'
                              country_code:
                                type: string
                                example: US
                                description: >-
                                  country_id takes precedence if both country_id
                                  and country_code provided.
                              subdivision_code:
                                type:
                                  - string
                                  - 'null'
                                example: NY
                              default:
                                type: boolean
                                example: true
                          shipping_method:
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: string
                                example: standard-shipping
                              name:
                                type: string
                                example: Standard Shipping
                          available_shipping_methods:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                  example: standard-shipping
                                title:
                                  type: string
                                  example: Standard Shipping
                                price:
                                  type:
                                    - number
                                    - string
                                  example: 5.99
                                price_label:
                                  type: string
                                  example: $5.99
                                delivery_time_estimate:
                                  type: string
                                  example: 3-5 business days
                          available_payment_methods:
                            type: array
                            items:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1337
                                    uuid:
                                      type: string
                                      example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                    type:
                                      type: string
                                      enum:
                                        - credit_card
                                    name:
                                      type: string
                                      example: Credit Card
                                    image_url:
                                      type: string
                                      example: https://example.com/image.png
                                    test:
                                      type: boolean
                                      example: true
                                      description: >-
                                        Determines if payment method is test
                                        instance or not. By default, set to
                                        `true`
                                    sandbox:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method is sandbox
                                        instance or not. By default, set to
                                        `false`
                                    apple_pay:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method supports
                                        ApplePay or not 
                                    bogus_gateway:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method is a Bogus
                                        instance or not.
                                    tokenize_path:
                                      type:
                                        - string
                                        - 'null'
                                      description: Path to tokenize, if applicable.
                                    token_provider:
                                      type: string
                                      enum:
                                        - spreedly
                                        - vgs
                                      description: >-
                                        Determines if payment tokenization is
                                        via spreedly or VGS
                                    apple_pay_merchant_identifier:
                                      type:
                                        - string
                                        - 'null'
                                      example: merchant.mycompany.com
                                      description: >-
                                        If ApplePay is supported, returns the
                                        merchant identifier registered with
                                        Apple, else returns nil
                                    supported_brands:
                                      type: array
                                      items:
                                        type: string
                                      example:
                                        - visa
                                        - master
                                        - american_express
                                        - discover
                                    publishable_key:
                                      type:
                                        - string
                                        - 'null'
                                      example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                      description: >-
                                        If publishable key is set for
                                        Hyperswitch, returns the publishable
                                        key, else returns nil
                                    customer_details_schema:
                                      type: object
                                      example: {}
                                      description: >-
                                        Schema defining required customer
                                        details for this payment method
                                  required:
                                    - id
                                    - type
                                    - name
                                    - supported_brands
                                    - test
                                    - sandbox
                                    - apple_pay
                                    - apple_pay_merchant_identifier
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1337
                                    uuid:
                                      type: string
                                      example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                    type:
                                      type: string
                                      enum:
                                        - klarna
                                    name:
                                      type: string
                                      example: Klarna
                                    image_url:
                                      type: string
                                      example: https://example.com/image.png
                                    test:
                                      type: boolean
                                      example: true
                                      description: >-
                                        Determines if payment method is test
                                        instance or not. By default, set to
                                        `true`
                                    sandbox:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method is sandbox
                                        instance or not. By default, set to
                                        `false`
                                    customer_details_schema:
                                      type: object
                                      example: {}
                                      description: >-
                                        Schema defining required customer
                                        details for this payment method
                          country:
                            type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              iso:
                                type: string
                                example: US
                              name:
                                type: string
                                example: United States
                              iso_name:
                                type: string
                                example: UNITED STATES
                              iso3:
                                type: string
                                example: USA
                              currency_code:
                                type: string
                                example: USD
                              currency_symbol:
                                type: string
                                example: $
                              province_required:
                                type: boolean
                                example: false
                              tax_enabled:
                                type:
                                  - boolean
                                  - 'null'
                                example: true
                              price_inclusive_of_tax:
                                type: boolean
                                example: false
                              price_inclusive_tax_name:
                                type:
                                  - string
                                  - 'null'
                                example: VAT
                          type:
                            type: string
                            enum:
                              - regular
                              - enrollment
                            example: regular
                          enrollment_pack_id:
                            type:
                              - integer
                              - 'null'
                            example: 1
                          enrollment_pack:
                            type:
                              - object
                              - 'null'
                            properties:
                              enrollment_pack_id:
                                type: integer
                                example: 1
                              additional_volume:
                                type:
                                  - integer
                                  - 'null'
                                example: 10
                              slug:
                                type: string
                                example: test-enrollment-pack
                              description:
                                type:
                                  - object
                                  - 'null'
                                  - string
                                properties:
                                  id:
                                    type: integer
                                    example: 111
                                  name:
                                    type: string
                                    example: description
                                  body:
                                    type: string
                                    example: >-
                                      <div>Try the latest and greatest of our
                                      sugar zip packs. Guaranteed to make you
                                      skinner and cure cancer.</div>
                                  record_type:
                                    type: string
                                    example: EnrollmentPack
                                  record_id:
                                    type: integer
                                    example: 1
                                  created_at:
                                    type: string
                                    format: date_time
                                    example: '2025-01-16T04:22:43.809Z'
                                  updated_at:
                                    type: string
                                    format: date_time
                                    example: '2025-01-22T10:23:52.941Z'
                                  locale:
                                    type: string
                                    example: en
                              enrollment_fee:
                                type:
                                  - number
                                  - string
                                example: 10
                              enrollment_fee_in_currency:
                                type: string
                                example: $10.00
                              images:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 2
                                    relateable_type:
                                      type: string
                                      example: EnrollmentPack
                                    relateable_id:
                                      type: integer
                                      example: 1
                                    image_url:
                                      type: string
                                      example: >-
                                        https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                    image_path:
                                      type: string
                                      example: jITWaU14QGe0y5AFgY7P_00179.svg
                                    position:
                                      type: integer
                                      example: 1
                                    shopify_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: null
                                    created_at:
                                      type: string
                                      format: date_time
                                      example: '2025-01-16T04:22:44.870Z'
                                    updated_at:
                                      type: string
                                      format: date_time
                                      example: '2025-01-16T04:22:44.870Z'
                                    external_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: null
                              items:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 625
                                    allow_subscription:
                                      type: boolean
                                      example: true
                                    cv:
                                      type:
                                        - number
                                        - string
                                      example: 0
                                    cv_in_currency:
                                      type: string
                                      example: $0.00
                                    cv_total:
                                      type: integer
                                      example: 0
                                    enrollment:
                                      type: boolean
                                      example: true
                                    enrollment_pack_id:
                                      type: integer
                                      example: 1
                                    price:
                                      type: string
                                      example: '11.13'
                                    price_in_currency:
                                      type: string
                                      example: $11.13
                                    product_title:
                                      type: string
                                      example: Zip Pack Sample Pack (30)
                                    quantity:
                                      type: integer
                                      example: 1
                                    qv:
                                      type:
                                        - number
                                        - string
                                      example: 0
                                    qv_in_currency:
                                      type: string
                                      example: $0.00
                                    qv_total:
                                      type: integer
                                      example: 0
                                    subscribe_and_save:
                                      type:
                                        - string
                                        - 'null'
                                      example: '-1988.87'
                                    subscribe_and_save_for_display:
                                      type:
                                        - string
                                        - 'null'
                                      example: Subscribe and save $-1,988.87
                                    subscribe_and_save_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $-1,988.87
                                    subscription:
                                      type: boolean
                                      example: false
                                    subscription_interval:
                                      type:
                                        - integer
                                        - 'null'
                                      example: 1
                                    subscription_interval_unit:
                                      type:
                                        - string
                                        - 'null'
                                      example: month
                                    subscription_only:
                                      type: boolean
                                      example: false
                                    subscription_plan_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: 1
                                    subscription_plans:
                                      oneOf:
                                        - type: array
                                          items:
                                            title: Commerce::SubscriptionPlan
                                            type: object
                                            properties:
                                              id:
                                                type: integer
                                              name:
                                                example: Test Subscription Plan
                                                type: string
                                              billing_interval:
                                                example: 1
                                                type: integer
                                                default: 1
                                                minimum: 1
                                                maximum: 29
                                              billing_interval_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type: string
                                                default: month
                                              billing_frequency_in_words:
                                                example: 2 Months
                                                type: string
                                              shipping_interval:
                                                example: 1
                                                type: integer
                                                default: 1
                                                minimum: 1
                                                maximum: 29
                                              shipping_interval_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type: string
                                                default: month
                                              volume_interval:
                                                example: 1
                                                type: integer
                                                default: 1
                                                minimum: 1
                                                maximum: 29
                                              volume_interval_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type: string
                                                default: month
                                              trial_period:
                                                example: 1
                                                type:
                                                  - integer
                                                  - 'null'
                                                minimum: 1
                                              trial_period_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type:
                                                  - string
                                                  - 'null'
                                              split_volume:
                                                example: true
                                                type: boolean
                                                default: false
                                              allow_max_billing_cycles:
                                                example: true
                                                type: boolean
                                                default: false
                                              max_billing_cycles:
                                                example: 3
                                                type:
                                                  - integer
                                                  - 'null'
                                              company_default:
                                                example: false
                                                type:
                                                  - boolean
                                                  - 'null'
                                                default: false
                                              products_count:
                                                example: 10
                                                type:
                                                  - integer
                                                  - 'null'
                                              subscribers_count:
                                                example: 10
                                                type:
                                                  - integer
                                                  - 'null'
                                              price:
                                                type: string
                                              price_in_currency:
                                                type: string
                                              subscription_start:
                                                type: string
                                              subscribe_and_save:
                                                type:
                                                  - string
                                                  - 'null'
                                              subscribe_and_save_in_currency:
                                                type:
                                                  - string
                                                  - 'null'
                                              subscribe_and_save_for_display:
                                                type:
                                                  - string
                                                  - 'null'
                                            required:
                                              - id
                                              - name
                                              - billing_interval
                                              - billing_interval_unit
                                              - billing_frequency_in_words
                                              - shipping_interval
                                              - shipping_interval_unit
                                              - volume_interval
                                              - volume_interval_unit
                                              - split_volume
                                              - allow_max_billing_cycles
                                              - price
                                              - price_in_currency
                                              - subscription_start
                                              - subscribe_and_save
                                              - subscribe_and_save_in_currency
                                              - subscribe_and_save_for_display
                                        - type: 'null'
                                    subscription_price:
                                      type: string
                                      example: '2000.0'
                                    subscription_price_in_currency:
                                      type: string
                                      example: $2,000.00
                                    subscription_start:
                                      type:
                                        - string
                                        - 'null'
                                      format: date
                                      example: '2025-02-28'
                                    tax:
                                      type: string
                                      example: '0.0'
                                    tax_in_currency:
                                      type: string
                                      example: $0.00
                                    total_after_discounts:
                                      type: string
                                      example: '90.00'
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: null
                                    display_to_customer:
                                      type: boolean
                                      example: false
                                    metadata:
                                      type: object
                                      description: >-
                                        A JSON object that can store any custom
                                        data structure
                                      example: {}
                                    errors:
                                      oneOf:
                                        - type: 'null'
                                        - type: array
                                          items:
                                            type: object
                                          example:
                                            - country:
                                                - >-
                                                  This product is not available for this
                                                  country. Please change your country
                              price:
                                type: string
                                example: '11.13'
                              price_in_currency:
                                type: string
                                example: $11.13
                              subscription_price:
                                type:
                                  - string
                                  - integer
                                example: 2000
                              subscription_price_in_currency:
                                type: string
                                example: $2,000.00
                              title:
                                type: string
                                example: enroll product
                              token:
                                type: string
                                example: NxL22AqLRRisfyF9LqxxWRak
                          metadata:
                            type: object
                            description: >-
                              A JSON object that can store any custom data
                              structure.
                          recurring:
                            oneOf:
                              - type: array
                                items:
                                  type: object
                                  properties:
                                    subtotal:
                                      type: string
                                      example: '10.0'
                                    subtotal_in_currency:
                                      type: string
                                      example: $10.0
                                    interval:
                                      type: integer
                                      example: 1
                                    interval_unit:
                                      type: string
                                      example: month
                                    subtotal_for_display:
                                      type: string
                                      example: $10.00 every 1 month
                                    start_date:
                                      type:
                                        - string
                                        - 'null'
                                      example: '2025-05-27'
                              - type: 'null'
                            default:
                              - subtotal: '10.0'
                                subtotal_in_currency: $10.0
                                interval: 1
                                interval_unit: month
                                subtotal_for_display: $10.00 every 1 month
                                start_date: '2025-05-27'
                          messages:
                            type: object
                            additionalProperties: true
                            example:
                              errors:
                                - Insufficient inventory
                                - Product no longer available
                              warnings:
                                - Low stock warning
                                - Shipping delays expected
                              info:
                                - Free shipping available
                                - Volume discount applied
                          points_enabled:
                            type: boolean
                            example: true
                          points_applied:
                            type: integer
                            example: 500
                            description: Number of points applied to the cart
                          points_applied_amount_in_currency:
                            type: number
                            example: 5
                            description: Currency value of applied points
                          customer_total_points:
                            type: integer
                            example: 1000
                            description: Customer's total available points balance
                          customer_total_points_in_currency:
                            type: number
                            example: 10
                            description: Currency value of available points
                          remaining_customer_points:
                            type: integer
                            example: 500
                            description: Customer's remaining points after cart redemption
                          remaining_customer_points_amount_in_currency:
                            type: number
                            example: 5
                            description: >-
                              Currency value of remaining points after cart
                              redemption
                          remaining_cart_amount_after_points:
                            type: number
                            example: 95
                            description: Amount to charge to card after points redemption
                          remaining_cart_amount_after_points_in_currency:
                            type:
                              - string
                            example: $95.00
                            description: >-
                              Amount in currency to charge to card after points
                              redemption
                          max_applicable_points:
                            type: integer
                            example: 500
                            description: Maximum points that can be applied to this cart
                required:
                  - error_message
                  - errors
                  - meta
        '422':
          description: invalid address type
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Invalid address type
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      country:
                        type: array
                        items:
                          type: string
      requestBody:
        content:
          application/json:
            schema:
              type:
                - object
                - 'null'
              properties:
                type:
                  type: string
                  enum:
                    - ship_to
                    - bill_to
                  example: bill_to
                use_shipping_address_for_billing:
                  type: boolean
                  example: false
                jwt:
                  type:
                    - string
                    - 'null'
                  example: eyJhbGciO1NiJ9.eyJhdXcyNjN9.AZ-4PAgFwVyGp
                address_id:
                  type:
                    - integer
                    - 'null'
                  example: 456
                address:
                  type:
                    - object
                    - 'null'
                  properties:
                    id:
                      type:
                        - integer
                        - 'null'
                      example: 456
                    first_name:
                      type: string
                      example: John
                    last_name:
                      type: string
                      example: Doe
                    address1:
                      type: string
                      example: 123 Main St
                    city:
                      type: string
                      example: Anytown
                    state:
                      type: string
                      example: CA
                    postal_code:
                      type: string
                      example: '12345'
                    country_code:
                      type: string
                      example: US
  /api/carts/{cart_token}:
    get:
      summary: Retrieves a cart
      tags:
        - Carts
      operationId: getCart
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
        - name: payment_methods_includes
          in: query
          required: false
          schema:
            type: string
      responses:
        '200':
          description: cart found
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      state:
                        type: string
                        example: start
                      processed:
                        type: boolean
                        example: false
                        description: >-
                          Determines if a cart payment has been processed or
                          not.
                      valid_for_checkout:
                        type: boolean
                        example: true
                      buyer_rep_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      buyer_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: buyer.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                              external_id:
                                type:
                                  - string
                                  - 'null'
                                example: '123241'
                            required:
                              - id
                          - type: 'null'
                      volume_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: volume.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                            required:
                              - id
                          - type: 'null'
                      currency_symbol:
                        type: string
                        example: $
                      currency_code:
                        type: string
                        example: USD
                      shipping_total_for_display:
                        type: string
                        example: Free
                      phone:
                        type:
                          - string
                          - 'null'
                        example: '4035551212'
                      payment_method_auto_assignable:
                        type: boolean
                        example: true
                        description: >-
                          Determines if a payment method can be auto-assigned to
                          the cart.
                      attribution:
                        oneOf:
                          - type: object
                            oneOf:
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  share_guid:
                                    type: string
                                    example: james-bond007
                                required:
                                  - id
                                  - share_guid
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  email:
                                    type: string
                                    example: james.bond@gmail.com
                                required:
                                  - id
                                  - email
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  username:
                                    type: string
                                    example: jaamball234
                                required:
                                  - id
                                  - username
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  fluid_rep_id:
                                    type: integer
                                    example: 23493
                                required:
                                  - id
                                  - fluid_rep_id
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: w3sdf92
                                required:
                                  - id
                          - type: 'null'
                        default:
                          id: 456
                          share_guid: james-bond007
                      agreements:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            required:
                              type: boolean
                              example: true
                            title:
                              type: string
                              example: Terms and Conditions
                            show_path:
                              type: string
                              example: /terms
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                      amount_total:
                        type: string
                        example: '121.65'
                      amount_total_in_currency:
                        type: string
                        example: $121.65 (USD)
                      sub_total:
                        type: string
                        example: '100.00'
                      sub_total_in_currency:
                        type: string
                        example: $100.00 (USD)
                      subtotal_after_discounts:
                        type: string
                        example: '90.00'
                      tax_total:
                        type: string
                        example: '20.00'
                      tax_total_in_currency:
                        type: string
                        example: $20.00 (USD)
                      shipping_total:
                        type:
                          - string
                          - 'null'
                        example: '1.65'
                      shipping_total_in_currency:
                        type: string
                        example: $1.65 (USD)
                      shipping_discount:
                        type: number
                        example: 10.25
                      discount_total:
                        type: string
                        example: '2.99'
                      discount_total_in_currency:
                        type: string
                        example: $2.99 (USD)
                      discount_breakdown:
                        type: object
                        properties:
                          internal_discounts:
                            type: number
                            example: 15
                          external_discounts:
                            type: number
                            example: 10
                          total_discounts:
                            type: number
                            example: 25
                      external_discount:
                        type: object
                        properties:
                          total:
                            type: number
                            example: 10
                          calculated_at:
                            type:
                              - string
                              - 'null'
                            format: date-time
                            example: '2024-01-10T15:30:00Z'
                          sources:
                            type: object
                            additionalProperties:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 6
                                description:
                                  type: string
                                  example: Gold tier discount
                                metadata:
                                  type: object
                              required:
                                - amount
                                - description
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: '1.90'
                      transaction_fee_in_currency:
                        type: string
                        example: $1.90 (USD)
                      cv_total:
                        type: integer
                        example: 10
                      qv_total:
                        type: integer
                        example: 15
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      payment_account:
                        type:
                          - string
                          - 'null'
                        example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                      payment_method:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: CreditCard
                              payment_method_type:
                                type: string
                                example: visa
                              last_four:
                                type: string
                                example: '1234'
                              exp_month:
                                type: string
                                example: '12'
                              exp_year:
                                type: string
                                example: '2025'
                              logo_url:
                                type: string
                                example: https://example.com/image.svg
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Paypal
                              status:
                                type: string
                                example: active
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Affirm
                              affirm_id:
                                type: string
                                example: affirm_123
                              status:
                                type: string
                                example: authorized
                              checkout_id:
                                type: string
                                example: checkout_456
                              created:
                                type: string
                                example: '2025-01-01T00:00:00Z'
                              auth_expiration:
                                type: string
                                example: '2025-01-02T00:00:00Z'
                              currency:
                                type: string
                                example: USD
                              amount:
                                type: string
                                example: '100.00'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Klarna
                              session_id:
                                type: string
                                example: klarna_session_789
                              intent:
                                type: string
                                example: buy
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Droplet
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: SomeCitcon
                      email:
                        type:
                          - string
                          - 'null'
                        example: user@example.com
                      enrollment_fee:
                        type:
                          - number
                          - string
                        example: '10.45'
                      enrollment_fee_in_currency:
                        type: string
                        example: $10.45
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT10
                          - DISCOUNT11
                      language_iso:
                        type:
                          - string
                          - 'null'
                        example: en
                      cart_token:
                        type: string
                        example: abc123
                      immutable_items:
                        type: boolean
                        example: false
                      digital_only:
                        type: boolean
                        example: false
                      requires_3ds:
                        type: boolean
                        example: false
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 101
                            price:
                              type: string
                              example: '43.41'
                            price_in_currency:
                              type: string
                              example: $43.41
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            cv:
                              type: integer
                              example: 5
                            cv_total:
                              type: integer
                              example: 15
                            qv:
                              type: integer
                              example: 7
                            qv_total:
                              type: integer
                              example: 21
                            discount_amount:
                              type: string
                              example: '10'
                            free_item:
                              type: boolean
                              example: false
                            discount_amount_in_currency:
                              type: string
                              example: $10.00
                            total_after_discounts:
                              type: string
                              example: '90.00'
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            product_title:
                              type:
                                - string
                                - 'null'
                              example: Sample Product
                            quantity:
                              type: integer
                              example: 3
                            subscription:
                              type: boolean
                              example: true
                            enrollment:
                              type: boolean
                              example: false
                            allow_subscription:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_plan_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_plans:
                              oneOf:
                                - type: array
                                  items:
                                    title: Commerce::SubscriptionPlan
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        example: Test Subscription Plan
                                        type: string
                                      billing_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      billing_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      billing_frequency_in_words:
                                        example: 2 Months
                                        type: string
                                      shipping_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      shipping_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      volume_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      volume_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      trial_period:
                                        example: 1
                                        type:
                                          - integer
                                          - 'null'
                                        minimum: 1
                                      trial_period_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type:
                                          - string
                                          - 'null'
                                      split_volume:
                                        example: true
                                        type: boolean
                                        default: false
                                      allow_max_billing_cycles:
                                        example: true
                                        type: boolean
                                        default: false
                                      max_billing_cycles:
                                        example: 3
                                        type:
                                          - integer
                                          - 'null'
                                      company_default:
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                        default: false
                                      products_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      subscribers_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      price:
                                        type: string
                                      price_in_currency:
                                        type: string
                                      subscription_start:
                                        type: string
                                      subscribe_and_save:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_in_currency:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_for_display:
                                        type:
                                          - string
                                          - 'null'
                                    required:
                                      - id
                                      - name
                                      - billing_interval
                                      - billing_interval_unit
                                      - billing_frequency_in_words
                                      - shipping_interval
                                      - shipping_interval_unit
                                      - volume_interval
                                      - volume_interval_unit
                                      - split_volume
                                      - allow_max_billing_cycles
                                      - price
                                      - price_in_currency
                                      - subscription_start
                                      - subscribe_and_save
                                      - subscribe_and_save_in_currency
                                      - subscribe_and_save_for_display
                                - type: 'null'
                            subscription_only:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_interval:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_interval_unit:
                              type:
                                - string
                                - 'null'
                              example: month
                            subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 10.5
                            subscription_price_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $10.50
                            subscription_start:
                              type:
                                - string
                                - 'null'
                              example: '2025-02-12'
                            subscribe_and_save:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 2.99
                            subscribe_and_save_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $2.99
                            subscribe_and_save_for_display:
                              type:
                                - string
                                - 'null'
                              example: Subscribe and save $2.99
                            title:
                              type:
                                - string
                                - 'null'
                              example: Surcharge
                            metadata:
                              type: object
                              description: >-
                                A JSON object that can store any custom data
                                structure
                              example: {}
                            product:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type: string
                                      example: Sample Product
                                    introduction:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Product Description
                                    cv:
                                      type: integer
                                      example: 10
                                    external_id:
                                      type:
                                        - string
                                        - 'null'
                                      example: ext-prod-123
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/product.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/product.png
                                    price:
                                      type: string
                                      example: '29.99'
                                    price_in_currency:
                                      type: string
                                      example: $29.99
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    tax:
                                      type: string
                                      example: '2.99'
                                    tax_in_currency:
                                      type: string
                                      example: $2.99
                                    metadata:
                                      type: object
                                      example:
                                        shopify_product_id: 9876054868270
                                    metafields:
                                      type: array
                                      items:
                                        title: LegacyMetafield
                                        type: object
                                        properties:
                                          namespace:
                                            description: >-
                                              A container for related metafields.
                                              Commonly used to group metafields by app
                                              or functionality.
                                            example: custom
                                            type: string
                                            maxLength: 20
                                            pattern: ^[a-zA-Z0-9_]+$
                                          key:
                                            description: >-
                                              The unique identifier for the metafield
                                              within its namespace. Must be unique per
                                              namespace and owner.
                                            example: material
                                            type: string
                                            maxLength: 30
                                            pattern: ^[a-zA-Z0-9_]+$
                                          value:
                                            description: >-
                                              The actual data stored in the metafield.
                                              Type depends on value_type.
                                            example: cotton
                                            type:
                                              - string
                                              - integer
                                              - object
                                              - boolean
                                              - number
                                          value_type:
                                            description: >-
                                              The data type that defines how the value
                                              should be interpreted and validated.
                                            example: single_line_text_field
                                            type: string
                                          description:
                                            description: >-
                                              Optional human-readable description
                                              explaining the purpose of this
                                              metafield.
                                            example: >-
                                              The primary material used in this
                                              product
                                            type:
                                              - string
                                              - 'null'
                                          created_at:
                                            description: >-
                                              Timestamp when the metafield was
                                              created.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          updated_at:
                                            description: >-
                                              Timestamp when the metafield was last
                                              updated.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          locked:
                                            description: >-
                                              Whether this metafield is locked and
                                              cannot be updated or deleted directly.
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                              - 'null'
                                          metafield_definition:
                                            description: >-
                                              The definition that defines validation
                                              rules and structure for this metafield
                                            type:
                                              - 'null'
                                              - object
                                        required:
                                          - namespace
                                          - key
                                          - value
                                          - value_type
                                          - description
                                          - created_at
                                          - updated_at
                                          - metafield_definition
                                - type: 'null'
                            variant:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Variant
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/sample.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/sample.png
                                    primary_image:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/primary.png
                                    price:
                                      type:
                                        - string
                                        - 'null'
                                      example: '34.44'
                                    price_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $34.44
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    options:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          title:
                                            type: string
                                            example: Size
                                          value:
                                            type: string
                                            example: XL
                                    physical:
                                      type:
                                        - boolean
                                        - 'null'
                                      example: true
                                    unit_of_size:
                                      type:
                                        - string
                                        - 'null'
                                      example: cm
                                    height:
                                      type:
                                        - number
                                        - 'null'
                                      example: 13
                                    width:
                                      type:
                                        - number
                                        - 'null'
                                      example: 6
                                    length:
                                      type:
                                        - number
                                        - 'null'
                                      example: 12
                                    unit_of_weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: kg
                                    weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                    hs_code:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                - type: 'null'
                            errors:
                              oneOf:
                                - type: 'null'
                                - type: array
                                  items:
                                    type: object
                                  example:
                                    - country:
                                        - >-
                                          This product is not available for this
                                          country. Please change your country
                            bundled_items:
                              type: array
                              items:
                                type: object
                                description: Bundled items for bundle products
                                properties:
                                  variant_id:
                                    type: integer
                                    example: 1
                                  product_id:
                                    type: integer
                                    example: 1
                                  product_title:
                                    type: string
                                    example: Product Title
                                  variant_title:
                                    type: string
                                    example: Variant Title
                                  option_titles:
                                    type: array
                                    example:
                                      - Option 1
                                      - Option 2
                                  quantity:
                                    type: integer
                                    example: 1
                                  display_to_customer:
                                    type: boolean
                                    example: true
                      ship_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      bill_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      shipping_method:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: string
                            example: standard-shipping
                          name:
                            type: string
                            example: Standard Shipping
                      available_shipping_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: standard-shipping
                            title:
                              type: string
                              example: Standard Shipping
                            price:
                              type:
                                - number
                                - string
                              example: 5.99
                            price_label:
                              type: string
                              example: $5.99
                            delivery_time_estimate:
                              type: string
                              example: 3-5 business days
                      available_payment_methods:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - credit_card
                                name:
                                  type: string
                                  example: Credit Card
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                apple_pay:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method supports
                                    ApplePay or not 
                                bogus_gateway:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is a Bogus
                                    instance or not.
                                tokenize_path:
                                  type:
                                    - string
                                    - 'null'
                                  description: Path to tokenize, if applicable.
                                token_provider:
                                  type: string
                                  enum:
                                    - spreedly
                                    - vgs
                                  description: >-
                                    Determines if payment tokenization is via
                                    spreedly or VGS
                                apple_pay_merchant_identifier:
                                  type:
                                    - string
                                    - 'null'
                                  example: merchant.mycompany.com
                                  description: >-
                                    If ApplePay is supported, returns the
                                    merchant identifier registered with Apple,
                                    else returns nil
                                supported_brands:
                                  type: array
                                  items:
                                    type: string
                                  example:
                                    - visa
                                    - master
                                    - american_express
                                    - discover
                                publishable_key:
                                  type:
                                    - string
                                    - 'null'
                                  example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                  description: >-
                                    If publishable key is set for Hyperswitch,
                                    returns the publishable key, else returns
                                    nil
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                              required:
                                - id
                                - type
                                - name
                                - supported_brands
                                - test
                                - sandbox
                                - apple_pay
                                - apple_pay_merchant_identifier
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - klarna
                                name:
                                  type: string
                                  example: Klarna
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                      country:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          iso:
                            type: string
                            example: US
                          name:
                            type: string
                            example: United States
                          iso_name:
                            type: string
                            example: UNITED STATES
                          iso3:
                            type: string
                            example: USA
                          currency_code:
                            type: string
                            example: USD
                          currency_symbol:
                            type: string
                            example: $
                          province_required:
                            type: boolean
                            example: false
                          tax_enabled:
                            type:
                              - boolean
                              - 'null'
                            example: true
                          price_inclusive_of_tax:
                            type: boolean
                            example: false
                          price_inclusive_tax_name:
                            type:
                              - string
                              - 'null'
                            example: VAT
                      type:
                        type: string
                        enum:
                          - regular
                          - enrollment
                        example: regular
                      enrollment_pack_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      enrollment_pack:
                        type:
                          - object
                          - 'null'
                        properties:
                          enrollment_pack_id:
                            type: integer
                            example: 1
                          additional_volume:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          slug:
                            type: string
                            example: test-enrollment-pack
                          description:
                            type:
                              - object
                              - 'null'
                              - string
                            properties:
                              id:
                                type: integer
                                example: 111
                              name:
                                type: string
                                example: description
                              body:
                                type: string
                                example: >-
                                  <div>Try the latest and greatest of our sugar
                                  zip packs. Guaranteed to make you skinner and
                                  cure cancer.</div>
                              record_type:
                                type: string
                                example: EnrollmentPack
                              record_id:
                                type: integer
                                example: 1
                              created_at:
                                type: string
                                format: date_time
                                example: '2025-01-16T04:22:43.809Z'
                              updated_at:
                                type: string
                                format: date_time
                                example: '2025-01-22T10:23:52.941Z'
                              locale:
                                type: string
                                example: en
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: 10
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.00
                          images:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2
                                relateable_type:
                                  type: string
                                  example: EnrollmentPack
                                relateable_id:
                                  type: integer
                                  example: 1
                                image_url:
                                  type: string
                                  example: >-
                                    https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                image_path:
                                  type: string
                                  example: jITWaU14QGe0y5AFgY7P_00179.svg
                                position:
                                  type: integer
                                  example: 1
                                shopify_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                                created_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                updated_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                external_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 625
                                allow_subscription:
                                  type: boolean
                                  example: true
                                cv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                cv_in_currency:
                                  type: string
                                  example: $0.00
                                cv_total:
                                  type: integer
                                  example: 0
                                enrollment:
                                  type: boolean
                                  example: true
                                enrollment_pack_id:
                                  type: integer
                                  example: 1
                                price:
                                  type: string
                                  example: '11.13'
                                price_in_currency:
                                  type: string
                                  example: $11.13
                                product_title:
                                  type: string
                                  example: Zip Pack Sample Pack (30)
                                quantity:
                                  type: integer
                                  example: 1
                                qv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                qv_in_currency:
                                  type: string
                                  example: $0.00
                                qv_total:
                                  type: integer
                                  example: 0
                                subscribe_and_save:
                                  type:
                                    - string
                                    - 'null'
                                  example: '-1988.87'
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $-1,988.87
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $-1,988.87
                                subscription:
                                  type: boolean
                                  example: false
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_only:
                                  type: boolean
                                  example: false
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_price:
                                  type: string
                                  example: '2000.0'
                                subscription_price_in_currency:
                                  type: string
                                  example: $2,000.00
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  format: date
                                  example: '2025-02-28'
                                tax:
                                  type: string
                                  example: '0.0'
                                tax_in_currency:
                                  type: string
                                  example: $0.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: null
                                display_to_customer:
                                  type: boolean
                                  example: false
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                          price:
                            type: string
                            example: '11.13'
                          price_in_currency:
                            type: string
                            example: $11.13
                          subscription_price:
                            type:
                              - string
                              - integer
                            example: 2000
                          subscription_price_in_currency:
                            type: string
                            example: $2,000.00
                          title:
                            type: string
                            example: enroll product
                          token:
                            type: string
                            example: NxL22AqLRRisfyF9LqxxWRak
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      recurring:
                        oneOf:
                          - type: array
                            items:
                              type: object
                              properties:
                                subtotal:
                                  type: string
                                  example: '10.0'
                                subtotal_in_currency:
                                  type: string
                                  example: $10.0
                                interval:
                                  type: integer
                                  example: 1
                                interval_unit:
                                  type: string
                                  example: month
                                subtotal_for_display:
                                  type: string
                                  example: $10.00 every 1 month
                                start_date:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-05-27'
                          - type: 'null'
                        default:
                          - subtotal: '10.0'
                            subtotal_in_currency: $10.0
                            interval: 1
                            interval_unit: month
                            subtotal_for_display: $10.00 every 1 month
                            start_date: '2025-05-27'
                      messages:
                        type: object
                        additionalProperties: true
                        example:
                          errors:
                            - Insufficient inventory
                            - Product no longer available
                          warnings:
                            - Low stock warning
                            - Shipping delays expected
                          info:
                            - Free shipping available
                            - Volume discount applied
                      points_enabled:
                        type: boolean
                        example: true
                      points_applied:
                        type: integer
                        example: 500
                        description: Number of points applied to the cart
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Currency value of applied points
                      customer_total_points:
                        type: integer
                        example: 1000
                        description: Customer's total available points balance
                      customer_total_points_in_currency:
                        type: number
                        example: 10
                        description: Currency value of available points
                      remaining_customer_points:
                        type: integer
                        example: 500
                        description: Customer's remaining points after cart redemption
                      remaining_customer_points_amount_in_currency:
                        type: number
                        example: 5
                        description: >-
                          Currency value of remaining points after cart
                          redemption
                      remaining_cart_amount_after_points:
                        type: number
                        example: 95
                        description: Amount to charge to card after points redemption
                      remaining_cart_amount_after_points_in_currency:
                        type:
                          - string
                        example: $95.00
                        description: >-
                          Amount in currency to charge to card after points
                          redemption
                      max_applicable_points:
                        type: integer
                        example: 500
                        description: Maximum points that can be applied to this cart
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      checkout_url:
                        type: string
                        example: https://checkout.fluid.com/checkout?jwt=abc123
                      shop_url:
                        type: string
                        example: https://myco.fluid.app
        '404':
          description: cart not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
                      example:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '410':
          description: cart is processed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Cart is processed and can't be modified
                  errors:
                    type: object
                    example:
                      cart:
                        - is processed and can't be modified
                  meta:
                    type: object
                    properties:
                      shop_url:
                        type: string
                        example: https://example.myshopify.com
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      cart:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 123
                          state:
                            type: string
                            example: start
                          processed:
                            type: boolean
                            example: false
                            description: >-
                              Determines if a cart payment has been processed or
                              not.
                          valid_for_checkout:
                            type: boolean
                            example: true
                          buyer_rep_id:
                            type:
                              - integer
                              - 'null'
                            example: 1
                          buyer_rep:
                            oneOf:
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 2
                                  email:
                                    type:
                                      - string
                                      - 'null'
                                    example: buyer.rep@example.com
                                  full_name:
                                    type:
                                      - string
                                      - 'null'
                                    example: John Doe
                                  image_url:
                                    type:
                                      - string
                                      - 'null'
                                    example: https://example.com/image.png
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: '123241'
                                required:
                                  - id
                              - type: 'null'
                          volume_rep:
                            oneOf:
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 2
                                  email:
                                    type:
                                      - string
                                      - 'null'
                                    example: volume.rep@example.com
                                  full_name:
                                    type:
                                      - string
                                      - 'null'
                                    example: John Doe
                                  image_url:
                                    type:
                                      - string
                                      - 'null'
                                    example: https://example.com/image.png
                                required:
                                  - id
                              - type: 'null'
                          currency_symbol:
                            type: string
                            example: $
                          currency_code:
                            type: string
                            example: USD
                          shipping_total_for_display:
                            type: string
                            example: Free
                          phone:
                            type:
                              - string
                              - 'null'
                            example: '4035551212'
                          payment_method_auto_assignable:
                            type: boolean
                            example: true
                            description: >-
                              Determines if a payment method can be
                              auto-assigned to the cart.
                          attribution:
                            oneOf:
                              - type: object
                                oneOf:
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      share_guid:
                                        type: string
                                        example: james-bond007
                                    required:
                                      - id
                                      - share_guid
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      email:
                                        type: string
                                        example: james.bond@gmail.com
                                    required:
                                      - id
                                      - email
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      username:
                                        type: string
                                        example: jaamball234
                                    required:
                                      - id
                                      - username
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      fluid_rep_id:
                                        type: integer
                                        example: 23493
                                    required:
                                      - id
                                      - fluid_rep_id
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      external_id:
                                        type:
                                          - string
                                          - 'null'
                                        example: w3sdf92
                                    required:
                                      - id
                              - type: 'null'
                            default:
                              id: 456
                              share_guid: james-bond007
                          agreements:
                            type: array
                            items:
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                  example: 1
                                required:
                                  type: boolean
                                  example: true
                                title:
                                  type: string
                                  example: Terms and Conditions
                                show_path:
                                  type: string
                                  example: /terms
                                enrollment_pack_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                          amount_total:
                            type: string
                            example: '121.65'
                          amount_total_in_currency:
                            type: string
                            example: $121.65 (USD)
                          sub_total:
                            type: string
                            example: '100.00'
                          sub_total_in_currency:
                            type: string
                            example: $100.00 (USD)
                          subtotal_after_discounts:
                            type: string
                            example: '90.00'
                          tax_total:
                            type: string
                            example: '20.00'
                          tax_total_in_currency:
                            type: string
                            example: $20.00 (USD)
                          shipping_total:
                            type:
                              - string
                              - 'null'
                            example: '1.65'
                          shipping_total_in_currency:
                            type: string
                            example: $1.65 (USD)
                          shipping_discount:
                            type: number
                            example: 10.25
                          discount_total:
                            type: string
                            example: '2.99'
                          discount_total_in_currency:
                            type: string
                            example: $2.99 (USD)
                          discount_breakdown:
                            type: object
                            properties:
                              internal_discounts:
                                type: number
                                example: 15
                              external_discounts:
                                type: number
                                example: 10
                              total_discounts:
                                type: number
                                example: 25
                          external_discount:
                            type: object
                            properties:
                              total:
                                type: number
                                example: 10
                              calculated_at:
                                type:
                                  - string
                                  - 'null'
                                format: date-time
                                example: '2024-01-10T15:30:00Z'
                              sources:
                                type: object
                                additionalProperties:
                                  type: object
                                  properties:
                                    amount:
                                      type: number
                                      example: 6
                                    description:
                                      type: string
                                      example: Gold tier discount
                                    metadata:
                                      type: object
                                  required:
                                    - amount
                                    - description
                          transaction_fee:
                            type:
                              - number
                              - string
                            example: '1.90'
                          transaction_fee_in_currency:
                            type: string
                            example: $1.90 (USD)
                          cv_total:
                            type: integer
                            example: 10
                          qv_total:
                            type: integer
                            example: 15
                          company:
                            type: object
                            properties:
                              id:
                                type: integer
                              name:
                                type: string
                              primary_domain_hostname:
                                type:
                                  - string
                                  - 'null'
                                example: fluid.com
                              subdomain:
                                type:
                                  - string
                                  - 'null'
                                example: myco
                              logo_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/logo.png
                              fluid_shop:
                                type:
                                  - string
                                  - 'null'
                                example: https://fluid-sample-shop.fluid.com
                              collect_phone:
                                type: boolean
                                example: true
                              require_phone:
                                type: boolean
                                example: false
                              require_billing_zip:
                                type: boolean
                                example: false
                              checkout_primary_button_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#000000'
                              checkout_primary_text_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#FFFFFF'
                              checkout_secondary_button_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#FFFFFF'
                              checkout_secondary_text_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#000000'
                              favicon_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/favicon.ico
                              order_on_behalf:
                                type: boolean
                                example: false
                              use_juspay_gateway:
                                type: boolean
                                example: false
                              reward_points_enabled:
                                type: boolean
                                example: false
                          payment_account:
                            type:
                              - string
                              - 'null'
                            example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                          payment_method:
                            oneOf:
                              - type: 'null'
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: CreditCard
                                  payment_method_type:
                                    type: string
                                    example: visa
                                  last_four:
                                    type: string
                                    example: '1234'
                                  exp_month:
                                    type: string
                                    example: '12'
                                  exp_year:
                                    type: string
                                    example: '2025'
                                  logo_url:
                                    type: string
                                    example: https://example.com/image.svg
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Paypal
                                  status:
                                    type: string
                                    example: active
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Affirm
                                  affirm_id:
                                    type: string
                                    example: affirm_123
                                  status:
                                    type: string
                                    example: authorized
                                  checkout_id:
                                    type: string
                                    example: checkout_456
                                  created:
                                    type: string
                                    example: '2025-01-01T00:00:00Z'
                                  auth_expiration:
                                    type: string
                                    example: '2025-01-02T00:00:00Z'
                                  currency:
                                    type: string
                                    example: USD
                                  amount:
                                    type: string
                                    example: '100.00'
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Klarna
                                  session_id:
                                    type: string
                                    example: klarna_session_789
                                  intent:
                                    type: string
                                    example: buy
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Droplet
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: SomeCitcon
                          email:
                            type:
                              - string
                              - 'null'
                            example: user@example.com
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: '10.45'
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.45
                          discount_codes:
                            type: array
                            items:
                              type: string
                            example:
                              - DISCOUNT10
                              - DISCOUNT11
                          language_iso:
                            type:
                              - string
                              - 'null'
                            example: en
                          cart_token:
                            type: string
                            example: abc123
                          immutable_items:
                            type: boolean
                            example: false
                          digital_only:
                            type: boolean
                            example: false
                          requires_3ds:
                            type: boolean
                            example: false
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 101
                                price:
                                  type: string
                                  example: '43.41'
                                price_in_currency:
                                  type: string
                                  example: $43.41
                                tax:
                                  type: string
                                  example: '2.99'
                                tax_in_currency:
                                  type: string
                                  example: $2.99
                                cv:
                                  type: integer
                                  example: 5
                                cv_total:
                                  type: integer
                                  example: 15
                                qv:
                                  type: integer
                                  example: 7
                                qv_total:
                                  type: integer
                                  example: 21
                                discount_amount:
                                  type: string
                                  example: '10'
                                free_item:
                                  type: boolean
                                  example: false
                                discount_amount_in_currency:
                                  type: string
                                  example: $10.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                enrollment_pack_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                display_to_customer:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                product_title:
                                  type:
                                    - string
                                    - 'null'
                                  example: Sample Product
                                quantity:
                                  type: integer
                                  example: 3
                                subscription:
                                  type: boolean
                                  example: true
                                enrollment:
                                  type: boolean
                                  example: false
                                allow_subscription:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_only:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_price:
                                  type:
                                    - number
                                    - string
                                    - 'null'
                                  example: 10.5
                                subscription_price_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $10.50
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-02-12'
                                subscribe_and_save:
                                  type:
                                    - number
                                    - string
                                    - 'null'
                                  example: 2.99
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $2.99
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $2.99
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: Surcharge
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                product:
                                  oneOf:
                                    - type: object
                                      properties:
                                        id:
                                          type: integer
                                          example: 1
                                        title:
                                          type: string
                                          example: Sample Product
                                        introduction:
                                          type:
                                            - string
                                            - 'null'
                                          example: Sample Product Description
                                        cv:
                                          type: integer
                                          example: 10
                                        external_id:
                                          type:
                                            - string
                                            - 'null'
                                          example: ext-prod-123
                                        image_path:
                                          type:
                                            - string
                                            - 'null'
                                          example: /images/product.png
                                        image_url:
                                          type:
                                            - string
                                            - 'null'
                                          example: https://example.com/images/product.png
                                        price:
                                          type: string
                                          example: '29.99'
                                        price_in_currency:
                                          type: string
                                          example: $29.99
                                        sku:
                                          type:
                                            - string
                                            - 'null'
                                          example: SKU12345
                                        tax:
                                          type: string
                                          example: '2.99'
                                        tax_in_currency:
                                          type: string
                                          example: $2.99
                                        metadata:
                                          type: object
                                          example:
                                            shopify_product_id: 9876054868270
                                        metafields:
                                          type: array
                                          items:
                                            title: LegacyMetafield
                                            type: object
                                            properties:
                                              namespace:
                                                description: >-
                                                  A container for related metafields.
                                                  Commonly used to group metafields by app
                                                  or functionality.
                                                example: custom
                                                type: string
                                                maxLength: 20
                                                pattern: ^[a-zA-Z0-9_]+$
                                              key:
                                                description: >-
                                                  The unique identifier for the metafield
                                                  within its namespace. Must be unique per
                                                  namespace and owner.
                                                example: material
                                                type: string
                                                maxLength: 30
                                                pattern: ^[a-zA-Z0-9_]+$
                                              value:
                                                description: >-
                                                  The actual data stored in the metafield.
                                                  Type depends on value_type.
                                                example: cotton
                                                type:
                                                  - string
                                                  - integer
                                                  - object
                                                  - boolean
                                                  - number
                                              value_type:
                                                description: >-
                                                  The data type that defines how the value
                                                  should be interpreted and validated.
                                                example: single_line_text_field
                                                type: string
                                              description:
                                                description: >-
                                                  Optional human-readable description
                                                  explaining the purpose of this
                                                  metafield.
                                                example: >-
                                                  The primary material used in this
                                                  product
                                                type:
                                                  - string
                                                  - 'null'
                                              created_at:
                                                description: >-
                                                  Timestamp when the metafield was
                                                  created.
                                                example: '2021-01-01T00:00:00Z'
                                                type: string
                                                format: date-time
                                              updated_at:
                                                description: >-
                                                  Timestamp when the metafield was last
                                                  updated.
                                                example: '2021-01-01T00:00:00Z'
                                                type: string
                                                format: date-time
                                              locked:
                                                description: >-
                                                  Whether this metafield is locked and
                                                  cannot be updated or deleted directly.
                                                example: false
                                                type:
                                                  - boolean
                                                  - 'null'
                                                  - 'null'
                                              metafield_definition:
                                                description: >-
                                                  The definition that defines validation
                                                  rules and structure for this metafield
                                                type:
                                                  - 'null'
                                                  - object
                                            required:
                                              - namespace
                                              - key
                                              - value
                                              - value_type
                                              - description
                                              - created_at
                                              - updated_at
                                              - metafield_definition
                                    - type: 'null'
                                variant:
                                  oneOf:
                                    - type: object
                                      properties:
                                        id:
                                          type: integer
                                          example: 1
                                        title:
                                          type:
                                            - string
                                            - 'null'
                                          example: Sample Variant
                                        image_path:
                                          type:
                                            - string
                                            - 'null'
                                          example: /images/sample.png
                                        image_url:
                                          type:
                                            - string
                                            - 'null'
                                          example: https://example.com/images/sample.png
                                        primary_image:
                                          type:
                                            - string
                                            - 'null'
                                          example: https://example.com/images/primary.png
                                        price:
                                          type:
                                            - string
                                            - 'null'
                                          example: '34.44'
                                        price_in_currency:
                                          type:
                                            - string
                                            - 'null'
                                          example: $34.44
                                        sku:
                                          type:
                                            - string
                                            - 'null'
                                          example: SKU12345
                                        options:
                                          type: array
                                          items:
                                            type: object
                                            properties:
                                              title:
                                                type: string
                                                example: Size
                                              value:
                                                type: string
                                                example: XL
                                        physical:
                                          type:
                                            - boolean
                                            - 'null'
                                          example: true
                                        unit_of_size:
                                          type:
                                            - string
                                            - 'null'
                                          example: cm
                                        height:
                                          type:
                                            - number
                                            - 'null'
                                          example: 13
                                        width:
                                          type:
                                            - number
                                            - 'null'
                                          example: 6
                                        length:
                                          type:
                                            - number
                                            - 'null'
                                          example: 12
                                        unit_of_weight:
                                          type:
                                            - string
                                            - 'null'
                                          example: kg
                                        weight:
                                          type:
                                            - string
                                            - 'null'
                                          example: '3.2'
                                        hs_code:
                                          type:
                                            - string
                                            - 'null'
                                          example: '3.2'
                                    - type: 'null'
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                                bundled_items:
                                  type: array
                                  items:
                                    type: object
                                    description: Bundled items for bundle products
                                    properties:
                                      variant_id:
                                        type: integer
                                        example: 1
                                      product_id:
                                        type: integer
                                        example: 1
                                      product_title:
                                        type: string
                                        example: Product Title
                                      variant_title:
                                        type: string
                                        example: Variant Title
                                      option_titles:
                                        type: array
                                        example:
                                          - Option 1
                                          - Option 2
                                      quantity:
                                        type: integer
                                        example: 1
                                      display_to_customer:
                                        type: boolean
                                        example: true
                          ship_to:
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                                example: 1
                              name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              first_name:
                                type:
                                  - string
                                  - 'null'
                                example: John
                              last_name:
                                type:
                                  - string
                                  - 'null'
                                example: Doe
                              address1:
                                type: string
                                example: 123 Main St
                              address2:
                                type:
                                  - string
                                  - 'null'
                                example: Apt 4B
                              address3:
                                type:
                                  - string
                                  - 'null'
                                example: Building 5
                              city:
                                type: string
                                example: New York
                              state:
                                type: string
                                example: NY
                              postal_code:
                                type: string
                                example: '10001'
                              country_code:
                                type: string
                                example: US
                                description: >-
                                  country_id takes precedence if both country_id
                                  and country_code provided.
                              subdivision_code:
                                type:
                                  - string
                                  - 'null'
                                example: NY
                              default:
                                type: boolean
                                example: true
                          bill_to:
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                                example: 1
                              name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              first_name:
                                type:
                                  - string
                                  - 'null'
                                example: John
                              last_name:
                                type:
                                  - string
                                  - 'null'
                                example: Doe
                              address1:
                                type: string
                                example: 123 Main St
                              address2:
                                type:
                                  - string
                                  - 'null'
                                example: Apt 4B
                              address3:
                                type:
                                  - string
                                  - 'null'
                                example: Building 5
                              city:
                                type: string
                                example: New York
                              state:
                                type: string
                                example: NY
                              postal_code:
                                type: string
                                example: '10001'
                              country_code:
                                type: string
                                example: US
                                description: >-
                                  country_id takes precedence if both country_id
                                  and country_code provided.
                              subdivision_code:
                                type:
                                  - string
                                  - 'null'
                                example: NY
                              default:
                                type: boolean
                                example: true
                          shipping_method:
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: string
                                example: standard-shipping
                              name:
                                type: string
                                example: Standard Shipping
                          available_shipping_methods:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                  example: standard-shipping
                                title:
                                  type: string
                                  example: Standard Shipping
                                price:
                                  type:
                                    - number
                                    - string
                                  example: 5.99
                                price_label:
                                  type: string
                                  example: $5.99
                                delivery_time_estimate:
                                  type: string
                                  example: 3-5 business days
                          available_payment_methods:
                            type: array
                            items:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1337
                                    uuid:
                                      type: string
                                      example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                    type:
                                      type: string
                                      enum:
                                        - credit_card
                                    name:
                                      type: string
                                      example: Credit Card
                                    image_url:
                                      type: string
                                      example: https://example.com/image.png
                                    test:
                                      type: boolean
                                      example: true
                                      description: >-
                                        Determines if payment method is test
                                        instance or not. By default, set to
                                        `true`
                                    sandbox:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method is sandbox
                                        instance or not. By default, set to
                                        `false`
                                    apple_pay:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method supports
                                        ApplePay or not 
                                    bogus_gateway:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method is a Bogus
                                        instance or not.
                                    tokenize_path:
                                      type:
                                        - string
                                        - 'null'
                                      description: Path to tokenize, if applicable.
                                    token_provider:
                                      type: string
                                      enum:
                                        - spreedly
                                        - vgs
                                      description: >-
                                        Determines if payment tokenization is
                                        via spreedly or VGS
                                    apple_pay_merchant_identifier:
                                      type:
                                        - string
                                        - 'null'
                                      example: merchant.mycompany.com
                                      description: >-
                                        If ApplePay is supported, returns the
                                        merchant identifier registered with
                                        Apple, else returns nil
                                    supported_brands:
                                      type: array
                                      items:
                                        type: string
                                      example:
                                        - visa
                                        - master
                                        - american_express
                                        - discover
                                    publishable_key:
                                      type:
                                        - string
                                        - 'null'
                                      example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                      description: >-
                                        If publishable key is set for
                                        Hyperswitch, returns the publishable
                                        key, else returns nil
                                    customer_details_schema:
                                      type: object
                                      example: {}
                                      description: >-
                                        Schema defining required customer
                                        details for this payment method
                                  required:
                                    - id
                                    - type
                                    - name
                                    - supported_brands
                                    - test
                                    - sandbox
                                    - apple_pay
                                    - apple_pay_merchant_identifier
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1337
                                    uuid:
                                      type: string
                                      example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                    type:
                                      type: string
                                      enum:
                                        - klarna
                                    name:
                                      type: string
                                      example: Klarna
                                    image_url:
                                      type: string
                                      example: https://example.com/image.png
                                    test:
                                      type: boolean
                                      example: true
                                      description: >-
                                        Determines if payment method is test
                                        instance or not. By default, set to
                                        `true`
                                    sandbox:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method is sandbox
                                        instance or not. By default, set to
                                        `false`
                                    customer_details_schema:
                                      type: object
                                      example: {}
                                      description: >-
                                        Schema defining required customer
                                        details for this payment method
                          country:
                            type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              iso:
                                type: string
                                example: US
                              name:
                                type: string
                                example: United States
                              iso_name:
                                type: string
                                example: UNITED STATES
                              iso3:
                                type: string
                                example: USA
                              currency_code:
                                type: string
                                example: USD
                              currency_symbol:
                                type: string
                                example: $
                              province_required:
                                type: boolean
                                example: false
                              tax_enabled:
                                type:
                                  - boolean
                                  - 'null'
                                example: true
                              price_inclusive_of_tax:
                                type: boolean
                                example: false
                              price_inclusive_tax_name:
                                type:
                                  - string
                                  - 'null'
                                example: VAT
                          type:
                            type: string
                            enum:
                              - regular
                              - enrollment
                            example: regular
                          enrollment_pack_id:
                            type:
                              - integer
                              - 'null'
                            example: 1
                          enrollment_pack:
                            type:
                              - object
                              - 'null'
                            properties:
                              enrollment_pack_id:
                                type: integer
                                example: 1
                              additional_volume:
                                type:
                                  - integer
                                  - 'null'
                                example: 10
                              slug:
                                type: string
                                example: test-enrollment-pack
                              description:
                                type:
                                  - object
                                  - 'null'
                                  - string
                                properties:
                                  id:
                                    type: integer
                                    example: 111
                                  name:
                                    type: string
                                    example: description
                                  body:
                                    type: string
                                    example: >-
                                      <div>Try the latest and greatest of our
                                      sugar zip packs. Guaranteed to make you
                                      skinner and cure cancer.</div>
                                  record_type:
                                    type: string
                                    example: EnrollmentPack
                                  record_id:
                                    type: integer
                                    example: 1
                                  created_at:
                                    type: string
                                    format: date_time
                                    example: '2025-01-16T04:22:43.809Z'
                                  updated_at:
                                    type: string
                                    format: date_time
                                    example: '2025-01-22T10:23:52.941Z'
                                  locale:
                                    type: string
                                    example: en
                              enrollment_fee:
                                type:
                                  - number
                                  - string
                                example: 10
                              enrollment_fee_in_currency:
                                type: string
                                example: $10.00
                              images:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 2
                                    relateable_type:
                                      type: string
                                      example: EnrollmentPack
                                    relateable_id:
                                      type: integer
                                      example: 1
                                    image_url:
                                      type: string
                                      example: >-
                                        https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                    image_path:
                                      type: string
                                      example: jITWaU14QGe0y5AFgY7P_00179.svg
                                    position:
                                      type: integer
                                      example: 1
                                    shopify_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: null
                                    created_at:
                                      type: string
                                      format: date_time
                                      example: '2025-01-16T04:22:44.870Z'
                                    updated_at:
                                      type: string
                                      format: date_time
                                      example: '2025-01-16T04:22:44.870Z'
                                    external_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: null
                              items:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 625
                                    allow_subscription:
                                      type: boolean
                                      example: true
                                    cv:
                                      type:
                                        - number
                                        - string
                                      example: 0
                                    cv_in_currency:
                                      type: string
                                      example: $0.00
                                    cv_total:
                                      type: integer
                                      example: 0
                                    enrollment:
                                      type: boolean
                                      example: true
                                    enrollment_pack_id:
                                      type: integer
                                      example: 1
                                    price:
                                      type: string
                                      example: '11.13'
                                    price_in_currency:
                                      type: string
                                      example: $11.13
                                    product_title:
                                      type: string
                                      example: Zip Pack Sample Pack (30)
                                    quantity:
                                      type: integer
                                      example: 1
                                    qv:
                                      type:
                                        - number
                                        - string
                                      example: 0
                                    qv_in_currency:
                                      type: string
                                      example: $0.00
                                    qv_total:
                                      type: integer
                                      example: 0
                                    subscribe_and_save:
                                      type:
                                        - string
                                        - 'null'
                                      example: '-1988.87'
                                    subscribe_and_save_for_display:
                                      type:
                                        - string
                                        - 'null'
                                      example: Subscribe and save $-1,988.87
                                    subscribe_and_save_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $-1,988.87
                                    subscription:
                                      type: boolean
                                      example: false
                                    subscription_interval:
                                      type:
                                        - integer
                                        - 'null'
                                      example: 1
                                    subscription_interval_unit:
                                      type:
                                        - string
                                        - 'null'
                                      example: month
                                    subscription_only:
                                      type: boolean
                                      example: false
                                    subscription_plan_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: 1
                                    subscription_plans:
                                      oneOf:
                                        - type: array
                                          items:
                                            title: Commerce::SubscriptionPlan
                                            type: object
                                            properties:
                                              id:
                                                type: integer
                                              name:
                                                example: Test Subscription Plan
                                                type: string
                                              billing_interval:
                                                example: 1
                                                type: integer
                                                default: 1
                                                minimum: 1
                                                maximum: 29
                                              billing_interval_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type: string
                                                default: month
                                              billing_frequency_in_words:
                                                example: 2 Months
                                                type: string
                                              shipping_interval:
                                                example: 1
                                                type: integer
                                                default: 1
                                                minimum: 1
                                                maximum: 29
                                              shipping_interval_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type: string
                                                default: month
                                              volume_interval:
                                                example: 1
                                                type: integer
                                                default: 1
                                                minimum: 1
                                                maximum: 29
                                              volume_interval_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type: string
                                                default: month
                                              trial_period:
                                                example: 1
                                                type:
                                                  - integer
                                                  - 'null'
                                                minimum: 1
                                              trial_period_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type:
                                                  - string
                                                  - 'null'
                                              split_volume:
                                                example: true
                                                type: boolean
                                                default: false
                                              allow_max_billing_cycles:
                                                example: true
                                                type: boolean
                                                default: false
                                              max_billing_cycles:
                                                example: 3
                                                type:
                                                  - integer
                                                  - 'null'
                                              company_default:
                                                example: false
                                                type:
                                                  - boolean
                                                  - 'null'
                                                default: false
                                              products_count:
                                                example: 10
                                                type:
                                                  - integer
                                                  - 'null'
                                              subscribers_count:
                                                example: 10
                                                type:
                                                  - integer
                                                  - 'null'
                                              price:
                                                type: string
                                              price_in_currency:
                                                type: string
                                              subscription_start:
                                                type: string
                                              subscribe_and_save:
                                                type:
                                                  - string
                                                  - 'null'
                                              subscribe_and_save_in_currency:
                                                type:
                                                  - string
                                                  - 'null'
                                              subscribe_and_save_for_display:
                                                type:
                                                  - string
                                                  - 'null'
                                            required:
                                              - id
                                              - name
                                              - billing_interval
                                              - billing_interval_unit
                                              - billing_frequency_in_words
                                              - shipping_interval
                                              - shipping_interval_unit
                                              - volume_interval
                                              - volume_interval_unit
                                              - split_volume
                                              - allow_max_billing_cycles
                                              - price
                                              - price_in_currency
                                              - subscription_start
                                              - subscribe_and_save
                                              - subscribe_and_save_in_currency
                                              - subscribe_and_save_for_display
                                        - type: 'null'
                                    subscription_price:
                                      type: string
                                      example: '2000.0'
                                    subscription_price_in_currency:
                                      type: string
                                      example: $2,000.00
                                    subscription_start:
                                      type:
                                        - string
                                        - 'null'
                                      format: date
                                      example: '2025-02-28'
                                    tax:
                                      type: string
                                      example: '0.0'
                                    tax_in_currency:
                                      type: string
                                      example: $0.00
                                    total_after_discounts:
                                      type: string
                                      example: '90.00'
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: null
                                    display_to_customer:
                                      type: boolean
                                      example: false
                                    metadata:
                                      type: object
                                      description: >-
                                        A JSON object that can store any custom
                                        data structure
                                      example: {}
                                    errors:
                                      oneOf:
                                        - type: 'null'
                                        - type: array
                                          items:
                                            type: object
                                          example:
                                            - country:
                                                - >-
                                                  This product is not available for this
                                                  country. Please change your country
                              price:
                                type: string
                                example: '11.13'
                              price_in_currency:
                                type: string
                                example: $11.13
                              subscription_price:
                                type:
                                  - string
                                  - integer
                                example: 2000
                              subscription_price_in_currency:
                                type: string
                                example: $2,000.00
                              title:
                                type: string
                                example: enroll product
                              token:
                                type: string
                                example: NxL22AqLRRisfyF9LqxxWRak
                          metadata:
                            type: object
                            description: >-
                              A JSON object that can store any custom data
                              structure.
                          recurring:
                            oneOf:
                              - type: array
                                items:
                                  type: object
                                  properties:
                                    subtotal:
                                      type: string
                                      example: '10.0'
                                    subtotal_in_currency:
                                      type: string
                                      example: $10.0
                                    interval:
                                      type: integer
                                      example: 1
                                    interval_unit:
                                      type: string
                                      example: month
                                    subtotal_for_display:
                                      type: string
                                      example: $10.00 every 1 month
                                    start_date:
                                      type:
                                        - string
                                        - 'null'
                                      example: '2025-05-27'
                              - type: 'null'
                            default:
                              - subtotal: '10.0'
                                subtotal_in_currency: $10.0
                                interval: 1
                                interval_unit: month
                                subtotal_for_display: $10.00 every 1 month
                                start_date: '2025-05-27'
                          messages:
                            type: object
                            additionalProperties: true
                            example:
                              errors:
                                - Insufficient inventory
                                - Product no longer available
                              warnings:
                                - Low stock warning
                                - Shipping delays expected
                              info:
                                - Free shipping available
                                - Volume discount applied
                          points_enabled:
                            type: boolean
                            example: true
                          points_applied:
                            type: integer
                            example: 500
                            description: Number of points applied to the cart
                          points_applied_amount_in_currency:
                            type: number
                            example: 5
                            description: Currency value of applied points
                          customer_total_points:
                            type: integer
                            example: 1000
                            description: Customer's total available points balance
                          customer_total_points_in_currency:
                            type: number
                            example: 10
                            description: Currency value of available points
                          remaining_customer_points:
                            type: integer
                            example: 500
                            description: Customer's remaining points after cart redemption
                          remaining_customer_points_amount_in_currency:
                            type: number
                            example: 5
                            description: >-
                              Currency value of remaining points after cart
                              redemption
                          remaining_cart_amount_after_points:
                            type: number
                            example: 95
                            description: Amount to charge to card after points redemption
                          remaining_cart_amount_after_points_in_currency:
                            type:
                              - string
                            example: $95.00
                            description: >-
                              Amount in currency to charge to card after points
                              redemption
                          max_applicable_points:
                            type: integer
                            example: 500
                            description: Maximum points that can be applied to this cart
    patch:
      summary: Updates a cart
      tags:
        - Carts
      operationId: updateCart
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: cart updated with phone number validation
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      state:
                        type: string
                        example: start
                      processed:
                        type: boolean
                        example: false
                        description: >-
                          Determines if a cart payment has been processed or
                          not.
                      valid_for_checkout:
                        type: boolean
                        example: true
                      buyer_rep_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      buyer_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: buyer.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                              external_id:
                                type:
                                  - string
                                  - 'null'
                                example: '123241'
                            required:
                              - id
                          - type: 'null'
                      volume_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: volume.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                            required:
                              - id
                          - type: 'null'
                      currency_symbol:
                        type: string
                        example: $
                      currency_code:
                        type: string
                        example: USD
                      shipping_total_for_display:
                        type: string
                        example: Free
                      phone:
                        type:
                          - string
                          - 'null'
                        example: '4035551212'
                      payment_method_auto_assignable:
                        type: boolean
                        example: true
                        description: >-
                          Determines if a payment method can be auto-assigned to
                          the cart.
                      attribution:
                        oneOf:
                          - type: object
                            oneOf:
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  share_guid:
                                    type: string
                                    example: james-bond007
                                required:
                                  - id
                                  - share_guid
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  email:
                                    type: string
                                    example: james.bond@gmail.com
                                required:
                                  - id
                                  - email
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  username:
                                    type: string
                                    example: jaamball234
                                required:
                                  - id
                                  - username
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  fluid_rep_id:
                                    type: integer
                                    example: 23493
                                required:
                                  - id
                                  - fluid_rep_id
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: w3sdf92
                                required:
                                  - id
                          - type: 'null'
                        default:
                          id: 456
                          share_guid: james-bond007
                      agreements:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            required:
                              type: boolean
                              example: true
                            title:
                              type: string
                              example: Terms and Conditions
                            show_path:
                              type: string
                              example: /terms
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                      amount_total:
                        type: string
                        example: '121.65'
                      amount_total_in_currency:
                        type: string
                        example: $121.65 (USD)
                      sub_total:
                        type: string
                        example: '100.00'
                      sub_total_in_currency:
                        type: string
                        example: $100.00 (USD)
                      subtotal_after_discounts:
                        type: string
                        example: '90.00'
                      tax_total:
                        type: string
                        example: '20.00'
                      tax_total_in_currency:
                        type: string
                        example: $20.00 (USD)
                      shipping_total:
                        type:
                          - string
                          - 'null'
                        example: '1.65'
                      shipping_total_in_currency:
                        type: string
                        example: $1.65 (USD)
                      shipping_discount:
                        type: number
                        example: 10.25
                      discount_total:
                        type: string
                        example: '2.99'
                      discount_total_in_currency:
                        type: string
                        example: $2.99 (USD)
                      discount_breakdown:
                        type: object
                        properties:
                          internal_discounts:
                            type: number
                            example: 15
                          external_discounts:
                            type: number
                            example: 10
                          total_discounts:
                            type: number
                            example: 25
                      external_discount:
                        type: object
                        properties:
                          total:
                            type: number
                            example: 10
                          calculated_at:
                            type:
                              - string
                              - 'null'
                            format: date-time
                            example: '2024-01-10T15:30:00Z'
                          sources:
                            type: object
                            additionalProperties:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 6
                                description:
                                  type: string
                                  example: Gold tier discount
                                metadata:
                                  type: object
                              required:
                                - amount
                                - description
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: '1.90'
                      transaction_fee_in_currency:
                        type: string
                        example: $1.90 (USD)
                      cv_total:
                        type: integer
                        example: 10
                      qv_total:
                        type: integer
                        example: 15
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      payment_account:
                        type:
                          - string
                          - 'null'
                        example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                      payment_method:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: CreditCard
                              payment_method_type:
                                type: string
                                example: visa
                              last_four:
                                type: string
                                example: '1234'
                              exp_month:
                                type: string
                                example: '12'
                              exp_year:
                                type: string
                                example: '2025'
                              logo_url:
                                type: string
                                example: https://example.com/image.svg
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Paypal
                              status:
                                type: string
                                example: active
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Affirm
                              affirm_id:
                                type: string
                                example: affirm_123
                              status:
                                type: string
                                example: authorized
                              checkout_id:
                                type: string
                                example: checkout_456
                              created:
                                type: string
                                example: '2025-01-01T00:00:00Z'
                              auth_expiration:
                                type: string
                                example: '2025-01-02T00:00:00Z'
                              currency:
                                type: string
                                example: USD
                              amount:
                                type: string
                                example: '100.00'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Klarna
                              session_id:
                                type: string
                                example: klarna_session_789
                              intent:
                                type: string
                                example: buy
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Droplet
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: SomeCitcon
                      email:
                        type:
                          - string
                          - 'null'
                        example: user@example.com
                      enrollment_fee:
                        type:
                          - number
                          - string
                        example: '10.45'
                      enrollment_fee_in_currency:
                        type: string
                        example: $10.45
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT10
                          - DISCOUNT11
                      language_iso:
                        type:
                          - string
                          - 'null'
                        example: en
                      cart_token:
                        type: string
                        example: abc123
                      immutable_items:
                        type: boolean
                        example: false
                      digital_only:
                        type: boolean
                        example: false
                      requires_3ds:
                        type: boolean
                        example: false
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 101
                            price:
                              type: string
                              example: '43.41'
                            price_in_currency:
                              type: string
                              example: $43.41
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            cv:
                              type: integer
                              example: 5
                            cv_total:
                              type: integer
                              example: 15
                            qv:
                              type: integer
                              example: 7
                            qv_total:
                              type: integer
                              example: 21
                            discount_amount:
                              type: string
                              example: '10'
                            free_item:
                              type: boolean
                              example: false
                            discount_amount_in_currency:
                              type: string
                              example: $10.00
                            total_after_discounts:
                              type: string
                              example: '90.00'
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            product_title:
                              type:
                                - string
                                - 'null'
                              example: Sample Product
                            quantity:
                              type: integer
                              example: 3
                            subscription:
                              type: boolean
                              example: true
                            enrollment:
                              type: boolean
                              example: false
                            allow_subscription:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_plan_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_plans:
                              oneOf:
                                - type: array
                                  items:
                                    title: Commerce::SubscriptionPlan
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        example: Test Subscription Plan
                                        type: string
                                      billing_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      billing_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      billing_frequency_in_words:
                                        example: 2 Months
                                        type: string
                                      shipping_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      shipping_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      volume_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      volume_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      trial_period:
                                        example: 1
                                        type:
                                          - integer
                                          - 'null'
                                        minimum: 1
                                      trial_period_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type:
                                          - string
                                          - 'null'
                                      split_volume:
                                        example: true
                                        type: boolean
                                        default: false
                                      allow_max_billing_cycles:
                                        example: true
                                        type: boolean
                                        default: false
                                      max_billing_cycles:
                                        example: 3
                                        type:
                                          - integer
                                          - 'null'
                                      company_default:
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                        default: false
                                      products_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      subscribers_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      price:
                                        type: string
                                      price_in_currency:
                                        type: string
                                      subscription_start:
                                        type: string
                                      subscribe_and_save:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_in_currency:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_for_display:
                                        type:
                                          - string
                                          - 'null'
                                    required:
                                      - id
                                      - name
                                      - billing_interval
                                      - billing_interval_unit
                                      - billing_frequency_in_words
                                      - shipping_interval
                                      - shipping_interval_unit
                                      - volume_interval
                                      - volume_interval_unit
                                      - split_volume
                                      - allow_max_billing_cycles
                                      - price
                                      - price_in_currency
                                      - subscription_start
                                      - subscribe_and_save
                                      - subscribe_and_save_in_currency
                                      - subscribe_and_save_for_display
                                - type: 'null'
                            subscription_only:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_interval:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_interval_unit:
                              type:
                                - string
                                - 'null'
                              example: month
                            subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 10.5
                            subscription_price_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $10.50
                            subscription_start:
                              type:
                                - string
                                - 'null'
                              example: '2025-02-12'
                            subscribe_and_save:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 2.99
                            subscribe_and_save_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $2.99
                            subscribe_and_save_for_display:
                              type:
                                - string
                                - 'null'
                              example: Subscribe and save $2.99
                            title:
                              type:
                                - string
                                - 'null'
                              example: Surcharge
                            metadata:
                              type: object
                              description: >-
                                A JSON object that can store any custom data
                                structure
                              example: {}
                            product:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type: string
                                      example: Sample Product
                                    introduction:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Product Description
                                    cv:
                                      type: integer
                                      example: 10
                                    external_id:
                                      type:
                                        - string
                                        - 'null'
                                      example: ext-prod-123
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/product.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/product.png
                                    price:
                                      type: string
                                      example: '29.99'
                                    price_in_currency:
                                      type: string
                                      example: $29.99
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    tax:
                                      type: string
                                      example: '2.99'
                                    tax_in_currency:
                                      type: string
                                      example: $2.99
                                    metadata:
                                      type: object
                                      example:
                                        shopify_product_id: 9876054868270
                                    metafields:
                                      type: array
                                      items:
                                        title: LegacyMetafield
                                        type: object
                                        properties:
                                          namespace:
                                            description: >-
                                              A container for related metafields.
                                              Commonly used to group metafields by app
                                              or functionality.
                                            example: custom
                                            type: string
                                            maxLength: 20
                                            pattern: ^[a-zA-Z0-9_]+$
                                          key:
                                            description: >-
                                              The unique identifier for the metafield
                                              within its namespace. Must be unique per
                                              namespace and owner.
                                            example: material
                                            type: string
                                            maxLength: 30
                                            pattern: ^[a-zA-Z0-9_]+$
                                          value:
                                            description: >-
                                              The actual data stored in the metafield.
                                              Type depends on value_type.
                                            example: cotton
                                            type:
                                              - string
                                              - integer
                                              - object
                                              - boolean
                                              - number
                                          value_type:
                                            description: >-
                                              The data type that defines how the value
                                              should be interpreted and validated.
                                            example: single_line_text_field
                                            type: string
                                          description:
                                            description: >-
                                              Optional human-readable description
                                              explaining the purpose of this
                                              metafield.
                                            example: >-
                                              The primary material used in this
                                              product
                                            type:
                                              - string
                                              - 'null'
                                          created_at:
                                            description: >-
                                              Timestamp when the metafield was
                                              created.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          updated_at:
                                            description: >-
                                              Timestamp when the metafield was last
                                              updated.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          locked:
                                            description: >-
                                              Whether this metafield is locked and
                                              cannot be updated or deleted directly.
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                              - 'null'
                                          metafield_definition:
                                            description: >-
                                              The definition that defines validation
                                              rules and structure for this metafield
                                            type:
                                              - 'null'
                                              - object
                                        required:
                                          - namespace
                                          - key
                                          - value
                                          - value_type
                                          - description
                                          - created_at
                                          - updated_at
                                          - metafield_definition
                                - type: 'null'
                            variant:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Variant
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/sample.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/sample.png
                                    primary_image:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/primary.png
                                    price:
                                      type:
                                        - string
                                        - 'null'
                                      example: '34.44'
                                    price_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $34.44
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    options:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          title:
                                            type: string
                                            example: Size
                                          value:
                                            type: string
                                            example: XL
                                    physical:
                                      type:
                                        - boolean
                                        - 'null'
                                      example: true
                                    unit_of_size:
                                      type:
                                        - string
                                        - 'null'
                                      example: cm
                                    height:
                                      type:
                                        - number
                                        - 'null'
                                      example: 13
                                    width:
                                      type:
                                        - number
                                        - 'null'
                                      example: 6
                                    length:
                                      type:
                                        - number
                                        - 'null'
                                      example: 12
                                    unit_of_weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: kg
                                    weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                    hs_code:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                - type: 'null'
                            errors:
                              oneOf:
                                - type: 'null'
                                - type: array
                                  items:
                                    type: object
                                  example:
                                    - country:
                                        - >-
                                          This product is not available for this
                                          country. Please change your country
                            bundled_items:
                              type: array
                              items:
                                type: object
                                description: Bundled items for bundle products
                                properties:
                                  variant_id:
                                    type: integer
                                    example: 1
                                  product_id:
                                    type: integer
                                    example: 1
                                  product_title:
                                    type: string
                                    example: Product Title
                                  variant_title:
                                    type: string
                                    example: Variant Title
                                  option_titles:
                                    type: array
                                    example:
                                      - Option 1
                                      - Option 2
                                  quantity:
                                    type: integer
                                    example: 1
                                  display_to_customer:
                                    type: boolean
                                    example: true
                      ship_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      bill_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      shipping_method:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: string
                            example: standard-shipping
                          name:
                            type: string
                            example: Standard Shipping
                      available_shipping_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: standard-shipping
                            title:
                              type: string
                              example: Standard Shipping
                            price:
                              type:
                                - number
                                - string
                              example: 5.99
                            price_label:
                              type: string
                              example: $5.99
                            delivery_time_estimate:
                              type: string
                              example: 3-5 business days
                      available_payment_methods:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - credit_card
                                name:
                                  type: string
                                  example: Credit Card
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                apple_pay:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method supports
                                    ApplePay or not 
                                bogus_gateway:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is a Bogus
                                    instance or not.
                                tokenize_path:
                                  type:
                                    - string
                                    - 'null'
                                  description: Path to tokenize, if applicable.
                                token_provider:
                                  type: string
                                  enum:
                                    - spreedly
                                    - vgs
                                  description: >-
                                    Determines if payment tokenization is via
                                    spreedly or VGS
                                apple_pay_merchant_identifier:
                                  type:
                                    - string
                                    - 'null'
                                  example: merchant.mycompany.com
                                  description: >-
                                    If ApplePay is supported, returns the
                                    merchant identifier registered with Apple,
                                    else returns nil
                                supported_brands:
                                  type: array
                                  items:
                                    type: string
                                  example:
                                    - visa
                                    - master
                                    - american_express
                                    - discover
                                publishable_key:
                                  type:
                                    - string
                                    - 'null'
                                  example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                  description: >-
                                    If publishable key is set for Hyperswitch,
                                    returns the publishable key, else returns
                                    nil
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                              required:
                                - id
                                - type
                                - name
                                - supported_brands
                                - test
                                - sandbox
                                - apple_pay
                                - apple_pay_merchant_identifier
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - klarna
                                name:
                                  type: string
                                  example: Klarna
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                      country:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          iso:
                            type: string
                            example: US
                          name:
                            type: string
                            example: United States
                          iso_name:
                            type: string
                            example: UNITED STATES
                          iso3:
                            type: string
                            example: USA
                          currency_code:
                            type: string
                            example: USD
                          currency_symbol:
                            type: string
                            example: $
                          province_required:
                            type: boolean
                            example: false
                          tax_enabled:
                            type:
                              - boolean
                              - 'null'
                            example: true
                          price_inclusive_of_tax:
                            type: boolean
                            example: false
                          price_inclusive_tax_name:
                            type:
                              - string
                              - 'null'
                            example: VAT
                      type:
                        type: string
                        enum:
                          - regular
                          - enrollment
                        example: regular
                      enrollment_pack_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      enrollment_pack:
                        type:
                          - object
                          - 'null'
                        properties:
                          enrollment_pack_id:
                            type: integer
                            example: 1
                          additional_volume:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          slug:
                            type: string
                            example: test-enrollment-pack
                          description:
                            type:
                              - object
                              - 'null'
                              - string
                            properties:
                              id:
                                type: integer
                                example: 111
                              name:
                                type: string
                                example: description
                              body:
                                type: string
                                example: >-
                                  <div>Try the latest and greatest of our sugar
                                  zip packs. Guaranteed to make you skinner and
                                  cure cancer.</div>
                              record_type:
                                type: string
                                example: EnrollmentPack
                              record_id:
                                type: integer
                                example: 1
                              created_at:
                                type: string
                                format: date_time
                                example: '2025-01-16T04:22:43.809Z'
                              updated_at:
                                type: string
                                format: date_time
                                example: '2025-01-22T10:23:52.941Z'
                              locale:
                                type: string
                                example: en
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: 10
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.00
                          images:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2
                                relateable_type:
                                  type: string
                                  example: EnrollmentPack
                                relateable_id:
                                  type: integer
                                  example: 1
                                image_url:
                                  type: string
                                  example: >-
                                    https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                image_path:
                                  type: string
                                  example: jITWaU14QGe0y5AFgY7P_00179.svg
                                position:
                                  type: integer
                                  example: 1
                                shopify_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                                created_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                updated_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                external_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 625
                                allow_subscription:
                                  type: boolean
                                  example: true
                                cv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                cv_in_currency:
                                  type: string
                                  example: $0.00
                                cv_total:
                                  type: integer
                                  example: 0
                                enrollment:
                                  type: boolean
                                  example: true
                                enrollment_pack_id:
                                  type: integer
                                  example: 1
                                price:
                                  type: string
                                  example: '11.13'
                                price_in_currency:
                                  type: string
                                  example: $11.13
                                product_title:
                                  type: string
                                  example: Zip Pack Sample Pack (30)
                                quantity:
                                  type: integer
                                  example: 1
                                qv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                qv_in_currency:
                                  type: string
                                  example: $0.00
                                qv_total:
                                  type: integer
                                  example: 0
                                subscribe_and_save:
                                  type:
                                    - string
                                    - 'null'
                                  example: '-1988.87'
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $-1,988.87
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $-1,988.87
                                subscription:
                                  type: boolean
                                  example: false
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_only:
                                  type: boolean
                                  example: false
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_price:
                                  type: string
                                  example: '2000.0'
                                subscription_price_in_currency:
                                  type: string
                                  example: $2,000.00
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  format: date
                                  example: '2025-02-28'
                                tax:
                                  type: string
                                  example: '0.0'
                                tax_in_currency:
                                  type: string
                                  example: $0.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: null
                                display_to_customer:
                                  type: boolean
                                  example: false
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                          price:
                            type: string
                            example: '11.13'
                          price_in_currency:
                            type: string
                            example: $11.13
                          subscription_price:
                            type:
                              - string
                              - integer
                            example: 2000
                          subscription_price_in_currency:
                            type: string
                            example: $2,000.00
                          title:
                            type: string
                            example: enroll product
                          token:
                            type: string
                            example: NxL22AqLRRisfyF9LqxxWRak
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      recurring:
                        oneOf:
                          - type: array
                            items:
                              type: object
                              properties:
                                subtotal:
                                  type: string
                                  example: '10.0'
                                subtotal_in_currency:
                                  type: string
                                  example: $10.0
                                interval:
                                  type: integer
                                  example: 1
                                interval_unit:
                                  type: string
                                  example: month
                                subtotal_for_display:
                                  type: string
                                  example: $10.00 every 1 month
                                start_date:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-05-27'
                          - type: 'null'
                        default:
                          - subtotal: '10.0'
                            subtotal_in_currency: $10.0
                            interval: 1
                            interval_unit: month
                            subtotal_for_display: $10.00 every 1 month
                            start_date: '2025-05-27'
                      messages:
                        type: object
                        additionalProperties: true
                        example:
                          errors:
                            - Insufficient inventory
                            - Product no longer available
                          warnings:
                            - Low stock warning
                            - Shipping delays expected
                          info:
                            - Free shipping available
                            - Volume discount applied
                      points_enabled:
                        type: boolean
                        example: true
                      points_applied:
                        type: integer
                        example: 500
                        description: Number of points applied to the cart
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Currency value of applied points
                      customer_total_points:
                        type: integer
                        example: 1000
                        description: Customer's total available points balance
                      customer_total_points_in_currency:
                        type: number
                        example: 10
                        description: Currency value of available points
                      remaining_customer_points:
                        type: integer
                        example: 500
                        description: Customer's remaining points after cart redemption
                      remaining_customer_points_amount_in_currency:
                        type: number
                        example: 5
                        description: >-
                          Currency value of remaining points after cart
                          redemption
                      remaining_cart_amount_after_points:
                        type: number
                        example: 95
                        description: Amount to charge to card after points redemption
                      remaining_cart_amount_after_points_in_currency:
                        type:
                          - string
                        example: $95.00
                        description: >-
                          Amount in currency to charge to card after points
                          redemption
                      max_applicable_points:
                        type: integer
                        example: 500
                        description: Maximum points that can be applied to this cart
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      checkout_url:
                        type: string
                        example: https://checkout.fluid.com/checkout?jwt=abc123
                      shop_url:
                        type: string
                        example: https://myco.fluid.app
        '404':
          description: cart not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
                      example:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '410':
          description: cart is in authorized enrollment state
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Cart is in authorized state and cannot be modified
                  errors:
                    type: object
                    example:
                      cart:
                        - is in authorized state and cannot be modified
                  meta:
                    type: object
                    properties:
                      shop_url:
                        type: string
                        example: https://example.myshopify.com
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      cart:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 123
                          state:
                            type: string
                            example: start
                          processed:
                            type: boolean
                            example: false
                            description: >-
                              Determines if a cart payment has been processed or
                              not.
                          valid_for_checkout:
                            type: boolean
                            example: true
                          buyer_rep_id:
                            type:
                              - integer
                              - 'null'
                            example: 1
                          buyer_rep:
                            oneOf:
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 2
                                  email:
                                    type:
                                      - string
                                      - 'null'
                                    example: buyer.rep@example.com
                                  full_name:
                                    type:
                                      - string
                                      - 'null'
                                    example: John Doe
                                  image_url:
                                    type:
                                      - string
                                      - 'null'
                                    example: https://example.com/image.png
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: '123241'
                                required:
                                  - id
                              - type: 'null'
                          volume_rep:
                            oneOf:
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 2
                                  email:
                                    type:
                                      - string
                                      - 'null'
                                    example: volume.rep@example.com
                                  full_name:
                                    type:
                                      - string
                                      - 'null'
                                    example: John Doe
                                  image_url:
                                    type:
                                      - string
                                      - 'null'
                                    example: https://example.com/image.png
                                required:
                                  - id
                              - type: 'null'
                          currency_symbol:
                            type: string
                            example: $
                          currency_code:
                            type: string
                            example: USD
                          shipping_total_for_display:
                            type: string
                            example: Free
                          phone:
                            type:
                              - string
                              - 'null'
                            example: '4035551212'
                          payment_method_auto_assignable:
                            type: boolean
                            example: true
                            description: >-
                              Determines if a payment method can be
                              auto-assigned to the cart.
                          attribution:
                            oneOf:
                              - type: object
                                oneOf:
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      share_guid:
                                        type: string
                                        example: james-bond007
                                    required:
                                      - id
                                      - share_guid
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      email:
                                        type: string
                                        example: james.bond@gmail.com
                                    required:
                                      - id
                                      - email
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      username:
                                        type: string
                                        example: jaamball234
                                    required:
                                      - id
                                      - username
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      fluid_rep_id:
                                        type: integer
                                        example: 23493
                                    required:
                                      - id
                                      - fluid_rep_id
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      external_id:
                                        type:
                                          - string
                                          - 'null'
                                        example: w3sdf92
                                    required:
                                      - id
                              - type: 'null'
                            default:
                              id: 456
                              share_guid: james-bond007
                          agreements:
                            type: array
                            items:
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                  example: 1
                                required:
                                  type: boolean
                                  example: true
                                title:
                                  type: string
                                  example: Terms and Conditions
                                show_path:
                                  type: string
                                  example: /terms
                                enrollment_pack_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                          amount_total:
                            type: string
                            example: '121.65'
                          amount_total_in_currency:
                            type: string
                            example: $121.65 (USD)
                          sub_total:
                            type: string
                            example: '100.00'
                          sub_total_in_currency:
                            type: string
                            example: $100.00 (USD)
                          subtotal_after_discounts:
                            type: string
                            example: '90.00'
                          tax_total:
                            type: string
                            example: '20.00'
                          tax_total_in_currency:
                            type: string
                            example: $20.00 (USD)
                          shipping_total:
                            type:
                              - string
                              - 'null'
                            example: '1.65'
                          shipping_total_in_currency:
                            type: string
                            example: $1.65 (USD)
                          shipping_discount:
                            type: number
                            example: 10.25
                          discount_total:
                            type: string
                            example: '2.99'
                          discount_total_in_currency:
                            type: string
                            example: $2.99 (USD)
                          discount_breakdown:
                            type: object
                            properties:
                              internal_discounts:
                                type: number
                                example: 15
                              external_discounts:
                                type: number
                                example: 10
                              total_discounts:
                                type: number
                                example: 25
                          external_discount:
                            type: object
                            properties:
                              total:
                                type: number
                                example: 10
                              calculated_at:
                                type:
                                  - string
                                  - 'null'
                                format: date-time
                                example: '2024-01-10T15:30:00Z'
                              sources:
                                type: object
                                additionalProperties:
                                  type: object
                                  properties:
                                    amount:
                                      type: number
                                      example: 6
                                    description:
                                      type: string
                                      example: Gold tier discount
                                    metadata:
                                      type: object
                                  required:
                                    - amount
                                    - description
                          transaction_fee:
                            type:
                              - number
                              - string
                            example: '1.90'
                          transaction_fee_in_currency:
                            type: string
                            example: $1.90 (USD)
                          cv_total:
                            type: integer
                            example: 10
                          qv_total:
                            type: integer
                            example: 15
                          company:
                            type: object
                            properties:
                              id:
                                type: integer
                              name:
                                type: string
                              primary_domain_hostname:
                                type:
                                  - string
                                  - 'null'
                                example: fluid.com
                              subdomain:
                                type:
                                  - string
                                  - 'null'
                                example: myco
                              logo_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/logo.png
                              fluid_shop:
                                type:
                                  - string
                                  - 'null'
                                example: https://fluid-sample-shop.fluid.com
                              collect_phone:
                                type: boolean
                                example: true
                              require_phone:
                                type: boolean
                                example: false
                              require_billing_zip:
                                type: boolean
                                example: false
                              checkout_primary_button_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#000000'
                              checkout_primary_text_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#FFFFFF'
                              checkout_secondary_button_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#FFFFFF'
                              checkout_secondary_text_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#000000'
                              favicon_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/favicon.ico
                              order_on_behalf:
                                type: boolean
                                example: false
                              use_juspay_gateway:
                                type: boolean
                                example: false
                              reward_points_enabled:
                                type: boolean
                                example: false
                          payment_account:
                            type:
                              - string
                              - 'null'
                            example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                          payment_method:
                            oneOf:
                              - type: 'null'
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: CreditCard
                                  payment_method_type:
                                    type: string
                                    example: visa
                                  last_four:
                                    type: string
                                    example: '1234'
                                  exp_month:
                                    type: string
                                    example: '12'
                                  exp_year:
                                    type: string
                                    example: '2025'
                                  logo_url:
                                    type: string
                                    example: https://example.com/image.svg
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Paypal
                                  status:
                                    type: string
                                    example: active
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Affirm
                                  affirm_id:
                                    type: string
                                    example: affirm_123
                                  status:
                                    type: string
                                    example: authorized
                                  checkout_id:
                                    type: string
                                    example: checkout_456
                                  created:
                                    type: string
                                    example: '2025-01-01T00:00:00Z'
                                  auth_expiration:
                                    type: string
                                    example: '2025-01-02T00:00:00Z'
                                  currency:
                                    type: string
                                    example: USD
                                  amount:
                                    type: string
                                    example: '100.00'
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Klarna
                                  session_id:
                                    type: string
                                    example: klarna_session_789
                                  intent:
                                    type: string
                                    example: buy
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Droplet
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: SomeCitcon
                          email:
                            type:
                              - string
                              - 'null'
                            example: user@example.com
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: '10.45'
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.45
                          discount_codes:
                            type: array
                            items:
                              type: string
                            example:
                              - DISCOUNT10
                              - DISCOUNT11
                          language_iso:
                            type:
                              - string
                              - 'null'
                            example: en
                          cart_token:
                            type: string
                            example: abc123
                          immutable_items:
                            type: boolean
                            example: false
                          digital_only:
                            type: boolean
                            example: false
                          requires_3ds:
                            type: boolean
                            example: false
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 101
                                price:
                                  type: string
                                  example: '43.41'
                                price_in_currency:
                                  type: string
                                  example: $43.41
                                tax:
                                  type: string
                                  example: '2.99'
                                tax_in_currency:
                                  type: string
                                  example: $2.99
                                cv:
                                  type: integer
                                  example: 5
                                cv_total:
                                  type: integer
                                  example: 15
                                qv:
                                  type: integer
                                  example: 7
                                qv_total:
                                  type: integer
                                  example: 21
                                discount_amount:
                                  type: string
                                  example: '10'
                                free_item:
                                  type: boolean
                                  example: false
                                discount_amount_in_currency:
                                  type: string
                                  example: $10.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                enrollment_pack_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                display_to_customer:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                product_title:
                                  type:
                                    - string
                                    - 'null'
                                  example: Sample Product
                                quantity:
                                  type: integer
                                  example: 3
                                subscription:
                                  type: boolean
                                  example: true
                                enrollment:
                                  type: boolean
                                  example: false
                                allow_subscription:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_only:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_price:
                                  type:
                                    - number
                                    - string
                                    - 'null'
                                  example: 10.5
                                subscription_price_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $10.50
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-02-12'
                                subscribe_and_save:
                                  type:
                                    - number
                                    - string
                                    - 'null'
                                  example: 2.99
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $2.99
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $2.99
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: Surcharge
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                product:
                                  oneOf:
                                    - type: object
                                      properties:
                                        id:
                                          type: integer
                                          example: 1
                                        title:
                                          type: string
                                          example: Sample Product
                                        introduction:
                                          type:
                                            - string
                                            - 'null'
                                          example: Sample Product Description
                                        cv:
                                          type: integer
                                          example: 10
                                        external_id:
                                          type:
                                            - string
                                            - 'null'
                                          example: ext-prod-123
                                        image_path:
                                          type:
                                            - string
                                            - 'null'
                                          example: /images/product.png
                                        image_url:
                                          type:
                                            - string
                                            - 'null'
                                          example: https://example.com/images/product.png
                                        price:
                                          type: string
                                          example: '29.99'
                                        price_in_currency:
                                          type: string
                                          example: $29.99
                                        sku:
                                          type:
                                            - string
                                            - 'null'
                                          example: SKU12345
                                        tax:
                                          type: string
                                          example: '2.99'
                                        tax_in_currency:
                                          type: string
                                          example: $2.99
                                        metadata:
                                          type: object
                                          example:
                                            shopify_product_id: 9876054868270
                                        metafields:
                                          type: array
                                          items:
                                            title: LegacyMetafield
                                            type: object
                                            properties:
                                              namespace:
                                                description: >-
                                                  A container for related metafields.
                                                  Commonly used to group metafields by app
                                                  or functionality.
                                                example: custom
                                                type: string
                                                maxLength: 20
                                                pattern: ^[a-zA-Z0-9_]+$
                                              key:
                                                description: >-
                                                  The unique identifier for the metafield
                                                  within its namespace. Must be unique per
                                                  namespace and owner.
                                                example: material
                                                type: string
                                                maxLength: 30
                                                pattern: ^[a-zA-Z0-9_]+$
                                              value:
                                                description: >-
                                                  The actual data stored in the metafield.
                                                  Type depends on value_type.
                                                example: cotton
                                                type:
                                                  - string
                                                  - integer
                                                  - object
                                                  - boolean
                                                  - number
                                              value_type:
                                                description: >-
                                                  The data type that defines how the value
                                                  should be interpreted and validated.
                                                example: single_line_text_field
                                                type: string
                                              description:
                                                description: >-
                                                  Optional human-readable description
                                                  explaining the purpose of this
                                                  metafield.
                                                example: >-
                                                  The primary material used in this
                                                  product
                                                type:
                                                  - string
                                                  - 'null'
                                              created_at:
                                                description: >-
                                                  Timestamp when the metafield was
                                                  created.
                                                example: '2021-01-01T00:00:00Z'
                                                type: string
                                                format: date-time
                                              updated_at:
                                                description: >-
                                                  Timestamp when the metafield was last
                                                  updated.
                                                example: '2021-01-01T00:00:00Z'
                                                type: string
                                                format: date-time
                                              locked:
                                                description: >-
                                                  Whether this metafield is locked and
                                                  cannot be updated or deleted directly.
                                                example: false
                                                type:
                                                  - boolean
                                                  - 'null'
                                                  - 'null'
                                              metafield_definition:
                                                description: >-
                                                  The definition that defines validation
                                                  rules and structure for this metafield
                                                type:
                                                  - 'null'
                                                  - object
                                            required:
                                              - namespace
                                              - key
                                              - value
                                              - value_type
                                              - description
                                              - created_at
                                              - updated_at
                                              - metafield_definition
                                    - type: 'null'
                                variant:
                                  oneOf:
                                    - type: object
                                      properties:
                                        id:
                                          type: integer
                                          example: 1
                                        title:
                                          type:
                                            - string
                                            - 'null'
                                          example: Sample Variant
                                        image_path:
                                          type:
                                            - string
                                            - 'null'
                                          example: /images/sample.png
                                        image_url:
                                          type:
                                            - string
                                            - 'null'
                                          example: https://example.com/images/sample.png
                                        primary_image:
                                          type:
                                            - string
                                            - 'null'
                                          example: https://example.com/images/primary.png
                                        price:
                                          type:
                                            - string
                                            - 'null'
                                          example: '34.44'
                                        price_in_currency:
                                          type:
                                            - string
                                            - 'null'
                                          example: $34.44
                                        sku:
                                          type:
                                            - string
                                            - 'null'
                                          example: SKU12345
                                        options:
                                          type: array
                                          items:
                                            type: object
                                            properties:
                                              title:
                                                type: string
                                                example: Size
                                              value:
                                                type: string
                                                example: XL
                                        physical:
                                          type:
                                            - boolean
                                            - 'null'
                                          example: true
                                        unit_of_size:
                                          type:
                                            - string
                                            - 'null'
                                          example: cm
                                        height:
                                          type:
                                            - number
                                            - 'null'
                                          example: 13
                                        width:
                                          type:
                                            - number
                                            - 'null'
                                          example: 6
                                        length:
                                          type:
                                            - number
                                            - 'null'
                                          example: 12
                                        unit_of_weight:
                                          type:
                                            - string
                                            - 'null'
                                          example: kg
                                        weight:
                                          type:
                                            - string
                                            - 'null'
                                          example: '3.2'
                                        hs_code:
                                          type:
                                            - string
                                            - 'null'
                                          example: '3.2'
                                    - type: 'null'
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                                bundled_items:
                                  type: array
                                  items:
                                    type: object
                                    description: Bundled items for bundle products
                                    properties:
                                      variant_id:
                                        type: integer
                                        example: 1
                                      product_id:
                                        type: integer
                                        example: 1
                                      product_title:
                                        type: string
                                        example: Product Title
                                      variant_title:
                                        type: string
                                        example: Variant Title
                                      option_titles:
                                        type: array
                                        example:
                                          - Option 1
                                          - Option 2
                                      quantity:
                                        type: integer
                                        example: 1
                                      display_to_customer:
                                        type: boolean
                                        example: true
                          ship_to:
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                                example: 1
                              name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              first_name:
                                type:
                                  - string
                                  - 'null'
                                example: John
                              last_name:
                                type:
                                  - string
                                  - 'null'
                                example: Doe
                              address1:
                                type: string
                                example: 123 Main St
                              address2:
                                type:
                                  - string
                                  - 'null'
                                example: Apt 4B
                              address3:
                                type:
                                  - string
                                  - 'null'
                                example: Building 5
                              city:
                                type: string
                                example: New York
                              state:
                                type: string
                                example: NY
                              postal_code:
                                type: string
                                example: '10001'
                              country_code:
                                type: string
                                example: US
                                description: >-
                                  country_id takes precedence if both country_id
                                  and country_code provided.
                              subdivision_code:
                                type:
                                  - string
                                  - 'null'
                                example: NY
                              default:
                                type: boolean
                                example: true
                          bill_to:
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                                example: 1
                              name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              first_name:
                                type:
                                  - string
                                  - 'null'
                                example: John
                              last_name:
                                type:
                                  - string
                                  - 'null'
                                example: Doe
                              address1:
                                type: string
                                example: 123 Main St
                              address2:
                                type:
                                  - string
                                  - 'null'
                                example: Apt 4B
                              address3:
                                type:
                                  - string
                                  - 'null'
                                example: Building 5
                              city:
                                type: string
                                example: New York
                              state:
                                type: string
                                example: NY
                              postal_code:
                                type: string
                                example: '10001'
                              country_code:
                                type: string
                                example: US
                                description: >-
                                  country_id takes precedence if both country_id
                                  and country_code provided.
                              subdivision_code:
                                type:
                                  - string
                                  - 'null'
                                example: NY
                              default:
                                type: boolean
                                example: true
                          shipping_method:
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: string
                                example: standard-shipping
                              name:
                                type: string
                                example: Standard Shipping
                          available_shipping_methods:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                  example: standard-shipping
                                title:
                                  type: string
                                  example: Standard Shipping
                                price:
                                  type:
                                    - number
                                    - string
                                  example: 5.99
                                price_label:
                                  type: string
                                  example: $5.99
                                delivery_time_estimate:
                                  type: string
                                  example: 3-5 business days
                          available_payment_methods:
                            type: array
                            items:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1337
                                    uuid:
                                      type: string
                                      example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                    type:
                                      type: string
                                      enum:
                                        - credit_card
                                    name:
                                      type: string
                                      example: Credit Card
                                    image_url:
                                      type: string
                                      example: https://example.com/image.png
                                    test:
                                      type: boolean
                                      example: true
                                      description: >-
                                        Determines if payment method is test
                                        instance or not. By default, set to
                                        `true`
                                    sandbox:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method is sandbox
                                        instance or not. By default, set to
                                        `false`
                                    apple_pay:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method supports
                                        ApplePay or not 
                                    bogus_gateway:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method is a Bogus
                                        instance or not.
                                    tokenize_path:
                                      type:
                                        - string
                                        - 'null'
                                      description: Path to tokenize, if applicable.
                                    token_provider:
                                      type: string
                                      enum:
                                        - spreedly
                                        - vgs
                                      description: >-
                                        Determines if payment tokenization is
                                        via spreedly or VGS
                                    apple_pay_merchant_identifier:
                                      type:
                                        - string
                                        - 'null'
                                      example: merchant.mycompany.com
                                      description: >-
                                        If ApplePay is supported, returns the
                                        merchant identifier registered with
                                        Apple, else returns nil
                                    supported_brands:
                                      type: array
                                      items:
                                        type: string
                                      example:
                                        - visa
                                        - master
                                        - american_express
                                        - discover
                                    publishable_key:
                                      type:
                                        - string
                                        - 'null'
                                      example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                      description: >-
                                        If publishable key is set for
                                        Hyperswitch, returns the publishable
                                        key, else returns nil
                                    customer_details_schema:
                                      type: object
                                      example: {}
                                      description: >-
                                        Schema defining required customer
                                        details for this payment method
                                  required:
                                    - id
                                    - type
                                    - name
                                    - supported_brands
                                    - test
                                    - sandbox
                                    - apple_pay
                                    - apple_pay_merchant_identifier
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1337
                                    uuid:
                                      type: string
                                      example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                    type:
                                      type: string
                                      enum:
                                        - klarna
                                    name:
                                      type: string
                                      example: Klarna
                                    image_url:
                                      type: string
                                      example: https://example.com/image.png
                                    test:
                                      type: boolean
                                      example: true
                                      description: >-
                                        Determines if payment method is test
                                        instance or not. By default, set to
                                        `true`
                                    sandbox:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method is sandbox
                                        instance or not. By default, set to
                                        `false`
                                    customer_details_schema:
                                      type: object
                                      example: {}
                                      description: >-
                                        Schema defining required customer
                                        details for this payment method
                          country:
                            type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              iso:
                                type: string
                                example: US
                              name:
                                type: string
                                example: United States
                              iso_name:
                                type: string
                                example: UNITED STATES
                              iso3:
                                type: string
                                example: USA
                              currency_code:
                                type: string
                                example: USD
                              currency_symbol:
                                type: string
                                example: $
                              province_required:
                                type: boolean
                                example: false
                              tax_enabled:
                                type:
                                  - boolean
                                  - 'null'
                                example: true
                              price_inclusive_of_tax:
                                type: boolean
                                example: false
                              price_inclusive_tax_name:
                                type:
                                  - string
                                  - 'null'
                                example: VAT
                          type:
                            type: string
                            enum:
                              - regular
                              - enrollment
                            example: regular
                          enrollment_pack_id:
                            type:
                              - integer
                              - 'null'
                            example: 1
                          enrollment_pack:
                            type:
                              - object
                              - 'null'
                            properties:
                              enrollment_pack_id:
                                type: integer
                                example: 1
                              additional_volume:
                                type:
                                  - integer
                                  - 'null'
                                example: 10
                              slug:
                                type: string
                                example: test-enrollment-pack
                              description:
                                type:
                                  - object
                                  - 'null'
                                  - string
                                properties:
                                  id:
                                    type: integer
                                    example: 111
                                  name:
                                    type: string
                                    example: description
                                  body:
                                    type: string
                                    example: >-
                                      <div>Try the latest and greatest of our
                                      sugar zip packs. Guaranteed to make you
                                      skinner and cure cancer.</div>
                                  record_type:
                                    type: string
                                    example: EnrollmentPack
                                  record_id:
                                    type: integer
                                    example: 1
                                  created_at:
                                    type: string
                                    format: date_time
                                    example: '2025-01-16T04:22:43.809Z'
                                  updated_at:
                                    type: string
                                    format: date_time
                                    example: '2025-01-22T10:23:52.941Z'
                                  locale:
                                    type: string
                                    example: en
                              enrollment_fee:
                                type:
                                  - number
                                  - string
                                example: 10
                              enrollment_fee_in_currency:
                                type: string
                                example: $10.00
                              images:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 2
                                    relateable_type:
                                      type: string
                                      example: EnrollmentPack
                                    relateable_id:
                                      type: integer
                                      example: 1
                                    image_url:
                                      type: string
                                      example: >-
                                        https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                    image_path:
                                      type: string
                                      example: jITWaU14QGe0y5AFgY7P_00179.svg
                                    position:
                                      type: integer
                                      example: 1
                                    shopify_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: null
                                    created_at:
                                      type: string
                                      format: date_time
                                      example: '2025-01-16T04:22:44.870Z'
                                    updated_at:
                                      type: string
                                      format: date_time
                                      example: '2025-01-16T04:22:44.870Z'
                                    external_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: null
                              items:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 625
                                    allow_subscription:
                                      type: boolean
                                      example: true
                                    cv:
                                      type:
                                        - number
                                        - string
                                      example: 0
                                    cv_in_currency:
                                      type: string
                                      example: $0.00
                                    cv_total:
                                      type: integer
                                      example: 0
                                    enrollment:
                                      type: boolean
                                      example: true
                                    enrollment_pack_id:
                                      type: integer
                                      example: 1
                                    price:
                                      type: string
                                      example: '11.13'
                                    price_in_currency:
                                      type: string
                                      example: $11.13
                                    product_title:
                                      type: string
                                      example: Zip Pack Sample Pack (30)
                                    quantity:
                                      type: integer
                                      example: 1
                                    qv:
                                      type:
                                        - number
                                        - string
                                      example: 0
                                    qv_in_currency:
                                      type: string
                                      example: $0.00
                                    qv_total:
                                      type: integer
                                      example: 0
                                    subscribe_and_save:
                                      type:
                                        - string
                                        - 'null'
                                      example: '-1988.87'
                                    subscribe_and_save_for_display:
                                      type:
                                        - string
                                        - 'null'
                                      example: Subscribe and save $-1,988.87
                                    subscribe_and_save_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $-1,988.87
                                    subscription:
                                      type: boolean
                                      example: false
                                    subscription_interval:
                                      type:
                                        - integer
                                        - 'null'
                                      example: 1
                                    subscription_interval_unit:
                                      type:
                                        - string
                                        - 'null'
                                      example: month
                                    subscription_only:
                                      type: boolean
                                      example: false
                                    subscription_plan_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: 1
                                    subscription_plans:
                                      oneOf:
                                        - type: array
                                          items:
                                            title: Commerce::SubscriptionPlan
                                            type: object
                                            properties:
                                              id:
                                                type: integer
                                              name:
                                                example: Test Subscription Plan
                                                type: string
                                              billing_interval:
                                                example: 1
                                                type: integer
                                                default: 1
                                                minimum: 1
                                                maximum: 29
                                              billing_interval_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type: string
                                                default: month
                                              billing_frequency_in_words:
                                                example: 2 Months
                                                type: string
                                              shipping_interval:
                                                example: 1
                                                type: integer
                                                default: 1
                                                minimum: 1
                                                maximum: 29
                                              shipping_interval_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type: string
                                                default: month
                                              volume_interval:
                                                example: 1
                                                type: integer
                                                default: 1
                                                minimum: 1
                                                maximum: 29
                                              volume_interval_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type: string
                                                default: month
                                              trial_period:
                                                example: 1
                                                type:
                                                  - integer
                                                  - 'null'
                                                minimum: 1
                                              trial_period_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type:
                                                  - string
                                                  - 'null'
                                              split_volume:
                                                example: true
                                                type: boolean
                                                default: false
                                              allow_max_billing_cycles:
                                                example: true
                                                type: boolean
                                                default: false
                                              max_billing_cycles:
                                                example: 3
                                                type:
                                                  - integer
                                                  - 'null'
                                              company_default:
                                                example: false
                                                type:
                                                  - boolean
                                                  - 'null'
                                                default: false
                                              products_count:
                                                example: 10
                                                type:
                                                  - integer
                                                  - 'null'
                                              subscribers_count:
                                                example: 10
                                                type:
                                                  - integer
                                                  - 'null'
                                              price:
                                                type: string
                                              price_in_currency:
                                                type: string
                                              subscription_start:
                                                type: string
                                              subscribe_and_save:
                                                type:
                                                  - string
                                                  - 'null'
                                              subscribe_and_save_in_currency:
                                                type:
                                                  - string
                                                  - 'null'
                                              subscribe_and_save_for_display:
                                                type:
                                                  - string
                                                  - 'null'
                                            required:
                                              - id
                                              - name
                                              - billing_interval
                                              - billing_interval_unit
                                              - billing_frequency_in_words
                                              - shipping_interval
                                              - shipping_interval_unit
                                              - volume_interval
                                              - volume_interval_unit
                                              - split_volume
                                              - allow_max_billing_cycles
                                              - price
                                              - price_in_currency
                                              - subscription_start
                                              - subscribe_and_save
                                              - subscribe_and_save_in_currency
                                              - subscribe_and_save_for_display
                                        - type: 'null'
                                    subscription_price:
                                      type: string
                                      example: '2000.0'
                                    subscription_price_in_currency:
                                      type: string
                                      example: $2,000.00
                                    subscription_start:
                                      type:
                                        - string
                                        - 'null'
                                      format: date
                                      example: '2025-02-28'
                                    tax:
                                      type: string
                                      example: '0.0'
                                    tax_in_currency:
                                      type: string
                                      example: $0.00
                                    total_after_discounts:
                                      type: string
                                      example: '90.00'
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: null
                                    display_to_customer:
                                      type: boolean
                                      example: false
                                    metadata:
                                      type: object
                                      description: >-
                                        A JSON object that can store any custom
                                        data structure
                                      example: {}
                                    errors:
                                      oneOf:
                                        - type: 'null'
                                        - type: array
                                          items:
                                            type: object
                                          example:
                                            - country:
                                                - >-
                                                  This product is not available for this
                                                  country. Please change your country
                              price:
                                type: string
                                example: '11.13'
                              price_in_currency:
                                type: string
                                example: $11.13
                              subscription_price:
                                type:
                                  - string
                                  - integer
                                example: 2000
                              subscription_price_in_currency:
                                type: string
                                example: $2,000.00
                              title:
                                type: string
                                example: enroll product
                              token:
                                type: string
                                example: NxL22AqLRRisfyF9LqxxWRak
                          metadata:
                            type: object
                            description: >-
                              A JSON object that can store any custom data
                              structure.
                          recurring:
                            oneOf:
                              - type: array
                                items:
                                  type: object
                                  properties:
                                    subtotal:
                                      type: string
                                      example: '10.0'
                                    subtotal_in_currency:
                                      type: string
                                      example: $10.0
                                    interval:
                                      type: integer
                                      example: 1
                                    interval_unit:
                                      type: string
                                      example: month
                                    subtotal_for_display:
                                      type: string
                                      example: $10.00 every 1 month
                                    start_date:
                                      type:
                                        - string
                                        - 'null'
                                      example: '2025-05-27'
                              - type: 'null'
                            default:
                              - subtotal: '10.0'
                                subtotal_in_currency: $10.0
                                interval: 1
                                interval_unit: month
                                subtotal_for_display: $10.00 every 1 month
                                start_date: '2025-05-27'
                          messages:
                            type: object
                            additionalProperties: true
                            example:
                              errors:
                                - Insufficient inventory
                                - Product no longer available
                              warnings:
                                - Low stock warning
                                - Shipping delays expected
                              info:
                                - Free shipping available
                                - Volume discount applied
                          points_enabled:
                            type: boolean
                            example: true
                          points_applied:
                            type: integer
                            example: 500
                            description: Number of points applied to the cart
                          points_applied_amount_in_currency:
                            type: number
                            example: 5
                            description: Currency value of applied points
                          customer_total_points:
                            type: integer
                            example: 1000
                            description: Customer's total available points balance
                          customer_total_points_in_currency:
                            type: number
                            example: 10
                            description: Currency value of available points
                          remaining_customer_points:
                            type: integer
                            example: 500
                            description: Customer's remaining points after cart redemption
                          remaining_customer_points_amount_in_currency:
                            type: number
                            example: 5
                            description: >-
                              Currency value of remaining points after cart
                              redemption
                          remaining_cart_amount_after_points:
                            type: number
                            example: 95
                            description: Amount to charge to card after points redemption
                          remaining_cart_amount_after_points_in_currency:
                            type:
                              - string
                            example: $95.00
                            description: >-
                              Amount in currency to charge to card after points
                              redemption
                          max_applicable_points:
                            type: integer
                            example: 500
                            description: Maximum points that can be applied to this cart
                required:
                  - error_message
                  - errors
                  - meta
        '422':
          description: email update rejected by callback
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      email:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                email:
                  type: string
                  format: email
                phone:
                  type: string
                  example: '4035551212'
  /api/carts/{cart_token}/discount:
    post:
      summary: Applies a discount to the cart
      tags:
        - Carts
      operationId: applyDiscount
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: discount applied
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      state:
                        type: string
                        example: start
                      processed:
                        type: boolean
                        example: false
                        description: >-
                          Determines if a cart payment has been processed or
                          not.
                      valid_for_checkout:
                        type: boolean
                        example: true
                      buyer_rep_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      buyer_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: buyer.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                              external_id:
                                type:
                                  - string
                                  - 'null'
                                example: '123241'
                            required:
                              - id
                          - type: 'null'
                      volume_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: volume.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                            required:
                              - id
                          - type: 'null'
                      currency_symbol:
                        type: string
                        example: $
                      currency_code:
                        type: string
                        example: USD
                      shipping_total_for_display:
                        type: string
                        example: Free
                      phone:
                        type:
                          - string
                          - 'null'
                        example: '4035551212'
                      payment_method_auto_assignable:
                        type: boolean
                        example: true
                        description: >-
                          Determines if a payment method can be auto-assigned to
                          the cart.
                      attribution:
                        oneOf:
                          - type: object
                            oneOf:
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  share_guid:
                                    type: string
                                    example: james-bond007
                                required:
                                  - id
                                  - share_guid
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  email:
                                    type: string
                                    example: james.bond@gmail.com
                                required:
                                  - id
                                  - email
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  username:
                                    type: string
                                    example: jaamball234
                                required:
                                  - id
                                  - username
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  fluid_rep_id:
                                    type: integer
                                    example: 23493
                                required:
                                  - id
                                  - fluid_rep_id
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: w3sdf92
                                required:
                                  - id
                          - type: 'null'
                        default:
                          id: 456
                          share_guid: james-bond007
                      agreements:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            required:
                              type: boolean
                              example: true
                            title:
                              type: string
                              example: Terms and Conditions
                            show_path:
                              type: string
                              example: /terms
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                      amount_total:
                        type: string
                        example: '121.65'
                      amount_total_in_currency:
                        type: string
                        example: $121.65 (USD)
                      sub_total:
                        type: string
                        example: '100.00'
                      sub_total_in_currency:
                        type: string
                        example: $100.00 (USD)
                      subtotal_after_discounts:
                        type: string
                        example: '90.00'
                      tax_total:
                        type: string
                        example: '20.00'
                      tax_total_in_currency:
                        type: string
                        example: $20.00 (USD)
                      shipping_total:
                        type:
                          - string
                          - 'null'
                        example: '1.65'
                      shipping_total_in_currency:
                        type: string
                        example: $1.65 (USD)
                      shipping_discount:
                        type: number
                        example: 10.25
                      discount_total:
                        type: string
                        example: '2.99'
                      discount_total_in_currency:
                        type: string
                        example: $2.99 (USD)
                      discount_breakdown:
                        type: object
                        properties:
                          internal_discounts:
                            type: number
                            example: 15
                          external_discounts:
                            type: number
                            example: 10
                          total_discounts:
                            type: number
                            example: 25
                      external_discount:
                        type: object
                        properties:
                          total:
                            type: number
                            example: 10
                          calculated_at:
                            type:
                              - string
                              - 'null'
                            format: date-time
                            example: '2024-01-10T15:30:00Z'
                          sources:
                            type: object
                            additionalProperties:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 6
                                description:
                                  type: string
                                  example: Gold tier discount
                                metadata:
                                  type: object
                              required:
                                - amount
                                - description
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: '1.90'
                      transaction_fee_in_currency:
                        type: string
                        example: $1.90 (USD)
                      cv_total:
                        type: integer
                        example: 10
                      qv_total:
                        type: integer
                        example: 15
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      payment_account:
                        type:
                          - string
                          - 'null'
                        example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                      payment_method:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: CreditCard
                              payment_method_type:
                                type: string
                                example: visa
                              last_four:
                                type: string
                                example: '1234'
                              exp_month:
                                type: string
                                example: '12'
                              exp_year:
                                type: string
                                example: '2025'
                              logo_url:
                                type: string
                                example: https://example.com/image.svg
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Paypal
                              status:
                                type: string
                                example: active
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Affirm
                              affirm_id:
                                type: string
                                example: affirm_123
                              status:
                                type: string
                                example: authorized
                              checkout_id:
                                type: string
                                example: checkout_456
                              created:
                                type: string
                                example: '2025-01-01T00:00:00Z'
                              auth_expiration:
                                type: string
                                example: '2025-01-02T00:00:00Z'
                              currency:
                                type: string
                                example: USD
                              amount:
                                type: string
                                example: '100.00'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Klarna
                              session_id:
                                type: string
                                example: klarna_session_789
                              intent:
                                type: string
                                example: buy
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Droplet
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: SomeCitcon
                      email:
                        type:
                          - string
                          - 'null'
                        example: user@example.com
                      enrollment_fee:
                        type:
                          - number
                          - string
                        example: '10.45'
                      enrollment_fee_in_currency:
                        type: string
                        example: $10.45
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT10
                          - DISCOUNT11
                      language_iso:
                        type:
                          - string
                          - 'null'
                        example: en
                      cart_token:
                        type: string
                        example: abc123
                      immutable_items:
                        type: boolean
                        example: false
                      digital_only:
                        type: boolean
                        example: false
                      requires_3ds:
                        type: boolean
                        example: false
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 101
                            price:
                              type: string
                              example: '43.41'
                            price_in_currency:
                              type: string
                              example: $43.41
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            cv:
                              type: integer
                              example: 5
                            cv_total:
                              type: integer
                              example: 15
                            qv:
                              type: integer
                              example: 7
                            qv_total:
                              type: integer
                              example: 21
                            discount_amount:
                              type: string
                              example: '10'
                            free_item:
                              type: boolean
                              example: false
                            discount_amount_in_currency:
                              type: string
                              example: $10.00
                            total_after_discounts:
                              type: string
                              example: '90.00'
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            product_title:
                              type:
                                - string
                                - 'null'
                              example: Sample Product
                            quantity:
                              type: integer
                              example: 3
                            subscription:
                              type: boolean
                              example: true
                            enrollment:
                              type: boolean
                              example: false
                            allow_subscription:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_plan_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_plans:
                              oneOf:
                                - type: array
                                  items:
                                    title: Commerce::SubscriptionPlan
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        example: Test Subscription Plan
                                        type: string
                                      billing_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      billing_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      billing_frequency_in_words:
                                        example: 2 Months
                                        type: string
                                      shipping_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      shipping_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      volume_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      volume_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      trial_period:
                                        example: 1
                                        type:
                                          - integer
                                          - 'null'
                                        minimum: 1
                                      trial_period_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type:
                                          - string
                                          - 'null'
                                      split_volume:
                                        example: true
                                        type: boolean
                                        default: false
                                      allow_max_billing_cycles:
                                        example: true
                                        type: boolean
                                        default: false
                                      max_billing_cycles:
                                        example: 3
                                        type:
                                          - integer
                                          - 'null'
                                      company_default:
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                        default: false
                                      products_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      subscribers_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      price:
                                        type: string
                                      price_in_currency:
                                        type: string
                                      subscription_start:
                                        type: string
                                      subscribe_and_save:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_in_currency:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_for_display:
                                        type:
                                          - string
                                          - 'null'
                                    required:
                                      - id
                                      - name
                                      - billing_interval
                                      - billing_interval_unit
                                      - billing_frequency_in_words
                                      - shipping_interval
                                      - shipping_interval_unit
                                      - volume_interval
                                      - volume_interval_unit
                                      - split_volume
                                      - allow_max_billing_cycles
                                      - price
                                      - price_in_currency
                                      - subscription_start
                                      - subscribe_and_save
                                      - subscribe_and_save_in_currency
                                      - subscribe_and_save_for_display
                                - type: 'null'
                            subscription_only:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_interval:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_interval_unit:
                              type:
                                - string
                                - 'null'
                              example: month
                            subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 10.5
                            subscription_price_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $10.50
                            subscription_start:
                              type:
                                - string
                                - 'null'
                              example: '2025-02-12'
                            subscribe_and_save:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 2.99
                            subscribe_and_save_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $2.99
                            subscribe_and_save_for_display:
                              type:
                                - string
                                - 'null'
                              example: Subscribe and save $2.99
                            title:
                              type:
                                - string
                                - 'null'
                              example: Surcharge
                            metadata:
                              type: object
                              description: >-
                                A JSON object that can store any custom data
                                structure
                              example: {}
                            product:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type: string
                                      example: Sample Product
                                    introduction:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Product Description
                                    cv:
                                      type: integer
                                      example: 10
                                    external_id:
                                      type:
                                        - string
                                        - 'null'
                                      example: ext-prod-123
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/product.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/product.png
                                    price:
                                      type: string
                                      example: '29.99'
                                    price_in_currency:
                                      type: string
                                      example: $29.99
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    tax:
                                      type: string
                                      example: '2.99'
                                    tax_in_currency:
                                      type: string
                                      example: $2.99
                                    metadata:
                                      type: object
                                      example:
                                        shopify_product_id: 9876054868270
                                    metafields:
                                      type: array
                                      items:
                                        title: LegacyMetafield
                                        type: object
                                        properties:
                                          namespace:
                                            description: >-
                                              A container for related metafields.
                                              Commonly used to group metafields by app
                                              or functionality.
                                            example: custom
                                            type: string
                                            maxLength: 20
                                            pattern: ^[a-zA-Z0-9_]+$
                                          key:
                                            description: >-
                                              The unique identifier for the metafield
                                              within its namespace. Must be unique per
                                              namespace and owner.
                                            example: material
                                            type: string
                                            maxLength: 30
                                            pattern: ^[a-zA-Z0-9_]+$
                                          value:
                                            description: >-
                                              The actual data stored in the metafield.
                                              Type depends on value_type.
                                            example: cotton
                                            type:
                                              - string
                                              - integer
                                              - object
                                              - boolean
                                              - number
                                          value_type:
                                            description: >-
                                              The data type that defines how the value
                                              should be interpreted and validated.
                                            example: single_line_text_field
                                            type: string
                                          description:
                                            description: >-
                                              Optional human-readable description
                                              explaining the purpose of this
                                              metafield.
                                            example: >-
                                              The primary material used in this
                                              product
                                            type:
                                              - string
                                              - 'null'
                                          created_at:
                                            description: >-
                                              Timestamp when the metafield was
                                              created.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          updated_at:
                                            description: >-
                                              Timestamp when the metafield was last
                                              updated.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          locked:
                                            description: >-
                                              Whether this metafield is locked and
                                              cannot be updated or deleted directly.
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                              - 'null'
                                          metafield_definition:
                                            description: >-
                                              The definition that defines validation
                                              rules and structure for this metafield
                                            type:
                                              - 'null'
                                              - object
                                        required:
                                          - namespace
                                          - key
                                          - value
                                          - value_type
                                          - description
                                          - created_at
                                          - updated_at
                                          - metafield_definition
                                - type: 'null'
                            variant:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Variant
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/sample.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/sample.png
                                    primary_image:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/primary.png
                                    price:
                                      type:
                                        - string
                                        - 'null'
                                      example: '34.44'
                                    price_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $34.44
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    options:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          title:
                                            type: string
                                            example: Size
                                          value:
                                            type: string
                                            example: XL
                                    physical:
                                      type:
                                        - boolean
                                        - 'null'
                                      example: true
                                    unit_of_size:
                                      type:
                                        - string
                                        - 'null'
                                      example: cm
                                    height:
                                      type:
                                        - number
                                        - 'null'
                                      example: 13
                                    width:
                                      type:
                                        - number
                                        - 'null'
                                      example: 6
                                    length:
                                      type:
                                        - number
                                        - 'null'
                                      example: 12
                                    unit_of_weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: kg
                                    weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                    hs_code:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                - type: 'null'
                            errors:
                              oneOf:
                                - type: 'null'
                                - type: array
                                  items:
                                    type: object
                                  example:
                                    - country:
                                        - >-
                                          This product is not available for this
                                          country. Please change your country
                            bundled_items:
                              type: array
                              items:
                                type: object
                                description: Bundled items for bundle products
                                properties:
                                  variant_id:
                                    type: integer
                                    example: 1
                                  product_id:
                                    type: integer
                                    example: 1
                                  product_title:
                                    type: string
                                    example: Product Title
                                  variant_title:
                                    type: string
                                    example: Variant Title
                                  option_titles:
                                    type: array
                                    example:
                                      - Option 1
                                      - Option 2
                                  quantity:
                                    type: integer
                                    example: 1
                                  display_to_customer:
                                    type: boolean
                                    example: true
                      ship_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      bill_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      shipping_method:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: string
                            example: standard-shipping
                          name:
                            type: string
                            example: Standard Shipping
                      available_shipping_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: standard-shipping
                            title:
                              type: string
                              example: Standard Shipping
                            price:
                              type:
                                - number
                                - string
                              example: 5.99
                            price_label:
                              type: string
                              example: $5.99
                            delivery_time_estimate:
                              type: string
                              example: 3-5 business days
                      available_payment_methods:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - credit_card
                                name:
                                  type: string
                                  example: Credit Card
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                apple_pay:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method supports
                                    ApplePay or not 
                                bogus_gateway:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is a Bogus
                                    instance or not.
                                tokenize_path:
                                  type:
                                    - string
                                    - 'null'
                                  description: Path to tokenize, if applicable.
                                token_provider:
                                  type: string
                                  enum:
                                    - spreedly
                                    - vgs
                                  description: >-
                                    Determines if payment tokenization is via
                                    spreedly or VGS
                                apple_pay_merchant_identifier:
                                  type:
                                    - string
                                    - 'null'
                                  example: merchant.mycompany.com
                                  description: >-
                                    If ApplePay is supported, returns the
                                    merchant identifier registered with Apple,
                                    else returns nil
                                supported_brands:
                                  type: array
                                  items:
                                    type: string
                                  example:
                                    - visa
                                    - master
                                    - american_express
                                    - discover
                                publishable_key:
                                  type:
                                    - string
                                    - 'null'
                                  example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                  description: >-
                                    If publishable key is set for Hyperswitch,
                                    returns the publishable key, else returns
                                    nil
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                              required:
                                - id
                                - type
                                - name
                                - supported_brands
                                - test
                                - sandbox
                                - apple_pay
                                - apple_pay_merchant_identifier
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - klarna
                                name:
                                  type: string
                                  example: Klarna
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                      country:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          iso:
                            type: string
                            example: US
                          name:
                            type: string
                            example: United States
                          iso_name:
                            type: string
                            example: UNITED STATES
                          iso3:
                            type: string
                            example: USA
                          currency_code:
                            type: string
                            example: USD
                          currency_symbol:
                            type: string
                            example: $
                          province_required:
                            type: boolean
                            example: false
                          tax_enabled:
                            type:
                              - boolean
                              - 'null'
                            example: true
                          price_inclusive_of_tax:
                            type: boolean
                            example: false
                          price_inclusive_tax_name:
                            type:
                              - string
                              - 'null'
                            example: VAT
                      type:
                        type: string
                        enum:
                          - regular
                          - enrollment
                        example: regular
                      enrollment_pack_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      enrollment_pack:
                        type:
                          - object
                          - 'null'
                        properties:
                          enrollment_pack_id:
                            type: integer
                            example: 1
                          additional_volume:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          slug:
                            type: string
                            example: test-enrollment-pack
                          description:
                            type:
                              - object
                              - 'null'
                              - string
                            properties:
                              id:
                                type: integer
                                example: 111
                              name:
                                type: string
                                example: description
                              body:
                                type: string
                                example: >-
                                  <div>Try the latest and greatest of our sugar
                                  zip packs. Guaranteed to make you skinner and
                                  cure cancer.</div>
                              record_type:
                                type: string
                                example: EnrollmentPack
                              record_id:
                                type: integer
                                example: 1
                              created_at:
                                type: string
                                format: date_time
                                example: '2025-01-16T04:22:43.809Z'
                              updated_at:
                                type: string
                                format: date_time
                                example: '2025-01-22T10:23:52.941Z'
                              locale:
                                type: string
                                example: en
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: 10
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.00
                          images:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2
                                relateable_type:
                                  type: string
                                  example: EnrollmentPack
                                relateable_id:
                                  type: integer
                                  example: 1
                                image_url:
                                  type: string
                                  example: >-
                                    https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                image_path:
                                  type: string
                                  example: jITWaU14QGe0y5AFgY7P_00179.svg
                                position:
                                  type: integer
                                  example: 1
                                shopify_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                                created_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                updated_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                external_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 625
                                allow_subscription:
                                  type: boolean
                                  example: true
                                cv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                cv_in_currency:
                                  type: string
                                  example: $0.00
                                cv_total:
                                  type: integer
                                  example: 0
                                enrollment:
                                  type: boolean
                                  example: true
                                enrollment_pack_id:
                                  type: integer
                                  example: 1
                                price:
                                  type: string
                                  example: '11.13'
                                price_in_currency:
                                  type: string
                                  example: $11.13
                                product_title:
                                  type: string
                                  example: Zip Pack Sample Pack (30)
                                quantity:
                                  type: integer
                                  example: 1
                                qv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                qv_in_currency:
                                  type: string
                                  example: $0.00
                                qv_total:
                                  type: integer
                                  example: 0
                                subscribe_and_save:
                                  type:
                                    - string
                                    - 'null'
                                  example: '-1988.87'
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $-1,988.87
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $-1,988.87
                                subscription:
                                  type: boolean
                                  example: false
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_only:
                                  type: boolean
                                  example: false
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_price:
                                  type: string
                                  example: '2000.0'
                                subscription_price_in_currency:
                                  type: string
                                  example: $2,000.00
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  format: date
                                  example: '2025-02-28'
                                tax:
                                  type: string
                                  example: '0.0'
                                tax_in_currency:
                                  type: string
                                  example: $0.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: null
                                display_to_customer:
                                  type: boolean
                                  example: false
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                          price:
                            type: string
                            example: '11.13'
                          price_in_currency:
                            type: string
                            example: $11.13
                          subscription_price:
                            type:
                              - string
                              - integer
                            example: 2000
                          subscription_price_in_currency:
                            type: string
                            example: $2,000.00
                          title:
                            type: string
                            example: enroll product
                          token:
                            type: string
                            example: NxL22AqLRRisfyF9LqxxWRak
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      recurring:
                        oneOf:
                          - type: array
                            items:
                              type: object
                              properties:
                                subtotal:
                                  type: string
                                  example: '10.0'
                                subtotal_in_currency:
                                  type: string
                                  example: $10.0
                                interval:
                                  type: integer
                                  example: 1
                                interval_unit:
                                  type: string
                                  example: month
                                subtotal_for_display:
                                  type: string
                                  example: $10.00 every 1 month
                                start_date:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-05-27'
                          - type: 'null'
                        default:
                          - subtotal: '10.0'
                            subtotal_in_currency: $10.0
                            interval: 1
                            interval_unit: month
                            subtotal_for_display: $10.00 every 1 month
                            start_date: '2025-05-27'
                      messages:
                        type: object
                        additionalProperties: true
                        example:
                          errors:
                            - Insufficient inventory
                            - Product no longer available
                          warnings:
                            - Low stock warning
                            - Shipping delays expected
                          info:
                            - Free shipping available
                            - Volume discount applied
                      points_enabled:
                        type: boolean
                        example: true
                      points_applied:
                        type: integer
                        example: 500
                        description: Number of points applied to the cart
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Currency value of applied points
                      customer_total_points:
                        type: integer
                        example: 1000
                        description: Customer's total available points balance
                      customer_total_points_in_currency:
                        type: number
                        example: 10
                        description: Currency value of available points
                      remaining_customer_points:
                        type: integer
                        example: 500
                        description: Customer's remaining points after cart redemption
                      remaining_customer_points_amount_in_currency:
                        type: number
                        example: 5
                        description: >-
                          Currency value of remaining points after cart
                          redemption
                      remaining_cart_amount_after_points:
                        type: number
                        example: 95
                        description: Amount to charge to card after points redemption
                      remaining_cart_amount_after_points_in_currency:
                        type:
                          - string
                        example: $95.00
                        description: >-
                          Amount in currency to charge to card after points
                          redemption
                      max_applicable_points:
                        type: integer
                        example: 500
                        description: Maximum points that can be applied to this cart
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      checkout_url:
                        type: string
                        example: https://checkout.fluid.com/checkout?jwt=abc123
                      shop_url:
                        type: string
                        example: https://myco.fluid.app
        '404':
          description: discount code not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
                      example:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '410':
          description: cart is in authorized enrollment state
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Cart is in authorized state and cannot be modified
                  errors:
                    type: object
                    example:
                      cart:
                        - is in authorized state and cannot be modified
                  meta:
                    type: object
                    properties:
                      shop_url:
                        type: string
                        example: https://example.myshopify.com
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      cart:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 123
                          state:
                            type: string
                            example: start
                          processed:
                            type: boolean
                            example: false
                            description: >-
                              Determines if a cart payment has been processed or
                              not.
                          valid_for_checkout:
                            type: boolean
                            example: true
                          buyer_rep_id:
                            type:
                              - integer
                              - 'null'
                            example: 1
                          buyer_rep:
                            oneOf:
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 2
                                  email:
                                    type:
                                      - string
                                      - 'null'
                                    example: buyer.rep@example.com
                                  full_name:
                                    type:
                                      - string
                                      - 'null'
                                    example: John Doe
                                  image_url:
                                    type:
                                      - string
                                      - 'null'
                                    example: https://example.com/image.png
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: '123241'
                                required:
                                  - id
                              - type: 'null'
                          volume_rep:
                            oneOf:
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 2
                                  email:
                                    type:
                                      - string
                                      - 'null'
                                    example: volume.rep@example.com
                                  full_name:
                                    type:
                                      - string
                                      - 'null'
                                    example: John Doe
                                  image_url:
                                    type:
                                      - string
                                      - 'null'
                                    example: https://example.com/image.png
                                required:
                                  - id
                              - type: 'null'
                          currency_symbol:
                            type: string
                            example: $
                          currency_code:
                            type: string
                            example: USD
                          shipping_total_for_display:
                            type: string
                            example: Free
                          phone:
                            type:
                              - string
                              - 'null'
                            example: '4035551212'
                          payment_method_auto_assignable:
                            type: boolean
                            example: true
                            description: >-
                              Determines if a payment method can be
                              auto-assigned to the cart.
                          attribution:
                            oneOf:
                              - type: object
                                oneOf:
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      share_guid:
                                        type: string
                                        example: james-bond007
                                    required:
                                      - id
                                      - share_guid
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      email:
                                        type: string
                                        example: james.bond@gmail.com
                                    required:
                                      - id
                                      - email
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      username:
                                        type: string
                                        example: jaamball234
                                    required:
                                      - id
                                      - username
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      fluid_rep_id:
                                        type: integer
                                        example: 23493
                                    required:
                                      - id
                                      - fluid_rep_id
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      external_id:
                                        type:
                                          - string
                                          - 'null'
                                        example: w3sdf92
                                    required:
                                      - id
                              - type: 'null'
                            default:
                              id: 456
                              share_guid: james-bond007
                          agreements:
                            type: array
                            items:
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                  example: 1
                                required:
                                  type: boolean
                                  example: true
                                title:
                                  type: string
                                  example: Terms and Conditions
                                show_path:
                                  type: string
                                  example: /terms
                                enrollment_pack_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                          amount_total:
                            type: string
                            example: '121.65'
                          amount_total_in_currency:
                            type: string
                            example: $121.65 (USD)
                          sub_total:
                            type: string
                            example: '100.00'
                          sub_total_in_currency:
                            type: string
                            example: $100.00 (USD)
                          subtotal_after_discounts:
                            type: string
                            example: '90.00'
                          tax_total:
                            type: string
                            example: '20.00'
                          tax_total_in_currency:
                            type: string
                            example: $20.00 (USD)
                          shipping_total:
                            type:
                              - string
                              - 'null'
                            example: '1.65'
                          shipping_total_in_currency:
                            type: string
                            example: $1.65 (USD)
                          shipping_discount:
                            type: number
                            example: 10.25
                          discount_total:
                            type: string
                            example: '2.99'
                          discount_total_in_currency:
                            type: string
                            example: $2.99 (USD)
                          discount_breakdown:
                            type: object
                            properties:
                              internal_discounts:
                                type: number
                                example: 15
                              external_discounts:
                                type: number
                                example: 10
                              total_discounts:
                                type: number
                                example: 25
                          external_discount:
                            type: object
                            properties:
                              total:
                                type: number
                                example: 10
                              calculated_at:
                                type:
                                  - string
                                  - 'null'
                                format: date-time
                                example: '2024-01-10T15:30:00Z'
                              sources:
                                type: object
                                additionalProperties:
                                  type: object
                                  properties:
                                    amount:
                                      type: number
                                      example: 6
                                    description:
                                      type: string
                                      example: Gold tier discount
                                    metadata:
                                      type: object
                                  required:
                                    - amount
                                    - description
                          transaction_fee:
                            type:
                              - number
                              - string
                            example: '1.90'
                          transaction_fee_in_currency:
                            type: string
                            example: $1.90 (USD)
                          cv_total:
                            type: integer
                            example: 10
                          qv_total:
                            type: integer
                            example: 15
                          company:
                            type: object
                            properties:
                              id:
                                type: integer
                              name:
                                type: string
                              primary_domain_hostname:
                                type:
                                  - string
                                  - 'null'
                                example: fluid.com
                              subdomain:
                                type:
                                  - string
                                  - 'null'
                                example: myco
                              logo_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/logo.png
                              fluid_shop:
                                type:
                                  - string
                                  - 'null'
                                example: https://fluid-sample-shop.fluid.com
                              collect_phone:
                                type: boolean
                                example: true
                              require_phone:
                                type: boolean
                                example: false
                              require_billing_zip:
                                type: boolean
                                example: false
                              checkout_primary_button_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#000000'
                              checkout_primary_text_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#FFFFFF'
                              checkout_secondary_button_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#FFFFFF'
                              checkout_secondary_text_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#000000'
                              favicon_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/favicon.ico
                              order_on_behalf:
                                type: boolean
                                example: false
                              use_juspay_gateway:
                                type: boolean
                                example: false
                              reward_points_enabled:
                                type: boolean
                                example: false
                          payment_account:
                            type:
                              - string
                              - 'null'
                            example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                          payment_method:
                            oneOf:
                              - type: 'null'
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: CreditCard
                                  payment_method_type:
                                    type: string
                                    example: visa
                                  last_four:
                                    type: string
                                    example: '1234'
                                  exp_month:
                                    type: string
                                    example: '12'
                                  exp_year:
                                    type: string
                                    example: '2025'
                                  logo_url:
                                    type: string
                                    example: https://example.com/image.svg
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Paypal
                                  status:
                                    type: string
                                    example: active
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Affirm
                                  affirm_id:
                                    type: string
                                    example: affirm_123
                                  status:
                                    type: string
                                    example: authorized
                                  checkout_id:
                                    type: string
                                    example: checkout_456
                                  created:
                                    type: string
                                    example: '2025-01-01T00:00:00Z'
                                  auth_expiration:
                                    type: string
                                    example: '2025-01-02T00:00:00Z'
                                  currency:
                                    type: string
                                    example: USD
                                  amount:
                                    type: string
                                    example: '100.00'
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Klarna
                                  session_id:
                                    type: string
                                    example: klarna_session_789
                                  intent:
                                    type: string
                                    example: buy
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Droplet
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: SomeCitcon
                          email:
                            type:
                              - string
                              - 'null'
                            example: user@example.com
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: '10.45'
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.45
                          discount_codes:
                            type: array
                            items:
                              type: string
                            example:
                              - DISCOUNT10
                              - DISCOUNT11
                          language_iso:
                            type:
                              - string
                              - 'null'
                            example: en
                          cart_token:
                            type: string
                            example: abc123
                          immutable_items:
                            type: boolean
                            example: false
                          digital_only:
                            type: boolean
                            example: false
                          requires_3ds:
                            type: boolean
                            example: false
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 101
                                price:
                                  type: string
                                  example: '43.41'
                                price_in_currency:
                                  type: string
                                  example: $43.41
                                tax:
                                  type: string
                                  example: '2.99'
                                tax_in_currency:
                                  type: string
                                  example: $2.99
                                cv:
                                  type: integer
                                  example: 5
                                cv_total:
                                  type: integer
                                  example: 15
                                qv:
                                  type: integer
                                  example: 7
                                qv_total:
                                  type: integer
                                  example: 21
                                discount_amount:
                                  type: string
                                  example: '10'
                                free_item:
                                  type: boolean
                                  example: false
                                discount_amount_in_currency:
                                  type: string
                                  example: $10.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                enrollment_pack_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                display_to_customer:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                product_title:
                                  type:
                                    - string
                                    - 'null'
                                  example: Sample Product
                                quantity:
                                  type: integer
                                  example: 3
                                subscription:
                                  type: boolean
                                  example: true
                                enrollment:
                                  type: boolean
                                  example: false
                                allow_subscription:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_only:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_price:
                                  type:
                                    - number
                                    - string
                                    - 'null'
                                  example: 10.5
                                subscription_price_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $10.50
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-02-12'
                                subscribe_and_save:
                                  type:
                                    - number
                                    - string
                                    - 'null'
                                  example: 2.99
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $2.99
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $2.99
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: Surcharge
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                product:
                                  oneOf:
                                    - type: object
                                      properties:
                                        id:
                                          type: integer
                                          example: 1
                                        title:
                                          type: string
                                          example: Sample Product
                                        introduction:
                                          type:
                                            - string
                                            - 'null'
                                          example: Sample Product Description
                                        cv:
                                          type: integer
                                          example: 10
                                        external_id:
                                          type:
                                            - string
                                            - 'null'
                                          example: ext-prod-123
                                        image_path:
                                          type:
                                            - string
                                            - 'null'
                                          example: /images/product.png
                                        image_url:
                                          type:
                                            - string
                                            - 'null'
                                          example: https://example.com/images/product.png
                                        price:
                                          type: string
                                          example: '29.99'
                                        price_in_currency:
                                          type: string
                                          example: $29.99
                                        sku:
                                          type:
                                            - string
                                            - 'null'
                                          example: SKU12345
                                        tax:
                                          type: string
                                          example: '2.99'
                                        tax_in_currency:
                                          type: string
                                          example: $2.99
                                        metadata:
                                          type: object
                                          example:
                                            shopify_product_id: 9876054868270
                                        metafields:
                                          type: array
                                          items:
                                            title: LegacyMetafield
                                            type: object
                                            properties:
                                              namespace:
                                                description: >-
                                                  A container for related metafields.
                                                  Commonly used to group metafields by app
                                                  or functionality.
                                                example: custom
                                                type: string
                                                maxLength: 20
                                                pattern: ^[a-zA-Z0-9_]+$
                                              key:
                                                description: >-
                                                  The unique identifier for the metafield
                                                  within its namespace. Must be unique per
                                                  namespace and owner.
                                                example: material
                                                type: string
                                                maxLength: 30
                                                pattern: ^[a-zA-Z0-9_]+$
                                              value:
                                                description: >-
                                                  The actual data stored in the metafield.
                                                  Type depends on value_type.
                                                example: cotton
                                                type:
                                                  - string
                                                  - integer
                                                  - object
                                                  - boolean
                                                  - number
                                              value_type:
                                                description: >-
                                                  The data type that defines how the value
                                                  should be interpreted and validated.
                                                example: single_line_text_field
                                                type: string
                                              description:
                                                description: >-
                                                  Optional human-readable description
                                                  explaining the purpose of this
                                                  metafield.
                                                example: >-
                                                  The primary material used in this
                                                  product
                                                type:
                                                  - string
                                                  - 'null'
                                              created_at:
                                                description: >-
                                                  Timestamp when the metafield was
                                                  created.
                                                example: '2021-01-01T00:00:00Z'
                                                type: string
                                                format: date-time
                                              updated_at:
                                                description: >-
                                                  Timestamp when the metafield was last
                                                  updated.
                                                example: '2021-01-01T00:00:00Z'
                                                type: string
                                                format: date-time
                                              locked:
                                                description: >-
                                                  Whether this metafield is locked and
                                                  cannot be updated or deleted directly.
                                                example: false
                                                type:
                                                  - boolean
                                                  - 'null'
                                                  - 'null'
                                              metafield_definition:
                                                description: >-
                                                  The definition that defines validation
                                                  rules and structure for this metafield
                                                type:
                                                  - 'null'
                                                  - object
                                            required:
                                              - namespace
                                              - key
                                              - value
                                              - value_type
                                              - description
                                              - created_at
                                              - updated_at
                                              - metafield_definition
                                    - type: 'null'
                                variant:
                                  oneOf:
                                    - type: object
                                      properties:
                                        id:
                                          type: integer
                                          example: 1
                                        title:
                                          type:
                                            - string
                                            - 'null'
                                          example: Sample Variant
                                        image_path:
                                          type:
                                            - string
                                            - 'null'
                                          example: /images/sample.png
                                        image_url:
                                          type:
                                            - string
                                            - 'null'
                                          example: https://example.com/images/sample.png
                                        primary_image:
                                          type:
                                            - string
                                            - 'null'
                                          example: https://example.com/images/primary.png
                                        price:
                                          type:
                                            - string
                                            - 'null'
                                          example: '34.44'
                                        price_in_currency:
                                          type:
                                            - string
                                            - 'null'
                                          example: $34.44
                                        sku:
                                          type:
                                            - string
                                            - 'null'
                                          example: SKU12345
                                        options:
                                          type: array
                                          items:
                                            type: object
                                            properties:
                                              title:
                                                type: string
                                                example: Size
                                              value:
                                                type: string
                                                example: XL
                                        physical:
                                          type:
                                            - boolean
                                            - 'null'
                                          example: true
                                        unit_of_size:
                                          type:
                                            - string
                                            - 'null'
                                          example: cm
                                        height:
                                          type:
                                            - number
                                            - 'null'
                                          example: 13
                                        width:
                                          type:
                                            - number
                                            - 'null'
                                          example: 6
                                        length:
                                          type:
                                            - number
                                            - 'null'
                                          example: 12
                                        unit_of_weight:
                                          type:
                                            - string
                                            - 'null'
                                          example: kg
                                        weight:
                                          type:
                                            - string
                                            - 'null'
                                          example: '3.2'
                                        hs_code:
                                          type:
                                            - string
                                            - 'null'
                                          example: '3.2'
                                    - type: 'null'
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                                bundled_items:
                                  type: array
                                  items:
                                    type: object
                                    description: Bundled items for bundle products
                                    properties:
                                      variant_id:
                                        type: integer
                                        example: 1
                                      product_id:
                                        type: integer
                                        example: 1
                                      product_title:
                                        type: string
                                        example: Product Title
                                      variant_title:
                                        type: string
                                        example: Variant Title
                                      option_titles:
                                        type: array
                                        example:
                                          - Option 1
                                          - Option 2
                                      quantity:
                                        type: integer
                                        example: 1
                                      display_to_customer:
                                        type: boolean
                                        example: true
                          ship_to:
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                                example: 1
                              name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              first_name:
                                type:
                                  - string
                                  - 'null'
                                example: John
                              last_name:
                                type:
                                  - string
                                  - 'null'
                                example: Doe
                              address1:
                                type: string
                                example: 123 Main St
                              address2:
                                type:
                                  - string
                                  - 'null'
                                example: Apt 4B
                              address3:
                                type:
                                  - string
                                  - 'null'
                                example: Building 5
                              city:
                                type: string
                                example: New York
                              state:
                                type: string
                                example: NY
                              postal_code:
                                type: string
                                example: '10001'
                              country_code:
                                type: string
                                example: US
                                description: >-
                                  country_id takes precedence if both country_id
                                  and country_code provided.
                              subdivision_code:
                                type:
                                  - string
                                  - 'null'
                                example: NY
                              default:
                                type: boolean
                                example: true
                          bill_to:
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                                example: 1
                              name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              first_name:
                                type:
                                  - string
                                  - 'null'
                                example: John
                              last_name:
                                type:
                                  - string
                                  - 'null'
                                example: Doe
                              address1:
                                type: string
                                example: 123 Main St
                              address2:
                                type:
                                  - string
                                  - 'null'
                                example: Apt 4B
                              address3:
                                type:
                                  - string
                                  - 'null'
                                example: Building 5
                              city:
                                type: string
                                example: New York
                              state:
                                type: string
                                example: NY
                              postal_code:
                                type: string
                                example: '10001'
                              country_code:
                                type: string
                                example: US
                                description: >-
                                  country_id takes precedence if both country_id
                                  and country_code provided.
                              subdivision_code:
                                type:
                                  - string
                                  - 'null'
                                example: NY
                              default:
                                type: boolean
                                example: true
                          shipping_method:
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: string
                                example: standard-shipping
                              name:
                                type: string
                                example: Standard Shipping
                          available_shipping_methods:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                  example: standard-shipping
                                title:
                                  type: string
                                  example: Standard Shipping
                                price:
                                  type:
                                    - number
                                    - string
                                  example: 5.99
                                price_label:
                                  type: string
                                  example: $5.99
                                delivery_time_estimate:
                                  type: string
                                  example: 3-5 business days
                          available_payment_methods:
                            type: array
                            items:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1337
                                    uuid:
                                      type: string
                                      example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                    type:
                                      type: string
                                      enum:
                                        - credit_card
                                    name:
                                      type: string
                                      example: Credit Card
                                    image_url:
                                      type: string
                                      example: https://example.com/image.png
                                    test:
                                      type: boolean
                                      example: true
                                      description: >-
                                        Determines if payment method is test
                                        instance or not. By default, set to
                                        `true`
                                    sandbox:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method is sandbox
                                        instance or not. By default, set to
                                        `false`
                                    apple_pay:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method supports
                                        ApplePay or not 
                                    bogus_gateway:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method is a Bogus
                                        instance or not.
                                    tokenize_path:
                                      type:
                                        - string
                                        - 'null'
                                      description: Path to tokenize, if applicable.
                                    token_provider:
                                      type: string
                                      enum:
                                        - spreedly
                                        - vgs
                                      description: >-
                                        Determines if payment tokenization is
                                        via spreedly or VGS
                                    apple_pay_merchant_identifier:
                                      type:
                                        - string
                                        - 'null'
                                      example: merchant.mycompany.com
                                      description: >-
                                        If ApplePay is supported, returns the
                                        merchant identifier registered with
                                        Apple, else returns nil
                                    supported_brands:
                                      type: array
                                      items:
                                        type: string
                                      example:
                                        - visa
                                        - master
                                        - american_express
                                        - discover
                                    publishable_key:
                                      type:
                                        - string
                                        - 'null'
                                      example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                      description: >-
                                        If publishable key is set for
                                        Hyperswitch, returns the publishable
                                        key, else returns nil
                                    customer_details_schema:
                                      type: object
                                      example: {}
                                      description: >-
                                        Schema defining required customer
                                        details for this payment method
                                  required:
                                    - id
                                    - type
                                    - name
                                    - supported_brands
                                    - test
                                    - sandbox
                                    - apple_pay
                                    - apple_pay_merchant_identifier
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1337
                                    uuid:
                                      type: string
                                      example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                    type:
                                      type: string
                                      enum:
                                        - klarna
                                    name:
                                      type: string
                                      example: Klarna
                                    image_url:
                                      type: string
                                      example: https://example.com/image.png
                                    test:
                                      type: boolean
                                      example: true
                                      description: >-
                                        Determines if payment method is test
                                        instance or not. By default, set to
                                        `true`
                                    sandbox:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method is sandbox
                                        instance or not. By default, set to
                                        `false`
                                    customer_details_schema:
                                      type: object
                                      example: {}
                                      description: >-
                                        Schema defining required customer
                                        details for this payment method
                          country:
                            type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              iso:
                                type: string
                                example: US
                              name:
                                type: string
                                example: United States
                              iso_name:
                                type: string
                                example: UNITED STATES
                              iso3:
                                type: string
                                example: USA
                              currency_code:
                                type: string
                                example: USD
                              currency_symbol:
                                type: string
                                example: $
                              province_required:
                                type: boolean
                                example: false
                              tax_enabled:
                                type:
                                  - boolean
                                  - 'null'
                                example: true
                              price_inclusive_of_tax:
                                type: boolean
                                example: false
                              price_inclusive_tax_name:
                                type:
                                  - string
                                  - 'null'
                                example: VAT
                          type:
                            type: string
                            enum:
                              - regular
                              - enrollment
                            example: regular
                          enrollment_pack_id:
                            type:
                              - integer
                              - 'null'
                            example: 1
                          enrollment_pack:
                            type:
                              - object
                              - 'null'
                            properties:
                              enrollment_pack_id:
                                type: integer
                                example: 1
                              additional_volume:
                                type:
                                  - integer
                                  - 'null'
                                example: 10
                              slug:
                                type: string
                                example: test-enrollment-pack
                              description:
                                type:
                                  - object
                                  - 'null'
                                  - string
                                properties:
                                  id:
                                    type: integer
                                    example: 111
                                  name:
                                    type: string
                                    example: description
                                  body:
                                    type: string
                                    example: >-
                                      <div>Try the latest and greatest of our
                                      sugar zip packs. Guaranteed to make you
                                      skinner and cure cancer.</div>
                                  record_type:
                                    type: string
                                    example: EnrollmentPack
                                  record_id:
                                    type: integer
                                    example: 1
                                  created_at:
                                    type: string
                                    format: date_time
                                    example: '2025-01-16T04:22:43.809Z'
                                  updated_at:
                                    type: string
                                    format: date_time
                                    example: '2025-01-22T10:23:52.941Z'
                                  locale:
                                    type: string
                                    example: en
                              enrollment_fee:
                                type:
                                  - number
                                  - string
                                example: 10
                              enrollment_fee_in_currency:
                                type: string
                                example: $10.00
                              images:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 2
                                    relateable_type:
                                      type: string
                                      example: EnrollmentPack
                                    relateable_id:
                                      type: integer
                                      example: 1
                                    image_url:
                                      type: string
                                      example: >-
                                        https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                    image_path:
                                      type: string
                                      example: jITWaU14QGe0y5AFgY7P_00179.svg
                                    position:
                                      type: integer
                                      example: 1
                                    shopify_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: null
                                    created_at:
                                      type: string
                                      format: date_time
                                      example: '2025-01-16T04:22:44.870Z'
                                    updated_at:
                                      type: string
                                      format: date_time
                                      example: '2025-01-16T04:22:44.870Z'
                                    external_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: null
                              items:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 625
                                    allow_subscription:
                                      type: boolean
                                      example: true
                                    cv:
                                      type:
                                        - number
                                        - string
                                      example: 0
                                    cv_in_currency:
                                      type: string
                                      example: $0.00
                                    cv_total:
                                      type: integer
                                      example: 0
                                    enrollment:
                                      type: boolean
                                      example: true
                                    enrollment_pack_id:
                                      type: integer
                                      example: 1
                                    price:
                                      type: string
                                      example: '11.13'
                                    price_in_currency:
                                      type: string
                                      example: $11.13
                                    product_title:
                                      type: string
                                      example: Zip Pack Sample Pack (30)
                                    quantity:
                                      type: integer
                                      example: 1
                                    qv:
                                      type:
                                        - number
                                        - string
                                      example: 0
                                    qv_in_currency:
                                      type: string
                                      example: $0.00
                                    qv_total:
                                      type: integer
                                      example: 0
                                    subscribe_and_save:
                                      type:
                                        - string
                                        - 'null'
                                      example: '-1988.87'
                                    subscribe_and_save_for_display:
                                      type:
                                        - string
                                        - 'null'
                                      example: Subscribe and save $-1,988.87
                                    subscribe_and_save_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $-1,988.87
                                    subscription:
                                      type: boolean
                                      example: false
                                    subscription_interval:
                                      type:
                                        - integer
                                        - 'null'
                                      example: 1
                                    subscription_interval_unit:
                                      type:
                                        - string
                                        - 'null'
                                      example: month
                                    subscription_only:
                                      type: boolean
                                      example: false
                                    subscription_plan_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: 1
                                    subscription_plans:
                                      oneOf:
                                        - type: array
                                          items:
                                            title: Commerce::SubscriptionPlan
                                            type: object
                                            properties:
                                              id:
                                                type: integer
                                              name:
                                                example: Test Subscription Plan
                                                type: string
                                              billing_interval:
                                                example: 1
                                                type: integer
                                                default: 1
                                                minimum: 1
                                                maximum: 29
                                              billing_interval_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type: string
                                                default: month
                                              billing_frequency_in_words:
                                                example: 2 Months
                                                type: string
                                              shipping_interval:
                                                example: 1
                                                type: integer
                                                default: 1
                                                minimum: 1
                                                maximum: 29
                                              shipping_interval_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type: string
                                                default: month
                                              volume_interval:
                                                example: 1
                                                type: integer
                                                default: 1
                                                minimum: 1
                                                maximum: 29
                                              volume_interval_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type: string
                                                default: month
                                              trial_period:
                                                example: 1
                                                type:
                                                  - integer
                                                  - 'null'
                                                minimum: 1
                                              trial_period_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type:
                                                  - string
                                                  - 'null'
                                              split_volume:
                                                example: true
                                                type: boolean
                                                default: false
                                              allow_max_billing_cycles:
                                                example: true
                                                type: boolean
                                                default: false
                                              max_billing_cycles:
                                                example: 3
                                                type:
                                                  - integer
                                                  - 'null'
                                              company_default:
                                                example: false
                                                type:
                                                  - boolean
                                                  - 'null'
                                                default: false
                                              products_count:
                                                example: 10
                                                type:
                                                  - integer
                                                  - 'null'
                                              subscribers_count:
                                                example: 10
                                                type:
                                                  - integer
                                                  - 'null'
                                              price:
                                                type: string
                                              price_in_currency:
                                                type: string
                                              subscription_start:
                                                type: string
                                              subscribe_and_save:
                                                type:
                                                  - string
                                                  - 'null'
                                              subscribe_and_save_in_currency:
                                                type:
                                                  - string
                                                  - 'null'
                                              subscribe_and_save_for_display:
                                                type:
                                                  - string
                                                  - 'null'
                                            required:
                                              - id
                                              - name
                                              - billing_interval
                                              - billing_interval_unit
                                              - billing_frequency_in_words
                                              - shipping_interval
                                              - shipping_interval_unit
                                              - volume_interval
                                              - volume_interval_unit
                                              - split_volume
                                              - allow_max_billing_cycles
                                              - price
                                              - price_in_currency
                                              - subscription_start
                                              - subscribe_and_save
                                              - subscribe_and_save_in_currency
                                              - subscribe_and_save_for_display
                                        - type: 'null'
                                    subscription_price:
                                      type: string
                                      example: '2000.0'
                                    subscription_price_in_currency:
                                      type: string
                                      example: $2,000.00
                                    subscription_start:
                                      type:
                                        - string
                                        - 'null'
                                      format: date
                                      example: '2025-02-28'
                                    tax:
                                      type: string
                                      example: '0.0'
                                    tax_in_currency:
                                      type: string
                                      example: $0.00
                                    total_after_discounts:
                                      type: string
                                      example: '90.00'
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: null
                                    display_to_customer:
                                      type: boolean
                                      example: false
                                    metadata:
                                      type: object
                                      description: >-
                                        A JSON object that can store any custom
                                        data structure
                                      example: {}
                                    errors:
                                      oneOf:
                                        - type: 'null'
                                        - type: array
                                          items:
                                            type: object
                                          example:
                                            - country:
                                                - >-
                                                  This product is not available for this
                                                  country. Please change your country
                              price:
                                type: string
                                example: '11.13'
                              price_in_currency:
                                type: string
                                example: $11.13
                              subscription_price:
                                type:
                                  - string
                                  - integer
                                example: 2000
                              subscription_price_in_currency:
                                type: string
                                example: $2,000.00
                              title:
                                type: string
                                example: enroll product
                              token:
                                type: string
                                example: NxL22AqLRRisfyF9LqxxWRak
                          metadata:
                            type: object
                            description: >-
                              A JSON object that can store any custom data
                              structure.
                          recurring:
                            oneOf:
                              - type: array
                                items:
                                  type: object
                                  properties:
                                    subtotal:
                                      type: string
                                      example: '10.0'
                                    subtotal_in_currency:
                                      type: string
                                      example: $10.0
                                    interval:
                                      type: integer
                                      example: 1
                                    interval_unit:
                                      type: string
                                      example: month
                                    subtotal_for_display:
                                      type: string
                                      example: $10.00 every 1 month
                                    start_date:
                                      type:
                                        - string
                                        - 'null'
                                      example: '2025-05-27'
                              - type: 'null'
                            default:
                              - subtotal: '10.0'
                                subtotal_in_currency: $10.0
                                interval: 1
                                interval_unit: month
                                subtotal_for_display: $10.00 every 1 month
                                start_date: '2025-05-27'
                          messages:
                            type: object
                            additionalProperties: true
                            example:
                              errors:
                                - Insufficient inventory
                                - Product no longer available
                              warnings:
                                - Low stock warning
                                - Shipping delays expected
                              info:
                                - Free shipping available
                                - Volume discount applied
                          points_enabled:
                            type: boolean
                            example: true
                          points_applied:
                            type: integer
                            example: 500
                            description: Number of points applied to the cart
                          points_applied_amount_in_currency:
                            type: number
                            example: 5
                            description: Currency value of applied points
                          customer_total_points:
                            type: integer
                            example: 1000
                            description: Customer's total available points balance
                          customer_total_points_in_currency:
                            type: number
                            example: 10
                            description: Currency value of available points
                          remaining_customer_points:
                            type: integer
                            example: 500
                            description: Customer's remaining points after cart redemption
                          remaining_customer_points_amount_in_currency:
                            type: number
                            example: 5
                            description: >-
                              Currency value of remaining points after cart
                              redemption
                          remaining_cart_amount_after_points:
                            type: number
                            example: 95
                            description: Amount to charge to card after points redemption
                          remaining_cart_amount_after_points_in_currency:
                            type:
                              - string
                            example: $95.00
                            description: >-
                              Amount in currency to charge to card after points
                              redemption
                          max_applicable_points:
                            type: integer
                            example: 500
                            description: Maximum points that can be applied to this cart
                required:
                  - error_message
                  - errors
                  - meta
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      coupon_code:
                        type: array
                        items:
                          type: string
                          example:
                            - already applied
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                discount_codes:
                  type: array
                  items:
                    type: string
  /api/carts/{cart_token}/discount/{discount_code}:
    delete:
      summary: Remove discount from the cart
      tags:
        - Carts
      operationId: removeDiscount
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
        - name: discount_code
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: discount removed
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      state:
                        type: string
                        example: start
                      processed:
                        type: boolean
                        example: false
                        description: >-
                          Determines if a cart payment has been processed or
                          not.
                      valid_for_checkout:
                        type: boolean
                        example: true
                      buyer_rep_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      buyer_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: buyer.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                              external_id:
                                type:
                                  - string
                                  - 'null'
                                example: '123241'
                            required:
                              - id
                          - type: 'null'
                      volume_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: volume.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                            required:
                              - id
                          - type: 'null'
                      currency_symbol:
                        type: string
                        example: $
                      currency_code:
                        type: string
                        example: USD
                      shipping_total_for_display:
                        type: string
                        example: Free
                      phone:
                        type:
                          - string
                          - 'null'
                        example: '4035551212'
                      payment_method_auto_assignable:
                        type: boolean
                        example: true
                        description: >-
                          Determines if a payment method can be auto-assigned to
                          the cart.
                      attribution:
                        oneOf:
                          - type: object
                            oneOf:
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  share_guid:
                                    type: string
                                    example: james-bond007
                                required:
                                  - id
                                  - share_guid
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  email:
                                    type: string
                                    example: james.bond@gmail.com
                                required:
                                  - id
                                  - email
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  username:
                                    type: string
                                    example: jaamball234
                                required:
                                  - id
                                  - username
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  fluid_rep_id:
                                    type: integer
                                    example: 23493
                                required:
                                  - id
                                  - fluid_rep_id
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: w3sdf92
                                required:
                                  - id
                          - type: 'null'
                        default:
                          id: 456
                          share_guid: james-bond007
                      agreements:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            required:
                              type: boolean
                              example: true
                            title:
                              type: string
                              example: Terms and Conditions
                            show_path:
                              type: string
                              example: /terms
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                      amount_total:
                        type: string
                        example: '121.65'
                      amount_total_in_currency:
                        type: string
                        example: $121.65 (USD)
                      sub_total:
                        type: string
                        example: '100.00'
                      sub_total_in_currency:
                        type: string
                        example: $100.00 (USD)
                      subtotal_after_discounts:
                        type: string
                        example: '90.00'
                      tax_total:
                        type: string
                        example: '20.00'
                      tax_total_in_currency:
                        type: string
                        example: $20.00 (USD)
                      shipping_total:
                        type:
                          - string
                          - 'null'
                        example: '1.65'
                      shipping_total_in_currency:
                        type: string
                        example: $1.65 (USD)
                      shipping_discount:
                        type: number
                        example: 10.25
                      discount_total:
                        type: string
                        example: '2.99'
                      discount_total_in_currency:
                        type: string
                        example: $2.99 (USD)
                      discount_breakdown:
                        type: object
                        properties:
                          internal_discounts:
                            type: number
                            example: 15
                          external_discounts:
                            type: number
                            example: 10
                          total_discounts:
                            type: number
                            example: 25
                      external_discount:
                        type: object
                        properties:
                          total:
                            type: number
                            example: 10
                          calculated_at:
                            type:
                              - string
                              - 'null'
                            format: date-time
                            example: '2024-01-10T15:30:00Z'
                          sources:
                            type: object
                            additionalProperties:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 6
                                description:
                                  type: string
                                  example: Gold tier discount
                                metadata:
                                  type: object
                              required:
                                - amount
                                - description
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: '1.90'
                      transaction_fee_in_currency:
                        type: string
                        example: $1.90 (USD)
                      cv_total:
                        type: integer
                        example: 10
                      qv_total:
                        type: integer
                        example: 15
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      payment_account:
                        type:
                          - string
                          - 'null'
                        example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                      payment_method:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: CreditCard
                              payment_method_type:
                                type: string
                                example: visa
                              last_four:
                                type: string
                                example: '1234'
                              exp_month:
                                type: string
                                example: '12'
                              exp_year:
                                type: string
                                example: '2025'
                              logo_url:
                                type: string
                                example: https://example.com/image.svg
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Paypal
                              status:
                                type: string
                                example: active
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Affirm
                              affirm_id:
                                type: string
                                example: affirm_123
                              status:
                                type: string
                                example: authorized
                              checkout_id:
                                type: string
                                example: checkout_456
                              created:
                                type: string
                                example: '2025-01-01T00:00:00Z'
                              auth_expiration:
                                type: string
                                example: '2025-01-02T00:00:00Z'
                              currency:
                                type: string
                                example: USD
                              amount:
                                type: string
                                example: '100.00'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Klarna
                              session_id:
                                type: string
                                example: klarna_session_789
                              intent:
                                type: string
                                example: buy
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Droplet
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: SomeCitcon
                      email:
                        type:
                          - string
                          - 'null'
                        example: user@example.com
                      enrollment_fee:
                        type:
                          - number
                          - string
                        example: '10.45'
                      enrollment_fee_in_currency:
                        type: string
                        example: $10.45
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT10
                          - DISCOUNT11
                      language_iso:
                        type:
                          - string
                          - 'null'
                        example: en
                      cart_token:
                        type: string
                        example: abc123
                      immutable_items:
                        type: boolean
                        example: false
                      digital_only:
                        type: boolean
                        example: false
                      requires_3ds:
                        type: boolean
                        example: false
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 101
                            price:
                              type: string
                              example: '43.41'
                            price_in_currency:
                              type: string
                              example: $43.41
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            cv:
                              type: integer
                              example: 5
                            cv_total:
                              type: integer
                              example: 15
                            qv:
                              type: integer
                              example: 7
                            qv_total:
                              type: integer
                              example: 21
                            discount_amount:
                              type: string
                              example: '10'
                            free_item:
                              type: boolean
                              example: false
                            discount_amount_in_currency:
                              type: string
                              example: $10.00
                            total_after_discounts:
                              type: string
                              example: '90.00'
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            product_title:
                              type:
                                - string
                                - 'null'
                              example: Sample Product
                            quantity:
                              type: integer
                              example: 3
                            subscription:
                              type: boolean
                              example: true
                            enrollment:
                              type: boolean
                              example: false
                            allow_subscription:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_plan_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_plans:
                              oneOf:
                                - type: array
                                  items:
                                    title: Commerce::SubscriptionPlan
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        example: Test Subscription Plan
                                        type: string
                                      billing_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      billing_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      billing_frequency_in_words:
                                        example: 2 Months
                                        type: string
                                      shipping_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      shipping_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      volume_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      volume_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      trial_period:
                                        example: 1
                                        type:
                                          - integer
                                          - 'null'
                                        minimum: 1
                                      trial_period_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type:
                                          - string
                                          - 'null'
                                      split_volume:
                                        example: true
                                        type: boolean
                                        default: false
                                      allow_max_billing_cycles:
                                        example: true
                                        type: boolean
                                        default: false
                                      max_billing_cycles:
                                        example: 3
                                        type:
                                          - integer
                                          - 'null'
                                      company_default:
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                        default: false
                                      products_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      subscribers_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      price:
                                        type: string
                                      price_in_currency:
                                        type: string
                                      subscription_start:
                                        type: string
                                      subscribe_and_save:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_in_currency:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_for_display:
                                        type:
                                          - string
                                          - 'null'
                                    required:
                                      - id
                                      - name
                                      - billing_interval
                                      - billing_interval_unit
                                      - billing_frequency_in_words
                                      - shipping_interval
                                      - shipping_interval_unit
                                      - volume_interval
                                      - volume_interval_unit
                                      - split_volume
                                      - allow_max_billing_cycles
                                      - price
                                      - price_in_currency
                                      - subscription_start
                                      - subscribe_and_save
                                      - subscribe_and_save_in_currency
                                      - subscribe_and_save_for_display
                                - type: 'null'
                            subscription_only:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_interval:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_interval_unit:
                              type:
                                - string
                                - 'null'
                              example: month
                            subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 10.5
                            subscription_price_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $10.50
                            subscription_start:
                              type:
                                - string
                                - 'null'
                              example: '2025-02-12'
                            subscribe_and_save:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 2.99
                            subscribe_and_save_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $2.99
                            subscribe_and_save_for_display:
                              type:
                                - string
                                - 'null'
                              example: Subscribe and save $2.99
                            title:
                              type:
                                - string
                                - 'null'
                              example: Surcharge
                            metadata:
                              type: object
                              description: >-
                                A JSON object that can store any custom data
                                structure
                              example: {}
                            product:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type: string
                                      example: Sample Product
                                    introduction:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Product Description
                                    cv:
                                      type: integer
                                      example: 10
                                    external_id:
                                      type:
                                        - string
                                        - 'null'
                                      example: ext-prod-123
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/product.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/product.png
                                    price:
                                      type: string
                                      example: '29.99'
                                    price_in_currency:
                                      type: string
                                      example: $29.99
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    tax:
                                      type: string
                                      example: '2.99'
                                    tax_in_currency:
                                      type: string
                                      example: $2.99
                                    metadata:
                                      type: object
                                      example:
                                        shopify_product_id: 9876054868270
                                    metafields:
                                      type: array
                                      items:
                                        title: LegacyMetafield
                                        type: object
                                        properties:
                                          namespace:
                                            description: >-
                                              A container for related metafields.
                                              Commonly used to group metafields by app
                                              or functionality.
                                            example: custom
                                            type: string
                                            maxLength: 20
                                            pattern: ^[a-zA-Z0-9_]+$
                                          key:
                                            description: >-
                                              The unique identifier for the metafield
                                              within its namespace. Must be unique per
                                              namespace and owner.
                                            example: material
                                            type: string
                                            maxLength: 30
                                            pattern: ^[a-zA-Z0-9_]+$
                                          value:
                                            description: >-
                                              The actual data stored in the metafield.
                                              Type depends on value_type.
                                            example: cotton
                                            type:
                                              - string
                                              - integer
                                              - object
                                              - boolean
                                              - number
                                          value_type:
                                            description: >-
                                              The data type that defines how the value
                                              should be interpreted and validated.
                                            example: single_line_text_field
                                            type: string
                                          description:
                                            description: >-
                                              Optional human-readable description
                                              explaining the purpose of this
                                              metafield.
                                            example: >-
                                              The primary material used in this
                                              product
                                            type:
                                              - string
                                              - 'null'
                                          created_at:
                                            description: >-
                                              Timestamp when the metafield was
                                              created.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          updated_at:
                                            description: >-
                                              Timestamp when the metafield was last
                                              updated.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          locked:
                                            description: >-
                                              Whether this metafield is locked and
                                              cannot be updated or deleted directly.
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                              - 'null'
                                          metafield_definition:
                                            description: >-
                                              The definition that defines validation
                                              rules and structure for this metafield
                                            type:
                                              - 'null'
                                              - object
                                        required:
                                          - namespace
                                          - key
                                          - value
                                          - value_type
                                          - description
                                          - created_at
                                          - updated_at
                                          - metafield_definition
                                - type: 'null'
                            variant:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Variant
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/sample.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/sample.png
                                    primary_image:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/primary.png
                                    price:
                                      type:
                                        - string
                                        - 'null'
                                      example: '34.44'
                                    price_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $34.44
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    options:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          title:
                                            type: string
                                            example: Size
                                          value:
                                            type: string
                                            example: XL
                                    physical:
                                      type:
                                        - boolean
                                        - 'null'
                                      example: true
                                    unit_of_size:
                                      type:
                                        - string
                                        - 'null'
                                      example: cm
                                    height:
                                      type:
                                        - number
                                        - 'null'
                                      example: 13
                                    width:
                                      type:
                                        - number
                                        - 'null'
                                      example: 6
                                    length:
                                      type:
                                        - number
                                        - 'null'
                                      example: 12
                                    unit_of_weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: kg
                                    weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                    hs_code:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                - type: 'null'
                            errors:
                              oneOf:
                                - type: 'null'
                                - type: array
                                  items:
                                    type: object
                                  example:
                                    - country:
                                        - >-
                                          This product is not available for this
                                          country. Please change your country
                            bundled_items:
                              type: array
                              items:
                                type: object
                                description: Bundled items for bundle products
                                properties:
                                  variant_id:
                                    type: integer
                                    example: 1
                                  product_id:
                                    type: integer
                                    example: 1
                                  product_title:
                                    type: string
                                    example: Product Title
                                  variant_title:
                                    type: string
                                    example: Variant Title
                                  option_titles:
                                    type: array
                                    example:
                                      - Option 1
                                      - Option 2
                                  quantity:
                                    type: integer
                                    example: 1
                                  display_to_customer:
                                    type: boolean
                                    example: true
                      ship_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      bill_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      shipping_method:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: string
                            example: standard-shipping
                          name:
                            type: string
                            example: Standard Shipping
                      available_shipping_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: standard-shipping
                            title:
                              type: string
                              example: Standard Shipping
                            price:
                              type:
                                - number
                                - string
                              example: 5.99
                            price_label:
                              type: string
                              example: $5.99
                            delivery_time_estimate:
                              type: string
                              example: 3-5 business days
                      available_payment_methods:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - credit_card
                                name:
                                  type: string
                                  example: Credit Card
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                apple_pay:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method supports
                                    ApplePay or not 
                                bogus_gateway:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is a Bogus
                                    instance or not.
                                tokenize_path:
                                  type:
                                    - string
                                    - 'null'
                                  description: Path to tokenize, if applicable.
                                token_provider:
                                  type: string
                                  enum:
                                    - spreedly
                                    - vgs
                                  description: >-
                                    Determines if payment tokenization is via
                                    spreedly or VGS
                                apple_pay_merchant_identifier:
                                  type:
                                    - string
                                    - 'null'
                                  example: merchant.mycompany.com
                                  description: >-
                                    If ApplePay is supported, returns the
                                    merchant identifier registered with Apple,
                                    else returns nil
                                supported_brands:
                                  type: array
                                  items:
                                    type: string
                                  example:
                                    - visa
                                    - master
                                    - american_express
                                    - discover
                                publishable_key:
                                  type:
                                    - string
                                    - 'null'
                                  example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                  description: >-
                                    If publishable key is set for Hyperswitch,
                                    returns the publishable key, else returns
                                    nil
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                              required:
                                - id
                                - type
                                - name
                                - supported_brands
                                - test
                                - sandbox
                                - apple_pay
                                - apple_pay_merchant_identifier
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - klarna
                                name:
                                  type: string
                                  example: Klarna
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                      country:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          iso:
                            type: string
                            example: US
                          name:
                            type: string
                            example: United States
                          iso_name:
                            type: string
                            example: UNITED STATES
                          iso3:
                            type: string
                            example: USA
                          currency_code:
                            type: string
                            example: USD
                          currency_symbol:
                            type: string
                            example: $
                          province_required:
                            type: boolean
                            example: false
                          tax_enabled:
                            type:
                              - boolean
                              - 'null'
                            example: true
                          price_inclusive_of_tax:
                            type: boolean
                            example: false
                          price_inclusive_tax_name:
                            type:
                              - string
                              - 'null'
                            example: VAT
                      type:
                        type: string
                        enum:
                          - regular
                          - enrollment
                        example: regular
                      enrollment_pack_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      enrollment_pack:
                        type:
                          - object
                          - 'null'
                        properties:
                          enrollment_pack_id:
                            type: integer
                            example: 1
                          additional_volume:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          slug:
                            type: string
                            example: test-enrollment-pack
                          description:
                            type:
                              - object
                              - 'null'
                              - string
                            properties:
                              id:
                                type: integer
                                example: 111
                              name:
                                type: string
                                example: description
                              body:
                                type: string
                                example: >-
                                  <div>Try the latest and greatest of our sugar
                                  zip packs. Guaranteed to make you skinner and
                                  cure cancer.</div>
                              record_type:
                                type: string
                                example: EnrollmentPack
                              record_id:
                                type: integer
                                example: 1
                              created_at:
                                type: string
                                format: date_time
                                example: '2025-01-16T04:22:43.809Z'
                              updated_at:
                                type: string
                                format: date_time
                                example: '2025-01-22T10:23:52.941Z'
                              locale:
                                type: string
                                example: en
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: 10
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.00
                          images:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2
                                relateable_type:
                                  type: string
                                  example: EnrollmentPack
                                relateable_id:
                                  type: integer
                                  example: 1
                                image_url:
                                  type: string
                                  example: >-
                                    https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                image_path:
                                  type: string
                                  example: jITWaU14QGe0y5AFgY7P_00179.svg
                                position:
                                  type: integer
                                  example: 1
                                shopify_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                                created_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                updated_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                external_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 625
                                allow_subscription:
                                  type: boolean
                                  example: true
                                cv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                cv_in_currency:
                                  type: string
                                  example: $0.00
                                cv_total:
                                  type: integer
                                  example: 0
                                enrollment:
                                  type: boolean
                                  example: true
                                enrollment_pack_id:
                                  type: integer
                                  example: 1
                                price:
                                  type: string
                                  example: '11.13'
                                price_in_currency:
                                  type: string
                                  example: $11.13
                                product_title:
                                  type: string
                                  example: Zip Pack Sample Pack (30)
                                quantity:
                                  type: integer
                                  example: 1
                                qv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                qv_in_currency:
                                  type: string
                                  example: $0.00
                                qv_total:
                                  type: integer
                                  example: 0
                                subscribe_and_save:
                                  type:
                                    - string
                                    - 'null'
                                  example: '-1988.87'
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $-1,988.87
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $-1,988.87
                                subscription:
                                  type: boolean
                                  example: false
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_only:
                                  type: boolean
                                  example: false
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_price:
                                  type: string
                                  example: '2000.0'
                                subscription_price_in_currency:
                                  type: string
                                  example: $2,000.00
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  format: date
                                  example: '2025-02-28'
                                tax:
                                  type: string
                                  example: '0.0'
                                tax_in_currency:
                                  type: string
                                  example: $0.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: null
                                display_to_customer:
                                  type: boolean
                                  example: false
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                          price:
                            type: string
                            example: '11.13'
                          price_in_currency:
                            type: string
                            example: $11.13
                          subscription_price:
                            type:
                              - string
                              - integer
                            example: 2000
                          subscription_price_in_currency:
                            type: string
                            example: $2,000.00
                          title:
                            type: string
                            example: enroll product
                          token:
                            type: string
                            example: NxL22AqLRRisfyF9LqxxWRak
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      recurring:
                        oneOf:
                          - type: array
                            items:
                              type: object
                              properties:
                                subtotal:
                                  type: string
                                  example: '10.0'
                                subtotal_in_currency:
                                  type: string
                                  example: $10.0
                                interval:
                                  type: integer
                                  example: 1
                                interval_unit:
                                  type: string
                                  example: month
                                subtotal_for_display:
                                  type: string
                                  example: $10.00 every 1 month
                                start_date:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-05-27'
                          - type: 'null'
                        default:
                          - subtotal: '10.0'
                            subtotal_in_currency: $10.0
                            interval: 1
                            interval_unit: month
                            subtotal_for_display: $10.00 every 1 month
                            start_date: '2025-05-27'
                      messages:
                        type: object
                        additionalProperties: true
                        example:
                          errors:
                            - Insufficient inventory
                            - Product no longer available
                          warnings:
                            - Low stock warning
                            - Shipping delays expected
                          info:
                            - Free shipping available
                            - Volume discount applied
                      points_enabled:
                        type: boolean
                        example: true
                      points_applied:
                        type: integer
                        example: 500
                        description: Number of points applied to the cart
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Currency value of applied points
                      customer_total_points:
                        type: integer
                        example: 1000
                        description: Customer's total available points balance
                      customer_total_points_in_currency:
                        type: number
                        example: 10
                        description: Currency value of available points
                      remaining_customer_points:
                        type: integer
                        example: 500
                        description: Customer's remaining points after cart redemption
                      remaining_customer_points_amount_in_currency:
                        type: number
                        example: 5
                        description: >-
                          Currency value of remaining points after cart
                          redemption
                      remaining_cart_amount_after_points:
                        type: number
                        example: 95
                        description: Amount to charge to card after points redemption
                      remaining_cart_amount_after_points_in_currency:
                        type:
                          - string
                        example: $95.00
                        description: >-
                          Amount in currency to charge to card after points
                          redemption
                      max_applicable_points:
                        type: integer
                        example: 500
                        description: Maximum points that can be applied to this cart
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      checkout_url:
                        type: string
                        example: https://checkout.fluid.com/checkout?jwt=abc123
                      shop_url:
                        type: string
                        example: https://myco.fluid.app
        '404':
          description: discount code not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
                      example:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/carts/{cart_token}/items:
    post:
      summary: >-
        Adds new items to cart, updates quantities of existing items, or removes
        items with quantity 0
      tags:
        - Carts
      operationId: addOrUpdateCartItems
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: removes item when quantity is 0
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      state:
                        type: string
                        example: start
                      processed:
                        type: boolean
                        example: false
                        description: >-
                          Determines if a cart payment has been processed or
                          not.
                      valid_for_checkout:
                        type: boolean
                        example: true
                      buyer_rep_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      buyer_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: buyer.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                              external_id:
                                type:
                                  - string
                                  - 'null'
                                example: '123241'
                            required:
                              - id
                          - type: 'null'
                      volume_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: volume.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                            required:
                              - id
                          - type: 'null'
                      currency_symbol:
                        type: string
                        example: $
                      currency_code:
                        type: string
                        example: USD
                      shipping_total_for_display:
                        type: string
                        example: Free
                      phone:
                        type:
                          - string
                          - 'null'
                        example: '4035551212'
                      payment_method_auto_assignable:
                        type: boolean
                        example: true
                        description: >-
                          Determines if a payment method can be auto-assigned to
                          the cart.
                      attribution:
                        oneOf:
                          - type: object
                            oneOf:
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  share_guid:
                                    type: string
                                    example: james-bond007
                                required:
                                  - id
                                  - share_guid
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  email:
                                    type: string
                                    example: james.bond@gmail.com
                                required:
                                  - id
                                  - email
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  username:
                                    type: string
                                    example: jaamball234
                                required:
                                  - id
                                  - username
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  fluid_rep_id:
                                    type: integer
                                    example: 23493
                                required:
                                  - id
                                  - fluid_rep_id
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: w3sdf92
                                required:
                                  - id
                          - type: 'null'
                        default:
                          id: 456
                          share_guid: james-bond007
                      agreements:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            required:
                              type: boolean
                              example: true
                            title:
                              type: string
                              example: Terms and Conditions
                            show_path:
                              type: string
                              example: /terms
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                      amount_total:
                        type: string
                        example: '121.65'
                      amount_total_in_currency:
                        type: string
                        example: $121.65 (USD)
                      sub_total:
                        type: string
                        example: '100.00'
                      sub_total_in_currency:
                        type: string
                        example: $100.00 (USD)
                      subtotal_after_discounts:
                        type: string
                        example: '90.00'
                      tax_total:
                        type: string
                        example: '20.00'
                      tax_total_in_currency:
                        type: string
                        example: $20.00 (USD)
                      shipping_total:
                        type:
                          - string
                          - 'null'
                        example: '1.65'
                      shipping_total_in_currency:
                        type: string
                        example: $1.65 (USD)
                      shipping_discount:
                        type: number
                        example: 10.25
                      discount_total:
                        type: string
                        example: '2.99'
                      discount_total_in_currency:
                        type: string
                        example: $2.99 (USD)
                      discount_breakdown:
                        type: object
                        properties:
                          internal_discounts:
                            type: number
                            example: 15
                          external_discounts:
                            type: number
                            example: 10
                          total_discounts:
                            type: number
                            example: 25
                      external_discount:
                        type: object
                        properties:
                          total:
                            type: number
                            example: 10
                          calculated_at:
                            type:
                              - string
                              - 'null'
                            format: date-time
                            example: '2024-01-10T15:30:00Z'
                          sources:
                            type: object
                            additionalProperties:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 6
                                description:
                                  type: string
                                  example: Gold tier discount
                                metadata:
                                  type: object
                              required:
                                - amount
                                - description
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: '1.90'
                      transaction_fee_in_currency:
                        type: string
                        example: $1.90 (USD)
                      cv_total:
                        type: integer
                        example: 10
                      qv_total:
                        type: integer
                        example: 15
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      payment_account:
                        type:
                          - string
                          - 'null'
                        example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                      payment_method:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: CreditCard
                              payment_method_type:
                                type: string
                                example: visa
                              last_four:
                                type: string
                                example: '1234'
                              exp_month:
                                type: string
                                example: '12'
                              exp_year:
                                type: string
                                example: '2025'
                              logo_url:
                                type: string
                                example: https://example.com/image.svg
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Paypal
                              status:
                                type: string
                                example: active
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Affirm
                              affirm_id:
                                type: string
                                example: affirm_123
                              status:
                                type: string
                                example: authorized
                              checkout_id:
                                type: string
                                example: checkout_456
                              created:
                                type: string
                                example: '2025-01-01T00:00:00Z'
                              auth_expiration:
                                type: string
                                example: '2025-01-02T00:00:00Z'
                              currency:
                                type: string
                                example: USD
                              amount:
                                type: string
                                example: '100.00'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Klarna
                              session_id:
                                type: string
                                example: klarna_session_789
                              intent:
                                type: string
                                example: buy
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Droplet
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: SomeCitcon
                      email:
                        type:
                          - string
                          - 'null'
                        example: user@example.com
                      enrollment_fee:
                        type:
                          - number
                          - string
                        example: '10.45'
                      enrollment_fee_in_currency:
                        type: string
                        example: $10.45
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT10
                          - DISCOUNT11
                      language_iso:
                        type:
                          - string
                          - 'null'
                        example: en
                      cart_token:
                        type: string
                        example: abc123
                      immutable_items:
                        type: boolean
                        example: false
                      digital_only:
                        type: boolean
                        example: false
                      requires_3ds:
                        type: boolean
                        example: false
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 101
                            price:
                              type: string
                              example: '43.41'
                            price_in_currency:
                              type: string
                              example: $43.41
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            cv:
                              type: integer
                              example: 5
                            cv_total:
                              type: integer
                              example: 15
                            qv:
                              type: integer
                              example: 7
                            qv_total:
                              type: integer
                              example: 21
                            discount_amount:
                              type: string
                              example: '10'
                            free_item:
                              type: boolean
                              example: false
                            discount_amount_in_currency:
                              type: string
                              example: $10.00
                            total_after_discounts:
                              type: string
                              example: '90.00'
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            product_title:
                              type:
                                - string
                                - 'null'
                              example: Sample Product
                            quantity:
                              type: integer
                              example: 3
                            subscription:
                              type: boolean
                              example: true
                            enrollment:
                              type: boolean
                              example: false
                            allow_subscription:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_plan_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_plans:
                              oneOf:
                                - type: array
                                  items:
                                    title: Commerce::SubscriptionPlan
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        example: Test Subscription Plan
                                        type: string
                                      billing_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      billing_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      billing_frequency_in_words:
                                        example: 2 Months
                                        type: string
                                      shipping_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      shipping_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      volume_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      volume_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      trial_period:
                                        example: 1
                                        type:
                                          - integer
                                          - 'null'
                                        minimum: 1
                                      trial_period_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type:
                                          - string
                                          - 'null'
                                      split_volume:
                                        example: true
                                        type: boolean
                                        default: false
                                      allow_max_billing_cycles:
                                        example: true
                                        type: boolean
                                        default: false
                                      max_billing_cycles:
                                        example: 3
                                        type:
                                          - integer
                                          - 'null'
                                      company_default:
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                        default: false
                                      products_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      subscribers_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      price:
                                        type: string
                                      price_in_currency:
                                        type: string
                                      subscription_start:
                                        type: string
                                      subscribe_and_save:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_in_currency:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_for_display:
                                        type:
                                          - string
                                          - 'null'
                                    required:
                                      - id
                                      - name
                                      - billing_interval
                                      - billing_interval_unit
                                      - billing_frequency_in_words
                                      - shipping_interval
                                      - shipping_interval_unit
                                      - volume_interval
                                      - volume_interval_unit
                                      - split_volume
                                      - allow_max_billing_cycles
                                      - price
                                      - price_in_currency
                                      - subscription_start
                                      - subscribe_and_save
                                      - subscribe_and_save_in_currency
                                      - subscribe_and_save_for_display
                                - type: 'null'
                            subscription_only:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_interval:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_interval_unit:
                              type:
                                - string
                                - 'null'
                              example: month
                            subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 10.5
                            subscription_price_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $10.50
                            subscription_start:
                              type:
                                - string
                                - 'null'
                              example: '2025-02-12'
                            subscribe_and_save:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 2.99
                            subscribe_and_save_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $2.99
                            subscribe_and_save_for_display:
                              type:
                                - string
                                - 'null'
                              example: Subscribe and save $2.99
                            title:
                              type:
                                - string
                                - 'null'
                              example: Surcharge
                            metadata:
                              type: object
                              description: >-
                                A JSON object that can store any custom data
                                structure
                              example: {}
                            product:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type: string
                                      example: Sample Product
                                    introduction:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Product Description
                                    cv:
                                      type: integer
                                      example: 10
                                    external_id:
                                      type:
                                        - string
                                        - 'null'
                                      example: ext-prod-123
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/product.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/product.png
                                    price:
                                      type: string
                                      example: '29.99'
                                    price_in_currency:
                                      type: string
                                      example: $29.99
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    tax:
                                      type: string
                                      example: '2.99'
                                    tax_in_currency:
                                      type: string
                                      example: $2.99
                                    metadata:
                                      type: object
                                      example:
                                        shopify_product_id: 9876054868270
                                    metafields:
                                      type: array
                                      items:
                                        title: LegacyMetafield
                                        type: object
                                        properties:
                                          namespace:
                                            description: >-
                                              A container for related metafields.
                                              Commonly used to group metafields by app
                                              or functionality.
                                            example: custom
                                            type: string
                                            maxLength: 20
                                            pattern: ^[a-zA-Z0-9_]+$
                                          key:
                                            description: >-
                                              The unique identifier for the metafield
                                              within its namespace. Must be unique per
                                              namespace and owner.
                                            example: material
                                            type: string
                                            maxLength: 30
                                            pattern: ^[a-zA-Z0-9_]+$
                                          value:
                                            description: >-
                                              The actual data stored in the metafield.
                                              Type depends on value_type.
                                            example: cotton
                                            type:
                                              - string
                                              - integer
                                              - object
                                              - boolean
                                              - number
                                          value_type:
                                            description: >-
                                              The data type that defines how the value
                                              should be interpreted and validated.
                                            example: single_line_text_field
                                            type: string
                                          description:
                                            description: >-
                                              Optional human-readable description
                                              explaining the purpose of this
                                              metafield.
                                            example: >-
                                              The primary material used in this
                                              product
                                            type:
                                              - string
                                              - 'null'
                                          created_at:
                                            description: >-
                                              Timestamp when the metafield was
                                              created.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          updated_at:
                                            description: >-
                                              Timestamp when the metafield was last
                                              updated.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          locked:
                                            description: >-
                                              Whether this metafield is locked and
                                              cannot be updated or deleted directly.
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                              - 'null'
                                          metafield_definition:
                                            description: >-
                                              The definition that defines validation
                                              rules and structure for this metafield
                                            type:
                                              - 'null'
                                              - object
                                        required:
                                          - namespace
                                          - key
                                          - value
                                          - value_type
                                          - description
                                          - created_at
                                          - updated_at
                                          - metafield_definition
                                - type: 'null'
                            variant:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Variant
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/sample.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/sample.png
                                    primary_image:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/primary.png
                                    price:
                                      type:
                                        - string
                                        - 'null'
                                      example: '34.44'
                                    price_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $34.44
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    options:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          title:
                                            type: string
                                            example: Size
                                          value:
                                            type: string
                                            example: XL
                                    physical:
                                      type:
                                        - boolean
                                        - 'null'
                                      example: true
                                    unit_of_size:
                                      type:
                                        - string
                                        - 'null'
                                      example: cm
                                    height:
                                      type:
                                        - number
                                        - 'null'
                                      example: 13
                                    width:
                                      type:
                                        - number
                                        - 'null'
                                      example: 6
                                    length:
                                      type:
                                        - number
                                        - 'null'
                                      example: 12
                                    unit_of_weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: kg
                                    weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                    hs_code:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                - type: 'null'
                            errors:
                              oneOf:
                                - type: 'null'
                                - type: array
                                  items:
                                    type: object
                                  example:
                                    - country:
                                        - >-
                                          This product is not available for this
                                          country. Please change your country
                            bundled_items:
                              type: array
                              items:
                                type: object
                                description: Bundled items for bundle products
                                properties:
                                  variant_id:
                                    type: integer
                                    example: 1
                                  product_id:
                                    type: integer
                                    example: 1
                                  product_title:
                                    type: string
                                    example: Product Title
                                  variant_title:
                                    type: string
                                    example: Variant Title
                                  option_titles:
                                    type: array
                                    example:
                                      - Option 1
                                      - Option 2
                                  quantity:
                                    type: integer
                                    example: 1
                                  display_to_customer:
                                    type: boolean
                                    example: true
                      ship_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      bill_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      shipping_method:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: string
                            example: standard-shipping
                          name:
                            type: string
                            example: Standard Shipping
                      available_shipping_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: standard-shipping
                            title:
                              type: string
                              example: Standard Shipping
                            price:
                              type:
                                - number
                                - string
                              example: 5.99
                            price_label:
                              type: string
                              example: $5.99
                            delivery_time_estimate:
                              type: string
                              example: 3-5 business days
                      available_payment_methods:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - credit_card
                                name:
                                  type: string
                                  example: Credit Card
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                apple_pay:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method supports
                                    ApplePay or not 
                                bogus_gateway:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is a Bogus
                                    instance or not.
                                tokenize_path:
                                  type:
                                    - string
                                    - 'null'
                                  description: Path to tokenize, if applicable.
                                token_provider:
                                  type: string
                                  enum:
                                    - spreedly
                                    - vgs
                                  description: >-
                                    Determines if payment tokenization is via
                                    spreedly or VGS
                                apple_pay_merchant_identifier:
                                  type:
                                    - string
                                    - 'null'
                                  example: merchant.mycompany.com
                                  description: >-
                                    If ApplePay is supported, returns the
                                    merchant identifier registered with Apple,
                                    else returns nil
                                supported_brands:
                                  type: array
                                  items:
                                    type: string
                                  example:
                                    - visa
                                    - master
                                    - american_express
                                    - discover
                                publishable_key:
                                  type:
                                    - string
                                    - 'null'
                                  example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                  description: >-
                                    If publishable key is set for Hyperswitch,
                                    returns the publishable key, else returns
                                    nil
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                              required:
                                - id
                                - type
                                - name
                                - supported_brands
                                - test
                                - sandbox
                                - apple_pay
                                - apple_pay_merchant_identifier
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - klarna
                                name:
                                  type: string
                                  example: Klarna
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                      country:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          iso:
                            type: string
                            example: US
                          name:
                            type: string
                            example: United States
                          iso_name:
                            type: string
                            example: UNITED STATES
                          iso3:
                            type: string
                            example: USA
                          currency_code:
                            type: string
                            example: USD
                          currency_symbol:
                            type: string
                            example: $
                          province_required:
                            type: boolean
                            example: false
                          tax_enabled:
                            type:
                              - boolean
                              - 'null'
                            example: true
                          price_inclusive_of_tax:
                            type: boolean
                            example: false
                          price_inclusive_tax_name:
                            type:
                              - string
                              - 'null'
                            example: VAT
                      type:
                        type: string
                        enum:
                          - regular
                          - enrollment
                        example: regular
                      enrollment_pack_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      enrollment_pack:
                        type:
                          - object
                          - 'null'
                        properties:
                          enrollment_pack_id:
                            type: integer
                            example: 1
                          additional_volume:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          slug:
                            type: string
                            example: test-enrollment-pack
                          description:
                            type:
                              - object
                              - 'null'
                              - string
                            properties:
                              id:
                                type: integer
                                example: 111
                              name:
                                type: string
                                example: description
                              body:
                                type: string
                                example: >-
                                  <div>Try the latest and greatest of our sugar
                                  zip packs. Guaranteed to make you skinner and
                                  cure cancer.</div>
                              record_type:
                                type: string
                                example: EnrollmentPack
                              record_id:
                                type: integer
                                example: 1
                              created_at:
                                type: string
                                format: date_time
                                example: '2025-01-16T04:22:43.809Z'
                              updated_at:
                                type: string
                                format: date_time
                                example: '2025-01-22T10:23:52.941Z'
                              locale:
                                type: string
                                example: en
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: 10
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.00
                          images:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2
                                relateable_type:
                                  type: string
                                  example: EnrollmentPack
                                relateable_id:
                                  type: integer
                                  example: 1
                                image_url:
                                  type: string
                                  example: >-
                                    https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                image_path:
                                  type: string
                                  example: jITWaU14QGe0y5AFgY7P_00179.svg
                                position:
                                  type: integer
                                  example: 1
                                shopify_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                                created_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                updated_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                external_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 625
                                allow_subscription:
                                  type: boolean
                                  example: true
                                cv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                cv_in_currency:
                                  type: string
                                  example: $0.00
                                cv_total:
                                  type: integer
                                  example: 0
                                enrollment:
                                  type: boolean
                                  example: true
                                enrollment_pack_id:
                                  type: integer
                                  example: 1
                                price:
                                  type: string
                                  example: '11.13'
                                price_in_currency:
                                  type: string
                                  example: $11.13
                                product_title:
                                  type: string
                                  example: Zip Pack Sample Pack (30)
                                quantity:
                                  type: integer
                                  example: 1
                                qv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                qv_in_currency:
                                  type: string
                                  example: $0.00
                                qv_total:
                                  type: integer
                                  example: 0
                                subscribe_and_save:
                                  type:
                                    - string
                                    - 'null'
                                  example: '-1988.87'
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $-1,988.87
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $-1,988.87
                                subscription:
                                  type: boolean
                                  example: false
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_only:
                                  type: boolean
                                  example: false
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_price:
                                  type: string
                                  example: '2000.0'
                                subscription_price_in_currency:
                                  type: string
                                  example: $2,000.00
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  format: date
                                  example: '2025-02-28'
                                tax:
                                  type: string
                                  example: '0.0'
                                tax_in_currency:
                                  type: string
                                  example: $0.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: null
                                display_to_customer:
                                  type: boolean
                                  example: false
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                          price:
                            type: string
                            example: '11.13'
                          price_in_currency:
                            type: string
                            example: $11.13
                          subscription_price:
                            type:
                              - string
                              - integer
                            example: 2000
                          subscription_price_in_currency:
                            type: string
                            example: $2,000.00
                          title:
                            type: string
                            example: enroll product
                          token:
                            type: string
                            example: NxL22AqLRRisfyF9LqxxWRak
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      recurring:
                        oneOf:
                          - type: array
                            items:
                              type: object
                              properties:
                                subtotal:
                                  type: string
                                  example: '10.0'
                                subtotal_in_currency:
                                  type: string
                                  example: $10.0
                                interval:
                                  type: integer
                                  example: 1
                                interval_unit:
                                  type: string
                                  example: month
                                subtotal_for_display:
                                  type: string
                                  example: $10.00 every 1 month
                                start_date:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-05-27'
                          - type: 'null'
                        default:
                          - subtotal: '10.0'
                            subtotal_in_currency: $10.0
                            interval: 1
                            interval_unit: month
                            subtotal_for_display: $10.00 every 1 month
                            start_date: '2025-05-27'
                      messages:
                        type: object
                        additionalProperties: true
                        example:
                          errors:
                            - Insufficient inventory
                            - Product no longer available
                          warnings:
                            - Low stock warning
                            - Shipping delays expected
                          info:
                            - Free shipping available
                            - Volume discount applied
                      points_enabled:
                        type: boolean
                        example: true
                      points_applied:
                        type: integer
                        example: 500
                        description: Number of points applied to the cart
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Currency value of applied points
                      customer_total_points:
                        type: integer
                        example: 1000
                        description: Customer's total available points balance
                      customer_total_points_in_currency:
                        type: number
                        example: 10
                        description: Currency value of available points
                      remaining_customer_points:
                        type: integer
                        example: 500
                        description: Customer's remaining points after cart redemption
                      remaining_customer_points_amount_in_currency:
                        type: number
                        example: 5
                        description: >-
                          Currency value of remaining points after cart
                          redemption
                      remaining_cart_amount_after_points:
                        type: number
                        example: 95
                        description: Amount to charge to card after points redemption
                      remaining_cart_amount_after_points_in_currency:
                        type:
                          - string
                        example: $95.00
                        description: >-
                          Amount in currency to charge to card after points
                          redemption
                      max_applicable_points:
                        type: integer
                        example: 500
                        description: Maximum points that can be applied to this cart
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      checkout_url:
                        type: string
                        example: https://checkout.fluid.com/checkout?jwt=abc123
                      shop_url:
                        type: string
                        example: https://myco.fluid.app
        '400':
          description: no cart items specified
        '410':
          description: cart is in authorized enrollment state
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Cart is in authorized state and cannot be modified
                  errors:
                    type: object
                    example:
                      cart:
                        - is in authorized state and cannot be modified
                  meta:
                    type: object
                    properties:
                      shop_url:
                        type: string
                        example: https://example.myshopify.com
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      cart:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 123
                          state:
                            type: string
                            example: start
                          processed:
                            type: boolean
                            example: false
                            description: >-
                              Determines if a cart payment has been processed or
                              not.
                          valid_for_checkout:
                            type: boolean
                            example: true
                          buyer_rep_id:
                            type:
                              - integer
                              - 'null'
                            example: 1
                          buyer_rep:
                            oneOf:
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 2
                                  email:
                                    type:
                                      - string
                                      - 'null'
                                    example: buyer.rep@example.com
                                  full_name:
                                    type:
                                      - string
                                      - 'null'
                                    example: John Doe
                                  image_url:
                                    type:
                                      - string
                                      - 'null'
                                    example: https://example.com/image.png
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: '123241'
                                required:
                                  - id
                              - type: 'null'
                          volume_rep:
                            oneOf:
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 2
                                  email:
                                    type:
                                      - string
                                      - 'null'
                                    example: volume.rep@example.com
                                  full_name:
                                    type:
                                      - string
                                      - 'null'
                                    example: John Doe
                                  image_url:
                                    type:
                                      - string
                                      - 'null'
                                    example: https://example.com/image.png
                                required:
                                  - id
                              - type: 'null'
                          currency_symbol:
                            type: string
                            example: $
                          currency_code:
                            type: string
                            example: USD
                          shipping_total_for_display:
                            type: string
                            example: Free
                          phone:
                            type:
                              - string
                              - 'null'
                            example: '4035551212'
                          payment_method_auto_assignable:
                            type: boolean
                            example: true
                            description: >-
                              Determines if a payment method can be
                              auto-assigned to the cart.
                          attribution:
                            oneOf:
                              - type: object
                                oneOf:
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      share_guid:
                                        type: string
                                        example: james-bond007
                                    required:
                                      - id
                                      - share_guid
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      email:
                                        type: string
                                        example: james.bond@gmail.com
                                    required:
                                      - id
                                      - email
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      username:
                                        type: string
                                        example: jaamball234
                                    required:
                                      - id
                                      - username
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      fluid_rep_id:
                                        type: integer
                                        example: 23493
                                    required:
                                      - id
                                      - fluid_rep_id
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      external_id:
                                        type:
                                          - string
                                          - 'null'
                                        example: w3sdf92
                                    required:
                                      - id
                              - type: 'null'
                            default:
                              id: 456
                              share_guid: james-bond007
                          agreements:
                            type: array
                            items:
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                  example: 1
                                required:
                                  type: boolean
                                  example: true
                                title:
                                  type: string
                                  example: Terms and Conditions
                                show_path:
                                  type: string
                                  example: /terms
                                enrollment_pack_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                          amount_total:
                            type: string
                            example: '121.65'
                          amount_total_in_currency:
                            type: string
                            example: $121.65 (USD)
                          sub_total:
                            type: string
                            example: '100.00'
                          sub_total_in_currency:
                            type: string
                            example: $100.00 (USD)
                          subtotal_after_discounts:
                            type: string
                            example: '90.00'
                          tax_total:
                            type: string
                            example: '20.00'
                          tax_total_in_currency:
                            type: string
                            example: $20.00 (USD)
                          shipping_total:
                            type:
                              - string
                              - 'null'
                            example: '1.65'
                          shipping_total_in_currency:
                            type: string
                            example: $1.65 (USD)
                          shipping_discount:
                            type: number
                            example: 10.25
                          discount_total:
                            type: string
                            example: '2.99'
                          discount_total_in_currency:
                            type: string
                            example: $2.99 (USD)
                          discount_breakdown:
                            type: object
                            properties:
                              internal_discounts:
                                type: number
                                example: 15
                              external_discounts:
                                type: number
                                example: 10
                              total_discounts:
                                type: number
                                example: 25
                          external_discount:
                            type: object
                            properties:
                              total:
                                type: number
                                example: 10
                              calculated_at:
                                type:
                                  - string
                                  - 'null'
                                format: date-time
                                example: '2024-01-10T15:30:00Z'
                              sources:
                                type: object
                                additionalProperties:
                                  type: object
                                  properties:
                                    amount:
                                      type: number
                                      example: 6
                                    description:
                                      type: string
                                      example: Gold tier discount
                                    metadata:
                                      type: object
                                  required:
                                    - amount
                                    - description
                          transaction_fee:
                            type:
                              - number
                              - string
                            example: '1.90'
                          transaction_fee_in_currency:
                            type: string
                            example: $1.90 (USD)
                          cv_total:
                            type: integer
                            example: 10
                          qv_total:
                            type: integer
                            example: 15
                          company:
                            type: object
                            properties:
                              id:
                                type: integer
                              name:
                                type: string
                              primary_domain_hostname:
                                type:
                                  - string
                                  - 'null'
                                example: fluid.com
                              subdomain:
                                type:
                                  - string
                                  - 'null'
                                example: myco
                              logo_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/logo.png
                              fluid_shop:
                                type:
                                  - string
                                  - 'null'
                                example: https://fluid-sample-shop.fluid.com
                              collect_phone:
                                type: boolean
                                example: true
                              require_phone:
                                type: boolean
                                example: false
                              require_billing_zip:
                                type: boolean
                                example: false
                              checkout_primary_button_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#000000'
                              checkout_primary_text_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#FFFFFF'
                              checkout_secondary_button_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#FFFFFF'
                              checkout_secondary_text_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#000000'
                              favicon_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/favicon.ico
                              order_on_behalf:
                                type: boolean
                                example: false
                              use_juspay_gateway:
                                type: boolean
                                example: false
                              reward_points_enabled:
                                type: boolean
                                example: false
                          payment_account:
                            type:
                              - string
                              - 'null'
                            example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                          payment_method:
                            oneOf:
                              - type: 'null'
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: CreditCard
                                  payment_method_type:
                                    type: string
                                    example: visa
                                  last_four:
                                    type: string
                                    example: '1234'
                                  exp_month:
                                    type: string
                                    example: '12'
                                  exp_year:
                                    type: string
                                    example: '2025'
                                  logo_url:
                                    type: string
                                    example: https://example.com/image.svg
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Paypal
                                  status:
                                    type: string
                                    example: active
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Affirm
                                  affirm_id:
                                    type: string
                                    example: affirm_123
                                  status:
                                    type: string
                                    example: authorized
                                  checkout_id:
                                    type: string
                                    example: checkout_456
                                  created:
                                    type: string
                                    example: '2025-01-01T00:00:00Z'
                                  auth_expiration:
                                    type: string
                                    example: '2025-01-02T00:00:00Z'
                                  currency:
                                    type: string
                                    example: USD
                                  amount:
                                    type: string
                                    example: '100.00'
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Klarna
                                  session_id:
                                    type: string
                                    example: klarna_session_789
                                  intent:
                                    type: string
                                    example: buy
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Droplet
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: SomeCitcon
                          email:
                            type:
                              - string
                              - 'null'
                            example: user@example.com
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: '10.45'
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.45
                          discount_codes:
                            type: array
                            items:
                              type: string
                            example:
                              - DISCOUNT10
                              - DISCOUNT11
                          language_iso:
                            type:
                              - string
                              - 'null'
                            example: en
                          cart_token:
                            type: string
                            example: abc123
                          immutable_items:
                            type: boolean
                            example: false
                          digital_only:
                            type: boolean
                            example: false
                          requires_3ds:
                            type: boolean
                            example: false
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 101
                                price:
                                  type: string
                                  example: '43.41'
                                price_in_currency:
                                  type: string
                                  example: $43.41
                                tax:
                                  type: string
                                  example: '2.99'
                                tax_in_currency:
                                  type: string
                                  example: $2.99
                                cv:
                                  type: integer
                                  example: 5
                                cv_total:
                                  type: integer
                                  example: 15
                                qv:
                                  type: integer
                                  example: 7
                                qv_total:
                                  type: integer
                                  example: 21
                                discount_amount:
                                  type: string
                                  example: '10'
                                free_item:
                                  type: boolean
                                  example: false
                                discount_amount_in_currency:
                                  type: string
                                  example: $10.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                enrollment_pack_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                display_to_customer:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                product_title:
                                  type:
                                    - string
                                    - 'null'
                                  example: Sample Product
                                quantity:
                                  type: integer
                                  example: 3
                                subscription:
                                  type: boolean
                                  example: true
                                enrollment:
                                  type: boolean
                                  example: false
                                allow_subscription:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_only:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_price:
                                  type:
                                    - number
                                    - string
                                    - 'null'
                                  example: 10.5
                                subscription_price_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $10.50
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-02-12'
                                subscribe_and_save:
                                  type:
                                    - number
                                    - string
                                    - 'null'
                                  example: 2.99
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $2.99
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $2.99
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: Surcharge
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                product:
                                  oneOf:
                                    - type: object
                                      properties:
                                        id:
                                          type: integer
                                          example: 1
                                        title:
                                          type: string
                                          example: Sample Product
                                        introduction:
                                          type:
                                            - string
                                            - 'null'
                                          example: Sample Product Description
                                        cv:
                                          type: integer
                                          example: 10
                                        external_id:
                                          type:
                                            - string
                                            - 'null'
                                          example: ext-prod-123
                                        image_path:
                                          type:
                                            - string
                                            - 'null'
                                          example: /images/product.png
                                        image_url:
                                          type:
                                            - string
                                            - 'null'
                                          example: https://example.com/images/product.png
                                        price:
                                          type: string
                                          example: '29.99'
                                        price_in_currency:
                                          type: string
                                          example: $29.99
                                        sku:
                                          type:
                                            - string
                                            - 'null'
                                          example: SKU12345
                                        tax:
                                          type: string
                                          example: '2.99'
                                        tax_in_currency:
                                          type: string
                                          example: $2.99
                                        metadata:
                                          type: object
                                          example:
                                            shopify_product_id: 9876054868270
                                        metafields:
                                          type: array
                                          items:
                                            title: LegacyMetafield
                                            type: object
                                            properties:
                                              namespace:
                                                description: >-
                                                  A container for related metafields.
                                                  Commonly used to group metafields by app
                                                  or functionality.
                                                example: custom
                                                type: string
                                                maxLength: 20
                                                pattern: ^[a-zA-Z0-9_]+$
                                              key:
                                                description: >-
                                                  The unique identifier for the metafield
                                                  within its namespace. Must be unique per
                                                  namespace and owner.
                                                example: material
                                                type: string
                                                maxLength: 30
                                                pattern: ^[a-zA-Z0-9_]+$
                                              value:
                                                description: >-
                                                  The actual data stored in the metafield.
                                                  Type depends on value_type.
                                                example: cotton
                                                type:
                                                  - string
                                                  - integer
                                                  - object
                                                  - boolean
                                                  - number
                                              value_type:
                                                description: >-
                                                  The data type that defines how the value
                                                  should be interpreted and validated.
                                                example: single_line_text_field
                                                type: string
                                              description:
                                                description: >-
                                                  Optional human-readable description
                                                  explaining the purpose of this
                                                  metafield.
                                                example: >-
                                                  The primary material used in this
                                                  product
                                                type:
                                                  - string
                                                  - 'null'
                                              created_at:
                                                description: >-
                                                  Timestamp when the metafield was
                                                  created.
                                                example: '2021-01-01T00:00:00Z'
                                                type: string
                                                format: date-time
                                              updated_at:
                                                description: >-
                                                  Timestamp when the metafield was last
                                                  updated.
                                                example: '2021-01-01T00:00:00Z'
                                                type: string
                                                format: date-time
                                              locked:
                                                description: >-
                                                  Whether this metafield is locked and
                                                  cannot be updated or deleted directly.
                                                example: false
                                                type:
                                                  - boolean
                                                  - 'null'
                                                  - 'null'
                                              metafield_definition:
                                                description: >-
                                                  The definition that defines validation
                                                  rules and structure for this metafield
                                                type:
                                                  - 'null'
                                                  - object
                                            required:
                                              - namespace
                                              - key
                                              - value
                                              - value_type
                                              - description
                                              - created_at
                                              - updated_at
                                              - metafield_definition
                                    - type: 'null'
                                variant:
                                  oneOf:
                                    - type: object
                                      properties:
                                        id:
                                          type: integer
                                          example: 1
                                        title:
                                          type:
                                            - string
                                            - 'null'
                                          example: Sample Variant
                                        image_path:
                                          type:
                                            - string
                                            - 'null'
                                          example: /images/sample.png
                                        image_url:
                                          type:
                                            - string
                                            - 'null'
                                          example: https://example.com/images/sample.png
                                        primary_image:
                                          type:
                                            - string
                                            - 'null'
                                          example: https://example.com/images/primary.png
                                        price:
                                          type:
                                            - string
                                            - 'null'
                                          example: '34.44'
                                        price_in_currency:
                                          type:
                                            - string
                                            - 'null'
                                          example: $34.44
                                        sku:
                                          type:
                                            - string
                                            - 'null'
                                          example: SKU12345
                                        options:
                                          type: array
                                          items:
                                            type: object
                                            properties:
                                              title:
                                                type: string
                                                example: Size
                                              value:
                                                type: string
                                                example: XL
                                        physical:
                                          type:
                                            - boolean
                                            - 'null'
                                          example: true
                                        unit_of_size:
                                          type:
                                            - string
                                            - 'null'
                                          example: cm
                                        height:
                                          type:
                                            - number
                                            - 'null'
                                          example: 13
                                        width:
                                          type:
                                            - number
                                            - 'null'
                                          example: 6
                                        length:
                                          type:
                                            - number
                                            - 'null'
                                          example: 12
                                        unit_of_weight:
                                          type:
                                            - string
                                            - 'null'
                                          example: kg
                                        weight:
                                          type:
                                            - string
                                            - 'null'
                                          example: '3.2'
                                        hs_code:
                                          type:
                                            - string
                                            - 'null'
                                          example: '3.2'
                                    - type: 'null'
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                                bundled_items:
                                  type: array
                                  items:
                                    type: object
                                    description: Bundled items for bundle products
                                    properties:
                                      variant_id:
                                        type: integer
                                        example: 1
                                      product_id:
                                        type: integer
                                        example: 1
                                      product_title:
                                        type: string
                                        example: Product Title
                                      variant_title:
                                        type: string
                                        example: Variant Title
                                      option_titles:
                                        type: array
                                        example:
                                          - Option 1
                                          - Option 2
                                      quantity:
                                        type: integer
                                        example: 1
                                      display_to_customer:
                                        type: boolean
                                        example: true
                          ship_to:
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                                example: 1
                              name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              first_name:
                                type:
                                  - string
                                  - 'null'
                                example: John
                              last_name:
                                type:
                                  - string
                                  - 'null'
                                example: Doe
                              address1:
                                type: string
                                example: 123 Main St
                              address2:
                                type:
                                  - string
                                  - 'null'
                                example: Apt 4B
                              address3:
                                type:
                                  - string
                                  - 'null'
                                example: Building 5
                              city:
                                type: string
                                example: New York
                              state:
                                type: string
                                example: NY
                              postal_code:
                                type: string
                                example: '10001'
                              country_code:
                                type: string
                                example: US
                                description: >-
                                  country_id takes precedence if both country_id
                                  and country_code provided.
                              subdivision_code:
                                type:
                                  - string
                                  - 'null'
                                example: NY
                              default:
                                type: boolean
                                example: true
                          bill_to:
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                                example: 1
                              name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              first_name:
                                type:
                                  - string
                                  - 'null'
                                example: John
                              last_name:
                                type:
                                  - string
                                  - 'null'
                                example: Doe
                              address1:
                                type: string
                                example: 123 Main St
                              address2:
                                type:
                                  - string
                                  - 'null'
                                example: Apt 4B
                              address3:
                                type:
                                  - string
                                  - 'null'
                                example: Building 5
                              city:
                                type: string
                                example: New York
                              state:
                                type: string
                                example: NY
                              postal_code:
                                type: string
                                example: '10001'
                              country_code:
                                type: string
                                example: US
                                description: >-
                                  country_id takes precedence if both country_id
                                  and country_code provided.
                              subdivision_code:
                                type:
                                  - string
                                  - 'null'
                                example: NY
                              default:
                                type: boolean
                                example: true
                          shipping_method:
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: string
                                example: standard-shipping
                              name:
                                type: string
                                example: Standard Shipping
                          available_shipping_methods:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                  example: standard-shipping
                                title:
                                  type: string
                                  example: Standard Shipping
                                price:
                                  type:
                                    - number
                                    - string
                                  example: 5.99
                                price_label:
                                  type: string
                                  example: $5.99
                                delivery_time_estimate:
                                  type: string
                                  example: 3-5 business days
                          available_payment_methods:
                            type: array
                            items:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1337
                                    uuid:
                                      type: string
                                      example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                    type:
                                      type: string
                                      enum:
                                        - credit_card
                                    name:
                                      type: string
                                      example: Credit Card
                                    image_url:
                                      type: string
                                      example: https://example.com/image.png
                                    test:
                                      type: boolean
                                      example: true
                                      description: >-
                                        Determines if payment method is test
                                        instance or not. By default, set to
                                        `true`
                                    sandbox:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method is sandbox
                                        instance or not. By default, set to
                                        `false`
                                    apple_pay:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method supports
                                        ApplePay or not 
                                    bogus_gateway:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method is a Bogus
                                        instance or not.
                                    tokenize_path:
                                      type:
                                        - string
                                        - 'null'
                                      description: Path to tokenize, if applicable.
                                    token_provider:
                                      type: string
                                      enum:
                                        - spreedly
                                        - vgs
                                      description: >-
                                        Determines if payment tokenization is
                                        via spreedly or VGS
                                    apple_pay_merchant_identifier:
                                      type:
                                        - string
                                        - 'null'
                                      example: merchant.mycompany.com
                                      description: >-
                                        If ApplePay is supported, returns the
                                        merchant identifier registered with
                                        Apple, else returns nil
                                    supported_brands:
                                      type: array
                                      items:
                                        type: string
                                      example:
                                        - visa
                                        - master
                                        - american_express
                                        - discover
                                    publishable_key:
                                      type:
                                        - string
                                        - 'null'
                                      example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                      description: >-
                                        If publishable key is set for
                                        Hyperswitch, returns the publishable
                                        key, else returns nil
                                    customer_details_schema:
                                      type: object
                                      example: {}
                                      description: >-
                                        Schema defining required customer
                                        details for this payment method
                                  required:
                                    - id
                                    - type
                                    - name
                                    - supported_brands
                                    - test
                                    - sandbox
                                    - apple_pay
                                    - apple_pay_merchant_identifier
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1337
                                    uuid:
                                      type: string
                                      example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                    type:
                                      type: string
                                      enum:
                                        - klarna
                                    name:
                                      type: string
                                      example: Klarna
                                    image_url:
                                      type: string
                                      example: https://example.com/image.png
                                    test:
                                      type: boolean
                                      example: true
                                      description: >-
                                        Determines if payment method is test
                                        instance or not. By default, set to
                                        `true`
                                    sandbox:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method is sandbox
                                        instance or not. By default, set to
                                        `false`
                                    customer_details_schema:
                                      type: object
                                      example: {}
                                      description: >-
                                        Schema defining required customer
                                        details for this payment method
                          country:
                            type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              iso:
                                type: string
                                example: US
                              name:
                                type: string
                                example: United States
                              iso_name:
                                type: string
                                example: UNITED STATES
                              iso3:
                                type: string
                                example: USA
                              currency_code:
                                type: string
                                example: USD
                              currency_symbol:
                                type: string
                                example: $
                              province_required:
                                type: boolean
                                example: false
                              tax_enabled:
                                type:
                                  - boolean
                                  - 'null'
                                example: true
                              price_inclusive_of_tax:
                                type: boolean
                                example: false
                              price_inclusive_tax_name:
                                type:
                                  - string
                                  - 'null'
                                example: VAT
                          type:
                            type: string
                            enum:
                              - regular
                              - enrollment
                            example: regular
                          enrollment_pack_id:
                            type:
                              - integer
                              - 'null'
                            example: 1
                          enrollment_pack:
                            type:
                              - object
                              - 'null'
                            properties:
                              enrollment_pack_id:
                                type: integer
                                example: 1
                              additional_volume:
                                type:
                                  - integer
                                  - 'null'
                                example: 10
                              slug:
                                type: string
                                example: test-enrollment-pack
                              description:
                                type:
                                  - object
                                  - 'null'
                                  - string
                                properties:
                                  id:
                                    type: integer
                                    example: 111
                                  name:
                                    type: string
                                    example: description
                                  body:
                                    type: string
                                    example: >-
                                      <div>Try the latest and greatest of our
                                      sugar zip packs. Guaranteed to make you
                                      skinner and cure cancer.</div>
                                  record_type:
                                    type: string
                                    example: EnrollmentPack
                                  record_id:
                                    type: integer
                                    example: 1
                                  created_at:
                                    type: string
                                    format: date_time
                                    example: '2025-01-16T04:22:43.809Z'
                                  updated_at:
                                    type: string
                                    format: date_time
                                    example: '2025-01-22T10:23:52.941Z'
                                  locale:
                                    type: string
                                    example: en
                              enrollment_fee:
                                type:
                                  - number
                                  - string
                                example: 10
                              enrollment_fee_in_currency:
                                type: string
                                example: $10.00
                              images:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 2
                                    relateable_type:
                                      type: string
                                      example: EnrollmentPack
                                    relateable_id:
                                      type: integer
                                      example: 1
                                    image_url:
                                      type: string
                                      example: >-
                                        https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                    image_path:
                                      type: string
                                      example: jITWaU14QGe0y5AFgY7P_00179.svg
                                    position:
                                      type: integer
                                      example: 1
                                    shopify_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: null
                                    created_at:
                                      type: string
                                      format: date_time
                                      example: '2025-01-16T04:22:44.870Z'
                                    updated_at:
                                      type: string
                                      format: date_time
                                      example: '2025-01-16T04:22:44.870Z'
                                    external_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: null
                              items:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 625
                                    allow_subscription:
                                      type: boolean
                                      example: true
                                    cv:
                                      type:
                                        - number
                                        - string
                                      example: 0
                                    cv_in_currency:
                                      type: string
                                      example: $0.00
                                    cv_total:
                                      type: integer
                                      example: 0
                                    enrollment:
                                      type: boolean
                                      example: true
                                    enrollment_pack_id:
                                      type: integer
                                      example: 1
                                    price:
                                      type: string
                                      example: '11.13'
                                    price_in_currency:
                                      type: string
                                      example: $11.13
                                    product_title:
                                      type: string
                                      example: Zip Pack Sample Pack (30)
                                    quantity:
                                      type: integer
                                      example: 1
                                    qv:
                                      type:
                                        - number
                                        - string
                                      example: 0
                                    qv_in_currency:
                                      type: string
                                      example: $0.00
                                    qv_total:
                                      type: integer
                                      example: 0
                                    subscribe_and_save:
                                      type:
                                        - string
                                        - 'null'
                                      example: '-1988.87'
                                    subscribe_and_save_for_display:
                                      type:
                                        - string
                                        - 'null'
                                      example: Subscribe and save $-1,988.87
                                    subscribe_and_save_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $-1,988.87
                                    subscription:
                                      type: boolean
                                      example: false
                                    subscription_interval:
                                      type:
                                        - integer
                                        - 'null'
                                      example: 1
                                    subscription_interval_unit:
                                      type:
                                        - string
                                        - 'null'
                                      example: month
                                    subscription_only:
                                      type: boolean
                                      example: false
                                    subscription_plan_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: 1
                                    subscription_plans:
                                      oneOf:
                                        - type: array
                                          items:
                                            title: Commerce::SubscriptionPlan
                                            type: object
                                            properties:
                                              id:
                                                type: integer
                                              name:
                                                example: Test Subscription Plan
                                                type: string
                                              billing_interval:
                                                example: 1
                                                type: integer
                                                default: 1
                                                minimum: 1
                                                maximum: 29
                                              billing_interval_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type: string
                                                default: month
                                              billing_frequency_in_words:
                                                example: 2 Months
                                                type: string
                                              shipping_interval:
                                                example: 1
                                                type: integer
                                                default: 1
                                                minimum: 1
                                                maximum: 29
                                              shipping_interval_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type: string
                                                default: month
                                              volume_interval:
                                                example: 1
                                                type: integer
                                                default: 1
                                                minimum: 1
                                                maximum: 29
                                              volume_interval_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type: string
                                                default: month
                                              trial_period:
                                                example: 1
                                                type:
                                                  - integer
                                                  - 'null'
                                                minimum: 1
                                              trial_period_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type:
                                                  - string
                                                  - 'null'
                                              split_volume:
                                                example: true
                                                type: boolean
                                                default: false
                                              allow_max_billing_cycles:
                                                example: true
                                                type: boolean
                                                default: false
                                              max_billing_cycles:
                                                example: 3
                                                type:
                                                  - integer
                                                  - 'null'
                                              company_default:
                                                example: false
                                                type:
                                                  - boolean
                                                  - 'null'
                                                default: false
                                              products_count:
                                                example: 10
                                                type:
                                                  - integer
                                                  - 'null'
                                              subscribers_count:
                                                example: 10
                                                type:
                                                  - integer
                                                  - 'null'
                                              price:
                                                type: string
                                              price_in_currency:
                                                type: string
                                              subscription_start:
                                                type: string
                                              subscribe_and_save:
                                                type:
                                                  - string
                                                  - 'null'
                                              subscribe_and_save_in_currency:
                                                type:
                                                  - string
                                                  - 'null'
                                              subscribe_and_save_for_display:
                                                type:
                                                  - string
                                                  - 'null'
                                            required:
                                              - id
                                              - name
                                              - billing_interval
                                              - billing_interval_unit
                                              - billing_frequency_in_words
                                              - shipping_interval
                                              - shipping_interval_unit
                                              - volume_interval
                                              - volume_interval_unit
                                              - split_volume
                                              - allow_max_billing_cycles
                                              - price
                                              - price_in_currency
                                              - subscription_start
                                              - subscribe_and_save
                                              - subscribe_and_save_in_currency
                                              - subscribe_and_save_for_display
                                        - type: 'null'
                                    subscription_price:
                                      type: string
                                      example: '2000.0'
                                    subscription_price_in_currency:
                                      type: string
                                      example: $2,000.00
                                    subscription_start:
                                      type:
                                        - string
                                        - 'null'
                                      format: date
                                      example: '2025-02-28'
                                    tax:
                                      type: string
                                      example: '0.0'
                                    tax_in_currency:
                                      type: string
                                      example: $0.00
                                    total_after_discounts:
                                      type: string
                                      example: '90.00'
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: null
                                    display_to_customer:
                                      type: boolean
                                      example: false
                                    metadata:
                                      type: object
                                      description: >-
                                        A JSON object that can store any custom
                                        data structure
                                      example: {}
                                    errors:
                                      oneOf:
                                        - type: 'null'
                                        - type: array
                                          items:
                                            type: object
                                          example:
                                            - country:
                                                - >-
                                                  This product is not available for this
                                                  country. Please change your country
                              price:
                                type: string
                                example: '11.13'
                              price_in_currency:
                                type: string
                                example: $11.13
                              subscription_price:
                                type:
                                  - string
                                  - integer
                                example: 2000
                              subscription_price_in_currency:
                                type: string
                                example: $2,000.00
                              title:
                                type: string
                                example: enroll product
                              token:
                                type: string
                                example: NxL22AqLRRisfyF9LqxxWRak
                          metadata:
                            type: object
                            description: >-
                              A JSON object that can store any custom data
                              structure.
                          recurring:
                            oneOf:
                              - type: array
                                items:
                                  type: object
                                  properties:
                                    subtotal:
                                      type: string
                                      example: '10.0'
                                    subtotal_in_currency:
                                      type: string
                                      example: $10.0
                                    interval:
                                      type: integer
                                      example: 1
                                    interval_unit:
                                      type: string
                                      example: month
                                    subtotal_for_display:
                                      type: string
                                      example: $10.00 every 1 month
                                    start_date:
                                      type:
                                        - string
                                        - 'null'
                                      example: '2025-05-27'
                              - type: 'null'
                            default:
                              - subtotal: '10.0'
                                subtotal_in_currency: $10.0
                                interval: 1
                                interval_unit: month
                                subtotal_for_display: $10.00 every 1 month
                                start_date: '2025-05-27'
                          messages:
                            type: object
                            additionalProperties: true
                            example:
                              errors:
                                - Insufficient inventory
                                - Product no longer available
                              warnings:
                                - Low stock warning
                                - Shipping delays expected
                              info:
                                - Free shipping available
                                - Volume discount applied
                          points_enabled:
                            type: boolean
                            example: true
                          points_applied:
                            type: integer
                            example: 500
                            description: Number of points applied to the cart
                          points_applied_amount_in_currency:
                            type: number
                            example: 5
                            description: Currency value of applied points
                          customer_total_points:
                            type: integer
                            example: 1000
                            description: Customer's total available points balance
                          customer_total_points_in_currency:
                            type: number
                            example: 10
                            description: Currency value of available points
                          remaining_customer_points:
                            type: integer
                            example: 500
                            description: Customer's remaining points after cart redemption
                          remaining_customer_points_amount_in_currency:
                            type: number
                            example: 5
                            description: >-
                              Currency value of remaining points after cart
                              redemption
                          remaining_cart_amount_after_points:
                            type: number
                            example: 95
                            description: Amount to charge to card after points redemption
                          remaining_cart_amount_after_points_in_currency:
                            type:
                              - string
                            example: $95.00
                            description: >-
                              Amount in currency to charge to card after points
                              redemption
                          max_applicable_points:
                            type: integer
                            example: 500
                            description: Maximum points that can be applied to this cart
                required:
                  - error_message
                  - errors
                  - meta
        '422':
          description: product not available in country
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - items
              properties:
                items:
                  type: array
                  description: >-
                    Array of items to add, update, or delete. If variant_id
                    already exists in cart,
                                  quantity will be updated; otherwise, a new item is added. Set quantity to 0 to remove an item.
                                  For custom items without variants, use [title, price, quantity]
                  example:
                    - variant_id: 123
                      quantity: 2
                    - title: Custom Surcharge
                      price: '10.99'
                      quantity: 1
                  items:
                    type: object
                    required:
                      - quantity
                    properties:
                      variant_id:
                        type: integer
                        description: |-
                          ID of the variant to add to cart
                                                                    (if item with this variant_id already exists, its quantity will be updated)
                        example: 123
                      quantity:
                        type: integer
                        description: |-
                          Quantity to set for this item
                                                                    (replaces existing quantity if item already exists in cart).
                                                                    Set to 0 to remove the item from the cart.
                        example: 2
                      title:
                        type: string
                        description: Title for custom items without variants
                        example: Custom Surcharge
                      price:
                        type:
                          - number
                          - string
                        description: Price for custom items without variants
                        example: '10.99'
                      subscription:
                        type: boolean
                        example: false
                        description: allow subscription for item
                      subscription_plan_id:
                        type: integer
                        description: |-
                          ID of the subscription plan
                                                                    (can be passed when subscription is true)
                        example: 456
                      enrollment_pack_id:
                        type: integer
                        description: ID of the enrollment pack to add to cart item
                        example: 789
    delete:
      summary: Removes items from cart
      tags:
        - Carts
      operationId: removeCartItems
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: items removed from cart
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      state:
                        type: string
                        example: start
                      processed:
                        type: boolean
                        example: false
                        description: >-
                          Determines if a cart payment has been processed or
                          not.
                      valid_for_checkout:
                        type: boolean
                        example: true
                      buyer_rep_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      buyer_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: buyer.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                              external_id:
                                type:
                                  - string
                                  - 'null'
                                example: '123241'
                            required:
                              - id
                          - type: 'null'
                      volume_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: volume.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                            required:
                              - id
                          - type: 'null'
                      currency_symbol:
                        type: string
                        example: $
                      currency_code:
                        type: string
                        example: USD
                      shipping_total_for_display:
                        type: string
                        example: Free
                      phone:
                        type:
                          - string
                          - 'null'
                        example: '4035551212'
                      payment_method_auto_assignable:
                        type: boolean
                        example: true
                        description: >-
                          Determines if a payment method can be auto-assigned to
                          the cart.
                      attribution:
                        oneOf:
                          - type: object
                            oneOf:
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  share_guid:
                                    type: string
                                    example: james-bond007
                                required:
                                  - id
                                  - share_guid
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  email:
                                    type: string
                                    example: james.bond@gmail.com
                                required:
                                  - id
                                  - email
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  username:
                                    type: string
                                    example: jaamball234
                                required:
                                  - id
                                  - username
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  fluid_rep_id:
                                    type: integer
                                    example: 23493
                                required:
                                  - id
                                  - fluid_rep_id
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: w3sdf92
                                required:
                                  - id
                          - type: 'null'
                        default:
                          id: 456
                          share_guid: james-bond007
                      agreements:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            required:
                              type: boolean
                              example: true
                            title:
                              type: string
                              example: Terms and Conditions
                            show_path:
                              type: string
                              example: /terms
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                      amount_total:
                        type: string
                        example: '121.65'
                      amount_total_in_currency:
                        type: string
                        example: $121.65 (USD)
                      sub_total:
                        type: string
                        example: '100.00'
                      sub_total_in_currency:
                        type: string
                        example: $100.00 (USD)
                      subtotal_after_discounts:
                        type: string
                        example: '90.00'
                      tax_total:
                        type: string
                        example: '20.00'
                      tax_total_in_currency:
                        type: string
                        example: $20.00 (USD)
                      shipping_total:
                        type:
                          - string
                          - 'null'
                        example: '1.65'
                      shipping_total_in_currency:
                        type: string
                        example: $1.65 (USD)
                      shipping_discount:
                        type: number
                        example: 10.25
                      discount_total:
                        type: string
                        example: '2.99'
                      discount_total_in_currency:
                        type: string
                        example: $2.99 (USD)
                      discount_breakdown:
                        type: object
                        properties:
                          internal_discounts:
                            type: number
                            example: 15
                          external_discounts:
                            type: number
                            example: 10
                          total_discounts:
                            type: number
                            example: 25
                      external_discount:
                        type: object
                        properties:
                          total:
                            type: number
                            example: 10
                          calculated_at:
                            type:
                              - string
                              - 'null'
                            format: date-time
                            example: '2024-01-10T15:30:00Z'
                          sources:
                            type: object
                            additionalProperties:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 6
                                description:
                                  type: string
                                  example: Gold tier discount
                                metadata:
                                  type: object
                              required:
                                - amount
                                - description
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: '1.90'
                      transaction_fee_in_currency:
                        type: string
                        example: $1.90 (USD)
                      cv_total:
                        type: integer
                        example: 10
                      qv_total:
                        type: integer
                        example: 15
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      payment_account:
                        type:
                          - string
                          - 'null'
                        example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                      payment_method:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: CreditCard
                              payment_method_type:
                                type: string
                                example: visa
                              last_four:
                                type: string
                                example: '1234'
                              exp_month:
                                type: string
                                example: '12'
                              exp_year:
                                type: string
                                example: '2025'
                              logo_url:
                                type: string
                                example: https://example.com/image.svg
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Paypal
                              status:
                                type: string
                                example: active
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Affirm
                              affirm_id:
                                type: string
                                example: affirm_123
                              status:
                                type: string
                                example: authorized
                              checkout_id:
                                type: string
                                example: checkout_456
                              created:
                                type: string
                                example: '2025-01-01T00:00:00Z'
                              auth_expiration:
                                type: string
                                example: '2025-01-02T00:00:00Z'
                              currency:
                                type: string
                                example: USD
                              amount:
                                type: string
                                example: '100.00'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Klarna
                              session_id:
                                type: string
                                example: klarna_session_789
                              intent:
                                type: string
                                example: buy
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Droplet
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: SomeCitcon
                      email:
                        type:
                          - string
                          - 'null'
                        example: user@example.com
                      enrollment_fee:
                        type:
                          - number
                          - string
                        example: '10.45'
                      enrollment_fee_in_currency:
                        type: string
                        example: $10.45
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT10
                          - DISCOUNT11
                      language_iso:
                        type:
                          - string
                          - 'null'
                        example: en
                      cart_token:
                        type: string
                        example: abc123
                      immutable_items:
                        type: boolean
                        example: false
                      digital_only:
                        type: boolean
                        example: false
                      requires_3ds:
                        type: boolean
                        example: false
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 101
                            price:
                              type: string
                              example: '43.41'
                            price_in_currency:
                              type: string
                              example: $43.41
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            cv:
                              type: integer
                              example: 5
                            cv_total:
                              type: integer
                              example: 15
                            qv:
                              type: integer
                              example: 7
                            qv_total:
                              type: integer
                              example: 21
                            discount_amount:
                              type: string
                              example: '10'
                            free_item:
                              type: boolean
                              example: false
                            discount_amount_in_currency:
                              type: string
                              example: $10.00
                            total_after_discounts:
                              type: string
                              example: '90.00'
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            product_title:
                              type:
                                - string
                                - 'null'
                              example: Sample Product
                            quantity:
                              type: integer
                              example: 3
                            subscription:
                              type: boolean
                              example: true
                            enrollment:
                              type: boolean
                              example: false
                            allow_subscription:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_plan_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_plans:
                              oneOf:
                                - type: array
                                  items:
                                    title: Commerce::SubscriptionPlan
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        example: Test Subscription Plan
                                        type: string
                                      billing_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      billing_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      billing_frequency_in_words:
                                        example: 2 Months
                                        type: string
                                      shipping_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      shipping_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      volume_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      volume_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      trial_period:
                                        example: 1
                                        type:
                                          - integer
                                          - 'null'
                                        minimum: 1
                                      trial_period_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type:
                                          - string
                                          - 'null'
                                      split_volume:
                                        example: true
                                        type: boolean
                                        default: false
                                      allow_max_billing_cycles:
                                        example: true
                                        type: boolean
                                        default: false
                                      max_billing_cycles:
                                        example: 3
                                        type:
                                          - integer
                                          - 'null'
                                      company_default:
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                        default: false
                                      products_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      subscribers_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      price:
                                        type: string
                                      price_in_currency:
                                        type: string
                                      subscription_start:
                                        type: string
                                      subscribe_and_save:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_in_currency:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_for_display:
                                        type:
                                          - string
                                          - 'null'
                                    required:
                                      - id
                                      - name
                                      - billing_interval
                                      - billing_interval_unit
                                      - billing_frequency_in_words
                                      - shipping_interval
                                      - shipping_interval_unit
                                      - volume_interval
                                      - volume_interval_unit
                                      - split_volume
                                      - allow_max_billing_cycles
                                      - price
                                      - price_in_currency
                                      - subscription_start
                                      - subscribe_and_save
                                      - subscribe_and_save_in_currency
                                      - subscribe_and_save_for_display
                                - type: 'null'
                            subscription_only:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_interval:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_interval_unit:
                              type:
                                - string
                                - 'null'
                              example: month
                            subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 10.5
                            subscription_price_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $10.50
                            subscription_start:
                              type:
                                - string
                                - 'null'
                              example: '2025-02-12'
                            subscribe_and_save:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 2.99
                            subscribe_and_save_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $2.99
                            subscribe_and_save_for_display:
                              type:
                                - string
                                - 'null'
                              example: Subscribe and save $2.99
                            title:
                              type:
                                - string
                                - 'null'
                              example: Surcharge
                            metadata:
                              type: object
                              description: >-
                                A JSON object that can store any custom data
                                structure
                              example: {}
                            product:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type: string
                                      example: Sample Product
                                    introduction:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Product Description
                                    cv:
                                      type: integer
                                      example: 10
                                    external_id:
                                      type:
                                        - string
                                        - 'null'
                                      example: ext-prod-123
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/product.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/product.png
                                    price:
                                      type: string
                                      example: '29.99'
                                    price_in_currency:
                                      type: string
                                      example: $29.99
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    tax:
                                      type: string
                                      example: '2.99'
                                    tax_in_currency:
                                      type: string
                                      example: $2.99
                                    metadata:
                                      type: object
                                      example:
                                        shopify_product_id: 9876054868270
                                    metafields:
                                      type: array
                                      items:
                                        title: LegacyMetafield
                                        type: object
                                        properties:
                                          namespace:
                                            description: >-
                                              A container for related metafields.
                                              Commonly used to group metafields by app
                                              or functionality.
                                            example: custom
                                            type: string
                                            maxLength: 20
                                            pattern: ^[a-zA-Z0-9_]+$
                                          key:
                                            description: >-
                                              The unique identifier for the metafield
                                              within its namespace. Must be unique per
                                              namespace and owner.
                                            example: material
                                            type: string
                                            maxLength: 30
                                            pattern: ^[a-zA-Z0-9_]+$
                                          value:
                                            description: >-
                                              The actual data stored in the metafield.
                                              Type depends on value_type.
                                            example: cotton
                                            type:
                                              - string
                                              - integer
                                              - object
                                              - boolean
                                              - number
                                          value_type:
                                            description: >-
                                              The data type that defines how the value
                                              should be interpreted and validated.
                                            example: single_line_text_field
                                            type: string
                                          description:
                                            description: >-
                                              Optional human-readable description
                                              explaining the purpose of this
                                              metafield.
                                            example: >-
                                              The primary material used in this
                                              product
                                            type:
                                              - string
                                              - 'null'
                                          created_at:
                                            description: >-
                                              Timestamp when the metafield was
                                              created.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          updated_at:
                                            description: >-
                                              Timestamp when the metafield was last
                                              updated.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          locked:
                                            description: >-
                                              Whether this metafield is locked and
                                              cannot be updated or deleted directly.
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                              - 'null'
                                          metafield_definition:
                                            description: >-
                                              The definition that defines validation
                                              rules and structure for this metafield
                                            type:
                                              - 'null'
                                              - object
                                        required:
                                          - namespace
                                          - key
                                          - value
                                          - value_type
                                          - description
                                          - created_at
                                          - updated_at
                                          - metafield_definition
                                - type: 'null'
                            variant:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Variant
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/sample.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/sample.png
                                    primary_image:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/primary.png
                                    price:
                                      type:
                                        - string
                                        - 'null'
                                      example: '34.44'
                                    price_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $34.44
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    options:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          title:
                                            type: string
                                            example: Size
                                          value:
                                            type: string
                                            example: XL
                                    physical:
                                      type:
                                        - boolean
                                        - 'null'
                                      example: true
                                    unit_of_size:
                                      type:
                                        - string
                                        - 'null'
                                      example: cm
                                    height:
                                      type:
                                        - number
                                        - 'null'
                                      example: 13
                                    width:
                                      type:
                                        - number
                                        - 'null'
                                      example: 6
                                    length:
                                      type:
                                        - number
                                        - 'null'
                                      example: 12
                                    unit_of_weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: kg
                                    weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                    hs_code:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                - type: 'null'
                            errors:
                              oneOf:
                                - type: 'null'
                                - type: array
                                  items:
                                    type: object
                                  example:
                                    - country:
                                        - >-
                                          This product is not available for this
                                          country. Please change your country
                            bundled_items:
                              type: array
                              items:
                                type: object
                                description: Bundled items for bundle products
                                properties:
                                  variant_id:
                                    type: integer
                                    example: 1
                                  product_id:
                                    type: integer
                                    example: 1
                                  product_title:
                                    type: string
                                    example: Product Title
                                  variant_title:
                                    type: string
                                    example: Variant Title
                                  option_titles:
                                    type: array
                                    example:
                                      - Option 1
                                      - Option 2
                                  quantity:
                                    type: integer
                                    example: 1
                                  display_to_customer:
                                    type: boolean
                                    example: true
                      ship_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      bill_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      shipping_method:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: string
                            example: standard-shipping
                          name:
                            type: string
                            example: Standard Shipping
                      available_shipping_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: standard-shipping
                            title:
                              type: string
                              example: Standard Shipping
                            price:
                              type:
                                - number
                                - string
                              example: 5.99
                            price_label:
                              type: string
                              example: $5.99
                            delivery_time_estimate:
                              type: string
                              example: 3-5 business days
                      available_payment_methods:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - credit_card
                                name:
                                  type: string
                                  example: Credit Card
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                apple_pay:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method supports
                                    ApplePay or not 
                                bogus_gateway:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is a Bogus
                                    instance or not.
                                tokenize_path:
                                  type:
                                    - string
                                    - 'null'
                                  description: Path to tokenize, if applicable.
                                token_provider:
                                  type: string
                                  enum:
                                    - spreedly
                                    - vgs
                                  description: >-
                                    Determines if payment tokenization is via
                                    spreedly or VGS
                                apple_pay_merchant_identifier:
                                  type:
                                    - string
                                    - 'null'
                                  example: merchant.mycompany.com
                                  description: >-
                                    If ApplePay is supported, returns the
                                    merchant identifier registered with Apple,
                                    else returns nil
                                supported_brands:
                                  type: array
                                  items:
                                    type: string
                                  example:
                                    - visa
                                    - master
                                    - american_express
                                    - discover
                                publishable_key:
                                  type:
                                    - string
                                    - 'null'
                                  example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                  description: >-
                                    If publishable key is set for Hyperswitch,
                                    returns the publishable key, else returns
                                    nil
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                              required:
                                - id
                                - type
                                - name
                                - supported_brands
                                - test
                                - sandbox
                                - apple_pay
                                - apple_pay_merchant_identifier
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - klarna
                                name:
                                  type: string
                                  example: Klarna
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                      country:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          iso:
                            type: string
                            example: US
                          name:
                            type: string
                            example: United States
                          iso_name:
                            type: string
                            example: UNITED STATES
                          iso3:
                            type: string
                            example: USA
                          currency_code:
                            type: string
                            example: USD
                          currency_symbol:
                            type: string
                            example: $
                          province_required:
                            type: boolean
                            example: false
                          tax_enabled:
                            type:
                              - boolean
                              - 'null'
                            example: true
                          price_inclusive_of_tax:
                            type: boolean
                            example: false
                          price_inclusive_tax_name:
                            type:
                              - string
                              - 'null'
                            example: VAT
                      type:
                        type: string
                        enum:
                          - regular
                          - enrollment
                        example: regular
                      enrollment_pack_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      enrollment_pack:
                        type:
                          - object
                          - 'null'
                        properties:
                          enrollment_pack_id:
                            type: integer
                            example: 1
                          additional_volume:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          slug:
                            type: string
                            example: test-enrollment-pack
                          description:
                            type:
                              - object
                              - 'null'
                              - string
                            properties:
                              id:
                                type: integer
                                example: 111
                              name:
                                type: string
                                example: description
                              body:
                                type: string
                                example: >-
                                  <div>Try the latest and greatest of our sugar
                                  zip packs. Guaranteed to make you skinner and
                                  cure cancer.</div>
                              record_type:
                                type: string
                                example: EnrollmentPack
                              record_id:
                                type: integer
                                example: 1
                              created_at:
                                type: string
                                format: date_time
                                example: '2025-01-16T04:22:43.809Z'
                              updated_at:
                                type: string
                                format: date_time
                                example: '2025-01-22T10:23:52.941Z'
                              locale:
                                type: string
                                example: en
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: 10
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.00
                          images:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2
                                relateable_type:
                                  type: string
                                  example: EnrollmentPack
                                relateable_id:
                                  type: integer
                                  example: 1
                                image_url:
                                  type: string
                                  example: >-
                                    https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                image_path:
                                  type: string
                                  example: jITWaU14QGe0y5AFgY7P_00179.svg
                                position:
                                  type: integer
                                  example: 1
                                shopify_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                                created_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                updated_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                external_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 625
                                allow_subscription:
                                  type: boolean
                                  example: true
                                cv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                cv_in_currency:
                                  type: string
                                  example: $0.00
                                cv_total:
                                  type: integer
                                  example: 0
                                enrollment:
                                  type: boolean
                                  example: true
                                enrollment_pack_id:
                                  type: integer
                                  example: 1
                                price:
                                  type: string
                                  example: '11.13'
                                price_in_currency:
                                  type: string
                                  example: $11.13
                                product_title:
                                  type: string
                                  example: Zip Pack Sample Pack (30)
                                quantity:
                                  type: integer
                                  example: 1
                                qv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                qv_in_currency:
                                  type: string
                                  example: $0.00
                                qv_total:
                                  type: integer
                                  example: 0
                                subscribe_and_save:
                                  type:
                                    - string
                                    - 'null'
                                  example: '-1988.87'
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $-1,988.87
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $-1,988.87
                                subscription:
                                  type: boolean
                                  example: false
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_only:
                                  type: boolean
                                  example: false
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_price:
                                  type: string
                                  example: '2000.0'
                                subscription_price_in_currency:
                                  type: string
                                  example: $2,000.00
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  format: date
                                  example: '2025-02-28'
                                tax:
                                  type: string
                                  example: '0.0'
                                tax_in_currency:
                                  type: string
                                  example: $0.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: null
                                display_to_customer:
                                  type: boolean
                                  example: false
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                          price:
                            type: string
                            example: '11.13'
                          price_in_currency:
                            type: string
                            example: $11.13
                          subscription_price:
                            type:
                              - string
                              - integer
                            example: 2000
                          subscription_price_in_currency:
                            type: string
                            example: $2,000.00
                          title:
                            type: string
                            example: enroll product
                          token:
                            type: string
                            example: NxL22AqLRRisfyF9LqxxWRak
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      recurring:
                        oneOf:
                          - type: array
                            items:
                              type: object
                              properties:
                                subtotal:
                                  type: string
                                  example: '10.0'
                                subtotal_in_currency:
                                  type: string
                                  example: $10.0
                                interval:
                                  type: integer
                                  example: 1
                                interval_unit:
                                  type: string
                                  example: month
                                subtotal_for_display:
                                  type: string
                                  example: $10.00 every 1 month
                                start_date:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-05-27'
                          - type: 'null'
                        default:
                          - subtotal: '10.0'
                            subtotal_in_currency: $10.0
                            interval: 1
                            interval_unit: month
                            subtotal_for_display: $10.00 every 1 month
                            start_date: '2025-05-27'
                      messages:
                        type: object
                        additionalProperties: true
                        example:
                          errors:
                            - Insufficient inventory
                            - Product no longer available
                          warnings:
                            - Low stock warning
                            - Shipping delays expected
                          info:
                            - Free shipping available
                            - Volume discount applied
                      points_enabled:
                        type: boolean
                        example: true
                      points_applied:
                        type: integer
                        example: 500
                        description: Number of points applied to the cart
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Currency value of applied points
                      customer_total_points:
                        type: integer
                        example: 1000
                        description: Customer's total available points balance
                      customer_total_points_in_currency:
                        type: number
                        example: 10
                        description: Currency value of available points
                      remaining_customer_points:
                        type: integer
                        example: 500
                        description: Customer's remaining points after cart redemption
                      remaining_customer_points_amount_in_currency:
                        type: number
                        example: 5
                        description: >-
                          Currency value of remaining points after cart
                          redemption
                      remaining_cart_amount_after_points:
                        type: number
                        example: 95
                        description: Amount to charge to card after points redemption
                      remaining_cart_amount_after_points_in_currency:
                        type:
                          - string
                        example: $95.00
                        description: >-
                          Amount in currency to charge to card after points
                          redemption
                      max_applicable_points:
                        type: integer
                        example: 500
                        description: Maximum points that can be applied to this cart
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      checkout_url:
                        type: string
                        example: https://checkout.fluid.com/checkout?jwt=abc123
                      shop_url:
                        type: string
                        example: https://myco.fluid.app
        '400':
          description: no cart items specified
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: No cart items specified
        '410':
          description: cart is in authorized enrollment state
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Cart is in authorized state and cannot be modified
                  errors:
                    type: object
                    example:
                      cart:
                        - is in authorized state and cannot be modified
                  meta:
                    type: object
                    properties:
                      shop_url:
                        type: string
                        example: https://example.myshopify.com
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      cart:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 123
                          state:
                            type: string
                            example: start
                          processed:
                            type: boolean
                            example: false
                            description: >-
                              Determines if a cart payment has been processed or
                              not.
                          valid_for_checkout:
                            type: boolean
                            example: true
                          buyer_rep_id:
                            type:
                              - integer
                              - 'null'
                            example: 1
                          buyer_rep:
                            oneOf:
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 2
                                  email:
                                    type:
                                      - string
                                      - 'null'
                                    example: buyer.rep@example.com
                                  full_name:
                                    type:
                                      - string
                                      - 'null'
                                    example: John Doe
                                  image_url:
                                    type:
                                      - string
                                      - 'null'
                                    example: https://example.com/image.png
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: '123241'
                                required:
                                  - id
                              - type: 'null'
                          volume_rep:
                            oneOf:
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 2
                                  email:
                                    type:
                                      - string
                                      - 'null'
                                    example: volume.rep@example.com
                                  full_name:
                                    type:
                                      - string
                                      - 'null'
                                    example: John Doe
                                  image_url:
                                    type:
                                      - string
                                      - 'null'
                                    example: https://example.com/image.png
                                required:
                                  - id
                              - type: 'null'
                          currency_symbol:
                            type: string
                            example: $
                          currency_code:
                            type: string
                            example: USD
                          shipping_total_for_display:
                            type: string
                            example: Free
                          phone:
                            type:
                              - string
                              - 'null'
                            example: '4035551212'
                          payment_method_auto_assignable:
                            type: boolean
                            example: true
                            description: >-
                              Determines if a payment method can be
                              auto-assigned to the cart.
                          attribution:
                            oneOf:
                              - type: object
                                oneOf:
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      share_guid:
                                        type: string
                                        example: james-bond007
                                    required:
                                      - id
                                      - share_guid
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      email:
                                        type: string
                                        example: james.bond@gmail.com
                                    required:
                                      - id
                                      - email
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      username:
                                        type: string
                                        example: jaamball234
                                    required:
                                      - id
                                      - username
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      fluid_rep_id:
                                        type: integer
                                        example: 23493
                                    required:
                                      - id
                                      - fluid_rep_id
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      external_id:
                                        type:
                                          - string
                                          - 'null'
                                        example: w3sdf92
                                    required:
                                      - id
                              - type: 'null'
                            default:
                              id: 456
                              share_guid: james-bond007
                          agreements:
                            type: array
                            items:
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                  example: 1
                                required:
                                  type: boolean
                                  example: true
                                title:
                                  type: string
                                  example: Terms and Conditions
                                show_path:
                                  type: string
                                  example: /terms
                                enrollment_pack_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                          amount_total:
                            type: string
                            example: '121.65'
                          amount_total_in_currency:
                            type: string
                            example: $121.65 (USD)
                          sub_total:
                            type: string
                            example: '100.00'
                          sub_total_in_currency:
                            type: string
                            example: $100.00 (USD)
                          subtotal_after_discounts:
                            type: string
                            example: '90.00'
                          tax_total:
                            type: string
                            example: '20.00'
                          tax_total_in_currency:
                            type: string
                            example: $20.00 (USD)
                          shipping_total:
                            type:
                              - string
                              - 'null'
                            example: '1.65'
                          shipping_total_in_currency:
                            type: string
                            example: $1.65 (USD)
                          shipping_discount:
                            type: number
                            example: 10.25
                          discount_total:
                            type: string
                            example: '2.99'
                          discount_total_in_currency:
                            type: string
                            example: $2.99 (USD)
                          discount_breakdown:
                            type: object
                            properties:
                              internal_discounts:
                                type: number
                                example: 15
                              external_discounts:
                                type: number
                                example: 10
                              total_discounts:
                                type: number
                                example: 25
                          external_discount:
                            type: object
                            properties:
                              total:
                                type: number
                                example: 10
                              calculated_at:
                                type:
                                  - string
                                  - 'null'
                                format: date-time
                                example: '2024-01-10T15:30:00Z'
                              sources:
                                type: object
                                additionalProperties:
                                  type: object
                                  properties:
                                    amount:
                                      type: number
                                      example: 6
                                    description:
                                      type: string
                                      example: Gold tier discount
                                    metadata:
                                      type: object
                                  required:
                                    - amount
                                    - description
                          transaction_fee:
                            type:
                              - number
                              - string
                            example: '1.90'
                          transaction_fee_in_currency:
                            type: string
                            example: $1.90 (USD)
                          cv_total:
                            type: integer
                            example: 10
                          qv_total:
                            type: integer
                            example: 15
                          company:
                            type: object
                            properties:
                              id:
                                type: integer
                              name:
                                type: string
                              primary_domain_hostname:
                                type:
                                  - string
                                  - 'null'
                                example: fluid.com
                              subdomain:
                                type:
                                  - string
                                  - 'null'
                                example: myco
                              logo_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/logo.png
                              fluid_shop:
                                type:
                                  - string
                                  - 'null'
                                example: https://fluid-sample-shop.fluid.com
                              collect_phone:
                                type: boolean
                                example: true
                              require_phone:
                                type: boolean
                                example: false
                              require_billing_zip:
                                type: boolean
                                example: false
                              checkout_primary_button_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#000000'
                              checkout_primary_text_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#FFFFFF'
                              checkout_secondary_button_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#FFFFFF'
                              checkout_secondary_text_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#000000'
                              favicon_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/favicon.ico
                              order_on_behalf:
                                type: boolean
                                example: false
                              use_juspay_gateway:
                                type: boolean
                                example: false
                              reward_points_enabled:
                                type: boolean
                                example: false
                          payment_account:
                            type:
                              - string
                              - 'null'
                            example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                          payment_method:
                            oneOf:
                              - type: 'null'
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: CreditCard
                                  payment_method_type:
                                    type: string
                                    example: visa
                                  last_four:
                                    type: string
                                    example: '1234'
                                  exp_month:
                                    type: string
                                    example: '12'
                                  exp_year:
                                    type: string
                                    example: '2025'
                                  logo_url:
                                    type: string
                                    example: https://example.com/image.svg
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Paypal
                                  status:
                                    type: string
                                    example: active
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Affirm
                                  affirm_id:
                                    type: string
                                    example: affirm_123
                                  status:
                                    type: string
                                    example: authorized
                                  checkout_id:
                                    type: string
                                    example: checkout_456
                                  created:
                                    type: string
                                    example: '2025-01-01T00:00:00Z'
                                  auth_expiration:
                                    type: string
                                    example: '2025-01-02T00:00:00Z'
                                  currency:
                                    type: string
                                    example: USD
                                  amount:
                                    type: string
                                    example: '100.00'
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Klarna
                                  session_id:
                                    type: string
                                    example: klarna_session_789
                                  intent:
                                    type: string
                                    example: buy
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Droplet
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: SomeCitcon
                          email:
                            type:
                              - string
                              - 'null'
                            example: user@example.com
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: '10.45'
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.45
                          discount_codes:
                            type: array
                            items:
                              type: string
                            example:
                              - DISCOUNT10
                              - DISCOUNT11
                          language_iso:
                            type:
                              - string
                              - 'null'
                            example: en
                          cart_token:
                            type: string
                            example: abc123
                          immutable_items:
                            type: boolean
                            example: false
                          digital_only:
                            type: boolean
                            example: false
                          requires_3ds:
                            type: boolean
                            example: false
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 101
                                price:
                                  type: string
                                  example: '43.41'
                                price_in_currency:
                                  type: string
                                  example: $43.41
                                tax:
                                  type: string
                                  example: '2.99'
                                tax_in_currency:
                                  type: string
                                  example: $2.99
                                cv:
                                  type: integer
                                  example: 5
                                cv_total:
                                  type: integer
                                  example: 15
                                qv:
                                  type: integer
                                  example: 7
                                qv_total:
                                  type: integer
                                  example: 21
                                discount_amount:
                                  type: string
                                  example: '10'
                                free_item:
                                  type: boolean
                                  example: false
                                discount_amount_in_currency:
                                  type: string
                                  example: $10.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                enrollment_pack_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                display_to_customer:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                product_title:
                                  type:
                                    - string
                                    - 'null'
                                  example: Sample Product
                                quantity:
                                  type: integer
                                  example: 3
                                subscription:
                                  type: boolean
                                  example: true
                                enrollment:
                                  type: boolean
                                  example: false
                                allow_subscription:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_only:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_price:
                                  type:
                                    - number
                                    - string
                                    - 'null'
                                  example: 10.5
                                subscription_price_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $10.50
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-02-12'
                                subscribe_and_save:
                                  type:
                                    - number
                                    - string
                                    - 'null'
                                  example: 2.99
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $2.99
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $2.99
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: Surcharge
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                product:
                                  oneOf:
                                    - type: object
                                      properties:
                                        id:
                                          type: integer
                                          example: 1
                                        title:
                                          type: string
                                          example: Sample Product
                                        introduction:
                                          type:
                                            - string
                                            - 'null'
                                          example: Sample Product Description
                                        cv:
                                          type: integer
                                          example: 10
                                        external_id:
                                          type:
                                            - string
                                            - 'null'
                                          example: ext-prod-123
                                        image_path:
                                          type:
                                            - string
                                            - 'null'
                                          example: /images/product.png
                                        image_url:
                                          type:
                                            - string
                                            - 'null'
                                          example: https://example.com/images/product.png
                                        price:
                                          type: string
                                          example: '29.99'
                                        price_in_currency:
                                          type: string
                                          example: $29.99
                                        sku:
                                          type:
                                            - string
                                            - 'null'
                                          example: SKU12345
                                        tax:
                                          type: string
                                          example: '2.99'
                                        tax_in_currency:
                                          type: string
                                          example: $2.99
                                        metadata:
                                          type: object
                                          example:
                                            shopify_product_id: 9876054868270
                                        metafields:
                                          type: array
                                          items:
                                            title: LegacyMetafield
                                            type: object
                                            properties:
                                              namespace:
                                                description: >-
                                                  A container for related metafields.
                                                  Commonly used to group metafields by app
                                                  or functionality.
                                                example: custom
                                                type: string
                                                maxLength: 20
                                                pattern: ^[a-zA-Z0-9_]+$
                                              key:
                                                description: >-
                                                  The unique identifier for the metafield
                                                  within its namespace. Must be unique per
                                                  namespace and owner.
                                                example: material
                                                type: string
                                                maxLength: 30
                                                pattern: ^[a-zA-Z0-9_]+$
                                              value:
                                                description: >-
                                                  The actual data stored in the metafield.
                                                  Type depends on value_type.
                                                example: cotton
                                                type:
                                                  - string
                                                  - integer
                                                  - object
                                                  - boolean
                                                  - number
                                              value_type:
                                                description: >-
                                                  The data type that defines how the value
                                                  should be interpreted and validated.
                                                example: single_line_text_field
                                                type: string
                                              description:
                                                description: >-
                                                  Optional human-readable description
                                                  explaining the purpose of this
                                                  metafield.
                                                example: >-
                                                  The primary material used in this
                                                  product
                                                type:
                                                  - string
                                                  - 'null'
                                              created_at:
                                                description: >-
                                                  Timestamp when the metafield was
                                                  created.
                                                example: '2021-01-01T00:00:00Z'
                                                type: string
                                                format: date-time
                                              updated_at:
                                                description: >-
                                                  Timestamp when the metafield was last
                                                  updated.
                                                example: '2021-01-01T00:00:00Z'
                                                type: string
                                                format: date-time
                                              locked:
                                                description: >-
                                                  Whether this metafield is locked and
                                                  cannot be updated or deleted directly.
                                                example: false
                                                type:
                                                  - boolean
                                                  - 'null'
                                                  - 'null'
                                              metafield_definition:
                                                description: >-
                                                  The definition that defines validation
                                                  rules and structure for this metafield
                                                type:
                                                  - 'null'
                                                  - object
                                            required:
                                              - namespace
                                              - key
                                              - value
                                              - value_type
                                              - description
                                              - created_at
                                              - updated_at
                                              - metafield_definition
                                    - type: 'null'
                                variant:
                                  oneOf:
                                    - type: object
                                      properties:
                                        id:
                                          type: integer
                                          example: 1
                                        title:
                                          type:
                                            - string
                                            - 'null'
                                          example: Sample Variant
                                        image_path:
                                          type:
                                            - string
                                            - 'null'
                                          example: /images/sample.png
                                        image_url:
                                          type:
                                            - string
                                            - 'null'
                                          example: https://example.com/images/sample.png
                                        primary_image:
                                          type:
                                            - string
                                            - 'null'
                                          example: https://example.com/images/primary.png
                                        price:
                                          type:
                                            - string
                                            - 'null'
                                          example: '34.44'
                                        price_in_currency:
                                          type:
                                            - string
                                            - 'null'
                                          example: $34.44
                                        sku:
                                          type:
                                            - string
                                            - 'null'
                                          example: SKU12345
                                        options:
                                          type: array
                                          items:
                                            type: object
                                            properties:
                                              title:
                                                type: string
                                                example: Size
                                              value:
                                                type: string
                                                example: XL
                                        physical:
                                          type:
                                            - boolean
                                            - 'null'
                                          example: true
                                        unit_of_size:
                                          type:
                                            - string
                                            - 'null'
                                          example: cm
                                        height:
                                          type:
                                            - number
                                            - 'null'
                                          example: 13
                                        width:
                                          type:
                                            - number
                                            - 'null'
                                          example: 6
                                        length:
                                          type:
                                            - number
                                            - 'null'
                                          example: 12
                                        unit_of_weight:
                                          type:
                                            - string
                                            - 'null'
                                          example: kg
                                        weight:
                                          type:
                                            - string
                                            - 'null'
                                          example: '3.2'
                                        hs_code:
                                          type:
                                            - string
                                            - 'null'
                                          example: '3.2'
                                    - type: 'null'
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                                bundled_items:
                                  type: array
                                  items:
                                    type: object
                                    description: Bundled items for bundle products
                                    properties:
                                      variant_id:
                                        type: integer
                                        example: 1
                                      product_id:
                                        type: integer
                                        example: 1
                                      product_title:
                                        type: string
                                        example: Product Title
                                      variant_title:
                                        type: string
                                        example: Variant Title
                                      option_titles:
                                        type: array
                                        example:
                                          - Option 1
                                          - Option 2
                                      quantity:
                                        type: integer
                                        example: 1
                                      display_to_customer:
                                        type: boolean
                                        example: true
                          ship_to:
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                                example: 1
                              name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              first_name:
                                type:
                                  - string
                                  - 'null'
                                example: John
                              last_name:
                                type:
                                  - string
                                  - 'null'
                                example: Doe
                              address1:
                                type: string
                                example: 123 Main St
                              address2:
                                type:
                                  - string
                                  - 'null'
                                example: Apt 4B
                              address3:
                                type:
                                  - string
                                  - 'null'
                                example: Building 5
                              city:
                                type: string
                                example: New York
                              state:
                                type: string
                                example: NY
                              postal_code:
                                type: string
                                example: '10001'
                              country_code:
                                type: string
                                example: US
                                description: >-
                                  country_id takes precedence if both country_id
                                  and country_code provided.
                              subdivision_code:
                                type:
                                  - string
                                  - 'null'
                                example: NY
                              default:
                                type: boolean
                                example: true
                          bill_to:
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                                example: 1
                              name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              first_name:
                                type:
                                  - string
                                  - 'null'
                                example: John
                              last_name:
                                type:
                                  - string
                                  - 'null'
                                example: Doe
                              address1:
                                type: string
                                example: 123 Main St
                              address2:
                                type:
                                  - string
                                  - 'null'
                                example: Apt 4B
                              address3:
                                type:
                                  - string
                                  - 'null'
                                example: Building 5
                              city:
                                type: string
                                example: New York
                              state:
                                type: string
                                example: NY
                              postal_code:
                                type: string
                                example: '10001'
                              country_code:
                                type: string
                                example: US
                                description: >-
                                  country_id takes precedence if both country_id
                                  and country_code provided.
                              subdivision_code:
                                type:
                                  - string
                                  - 'null'
                                example: NY
                              default:
                                type: boolean
                                example: true
                          shipping_method:
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: string
                                example: standard-shipping
                              name:
                                type: string
                                example: Standard Shipping
                          available_shipping_methods:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                  example: standard-shipping
                                title:
                                  type: string
                                  example: Standard Shipping
                                price:
                                  type:
                                    - number
                                    - string
                                  example: 5.99
                                price_label:
                                  type: string
                                  example: $5.99
                                delivery_time_estimate:
                                  type: string
                                  example: 3-5 business days
                          available_payment_methods:
                            type: array
                            items:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1337
                                    uuid:
                                      type: string
                                      example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                    type:
                                      type: string
                                      enum:
                                        - credit_card
                                    name:
                                      type: string
                                      example: Credit Card
                                    image_url:
                                      type: string
                                      example: https://example.com/image.png
                                    test:
                                      type: boolean
                                      example: true
                                      description: >-
                                        Determines if payment method is test
                                        instance or not. By default, set to
                                        `true`
                                    sandbox:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method is sandbox
                                        instance or not. By default, set to
                                        `false`
                                    apple_pay:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method supports
                                        ApplePay or not 
                                    bogus_gateway:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method is a Bogus
                                        instance or not.
                                    tokenize_path:
                                      type:
                                        - string
                                        - 'null'
                                      description: Path to tokenize, if applicable.
                                    token_provider:
                                      type: string
                                      enum:
                                        - spreedly
                                        - vgs
                                      description: >-
                                        Determines if payment tokenization is
                                        via spreedly or VGS
                                    apple_pay_merchant_identifier:
                                      type:
                                        - string
                                        - 'null'
                                      example: merchant.mycompany.com
                                      description: >-
                                        If ApplePay is supported, returns the
                                        merchant identifier registered with
                                        Apple, else returns nil
                                    supported_brands:
                                      type: array
                                      items:
                                        type: string
                                      example:
                                        - visa
                                        - master
                                        - american_express
                                        - discover
                                    publishable_key:
                                      type:
                                        - string
                                        - 'null'
                                      example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                      description: >-
                                        If publishable key is set for
                                        Hyperswitch, returns the publishable
                                        key, else returns nil
                                    customer_details_schema:
                                      type: object
                                      example: {}
                                      description: >-
                                        Schema defining required customer
                                        details for this payment method
                                  required:
                                    - id
                                    - type
                                    - name
                                    - supported_brands
                                    - test
                                    - sandbox
                                    - apple_pay
                                    - apple_pay_merchant_identifier
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1337
                                    uuid:
                                      type: string
                                      example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                    type:
                                      type: string
                                      enum:
                                        - klarna
                                    name:
                                      type: string
                                      example: Klarna
                                    image_url:
                                      type: string
                                      example: https://example.com/image.png
                                    test:
                                      type: boolean
                                      example: true
                                      description: >-
                                        Determines if payment method is test
                                        instance or not. By default, set to
                                        `true`
                                    sandbox:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method is sandbox
                                        instance or not. By default, set to
                                        `false`
                                    customer_details_schema:
                                      type: object
                                      example: {}
                                      description: >-
                                        Schema defining required customer
                                        details for this payment method
                          country:
                            type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              iso:
                                type: string
                                example: US
                              name:
                                type: string
                                example: United States
                              iso_name:
                                type: string
                                example: UNITED STATES
                              iso3:
                                type: string
                                example: USA
                              currency_code:
                                type: string
                                example: USD
                              currency_symbol:
                                type: string
                                example: $
                              province_required:
                                type: boolean
                                example: false
                              tax_enabled:
                                type:
                                  - boolean
                                  - 'null'
                                example: true
                              price_inclusive_of_tax:
                                type: boolean
                                example: false
                              price_inclusive_tax_name:
                                type:
                                  - string
                                  - 'null'
                                example: VAT
                          type:
                            type: string
                            enum:
                              - regular
                              - enrollment
                            example: regular
                          enrollment_pack_id:
                            type:
                              - integer
                              - 'null'
                            example: 1
                          enrollment_pack:
                            type:
                              - object
                              - 'null'
                            properties:
                              enrollment_pack_id:
                                type: integer
                                example: 1
                              additional_volume:
                                type:
                                  - integer
                                  - 'null'
                                example: 10
                              slug:
                                type: string
                                example: test-enrollment-pack
                              description:
                                type:
                                  - object
                                  - 'null'
                                  - string
                                properties:
                                  id:
                                    type: integer
                                    example: 111
                                  name:
                                    type: string
                                    example: description
                                  body:
                                    type: string
                                    example: >-
                                      <div>Try the latest and greatest of our
                                      sugar zip packs. Guaranteed to make you
                                      skinner and cure cancer.</div>
                                  record_type:
                                    type: string
                                    example: EnrollmentPack
                                  record_id:
                                    type: integer
                                    example: 1
                                  created_at:
                                    type: string
                                    format: date_time
                                    example: '2025-01-16T04:22:43.809Z'
                                  updated_at:
                                    type: string
                                    format: date_time
                                    example: '2025-01-22T10:23:52.941Z'
                                  locale:
                                    type: string
                                    example: en
                              enrollment_fee:
                                type:
                                  - number
                                  - string
                                example: 10
                              enrollment_fee_in_currency:
                                type: string
                                example: $10.00
                              images:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 2
                                    relateable_type:
                                      type: string
                                      example: EnrollmentPack
                                    relateable_id:
                                      type: integer
                                      example: 1
                                    image_url:
                                      type: string
                                      example: >-
                                        https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                    image_path:
                                      type: string
                                      example: jITWaU14QGe0y5AFgY7P_00179.svg
                                    position:
                                      type: integer
                                      example: 1
                                    shopify_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: null
                                    created_at:
                                      type: string
                                      format: date_time
                                      example: '2025-01-16T04:22:44.870Z'
                                    updated_at:
                                      type: string
                                      format: date_time
                                      example: '2025-01-16T04:22:44.870Z'
                                    external_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: null
                              items:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 625
                                    allow_subscription:
                                      type: boolean
                                      example: true
                                    cv:
                                      type:
                                        - number
                                        - string
                                      example: 0
                                    cv_in_currency:
                                      type: string
                                      example: $0.00
                                    cv_total:
                                      type: integer
                                      example: 0
                                    enrollment:
                                      type: boolean
                                      example: true
                                    enrollment_pack_id:
                                      type: integer
                                      example: 1
                                    price:
                                      type: string
                                      example: '11.13'
                                    price_in_currency:
                                      type: string
                                      example: $11.13
                                    product_title:
                                      type: string
                                      example: Zip Pack Sample Pack (30)
                                    quantity:
                                      type: integer
                                      example: 1
                                    qv:
                                      type:
                                        - number
                                        - string
                                      example: 0
                                    qv_in_currency:
                                      type: string
                                      example: $0.00
                                    qv_total:
                                      type: integer
                                      example: 0
                                    subscribe_and_save:
                                      type:
                                        - string
                                        - 'null'
                                      example: '-1988.87'
                                    subscribe_and_save_for_display:
                                      type:
                                        - string
                                        - 'null'
                                      example: Subscribe and save $-1,988.87
                                    subscribe_and_save_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $-1,988.87
                                    subscription:
                                      type: boolean
                                      example: false
                                    subscription_interval:
                                      type:
                                        - integer
                                        - 'null'
                                      example: 1
                                    subscription_interval_unit:
                                      type:
                                        - string
                                        - 'null'
                                      example: month
                                    subscription_only:
                                      type: boolean
                                      example: false
                                    subscription_plan_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: 1
                                    subscription_plans:
                                      oneOf:
                                        - type: array
                                          items:
                                            title: Commerce::SubscriptionPlan
                                            type: object
                                            properties:
                                              id:
                                                type: integer
                                              name:
                                                example: Test Subscription Plan
                                                type: string
                                              billing_interval:
                                                example: 1
                                                type: integer
                                                default: 1
                                                minimum: 1
                                                maximum: 29
                                              billing_interval_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type: string
                                                default: month
                                              billing_frequency_in_words:
                                                example: 2 Months
                                                type: string
                                              shipping_interval:
                                                example: 1
                                                type: integer
                                                default: 1
                                                minimum: 1
                                                maximum: 29
                                              shipping_interval_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type: string
                                                default: month
                                              volume_interval:
                                                example: 1
                                                type: integer
                                                default: 1
                                                minimum: 1
                                                maximum: 29
                                              volume_interval_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type: string
                                                default: month
                                              trial_period:
                                                example: 1
                                                type:
                                                  - integer
                                                  - 'null'
                                                minimum: 1
                                              trial_period_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type:
                                                  - string
                                                  - 'null'
                                              split_volume:
                                                example: true
                                                type: boolean
                                                default: false
                                              allow_max_billing_cycles:
                                                example: true
                                                type: boolean
                                                default: false
                                              max_billing_cycles:
                                                example: 3
                                                type:
                                                  - integer
                                                  - 'null'
                                              company_default:
                                                example: false
                                                type:
                                                  - boolean
                                                  - 'null'
                                                default: false
                                              products_count:
                                                example: 10
                                                type:
                                                  - integer
                                                  - 'null'
                                              subscribers_count:
                                                example: 10
                                                type:
                                                  - integer
                                                  - 'null'
                                              price:
                                                type: string
                                              price_in_currency:
                                                type: string
                                              subscription_start:
                                                type: string
                                              subscribe_and_save:
                                                type:
                                                  - string
                                                  - 'null'
                                              subscribe_and_save_in_currency:
                                                type:
                                                  - string
                                                  - 'null'
                                              subscribe_and_save_for_display:
                                                type:
                                                  - string
                                                  - 'null'
                                            required:
                                              - id
                                              - name
                                              - billing_interval
                                              - billing_interval_unit
                                              - billing_frequency_in_words
                                              - shipping_interval
                                              - shipping_interval_unit
                                              - volume_interval
                                              - volume_interval_unit
                                              - split_volume
                                              - allow_max_billing_cycles
                                              - price
                                              - price_in_currency
                                              - subscription_start
                                              - subscribe_and_save
                                              - subscribe_and_save_in_currency
                                              - subscribe_and_save_for_display
                                        - type: 'null'
                                    subscription_price:
                                      type: string
                                      example: '2000.0'
                                    subscription_price_in_currency:
                                      type: string
                                      example: $2,000.00
                                    subscription_start:
                                      type:
                                        - string
                                        - 'null'
                                      format: date
                                      example: '2025-02-28'
                                    tax:
                                      type: string
                                      example: '0.0'
                                    tax_in_currency:
                                      type: string
                                      example: $0.00
                                    total_after_discounts:
                                      type: string
                                      example: '90.00'
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: null
                                    display_to_customer:
                                      type: boolean
                                      example: false
                                    metadata:
                                      type: object
                                      description: >-
                                        A JSON object that can store any custom
                                        data structure
                                      example: {}
                                    errors:
                                      oneOf:
                                        - type: 'null'
                                        - type: array
                                          items:
                                            type: object
                                          example:
                                            - country:
                                                - >-
                                                  This product is not available for this
                                                  country. Please change your country
                              price:
                                type: string
                                example: '11.13'
                              price_in_currency:
                                type: string
                                example: $11.13
                              subscription_price:
                                type:
                                  - string
                                  - integer
                                example: 2000
                              subscription_price_in_currency:
                                type: string
                                example: $2,000.00
                              title:
                                type: string
                                example: enroll product
                              token:
                                type: string
                                example: NxL22AqLRRisfyF9LqxxWRak
                          metadata:
                            type: object
                            description: >-
                              A JSON object that can store any custom data
                              structure.
                          recurring:
                            oneOf:
                              - type: array
                                items:
                                  type: object
                                  properties:
                                    subtotal:
                                      type: string
                                      example: '10.0'
                                    subtotal_in_currency:
                                      type: string
                                      example: $10.0
                                    interval:
                                      type: integer
                                      example: 1
                                    interval_unit:
                                      type: string
                                      example: month
                                    subtotal_for_display:
                                      type: string
                                      example: $10.00 every 1 month
                                    start_date:
                                      type:
                                        - string
                                        - 'null'
                                      example: '2025-05-27'
                              - type: 'null'
                            default:
                              - subtotal: '10.0'
                                subtotal_in_currency: $10.0
                                interval: 1
                                interval_unit: month
                                subtotal_for_display: $10.00 every 1 month
                                start_date: '2025-05-27'
                          messages:
                            type: object
                            additionalProperties: true
                            example:
                              errors:
                                - Insufficient inventory
                                - Product no longer available
                              warnings:
                                - Low stock warning
                                - Shipping delays expected
                              info:
                                - Free shipping available
                                - Volume discount applied
                          points_enabled:
                            type: boolean
                            example: true
                          points_applied:
                            type: integer
                            example: 500
                            description: Number of points applied to the cart
                          points_applied_amount_in_currency:
                            type: number
                            example: 5
                            description: Currency value of applied points
                          customer_total_points:
                            type: integer
                            example: 1000
                            description: Customer's total available points balance
                          customer_total_points_in_currency:
                            type: number
                            example: 10
                            description: Currency value of available points
                          remaining_customer_points:
                            type: integer
                            example: 500
                            description: Customer's remaining points after cart redemption
                          remaining_customer_points_amount_in_currency:
                            type: number
                            example: 5
                            description: >-
                              Currency value of remaining points after cart
                              redemption
                          remaining_cart_amount_after_points:
                            type: number
                            example: 95
                            description: Amount to charge to card after points redemption
                          remaining_cart_amount_after_points_in_currency:
                            type:
                              - string
                            example: $95.00
                            description: >-
                              Amount in currency to charge to card after points
                              redemption
                          max_applicable_points:
                            type: integer
                            example: 500
                            description: Maximum points that can be applied to this cart
                required:
                  - error_message
                  - errors
                  - meta
        '422':
          description: variant id not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Cart item with variant_id not found
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - items
              properties:
                items:
                  type: array
                  items:
                    type: object
                    required:
                      - variant_id
                    properties:
                      variant_id:
                        type: integer
  /api/carts/{cart_token}/items/{item_id}:
    delete:
      summary: Removes item from cart
      tags:
        - Carts
      operationId: removeCartItem
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
        - name: item_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: item removed from cart
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      state:
                        type: string
                        example: start
                      processed:
                        type: boolean
                        example: false
                        description: >-
                          Determines if a cart payment has been processed or
                          not.
                      valid_for_checkout:
                        type: boolean
                        example: true
                      buyer_rep_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      buyer_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: buyer.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                              external_id:
                                type:
                                  - string
                                  - 'null'
                                example: '123241'
                            required:
                              - id
                          - type: 'null'
                      volume_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: volume.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                            required:
                              - id
                          - type: 'null'
                      currency_symbol:
                        type: string
                        example: $
                      currency_code:
                        type: string
                        example: USD
                      shipping_total_for_display:
                        type: string
                        example: Free
                      phone:
                        type:
                          - string
                          - 'null'
                        example: '4035551212'
                      payment_method_auto_assignable:
                        type: boolean
                        example: true
                        description: >-
                          Determines if a payment method can be auto-assigned to
                          the cart.
                      attribution:
                        oneOf:
                          - type: object
                            oneOf:
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  share_guid:
                                    type: string
                                    example: james-bond007
                                required:
                                  - id
                                  - share_guid
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  email:
                                    type: string
                                    example: james.bond@gmail.com
                                required:
                                  - id
                                  - email
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  username:
                                    type: string
                                    example: jaamball234
                                required:
                                  - id
                                  - username
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  fluid_rep_id:
                                    type: integer
                                    example: 23493
                                required:
                                  - id
                                  - fluid_rep_id
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: w3sdf92
                                required:
                                  - id
                          - type: 'null'
                        default:
                          id: 456
                          share_guid: james-bond007
                      agreements:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            required:
                              type: boolean
                              example: true
                            title:
                              type: string
                              example: Terms and Conditions
                            show_path:
                              type: string
                              example: /terms
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                      amount_total:
                        type: string
                        example: '121.65'
                      amount_total_in_currency:
                        type: string
                        example: $121.65 (USD)
                      sub_total:
                        type: string
                        example: '100.00'
                      sub_total_in_currency:
                        type: string
                        example: $100.00 (USD)
                      subtotal_after_discounts:
                        type: string
                        example: '90.00'
                      tax_total:
                        type: string
                        example: '20.00'
                      tax_total_in_currency:
                        type: string
                        example: $20.00 (USD)
                      shipping_total:
                        type:
                          - string
                          - 'null'
                        example: '1.65'
                      shipping_total_in_currency:
                        type: string
                        example: $1.65 (USD)
                      shipping_discount:
                        type: number
                        example: 10.25
                      discount_total:
                        type: string
                        example: '2.99'
                      discount_total_in_currency:
                        type: string
                        example: $2.99 (USD)
                      discount_breakdown:
                        type: object
                        properties:
                          internal_discounts:
                            type: number
                            example: 15
                          external_discounts:
                            type: number
                            example: 10
                          total_discounts:
                            type: number
                            example: 25
                      external_discount:
                        type: object
                        properties:
                          total:
                            type: number
                            example: 10
                          calculated_at:
                            type:
                              - string
                              - 'null'
                            format: date-time
                            example: '2024-01-10T15:30:00Z'
                          sources:
                            type: object
                            additionalProperties:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 6
                                description:
                                  type: string
                                  example: Gold tier discount
                                metadata:
                                  type: object
                              required:
                                - amount
                                - description
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: '1.90'
                      transaction_fee_in_currency:
                        type: string
                        example: $1.90 (USD)
                      cv_total:
                        type: integer
                        example: 10
                      qv_total:
                        type: integer
                        example: 15
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      payment_account:
                        type:
                          - string
                          - 'null'
                        example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                      payment_method:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: CreditCard
                              payment_method_type:
                                type: string
                                example: visa
                              last_four:
                                type: string
                                example: '1234'
                              exp_month:
                                type: string
                                example: '12'
                              exp_year:
                                type: string
                                example: '2025'
                              logo_url:
                                type: string
                                example: https://example.com/image.svg
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Paypal
                              status:
                                type: string
                                example: active
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Affirm
                              affirm_id:
                                type: string
                                example: affirm_123
                              status:
                                type: string
                                example: authorized
                              checkout_id:
                                type: string
                                example: checkout_456
                              created:
                                type: string
                                example: '2025-01-01T00:00:00Z'
                              auth_expiration:
                                type: string
                                example: '2025-01-02T00:00:00Z'
                              currency:
                                type: string
                                example: USD
                              amount:
                                type: string
                                example: '100.00'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Klarna
                              session_id:
                                type: string
                                example: klarna_session_789
                              intent:
                                type: string
                                example: buy
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Droplet
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: SomeCitcon
                      email:
                        type:
                          - string
                          - 'null'
                        example: user@example.com
                      enrollment_fee:
                        type:
                          - number
                          - string
                        example: '10.45'
                      enrollment_fee_in_currency:
                        type: string
                        example: $10.45
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT10
                          - DISCOUNT11
                      language_iso:
                        type:
                          - string
                          - 'null'
                        example: en
                      cart_token:
                        type: string
                        example: abc123
                      immutable_items:
                        type: boolean
                        example: false
                      digital_only:
                        type: boolean
                        example: false
                      requires_3ds:
                        type: boolean
                        example: false
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 101
                            price:
                              type: string
                              example: '43.41'
                            price_in_currency:
                              type: string
                              example: $43.41
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            cv:
                              type: integer
                              example: 5
                            cv_total:
                              type: integer
                              example: 15
                            qv:
                              type: integer
                              example: 7
                            qv_total:
                              type: integer
                              example: 21
                            discount_amount:
                              type: string
                              example: '10'
                            free_item:
                              type: boolean
                              example: false
                            discount_amount_in_currency:
                              type: string
                              example: $10.00
                            total_after_discounts:
                              type: string
                              example: '90.00'
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            product_title:
                              type:
                                - string
                                - 'null'
                              example: Sample Product
                            quantity:
                              type: integer
                              example: 3
                            subscription:
                              type: boolean
                              example: true
                            enrollment:
                              type: boolean
                              example: false
                            allow_subscription:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_plan_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_plans:
                              oneOf:
                                - type: array
                                  items:
                                    title: Commerce::SubscriptionPlan
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        example: Test Subscription Plan
                                        type: string
                                      billing_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      billing_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      billing_frequency_in_words:
                                        example: 2 Months
                                        type: string
                                      shipping_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      shipping_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      volume_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      volume_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      trial_period:
                                        example: 1
                                        type:
                                          - integer
                                          - 'null'
                                        minimum: 1
                                      trial_period_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type:
                                          - string
                                          - 'null'
                                      split_volume:
                                        example: true
                                        type: boolean
                                        default: false
                                      allow_max_billing_cycles:
                                        example: true
                                        type: boolean
                                        default: false
                                      max_billing_cycles:
                                        example: 3
                                        type:
                                          - integer
                                          - 'null'
                                      company_default:
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                        default: false
                                      products_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      subscribers_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      price:
                                        type: string
                                      price_in_currency:
                                        type: string
                                      subscription_start:
                                        type: string
                                      subscribe_and_save:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_in_currency:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_for_display:
                                        type:
                                          - string
                                          - 'null'
                                    required:
                                      - id
                                      - name
                                      - billing_interval
                                      - billing_interval_unit
                                      - billing_frequency_in_words
                                      - shipping_interval
                                      - shipping_interval_unit
                                      - volume_interval
                                      - volume_interval_unit
                                      - split_volume
                                      - allow_max_billing_cycles
                                      - price
                                      - price_in_currency
                                      - subscription_start
                                      - subscribe_and_save
                                      - subscribe_and_save_in_currency
                                      - subscribe_and_save_for_display
                                - type: 'null'
                            subscription_only:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_interval:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_interval_unit:
                              type:
                                - string
                                - 'null'
                              example: month
                            subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 10.5
                            subscription_price_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $10.50
                            subscription_start:
                              type:
                                - string
                                - 'null'
                              example: '2025-02-12'
                            subscribe_and_save:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 2.99
                            subscribe_and_save_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $2.99
                            subscribe_and_save_for_display:
                              type:
                                - string
                                - 'null'
                              example: Subscribe and save $2.99
                            title:
                              type:
                                - string
                                - 'null'
                              example: Surcharge
                            metadata:
                              type: object
                              description: >-
                                A JSON object that can store any custom data
                                structure
                              example: {}
                            product:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type: string
                                      example: Sample Product
                                    introduction:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Product Description
                                    cv:
                                      type: integer
                                      example: 10
                                    external_id:
                                      type:
                                        - string
                                        - 'null'
                                      example: ext-prod-123
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/product.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/product.png
                                    price:
                                      type: string
                                      example: '29.99'
                                    price_in_currency:
                                      type: string
                                      example: $29.99
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    tax:
                                      type: string
                                      example: '2.99'
                                    tax_in_currency:
                                      type: string
                                      example: $2.99
                                    metadata:
                                      type: object
                                      example:
                                        shopify_product_id: 9876054868270
                                    metafields:
                                      type: array
                                      items:
                                        title: LegacyMetafield
                                        type: object
                                        properties:
                                          namespace:
                                            description: >-
                                              A container for related metafields.
                                              Commonly used to group metafields by app
                                              or functionality.
                                            example: custom
                                            type: string
                                            maxLength: 20
                                            pattern: ^[a-zA-Z0-9_]+$
                                          key:
                                            description: >-
                                              The unique identifier for the metafield
                                              within its namespace. Must be unique per
                                              namespace and owner.
                                            example: material
                                            type: string
                                            maxLength: 30
                                            pattern: ^[a-zA-Z0-9_]+$
                                          value:
                                            description: >-
                                              The actual data stored in the metafield.
                                              Type depends on value_type.
                                            example: cotton
                                            type:
                                              - string
                                              - integer
                                              - object
                                              - boolean
                                              - number
                                          value_type:
                                            description: >-
                                              The data type that defines how the value
                                              should be interpreted and validated.
                                            example: single_line_text_field
                                            type: string
                                          description:
                                            description: >-
                                              Optional human-readable description
                                              explaining the purpose of this
                                              metafield.
                                            example: >-
                                              The primary material used in this
                                              product
                                            type:
                                              - string
                                              - 'null'
                                          created_at:
                                            description: >-
                                              Timestamp when the metafield was
                                              created.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          updated_at:
                                            description: >-
                                              Timestamp when the metafield was last
                                              updated.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          locked:
                                            description: >-
                                              Whether this metafield is locked and
                                              cannot be updated or deleted directly.
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                              - 'null'
                                          metafield_definition:
                                            description: >-
                                              The definition that defines validation
                                              rules and structure for this metafield
                                            type:
                                              - 'null'
                                              - object
                                        required:
                                          - namespace
                                          - key
                                          - value
                                          - value_type
                                          - description
                                          - created_at
                                          - updated_at
                                          - metafield_definition
                                - type: 'null'
                            variant:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Variant
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/sample.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/sample.png
                                    primary_image:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/primary.png
                                    price:
                                      type:
                                        - string
                                        - 'null'
                                      example: '34.44'
                                    price_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $34.44
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    options:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          title:
                                            type: string
                                            example: Size
                                          value:
                                            type: string
                                            example: XL
                                    physical:
                                      type:
                                        - boolean
                                        - 'null'
                                      example: true
                                    unit_of_size:
                                      type:
                                        - string
                                        - 'null'
                                      example: cm
                                    height:
                                      type:
                                        - number
                                        - 'null'
                                      example: 13
                                    width:
                                      type:
                                        - number
                                        - 'null'
                                      example: 6
                                    length:
                                      type:
                                        - number
                                        - 'null'
                                      example: 12
                                    unit_of_weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: kg
                                    weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                    hs_code:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                - type: 'null'
                            errors:
                              oneOf:
                                - type: 'null'
                                - type: array
                                  items:
                                    type: object
                                  example:
                                    - country:
                                        - >-
                                          This product is not available for this
                                          country. Please change your country
                            bundled_items:
                              type: array
                              items:
                                type: object
                                description: Bundled items for bundle products
                                properties:
                                  variant_id:
                                    type: integer
                                    example: 1
                                  product_id:
                                    type: integer
                                    example: 1
                                  product_title:
                                    type: string
                                    example: Product Title
                                  variant_title:
                                    type: string
                                    example: Variant Title
                                  option_titles:
                                    type: array
                                    example:
                                      - Option 1
                                      - Option 2
                                  quantity:
                                    type: integer
                                    example: 1
                                  display_to_customer:
                                    type: boolean
                                    example: true
                      ship_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      bill_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      shipping_method:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: string
                            example: standard-shipping
                          name:
                            type: string
                            example: Standard Shipping
                      available_shipping_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: standard-shipping
                            title:
                              type: string
                              example: Standard Shipping
                            price:
                              type:
                                - number
                                - string
                              example: 5.99
                            price_label:
                              type: string
                              example: $5.99
                            delivery_time_estimate:
                              type: string
                              example: 3-5 business days
                      available_payment_methods:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - credit_card
                                name:
                                  type: string
                                  example: Credit Card
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                apple_pay:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method supports
                                    ApplePay or not 
                                bogus_gateway:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is a Bogus
                                    instance or not.
                                tokenize_path:
                                  type:
                                    - string
                                    - 'null'
                                  description: Path to tokenize, if applicable.
                                token_provider:
                                  type: string
                                  enum:
                                    - spreedly
                                    - vgs
                                  description: >-
                                    Determines if payment tokenization is via
                                    spreedly or VGS
                                apple_pay_merchant_identifier:
                                  type:
                                    - string
                                    - 'null'
                                  example: merchant.mycompany.com
                                  description: >-
                                    If ApplePay is supported, returns the
                                    merchant identifier registered with Apple,
                                    else returns nil
                                supported_brands:
                                  type: array
                                  items:
                                    type: string
                                  example:
                                    - visa
                                    - master
                                    - american_express
                                    - discover
                                publishable_key:
                                  type:
                                    - string
                                    - 'null'
                                  example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                  description: >-
                                    If publishable key is set for Hyperswitch,
                                    returns the publishable key, else returns
                                    nil
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                              required:
                                - id
                                - type
                                - name
                                - supported_brands
                                - test
                                - sandbox
                                - apple_pay
                                - apple_pay_merchant_identifier
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - klarna
                                name:
                                  type: string
                                  example: Klarna
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                      country:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          iso:
                            type: string
                            example: US
                          name:
                            type: string
                            example: United States
                          iso_name:
                            type: string
                            example: UNITED STATES
                          iso3:
                            type: string
                            example: USA
                          currency_code:
                            type: string
                            example: USD
                          currency_symbol:
                            type: string
                            example: $
                          province_required:
                            type: boolean
                            example: false
                          tax_enabled:
                            type:
                              - boolean
                              - 'null'
                            example: true
                          price_inclusive_of_tax:
                            type: boolean
                            example: false
                          price_inclusive_tax_name:
                            type:
                              - string
                              - 'null'
                            example: VAT
                      type:
                        type: string
                        enum:
                          - regular
                          - enrollment
                        example: regular
                      enrollment_pack_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      enrollment_pack:
                        type:
                          - object
                          - 'null'
                        properties:
                          enrollment_pack_id:
                            type: integer
                            example: 1
                          additional_volume:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          slug:
                            type: string
                            example: test-enrollment-pack
                          description:
                            type:
                              - object
                              - 'null'
                              - string
                            properties:
                              id:
                                type: integer
                                example: 111
                              name:
                                type: string
                                example: description
                              body:
                                type: string
                                example: >-
                                  <div>Try the latest and greatest of our sugar
                                  zip packs. Guaranteed to make you skinner and
                                  cure cancer.</div>
                              record_type:
                                type: string
                                example: EnrollmentPack
                              record_id:
                                type: integer
                                example: 1
                              created_at:
                                type: string
                                format: date_time
                                example: '2025-01-16T04:22:43.809Z'
                              updated_at:
                                type: string
                                format: date_time
                                example: '2025-01-22T10:23:52.941Z'
                              locale:
                                type: string
                                example: en
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: 10
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.00
                          images:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2
                                relateable_type:
                                  type: string
                                  example: EnrollmentPack
                                relateable_id:
                                  type: integer
                                  example: 1
                                image_url:
                                  type: string
                                  example: >-
                                    https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                image_path:
                                  type: string
                                  example: jITWaU14QGe0y5AFgY7P_00179.svg
                                position:
                                  type: integer
                                  example: 1
                                shopify_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                                created_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                updated_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                external_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 625
                                allow_subscription:
                                  type: boolean
                                  example: true
                                cv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                cv_in_currency:
                                  type: string
                                  example: $0.00
                                cv_total:
                                  type: integer
                                  example: 0
                                enrollment:
                                  type: boolean
                                  example: true
                                enrollment_pack_id:
                                  type: integer
                                  example: 1
                                price:
                                  type: string
                                  example: '11.13'
                                price_in_currency:
                                  type: string
                                  example: $11.13
                                product_title:
                                  type: string
                                  example: Zip Pack Sample Pack (30)
                                quantity:
                                  type: integer
                                  example: 1
                                qv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                qv_in_currency:
                                  type: string
                                  example: $0.00
                                qv_total:
                                  type: integer
                                  example: 0
                                subscribe_and_save:
                                  type:
                                    - string
                                    - 'null'
                                  example: '-1988.87'
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $-1,988.87
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $-1,988.87
                                subscription:
                                  type: boolean
                                  example: false
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_only:
                                  type: boolean
                                  example: false
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_price:
                                  type: string
                                  example: '2000.0'
                                subscription_price_in_currency:
                                  type: string
                                  example: $2,000.00
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  format: date
                                  example: '2025-02-28'
                                tax:
                                  type: string
                                  example: '0.0'
                                tax_in_currency:
                                  type: string
                                  example: $0.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: null
                                display_to_customer:
                                  type: boolean
                                  example: false
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                          price:
                            type: string
                            example: '11.13'
                          price_in_currency:
                            type: string
                            example: $11.13
                          subscription_price:
                            type:
                              - string
                              - integer
                            example: 2000
                          subscription_price_in_currency:
                            type: string
                            example: $2,000.00
                          title:
                            type: string
                            example: enroll product
                          token:
                            type: string
                            example: NxL22AqLRRisfyF9LqxxWRak
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      recurring:
                        oneOf:
                          - type: array
                            items:
                              type: object
                              properties:
                                subtotal:
                                  type: string
                                  example: '10.0'
                                subtotal_in_currency:
                                  type: string
                                  example: $10.0
                                interval:
                                  type: integer
                                  example: 1
                                interval_unit:
                                  type: string
                                  example: month
                                subtotal_for_display:
                                  type: string
                                  example: $10.00 every 1 month
                                start_date:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-05-27'
                          - type: 'null'
                        default:
                          - subtotal: '10.0'
                            subtotal_in_currency: $10.0
                            interval: 1
                            interval_unit: month
                            subtotal_for_display: $10.00 every 1 month
                            start_date: '2025-05-27'
                      messages:
                        type: object
                        additionalProperties: true
                        example:
                          errors:
                            - Insufficient inventory
                            - Product no longer available
                          warnings:
                            - Low stock warning
                            - Shipping delays expected
                          info:
                            - Free shipping available
                            - Volume discount applied
                      points_enabled:
                        type: boolean
                        example: true
                      points_applied:
                        type: integer
                        example: 500
                        description: Number of points applied to the cart
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Currency value of applied points
                      customer_total_points:
                        type: integer
                        example: 1000
                        description: Customer's total available points balance
                      customer_total_points_in_currency:
                        type: number
                        example: 10
                        description: Currency value of available points
                      remaining_customer_points:
                        type: integer
                        example: 500
                        description: Customer's remaining points after cart redemption
                      remaining_customer_points_amount_in_currency:
                        type: number
                        example: 5
                        description: >-
                          Currency value of remaining points after cart
                          redemption
                      remaining_cart_amount_after_points:
                        type: number
                        example: 95
                        description: Amount to charge to card after points redemption
                      remaining_cart_amount_after_points_in_currency:
                        type:
                          - string
                        example: $95.00
                        description: >-
                          Amount in currency to charge to card after points
                          redemption
                      max_applicable_points:
                        type: integer
                        example: 500
                        description: Maximum points that can be applied to this cart
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      checkout_url:
                        type: string
                        example: https://checkout.fluid.com/checkout?jwt=abc123
                      shop_url:
                        type: string
                        example: https://myco.fluid.app
        '400':
          description: no cart item specified
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: No cart item specified
        '404':
          description: item id not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Cart item not found
        '410':
          description: cart is in authorized enrollment state
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Cart is in authorized state and cannot be modified
                  errors:
                    type: object
                    example:
                      cart:
                        - is in authorized state and cannot be modified
                  meta:
                    type: object
                    properties:
                      shop_url:
                        type: string
                        example: https://example.myshopify.com
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      cart:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 123
                          state:
                            type: string
                            example: start
                          processed:
                            type: boolean
                            example: false
                            description: >-
                              Determines if a cart payment has been processed or
                              not.
                          valid_for_checkout:
                            type: boolean
                            example: true
                          buyer_rep_id:
                            type:
                              - integer
                              - 'null'
                            example: 1
                          buyer_rep:
                            oneOf:
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 2
                                  email:
                                    type:
                                      - string
                                      - 'null'
                                    example: buyer.rep@example.com
                                  full_name:
                                    type:
                                      - string
                                      - 'null'
                                    example: John Doe
                                  image_url:
                                    type:
                                      - string
                                      - 'null'
                                    example: https://example.com/image.png
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: '123241'
                                required:
                                  - id
                              - type: 'null'
                          volume_rep:
                            oneOf:
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 2
                                  email:
                                    type:
                                      - string
                                      - 'null'
                                    example: volume.rep@example.com
                                  full_name:
                                    type:
                                      - string
                                      - 'null'
                                    example: John Doe
                                  image_url:
                                    type:
                                      - string
                                      - 'null'
                                    example: https://example.com/image.png
                                required:
                                  - id
                              - type: 'null'
                          currency_symbol:
                            type: string
                            example: $
                          currency_code:
                            type: string
                            example: USD
                          shipping_total_for_display:
                            type: string
                            example: Free
                          phone:
                            type:
                              - string
                              - 'null'
                            example: '4035551212'
                          payment_method_auto_assignable:
                            type: boolean
                            example: true
                            description: >-
                              Determines if a payment method can be
                              auto-assigned to the cart.
                          attribution:
                            oneOf:
                              - type: object
                                oneOf:
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      share_guid:
                                        type: string
                                        example: james-bond007
                                    required:
                                      - id
                                      - share_guid
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      email:
                                        type: string
                                        example: james.bond@gmail.com
                                    required:
                                      - id
                                      - email
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      username:
                                        type: string
                                        example: jaamball234
                                    required:
                                      - id
                                      - username
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      fluid_rep_id:
                                        type: integer
                                        example: 23493
                                    required:
                                      - id
                                      - fluid_rep_id
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      external_id:
                                        type:
                                          - string
                                          - 'null'
                                        example: w3sdf92
                                    required:
                                      - id
                              - type: 'null'
                            default:
                              id: 456
                              share_guid: james-bond007
                          agreements:
                            type: array
                            items:
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                  example: 1
                                required:
                                  type: boolean
                                  example: true
                                title:
                                  type: string
                                  example: Terms and Conditions
                                show_path:
                                  type: string
                                  example: /terms
                                enrollment_pack_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                          amount_total:
                            type: string
                            example: '121.65'
                          amount_total_in_currency:
                            type: string
                            example: $121.65 (USD)
                          sub_total:
                            type: string
                            example: '100.00'
                          sub_total_in_currency:
                            type: string
                            example: $100.00 (USD)
                          subtotal_after_discounts:
                            type: string
                            example: '90.00'
                          tax_total:
                            type: string
                            example: '20.00'
                          tax_total_in_currency:
                            type: string
                            example: $20.00 (USD)
                          shipping_total:
                            type:
                              - string
                              - 'null'
                            example: '1.65'
                          shipping_total_in_currency:
                            type: string
                            example: $1.65 (USD)
                          shipping_discount:
                            type: number
                            example: 10.25
                          discount_total:
                            type: string
                            example: '2.99'
                          discount_total_in_currency:
                            type: string
                            example: $2.99 (USD)
                          discount_breakdown:
                            type: object
                            properties:
                              internal_discounts:
                                type: number
                                example: 15
                              external_discounts:
                                type: number
                                example: 10
                              total_discounts:
                                type: number
                                example: 25
                          external_discount:
                            type: object
                            properties:
                              total:
                                type: number
                                example: 10
                              calculated_at:
                                type:
                                  - string
                                  - 'null'
                                format: date-time
                                example: '2024-01-10T15:30:00Z'
                              sources:
                                type: object
                                additionalProperties:
                                  type: object
                                  properties:
                                    amount:
                                      type: number
                                      example: 6
                                    description:
                                      type: string
                                      example: Gold tier discount
                                    metadata:
                                      type: object
                                  required:
                                    - amount
                                    - description
                          transaction_fee:
                            type:
                              - number
                              - string
                            example: '1.90'
                          transaction_fee_in_currency:
                            type: string
                            example: $1.90 (USD)
                          cv_total:
                            type: integer
                            example: 10
                          qv_total:
                            type: integer
                            example: 15
                          company:
                            type: object
                            properties:
                              id:
                                type: integer
                              name:
                                type: string
                              primary_domain_hostname:
                                type:
                                  - string
                                  - 'null'
                                example: fluid.com
                              subdomain:
                                type:
                                  - string
                                  - 'null'
                                example: myco
                              logo_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/logo.png
                              fluid_shop:
                                type:
                                  - string
                                  - 'null'
                                example: https://fluid-sample-shop.fluid.com
                              collect_phone:
                                type: boolean
                                example: true
                              require_phone:
                                type: boolean
                                example: false
                              require_billing_zip:
                                type: boolean
                                example: false
                              checkout_primary_button_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#000000'
                              checkout_primary_text_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#FFFFFF'
                              checkout_secondary_button_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#FFFFFF'
                              checkout_secondary_text_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#000000'
                              favicon_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/favicon.ico
                              order_on_behalf:
                                type: boolean
                                example: false
                              use_juspay_gateway:
                                type: boolean
                                example: false
                              reward_points_enabled:
                                type: boolean
                                example: false
                          payment_account:
                            type:
                              - string
                              - 'null'
                            example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                          payment_method:
                            oneOf:
                              - type: 'null'
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: CreditCard
                                  payment_method_type:
                                    type: string
                                    example: visa
                                  last_four:
                                    type: string
                                    example: '1234'
                                  exp_month:
                                    type: string
                                    example: '12'
                                  exp_year:
                                    type: string
                                    example: '2025'
                                  logo_url:
                                    type: string
                                    example: https://example.com/image.svg
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Paypal
                                  status:
                                    type: string
                                    example: active
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Affirm
                                  affirm_id:
                                    type: string
                                    example: affirm_123
                                  status:
                                    type: string
                                    example: authorized
                                  checkout_id:
                                    type: string
                                    example: checkout_456
                                  created:
                                    type: string
                                    example: '2025-01-01T00:00:00Z'
                                  auth_expiration:
                                    type: string
                                    example: '2025-01-02T00:00:00Z'
                                  currency:
                                    type: string
                                    example: USD
                                  amount:
                                    type: string
                                    example: '100.00'
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Klarna
                                  session_id:
                                    type: string
                                    example: klarna_session_789
                                  intent:
                                    type: string
                                    example: buy
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Droplet
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: SomeCitcon
                          email:
                            type:
                              - string
                              - 'null'
                            example: user@example.com
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: '10.45'
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.45
                          discount_codes:
                            type: array
                            items:
                              type: string
                            example:
                              - DISCOUNT10
                              - DISCOUNT11
                          language_iso:
                            type:
                              - string
                              - 'null'
                            example: en
                          cart_token:
                            type: string
                            example: abc123
                          immutable_items:
                            type: boolean
                            example: false
                          digital_only:
                            type: boolean
                            example: false
                          requires_3ds:
                            type: boolean
                            example: false
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 101
                                price:
                                  type: string
                                  example: '43.41'
                                price_in_currency:
                                  type: string
                                  example: $43.41
                                tax:
                                  type: string
                                  example: '2.99'
                                tax_in_currency:
                                  type: string
                                  example: $2.99
                                cv:
                                  type: integer
                                  example: 5
                                cv_total:
                                  type: integer
                                  example: 15
                                qv:
                                  type: integer
                                  example: 7
                                qv_total:
                                  type: integer
                                  example: 21
                                discount_amount:
                                  type: string
                                  example: '10'
                                free_item:
                                  type: boolean
                                  example: false
                                discount_amount_in_currency:
                                  type: string
                                  example: $10.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                enrollment_pack_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                display_to_customer:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                product_title:
                                  type:
                                    - string
                                    - 'null'
                                  example: Sample Product
                                quantity:
                                  type: integer
                                  example: 3
                                subscription:
                                  type: boolean
                                  example: true
                                enrollment:
                                  type: boolean
                                  example: false
                                allow_subscription:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_only:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_price:
                                  type:
                                    - number
                                    - string
                                    - 'null'
                                  example: 10.5
                                subscription_price_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $10.50
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-02-12'
                                subscribe_and_save:
                                  type:
                                    - number
                                    - string
                                    - 'null'
                                  example: 2.99
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $2.99
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $2.99
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: Surcharge
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                product:
                                  oneOf:
                                    - type: object
                                      properties:
                                        id:
                                          type: integer
                                          example: 1
                                        title:
                                          type: string
                                          example: Sample Product
                                        introduction:
                                          type:
                                            - string
                                            - 'null'
                                          example: Sample Product Description
                                        cv:
                                          type: integer
                                          example: 10
                                        external_id:
                                          type:
                                            - string
                                            - 'null'
                                          example: ext-prod-123
                                        image_path:
                                          type:
                                            - string
                                            - 'null'
                                          example: /images/product.png
                                        image_url:
                                          type:
                                            - string
                                            - 'null'
                                          example: https://example.com/images/product.png
                                        price:
                                          type: string
                                          example: '29.99'
                                        price_in_currency:
                                          type: string
                                          example: $29.99
                                        sku:
                                          type:
                                            - string
                                            - 'null'
                                          example: SKU12345
                                        tax:
                                          type: string
                                          example: '2.99'
                                        tax_in_currency:
                                          type: string
                                          example: $2.99
                                        metadata:
                                          type: object
                                          example:
                                            shopify_product_id: 9876054868270
                                        metafields:
                                          type: array
                                          items:
                                            title: LegacyMetafield
                                            type: object
                                            properties:
                                              namespace:
                                                description: >-
                                                  A container for related metafields.
                                                  Commonly used to group metafields by app
                                                  or functionality.
                                                example: custom
                                                type: string
                                                maxLength: 20
                                                pattern: ^[a-zA-Z0-9_]+$
                                              key:
                                                description: >-
                                                  The unique identifier for the metafield
                                                  within its namespace. Must be unique per
                                                  namespace and owner.
                                                example: material
                                                type: string
                                                maxLength: 30
                                                pattern: ^[a-zA-Z0-9_]+$
                                              value:
                                                description: >-
                                                  The actual data stored in the metafield.
                                                  Type depends on value_type.
                                                example: cotton
                                                type:
                                                  - string
                                                  - integer
                                                  - object
                                                  - boolean
                                                  - number
                                              value_type:
                                                description: >-
                                                  The data type that defines how the value
                                                  should be interpreted and validated.
                                                example: single_line_text_field
                                                type: string
                                              description:
                                                description: >-
                                                  Optional human-readable description
                                                  explaining the purpose of this
                                                  metafield.
                                                example: >-
                                                  The primary material used in this
                                                  product
                                                type:
                                                  - string
                                                  - 'null'
                                              created_at:
                                                description: >-
                                                  Timestamp when the metafield was
                                                  created.
                                                example: '2021-01-01T00:00:00Z'
                                                type: string
                                                format: date-time
                                              updated_at:
                                                description: >-
                                                  Timestamp when the metafield was last
                                                  updated.
                                                example: '2021-01-01T00:00:00Z'
                                                type: string
                                                format: date-time
                                              locked:
                                                description: >-
                                                  Whether this metafield is locked and
                                                  cannot be updated or deleted directly.
                                                example: false
                                                type:
                                                  - boolean
                                                  - 'null'
                                                  - 'null'
                                              metafield_definition:
                                                description: >-
                                                  The definition that defines validation
                                                  rules and structure for this metafield
                                                type:
                                                  - 'null'
                                                  - object
                                            required:
                                              - namespace
                                              - key
                                              - value
                                              - value_type
                                              - description
                                              - created_at
                                              - updated_at
                                              - metafield_definition
                                    - type: 'null'
                                variant:
                                  oneOf:
                                    - type: object
                                      properties:
                                        id:
                                          type: integer
                                          example: 1
                                        title:
                                          type:
                                            - string
                                            - 'null'
                                          example: Sample Variant
                                        image_path:
                                          type:
                                            - string
                                            - 'null'
                                          example: /images/sample.png
                                        image_url:
                                          type:
                                            - string
                                            - 'null'
                                          example: https://example.com/images/sample.png
                                        primary_image:
                                          type:
                                            - string
                                            - 'null'
                                          example: https://example.com/images/primary.png
                                        price:
                                          type:
                                            - string
                                            - 'null'
                                          example: '34.44'
                                        price_in_currency:
                                          type:
                                            - string
                                            - 'null'
                                          example: $34.44
                                        sku:
                                          type:
                                            - string
                                            - 'null'
                                          example: SKU12345
                                        options:
                                          type: array
                                          items:
                                            type: object
                                            properties:
                                              title:
                                                type: string
                                                example: Size
                                              value:
                                                type: string
                                                example: XL
                                        physical:
                                          type:
                                            - boolean
                                            - 'null'
                                          example: true
                                        unit_of_size:
                                          type:
                                            - string
                                            - 'null'
                                          example: cm
                                        height:
                                          type:
                                            - number
                                            - 'null'
                                          example: 13
                                        width:
                                          type:
                                            - number
                                            - 'null'
                                          example: 6
                                        length:
                                          type:
                                            - number
                                            - 'null'
                                          example: 12
                                        unit_of_weight:
                                          type:
                                            - string
                                            - 'null'
                                          example: kg
                                        weight:
                                          type:
                                            - string
                                            - 'null'
                                          example: '3.2'
                                        hs_code:
                                          type:
                                            - string
                                            - 'null'
                                          example: '3.2'
                                    - type: 'null'
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                                bundled_items:
                                  type: array
                                  items:
                                    type: object
                                    description: Bundled items for bundle products
                                    properties:
                                      variant_id:
                                        type: integer
                                        example: 1
                                      product_id:
                                        type: integer
                                        example: 1
                                      product_title:
                                        type: string
                                        example: Product Title
                                      variant_title:
                                        type: string
                                        example: Variant Title
                                      option_titles:
                                        type: array
                                        example:
                                          - Option 1
                                          - Option 2
                                      quantity:
                                        type: integer
                                        example: 1
                                      display_to_customer:
                                        type: boolean
                                        example: true
                          ship_to:
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                                example: 1
                              name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              first_name:
                                type:
                                  - string
                                  - 'null'
                                example: John
                              last_name:
                                type:
                                  - string
                                  - 'null'
                                example: Doe
                              address1:
                                type: string
                                example: 123 Main St
                              address2:
                                type:
                                  - string
                                  - 'null'
                                example: Apt 4B
                              address3:
                                type:
                                  - string
                                  - 'null'
                                example: Building 5
                              city:
                                type: string
                                example: New York
                              state:
                                type: string
                                example: NY
                              postal_code:
                                type: string
                                example: '10001'
                              country_code:
                                type: string
                                example: US
                                description: >-
                                  country_id takes precedence if both country_id
                                  and country_code provided.
                              subdivision_code:
                                type:
                                  - string
                                  - 'null'
                                example: NY
                              default:
                                type: boolean
                                example: true
                          bill_to:
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                                example: 1
                              name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              first_name:
                                type:
                                  - string
                                  - 'null'
                                example: John
                              last_name:
                                type:
                                  - string
                                  - 'null'
                                example: Doe
                              address1:
                                type: string
                                example: 123 Main St
                              address2:
                                type:
                                  - string
                                  - 'null'
                                example: Apt 4B
                              address3:
                                type:
                                  - string
                                  - 'null'
                                example: Building 5
                              city:
                                type: string
                                example: New York
                              state:
                                type: string
                                example: NY
                              postal_code:
                                type: string
                                example: '10001'
                              country_code:
                                type: string
                                example: US
                                description: >-
                                  country_id takes precedence if both country_id
                                  and country_code provided.
                              subdivision_code:
                                type:
                                  - string
                                  - 'null'
                                example: NY
                              default:
                                type: boolean
                                example: true
                          shipping_method:
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: string
                                example: standard-shipping
                              name:
                                type: string
                                example: Standard Shipping
                          available_shipping_methods:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                  example: standard-shipping
                                title:
                                  type: string
                                  example: Standard Shipping
                                price:
                                  type:
                                    - number
                                    - string
                                  example: 5.99
                                price_label:
                                  type: string
                                  example: $5.99
                                delivery_time_estimate:
                                  type: string
                                  example: 3-5 business days
                          available_payment_methods:
                            type: array
                            items:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1337
                                    uuid:
                                      type: string
                                      example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                    type:
                                      type: string
                                      enum:
                                        - credit_card
                                    name:
                                      type: string
                                      example: Credit Card
                                    image_url:
                                      type: string
                                      example: https://example.com/image.png
                                    test:
                                      type: boolean
                                      example: true
                                      description: >-
                                        Determines if payment method is test
                                        instance or not. By default, set to
                                        `true`
                                    sandbox:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method is sandbox
                                        instance or not. By default, set to
                                        `false`
                                    apple_pay:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method supports
                                        ApplePay or not 
                                    bogus_gateway:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method is a Bogus
                                        instance or not.
                                    tokenize_path:
                                      type:
                                        - string
                                        - 'null'
                                      description: Path to tokenize, if applicable.
                                    token_provider:
                                      type: string
                                      enum:
                                        - spreedly
                                        - vgs
                                      description: >-
                                        Determines if payment tokenization is
                                        via spreedly or VGS
                                    apple_pay_merchant_identifier:
                                      type:
                                        - string
                                        - 'null'
                                      example: merchant.mycompany.com
                                      description: >-
                                        If ApplePay is supported, returns the
                                        merchant identifier registered with
                                        Apple, else returns nil
                                    supported_brands:
                                      type: array
                                      items:
                                        type: string
                                      example:
                                        - visa
                                        - master
                                        - american_express
                                        - discover
                                    publishable_key:
                                      type:
                                        - string
                                        - 'null'
                                      example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                      description: >-
                                        If publishable key is set for
                                        Hyperswitch, returns the publishable
                                        key, else returns nil
                                    customer_details_schema:
                                      type: object
                                      example: {}
                                      description: >-
                                        Schema defining required customer
                                        details for this payment method
                                  required:
                                    - id
                                    - type
                                    - name
                                    - supported_brands
                                    - test
                                    - sandbox
                                    - apple_pay
                                    - apple_pay_merchant_identifier
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1337
                                    uuid:
                                      type: string
                                      example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                    type:
                                      type: string
                                      enum:
                                        - klarna
                                    name:
                                      type: string
                                      example: Klarna
                                    image_url:
                                      type: string
                                      example: https://example.com/image.png
                                    test:
                                      type: boolean
                                      example: true
                                      description: >-
                                        Determines if payment method is test
                                        instance or not. By default, set to
                                        `true`
                                    sandbox:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method is sandbox
                                        instance or not. By default, set to
                                        `false`
                                    customer_details_schema:
                                      type: object
                                      example: {}
                                      description: >-
                                        Schema defining required customer
                                        details for this payment method
                          country:
                            type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              iso:
                                type: string
                                example: US
                              name:
                                type: string
                                example: United States
                              iso_name:
                                type: string
                                example: UNITED STATES
                              iso3:
                                type: string
                                example: USA
                              currency_code:
                                type: string
                                example: USD
                              currency_symbol:
                                type: string
                                example: $
                              province_required:
                                type: boolean
                                example: false
                              tax_enabled:
                                type:
                                  - boolean
                                  - 'null'
                                example: true
                              price_inclusive_of_tax:
                                type: boolean
                                example: false
                              price_inclusive_tax_name:
                                type:
                                  - string
                                  - 'null'
                                example: VAT
                          type:
                            type: string
                            enum:
                              - regular
                              - enrollment
                            example: regular
                          enrollment_pack_id:
                            type:
                              - integer
                              - 'null'
                            example: 1
                          enrollment_pack:
                            type:
                              - object
                              - 'null'
                            properties:
                              enrollment_pack_id:
                                type: integer
                                example: 1
                              additional_volume:
                                type:
                                  - integer
                                  - 'null'
                                example: 10
                              slug:
                                type: string
                                example: test-enrollment-pack
                              description:
                                type:
                                  - object
                                  - 'null'
                                  - string
                                properties:
                                  id:
                                    type: integer
                                    example: 111
                                  name:
                                    type: string
                                    example: description
                                  body:
                                    type: string
                                    example: >-
                                      <div>Try the latest and greatest of our
                                      sugar zip packs. Guaranteed to make you
                                      skinner and cure cancer.</div>
                                  record_type:
                                    type: string
                                    example: EnrollmentPack
                                  record_id:
                                    type: integer
                                    example: 1
                                  created_at:
                                    type: string
                                    format: date_time
                                    example: '2025-01-16T04:22:43.809Z'
                                  updated_at:
                                    type: string
                                    format: date_time
                                    example: '2025-01-22T10:23:52.941Z'
                                  locale:
                                    type: string
                                    example: en
                              enrollment_fee:
                                type:
                                  - number
                                  - string
                                example: 10
                              enrollment_fee_in_currency:
                                type: string
                                example: $10.00
                              images:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 2
                                    relateable_type:
                                      type: string
                                      example: EnrollmentPack
                                    relateable_id:
                                      type: integer
                                      example: 1
                                    image_url:
                                      type: string
                                      example: >-
                                        https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                    image_path:
                                      type: string
                                      example: jITWaU14QGe0y5AFgY7P_00179.svg
                                    position:
                                      type: integer
                                      example: 1
                                    shopify_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: null
                                    created_at:
                                      type: string
                                      format: date_time
                                      example: '2025-01-16T04:22:44.870Z'
                                    updated_at:
                                      type: string
                                      format: date_time
                                      example: '2025-01-16T04:22:44.870Z'
                                    external_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: null
                              items:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 625
                                    allow_subscription:
                                      type: boolean
                                      example: true
                                    cv:
                                      type:
                                        - number
                                        - string
                                      example: 0
                                    cv_in_currency:
                                      type: string
                                      example: $0.00
                                    cv_total:
                                      type: integer
                                      example: 0
                                    enrollment:
                                      type: boolean
                                      example: true
                                    enrollment_pack_id:
                                      type: integer
                                      example: 1
                                    price:
                                      type: string
                                      example: '11.13'
                                    price_in_currency:
                                      type: string
                                      example: $11.13
                                    product_title:
                                      type: string
                                      example: Zip Pack Sample Pack (30)
                                    quantity:
                                      type: integer
                                      example: 1
                                    qv:
                                      type:
                                        - number
                                        - string
                                      example: 0
                                    qv_in_currency:
                                      type: string
                                      example: $0.00
                                    qv_total:
                                      type: integer
                                      example: 0
                                    subscribe_and_save:
                                      type:
                                        - string
                                        - 'null'
                                      example: '-1988.87'
                                    subscribe_and_save_for_display:
                                      type:
                                        - string
                                        - 'null'
                                      example: Subscribe and save $-1,988.87
                                    subscribe_and_save_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $-1,988.87
                                    subscription:
                                      type: boolean
                                      example: false
                                    subscription_interval:
                                      type:
                                        - integer
                                        - 'null'
                                      example: 1
                                    subscription_interval_unit:
                                      type:
                                        - string
                                        - 'null'
                                      example: month
                                    subscription_only:
                                      type: boolean
                                      example: false
                                    subscription_plan_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: 1
                                    subscription_plans:
                                      oneOf:
                                        - type: array
                                          items:
                                            title: Commerce::SubscriptionPlan
                                            type: object
                                            properties:
                                              id:
                                                type: integer
                                              name:
                                                example: Test Subscription Plan
                                                type: string
                                              billing_interval:
                                                example: 1
                                                type: integer
                                                default: 1
                                                minimum: 1
                                                maximum: 29
                                              billing_interval_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type: string
                                                default: month
                                              billing_frequency_in_words:
                                                example: 2 Months
                                                type: string
                                              shipping_interval:
                                                example: 1
                                                type: integer
                                                default: 1
                                                minimum: 1
                                                maximum: 29
                                              shipping_interval_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type: string
                                                default: month
                                              volume_interval:
                                                example: 1
                                                type: integer
                                                default: 1
                                                minimum: 1
                                                maximum: 29
                                              volume_interval_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type: string
                                                default: month
                                              trial_period:
                                                example: 1
                                                type:
                                                  - integer
                                                  - 'null'
                                                minimum: 1
                                              trial_period_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type:
                                                  - string
                                                  - 'null'
                                              split_volume:
                                                example: true
                                                type: boolean
                                                default: false
                                              allow_max_billing_cycles:
                                                example: true
                                                type: boolean
                                                default: false
                                              max_billing_cycles:
                                                example: 3
                                                type:
                                                  - integer
                                                  - 'null'
                                              company_default:
                                                example: false
                                                type:
                                                  - boolean
                                                  - 'null'
                                                default: false
                                              products_count:
                                                example: 10
                                                type:
                                                  - integer
                                                  - 'null'
                                              subscribers_count:
                                                example: 10
                                                type:
                                                  - integer
                                                  - 'null'
                                              price:
                                                type: string
                                              price_in_currency:
                                                type: string
                                              subscription_start:
                                                type: string
                                              subscribe_and_save:
                                                type:
                                                  - string
                                                  - 'null'
                                              subscribe_and_save_in_currency:
                                                type:
                                                  - string
                                                  - 'null'
                                              subscribe_and_save_for_display:
                                                type:
                                                  - string
                                                  - 'null'
                                            required:
                                              - id
                                              - name
                                              - billing_interval
                                              - billing_interval_unit
                                              - billing_frequency_in_words
                                              - shipping_interval
                                              - shipping_interval_unit
                                              - volume_interval
                                              - volume_interval_unit
                                              - split_volume
                                              - allow_max_billing_cycles
                                              - price
                                              - price_in_currency
                                              - subscription_start
                                              - subscribe_and_save
                                              - subscribe_and_save_in_currency
                                              - subscribe_and_save_for_display
                                        - type: 'null'
                                    subscription_price:
                                      type: string
                                      example: '2000.0'
                                    subscription_price_in_currency:
                                      type: string
                                      example: $2,000.00
                                    subscription_start:
                                      type:
                                        - string
                                        - 'null'
                                      format: date
                                      example: '2025-02-28'
                                    tax:
                                      type: string
                                      example: '0.0'
                                    tax_in_currency:
                                      type: string
                                      example: $0.00
                                    total_after_discounts:
                                      type: string
                                      example: '90.00'
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: null
                                    display_to_customer:
                                      type: boolean
                                      example: false
                                    metadata:
                                      type: object
                                      description: >-
                                        A JSON object that can store any custom
                                        data structure
                                      example: {}
                                    errors:
                                      oneOf:
                                        - type: 'null'
                                        - type: array
                                          items:
                                            type: object
                                          example:
                                            - country:
                                                - >-
                                                  This product is not available for this
                                                  country. Please change your country
                              price:
                                type: string
                                example: '11.13'
                              price_in_currency:
                                type: string
                                example: $11.13
                              subscription_price:
                                type:
                                  - string
                                  - integer
                                example: 2000
                              subscription_price_in_currency:
                                type: string
                                example: $2,000.00
                              title:
                                type: string
                                example: enroll product
                              token:
                                type: string
                                example: NxL22AqLRRisfyF9LqxxWRak
                          metadata:
                            type: object
                            description: >-
                              A JSON object that can store any custom data
                              structure.
                          recurring:
                            oneOf:
                              - type: array
                                items:
                                  type: object
                                  properties:
                                    subtotal:
                                      type: string
                                      example: '10.0'
                                    subtotal_in_currency:
                                      type: string
                                      example: $10.0
                                    interval:
                                      type: integer
                                      example: 1
                                    interval_unit:
                                      type: string
                                      example: month
                                    subtotal_for_display:
                                      type: string
                                      example: $10.00 every 1 month
                                    start_date:
                                      type:
                                        - string
                                        - 'null'
                                      example: '2025-05-27'
                              - type: 'null'
                            default:
                              - subtotal: '10.0'
                                subtotal_in_currency: $10.0
                                interval: 1
                                interval_unit: month
                                subtotal_for_display: $10.00 every 1 month
                                start_date: '2025-05-27'
                          messages:
                            type: object
                            additionalProperties: true
                            example:
                              errors:
                                - Insufficient inventory
                                - Product no longer available
                              warnings:
                                - Low stock warning
                                - Shipping delays expected
                              info:
                                - Free shipping available
                                - Volume discount applied
                          points_enabled:
                            type: boolean
                            example: true
                          points_applied:
                            type: integer
                            example: 500
                            description: Number of points applied to the cart
                          points_applied_amount_in_currency:
                            type: number
                            example: 5
                            description: Currency value of applied points
                          customer_total_points:
                            type: integer
                            example: 1000
                            description: Customer's total available points balance
                          customer_total_points_in_currency:
                            type: number
                            example: 10
                            description: Currency value of available points
                          remaining_customer_points:
                            type: integer
                            example: 500
                            description: Customer's remaining points after cart redemption
                          remaining_customer_points_amount_in_currency:
                            type: number
                            example: 5
                            description: >-
                              Currency value of remaining points after cart
                              redemption
                          remaining_cart_amount_after_points:
                            type: number
                            example: 95
                            description: Amount to charge to card after points redemption
                          remaining_cart_amount_after_points_in_currency:
                            type:
                              - string
                            example: $95.00
                            description: >-
                              Amount in currency to charge to card after points
                              redemption
                          max_applicable_points:
                            type: integer
                            example: 500
                            description: Maximum points that can be applied to this cart
                required:
                  - error_message
                  - errors
                  - meta
        '422':
          description: cannot remove item from cart if immutable items is true
  /api/carts/{cart_token}/enroll:
    get:
      summary: Retrieves enroll for cart
      tags:
        - Carts
      operationId: getCartEnrollFields
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
        - name: placement
          in: query
          required: false
          schema:
            type: string
            enum:
              - pre_purchase
              - post_purchase
              - all
            default: all
      responses:
        '200':
          description: enroll fields found
          content:
            application/json:
              schema:
                type: object
                properties:
                  enroll:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      active:
                        type: boolean
                        example: true
                      default:
                        type: boolean
                        example: false
                      title:
                        type: string
                        example: Customer Details
                      fields:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 2
                            type:
                              type: string
                              example: text
                            metadata:
                              type:
                                - string
                                - 'null'
                              example: >-
                                {"element_type":"input","label":"Phone
                                Number","field_data_value":"","required":true,"auto_translate":true,"is_form_field":true,"targetIndex":0}]
                            title:
                              type: string
                              example: Email
                            position:
                              type: integer
                              example: 0
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '404':
          description: enroll not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Enroll not found
                  errors:
                    type: object
                    example:
                      enroll:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/carts/{cart_token}/payment_methods/{type}:
    post:
      summary: Sets cart payment method
      tags:
        - Carts
      operationId: setCartPaymentMethod
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
        - name: type
          in: path
          required: true
          description: Type of payment method
          schema:
            type: string
            enum:
              - credit_card
              - paypal
              - bread
              - affirm
              - klarna
              - g_cash_citcon
              - ali_pay_citcon
        - name: jwt
          in: query
          required: false
          description: >-
            JWT token to authenticate (Optional, if payment method id is not
            provided)
          schema:
            type: string
        - name: payment_method_id
          in: query
          required: false
          description: Payment Method id (Optional)
          schema:
            type: integer
      responses:
        '201':
          description: payment method added with billing address
          content:
            application/json:
              schema:
                type: object
                properties:
                  card:
                    type: object
                    properties:
                      user_id:
                        type:
                          - string
                          - 'null'
                        example: '123'
                      spreedly_token:
                        type: string
                        example: 01JKFTVM6Z44YFPSS9KK36KMSV
                      full_name:
                        type: string
                        example: John Doe
                      month:
                        type: integer
                        example: 3
                      year:
                        type: integer
                        example: 2032
                      number:
                        type: string
                        example: XXXX-XXXX-XXXX-4444
                      last_four_digits:
                        type: string
                        example: '4444'
                      first_six_digits:
                        type:
                          - string
                          - 'null'
                        example: '555555'
                      card_type:
                        type: string
                        example: master
                      address_id:
                        type:
                          - integer
                          - 'null'
                        example: 123
                      fingerprint:
                        type:
                          - string
                          - 'null'
                        example: 6eb05c4c7fc52fec38ef6e0651e8225be41c
                      default:
                        type: boolean
                        example: false
                      active:
                        type: boolean
                        example: true
                      created_at:
                        type: string
                        format: date-time
                        example: '2021-01-01T00:00:00Z'
                      updated_at:
                        type: string
                        format: date-time
                        example: '2021-01-01T00:00:00Z'
                      fluid:
                        type: boolean
                        example: true
                      test:
                        type:
                          - boolean
                          - 'null'
                        example: true
                      email:
                        type:
                          - string
                          - 'null'
                        example: john@example.com
                      customer_id:
                        type:
                          - string
                          - 'null'
                        example: '123'
                      fluid_pay_account_id:
                        type:
                          - string
                          - 'null'
                        example: '123'
                      token_provider:
                        type:
                          - string
                          - 'null'
                        example: vgs
                      token:
                        type:
                          - string
                          - 'null'
                        example: 01JKFTVM6Z44YFPSS9KK36KMSV
                      cvv_token:
                        type:
                          - string
                          - 'null'
                        example: '411'
                required:
                  - card
        '404':
          description: cart not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
                      example:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '410':
          description: Cart is processed and cannot be modified
        '422':
          description: invalid payment method
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - payment_method
              properties:
                billing_postal_code:
                  type: string
                  description: Billing postal code
                  example: '123'
                payment_method:
                  type: object
                  properties:
                    token_provider:
                      type: string
                      description: Payment method token provider (optional for spreedly)
                      example: vgs
                    token:
                      type: string
                      description: Payment method token from provider
                    last_four:
                      type: string
                      description: Last 4 digits of credit card (optional for vgs)
                    card_type:
                      type: string
                      description: >-
                        Type of credit card(visa, mastercard, etc)(optional for
                        vgs)
                    cvv_token:
                      type: string
                      description: CVV Token value
                    exp_month:
                      type: string
                      description: Expiration month (MM)
                    exp_year:
                      type: string
                      description: Expiration year (YYYY)
                    card_holder:
                      type: string
                      description: Card holder full name (optional for spreedly)
                    payment_account_id:
                      type: string
                      description: >-
                        Selected payment account id (required only when
                        integration_class
                                                                            is Droplet)
                billing_address:
                  type: object
                  properties:
                    address1:
                      type: string
                      description: Address line 1
                      example: 123 Main St
                    address2:
                      type: string
                      description: Address line 2
                      example: Apt 4B
                    city:
                      type: string
                      description: City
                      example: New York
                    state:
                      type: string
                      description: State
                      example: NY
                    zip:
                      type: string
                      description: Zip code
                      example: '10001'
                    country:
                      type: string
                      description: Country (required for paypal rest gateway)
                      example: US
                payment_account:
                  type: string
                  example: pa_MyW8X11CuEbZyGHUi0DOHZrlzFE1cXhA
                  description: >-
                    Payment account UUID; when supplied, it overrides implicit
                    payment account inference.
                customer_details:
                  type:
                    - object
                    - 'null'
                  properties:
                    email:
                      type: string
                      description: Email
                      example: john.doe@example.com
                    phone:
                      type: string
                      description: Phone
                      example: '1234567890'
        required: true
  /api/carts/{cart_token}/payment_account/{payment_account_id}/vault:
    get:
      summary: Gets VGS vault access token
      tags:
        - Carts
      operationId: getVGSVaultAccessToken
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
        - name: payment_account_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: VGS vault access token
          content:
            application/json:
              schema:
                type: object
                properties:
                  vault:
                    type: object
                    properties:
                      vault_id:
                        type: string
                        example: tntydlnduqt
                      environment:
                        type: string
                        example: sandbox or live
                      access_token:
                        type: string
                        example: eyJhbGci...
                      route_id:
                        type: string
                        example: e83a1bc9-1212-41e8-9ed2-c04efec22b03
                    required:
                      - vault_id
                      - environment
                      - access_token
                      - route_id
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - vault
                  - meta
        '404':
          description: cart not found or does not belong to payment account's company
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Payment account not found
                  errors:
                    type: object
                    example:
                      vault:
                        - payment_account not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: Could not get VGS access token
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Could not get VGS access token
                  errors:
                    type: object
                    example:
                      vault:
                        - could not get access_token
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/carts/{cart_token}/shipping_method:
    post:
      summary: Sets cart shipping method
      tags:
        - Carts
      operationId: setCartShippingMethod
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: shipping method set
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      state:
                        type: string
                        example: start
                      processed:
                        type: boolean
                        example: false
                        description: >-
                          Determines if a cart payment has been processed or
                          not.
                      valid_for_checkout:
                        type: boolean
                        example: true
                      buyer_rep_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      buyer_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: buyer.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                              external_id:
                                type:
                                  - string
                                  - 'null'
                                example: '123241'
                            required:
                              - id
                          - type: 'null'
                      volume_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: volume.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                            required:
                              - id
                          - type: 'null'
                      currency_symbol:
                        type: string
                        example: $
                      currency_code:
                        type: string
                        example: USD
                      shipping_total_for_display:
                        type: string
                        example: Free
                      phone:
                        type:
                          - string
                          - 'null'
                        example: '4035551212'
                      payment_method_auto_assignable:
                        type: boolean
                        example: true
                        description: >-
                          Determines if a payment method can be auto-assigned to
                          the cart.
                      attribution:
                        oneOf:
                          - type: object
                            oneOf:
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  share_guid:
                                    type: string
                                    example: james-bond007
                                required:
                                  - id
                                  - share_guid
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  email:
                                    type: string
                                    example: james.bond@gmail.com
                                required:
                                  - id
                                  - email
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  username:
                                    type: string
                                    example: jaamball234
                                required:
                                  - id
                                  - username
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  fluid_rep_id:
                                    type: integer
                                    example: 23493
                                required:
                                  - id
                                  - fluid_rep_id
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: w3sdf92
                                required:
                                  - id
                          - type: 'null'
                        default:
                          id: 456
                          share_guid: james-bond007
                      agreements:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            required:
                              type: boolean
                              example: true
                            title:
                              type: string
                              example: Terms and Conditions
                            show_path:
                              type: string
                              example: /terms
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                      amount_total:
                        type: string
                        example: '121.65'
                      amount_total_in_currency:
                        type: string
                        example: $121.65 (USD)
                      sub_total:
                        type: string
                        example: '100.00'
                      sub_total_in_currency:
                        type: string
                        example: $100.00 (USD)
                      subtotal_after_discounts:
                        type: string
                        example: '90.00'
                      tax_total:
                        type: string
                        example: '20.00'
                      tax_total_in_currency:
                        type: string
                        example: $20.00 (USD)
                      shipping_total:
                        type:
                          - string
                          - 'null'
                        example: '1.65'
                      shipping_total_in_currency:
                        type: string
                        example: $1.65 (USD)
                      shipping_discount:
                        type: number
                        example: 10.25
                      discount_total:
                        type: string
                        example: '2.99'
                      discount_total_in_currency:
                        type: string
                        example: $2.99 (USD)
                      discount_breakdown:
                        type: object
                        properties:
                          internal_discounts:
                            type: number
                            example: 15
                          external_discounts:
                            type: number
                            example: 10
                          total_discounts:
                            type: number
                            example: 25
                      external_discount:
                        type: object
                        properties:
                          total:
                            type: number
                            example: 10
                          calculated_at:
                            type:
                              - string
                              - 'null'
                            format: date-time
                            example: '2024-01-10T15:30:00Z'
                          sources:
                            type: object
                            additionalProperties:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 6
                                description:
                                  type: string
                                  example: Gold tier discount
                                metadata:
                                  type: object
                              required:
                                - amount
                                - description
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: '1.90'
                      transaction_fee_in_currency:
                        type: string
                        example: $1.90 (USD)
                      cv_total:
                        type: integer
                        example: 10
                      qv_total:
                        type: integer
                        example: 15
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      payment_account:
                        type:
                          - string
                          - 'null'
                        example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                      payment_method:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: CreditCard
                              payment_method_type:
                                type: string
                                example: visa
                              last_four:
                                type: string
                                example: '1234'
                              exp_month:
                                type: string
                                example: '12'
                              exp_year:
                                type: string
                                example: '2025'
                              logo_url:
                                type: string
                                example: https://example.com/image.svg
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Paypal
                              status:
                                type: string
                                example: active
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Affirm
                              affirm_id:
                                type: string
                                example: affirm_123
                              status:
                                type: string
                                example: authorized
                              checkout_id:
                                type: string
                                example: checkout_456
                              created:
                                type: string
                                example: '2025-01-01T00:00:00Z'
                              auth_expiration:
                                type: string
                                example: '2025-01-02T00:00:00Z'
                              currency:
                                type: string
                                example: USD
                              amount:
                                type: string
                                example: '100.00'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Klarna
                              session_id:
                                type: string
                                example: klarna_session_789
                              intent:
                                type: string
                                example: buy
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Droplet
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: SomeCitcon
                      email:
                        type:
                          - string
                          - 'null'
                        example: user@example.com
                      enrollment_fee:
                        type:
                          - number
                          - string
                        example: '10.45'
                      enrollment_fee_in_currency:
                        type: string
                        example: $10.45
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT10
                          - DISCOUNT11
                      language_iso:
                        type:
                          - string
                          - 'null'
                        example: en
                      cart_token:
                        type: string
                        example: abc123
                      immutable_items:
                        type: boolean
                        example: false
                      digital_only:
                        type: boolean
                        example: false
                      requires_3ds:
                        type: boolean
                        example: false
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 101
                            price:
                              type: string
                              example: '43.41'
                            price_in_currency:
                              type: string
                              example: $43.41
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            cv:
                              type: integer
                              example: 5
                            cv_total:
                              type: integer
                              example: 15
                            qv:
                              type: integer
                              example: 7
                            qv_total:
                              type: integer
                              example: 21
                            discount_amount:
                              type: string
                              example: '10'
                            free_item:
                              type: boolean
                              example: false
                            discount_amount_in_currency:
                              type: string
                              example: $10.00
                            total_after_discounts:
                              type: string
                              example: '90.00'
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            product_title:
                              type:
                                - string
                                - 'null'
                              example: Sample Product
                            quantity:
                              type: integer
                              example: 3
                            subscription:
                              type: boolean
                              example: true
                            enrollment:
                              type: boolean
                              example: false
                            allow_subscription:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_plan_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_plans:
                              oneOf:
                                - type: array
                                  items:
                                    title: Commerce::SubscriptionPlan
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        example: Test Subscription Plan
                                        type: string
                                      billing_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      billing_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      billing_frequency_in_words:
                                        example: 2 Months
                                        type: string
                                      shipping_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      shipping_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      volume_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      volume_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      trial_period:
                                        example: 1
                                        type:
                                          - integer
                                          - 'null'
                                        minimum: 1
                                      trial_period_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type:
                                          - string
                                          - 'null'
                                      split_volume:
                                        example: true
                                        type: boolean
                                        default: false
                                      allow_max_billing_cycles:
                                        example: true
                                        type: boolean
                                        default: false
                                      max_billing_cycles:
                                        example: 3
                                        type:
                                          - integer
                                          - 'null'
                                      company_default:
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                        default: false
                                      products_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      subscribers_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      price:
                                        type: string
                                      price_in_currency:
                                        type: string
                                      subscription_start:
                                        type: string
                                      subscribe_and_save:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_in_currency:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_for_display:
                                        type:
                                          - string
                                          - 'null'
                                    required:
                                      - id
                                      - name
                                      - billing_interval
                                      - billing_interval_unit
                                      - billing_frequency_in_words
                                      - shipping_interval
                                      - shipping_interval_unit
                                      - volume_interval
                                      - volume_interval_unit
                                      - split_volume
                                      - allow_max_billing_cycles
                                      - price
                                      - price_in_currency
                                      - subscription_start
                                      - subscribe_and_save
                                      - subscribe_and_save_in_currency
                                      - subscribe_and_save_for_display
                                - type: 'null'
                            subscription_only:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_interval:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_interval_unit:
                              type:
                                - string
                                - 'null'
                              example: month
                            subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 10.5
                            subscription_price_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $10.50
                            subscription_start:
                              type:
                                - string
                                - 'null'
                              example: '2025-02-12'
                            subscribe_and_save:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 2.99
                            subscribe_and_save_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $2.99
                            subscribe_and_save_for_display:
                              type:
                                - string
                                - 'null'
                              example: Subscribe and save $2.99
                            title:
                              type:
                                - string
                                - 'null'
                              example: Surcharge
                            metadata:
                              type: object
                              description: >-
                                A JSON object that can store any custom data
                                structure
                              example: {}
                            product:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type: string
                                      example: Sample Product
                                    introduction:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Product Description
                                    cv:
                                      type: integer
                                      example: 10
                                    external_id:
                                      type:
                                        - string
                                        - 'null'
                                      example: ext-prod-123
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/product.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/product.png
                                    price:
                                      type: string
                                      example: '29.99'
                                    price_in_currency:
                                      type: string
                                      example: $29.99
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    tax:
                                      type: string
                                      example: '2.99'
                                    tax_in_currency:
                                      type: string
                                      example: $2.99
                                    metadata:
                                      type: object
                                      example:
                                        shopify_product_id: 9876054868270
                                    metafields:
                                      type: array
                                      items:
                                        title: LegacyMetafield
                                        type: object
                                        properties:
                                          namespace:
                                            description: >-
                                              A container for related metafields.
                                              Commonly used to group metafields by app
                                              or functionality.
                                            example: custom
                                            type: string
                                            maxLength: 20
                                            pattern: ^[a-zA-Z0-9_]+$
                                          key:
                                            description: >-
                                              The unique identifier for the metafield
                                              within its namespace. Must be unique per
                                              namespace and owner.
                                            example: material
                                            type: string
                                            maxLength: 30
                                            pattern: ^[a-zA-Z0-9_]+$
                                          value:
                                            description: >-
                                              The actual data stored in the metafield.
                                              Type depends on value_type.
                                            example: cotton
                                            type:
                                              - string
                                              - integer
                                              - object
                                              - boolean
                                              - number
                                          value_type:
                                            description: >-
                                              The data type that defines how the value
                                              should be interpreted and validated.
                                            example: single_line_text_field
                                            type: string
                                          description:
                                            description: >-
                                              Optional human-readable description
                                              explaining the purpose of this
                                              metafield.
                                            example: >-
                                              The primary material used in this
                                              product
                                            type:
                                              - string
                                              - 'null'
                                          created_at:
                                            description: >-
                                              Timestamp when the metafield was
                                              created.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          updated_at:
                                            description: >-
                                              Timestamp when the metafield was last
                                              updated.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          locked:
                                            description: >-
                                              Whether this metafield is locked and
                                              cannot be updated or deleted directly.
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                              - 'null'
                                          metafield_definition:
                                            description: >-
                                              The definition that defines validation
                                              rules and structure for this metafield
                                            type:
                                              - 'null'
                                              - object
                                        required:
                                          - namespace
                                          - key
                                          - value
                                          - value_type
                                          - description
                                          - created_at
                                          - updated_at
                                          - metafield_definition
                                - type: 'null'
                            variant:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Variant
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/sample.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/sample.png
                                    primary_image:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/primary.png
                                    price:
                                      type:
                                        - string
                                        - 'null'
                                      example: '34.44'
                                    price_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $34.44
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    options:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          title:
                                            type: string
                                            example: Size
                                          value:
                                            type: string
                                            example: XL
                                    physical:
                                      type:
                                        - boolean
                                        - 'null'
                                      example: true
                                    unit_of_size:
                                      type:
                                        - string
                                        - 'null'
                                      example: cm
                                    height:
                                      type:
                                        - number
                                        - 'null'
                                      example: 13
                                    width:
                                      type:
                                        - number
                                        - 'null'
                                      example: 6
                                    length:
                                      type:
                                        - number
                                        - 'null'
                                      example: 12
                                    unit_of_weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: kg
                                    weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                    hs_code:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                - type: 'null'
                            errors:
                              oneOf:
                                - type: 'null'
                                - type: array
                                  items:
                                    type: object
                                  example:
                                    - country:
                                        - >-
                                          This product is not available for this
                                          country. Please change your country
                            bundled_items:
                              type: array
                              items:
                                type: object
                                description: Bundled items for bundle products
                                properties:
                                  variant_id:
                                    type: integer
                                    example: 1
                                  product_id:
                                    type: integer
                                    example: 1
                                  product_title:
                                    type: string
                                    example: Product Title
                                  variant_title:
                                    type: string
                                    example: Variant Title
                                  option_titles:
                                    type: array
                                    example:
                                      - Option 1
                                      - Option 2
                                  quantity:
                                    type: integer
                                    example: 1
                                  display_to_customer:
                                    type: boolean
                                    example: true
                      ship_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      bill_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      shipping_method:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: string
                            example: standard-shipping
                          name:
                            type: string
                            example: Standard Shipping
                      available_shipping_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: standard-shipping
                            title:
                              type: string
                              example: Standard Shipping
                            price:
                              type:
                                - number
                                - string
                              example: 5.99
                            price_label:
                              type: string
                              example: $5.99
                            delivery_time_estimate:
                              type: string
                              example: 3-5 business days
                      available_payment_methods:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - credit_card
                                name:
                                  type: string
                                  example: Credit Card
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                apple_pay:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method supports
                                    ApplePay or not 
                                bogus_gateway:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is a Bogus
                                    instance or not.
                                tokenize_path:
                                  type:
                                    - string
                                    - 'null'
                                  description: Path to tokenize, if applicable.
                                token_provider:
                                  type: string
                                  enum:
                                    - spreedly
                                    - vgs
                                  description: >-
                                    Determines if payment tokenization is via
                                    spreedly or VGS
                                apple_pay_merchant_identifier:
                                  type:
                                    - string
                                    - 'null'
                                  example: merchant.mycompany.com
                                  description: >-
                                    If ApplePay is supported, returns the
                                    merchant identifier registered with Apple,
                                    else returns nil
                                supported_brands:
                                  type: array
                                  items:
                                    type: string
                                  example:
                                    - visa
                                    - master
                                    - american_express
                                    - discover
                                publishable_key:
                                  type:
                                    - string
                                    - 'null'
                                  example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                  description: >-
                                    If publishable key is set for Hyperswitch,
                                    returns the publishable key, else returns
                                    nil
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                              required:
                                - id
                                - type
                                - name
                                - supported_brands
                                - test
                                - sandbox
                                - apple_pay
                                - apple_pay_merchant_identifier
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - klarna
                                name:
                                  type: string
                                  example: Klarna
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                      country:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          iso:
                            type: string
                            example: US
                          name:
                            type: string
                            example: United States
                          iso_name:
                            type: string
                            example: UNITED STATES
                          iso3:
                            type: string
                            example: USA
                          currency_code:
                            type: string
                            example: USD
                          currency_symbol:
                            type: string
                            example: $
                          province_required:
                            type: boolean
                            example: false
                          tax_enabled:
                            type:
                              - boolean
                              - 'null'
                            example: true
                          price_inclusive_of_tax:
                            type: boolean
                            example: false
                          price_inclusive_tax_name:
                            type:
                              - string
                              - 'null'
                            example: VAT
                      type:
                        type: string
                        enum:
                          - regular
                          - enrollment
                        example: regular
                      enrollment_pack_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      enrollment_pack:
                        type:
                          - object
                          - 'null'
                        properties:
                          enrollment_pack_id:
                            type: integer
                            example: 1
                          additional_volume:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          slug:
                            type: string
                            example: test-enrollment-pack
                          description:
                            type:
                              - object
                              - 'null'
                              - string
                            properties:
                              id:
                                type: integer
                                example: 111
                              name:
                                type: string
                                example: description
                              body:
                                type: string
                                example: >-
                                  <div>Try the latest and greatest of our sugar
                                  zip packs. Guaranteed to make you skinner and
                                  cure cancer.</div>
                              record_type:
                                type: string
                                example: EnrollmentPack
                              record_id:
                                type: integer
                                example: 1
                              created_at:
                                type: string
                                format: date_time
                                example: '2025-01-16T04:22:43.809Z'
                              updated_at:
                                type: string
                                format: date_time
                                example: '2025-01-22T10:23:52.941Z'
                              locale:
                                type: string
                                example: en
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: 10
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.00
                          images:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2
                                relateable_type:
                                  type: string
                                  example: EnrollmentPack
                                relateable_id:
                                  type: integer
                                  example: 1
                                image_url:
                                  type: string
                                  example: >-
                                    https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                image_path:
                                  type: string
                                  example: jITWaU14QGe0y5AFgY7P_00179.svg
                                position:
                                  type: integer
                                  example: 1
                                shopify_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                                created_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                updated_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                external_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 625
                                allow_subscription:
                                  type: boolean
                                  example: true
                                cv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                cv_in_currency:
                                  type: string
                                  example: $0.00
                                cv_total:
                                  type: integer
                                  example: 0
                                enrollment:
                                  type: boolean
                                  example: true
                                enrollment_pack_id:
                                  type: integer
                                  example: 1
                                price:
                                  type: string
                                  example: '11.13'
                                price_in_currency:
                                  type: string
                                  example: $11.13
                                product_title:
                                  type: string
                                  example: Zip Pack Sample Pack (30)
                                quantity:
                                  type: integer
                                  example: 1
                                qv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                qv_in_currency:
                                  type: string
                                  example: $0.00
                                qv_total:
                                  type: integer
                                  example: 0
                                subscribe_and_save:
                                  type:
                                    - string
                                    - 'null'
                                  example: '-1988.87'
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $-1,988.87
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $-1,988.87
                                subscription:
                                  type: boolean
                                  example: false
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_only:
                                  type: boolean
                                  example: false
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_price:
                                  type: string
                                  example: '2000.0'
                                subscription_price_in_currency:
                                  type: string
                                  example: $2,000.00
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  format: date
                                  example: '2025-02-28'
                                tax:
                                  type: string
                                  example: '0.0'
                                tax_in_currency:
                                  type: string
                                  example: $0.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: null
                                display_to_customer:
                                  type: boolean
                                  example: false
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                          price:
                            type: string
                            example: '11.13'
                          price_in_currency:
                            type: string
                            example: $11.13
                          subscription_price:
                            type:
                              - string
                              - integer
                            example: 2000
                          subscription_price_in_currency:
                            type: string
                            example: $2,000.00
                          title:
                            type: string
                            example: enroll product
                          token:
                            type: string
                            example: NxL22AqLRRisfyF9LqxxWRak
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      recurring:
                        oneOf:
                          - type: array
                            items:
                              type: object
                              properties:
                                subtotal:
                                  type: string
                                  example: '10.0'
                                subtotal_in_currency:
                                  type: string
                                  example: $10.0
                                interval:
                                  type: integer
                                  example: 1
                                interval_unit:
                                  type: string
                                  example: month
                                subtotal_for_display:
                                  type: string
                                  example: $10.00 every 1 month
                                start_date:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-05-27'
                          - type: 'null'
                        default:
                          - subtotal: '10.0'
                            subtotal_in_currency: $10.0
                            interval: 1
                            interval_unit: month
                            subtotal_for_display: $10.00 every 1 month
                            start_date: '2025-05-27'
                      messages:
                        type: object
                        additionalProperties: true
                        example:
                          errors:
                            - Insufficient inventory
                            - Product no longer available
                          warnings:
                            - Low stock warning
                            - Shipping delays expected
                          info:
                            - Free shipping available
                            - Volume discount applied
                      points_enabled:
                        type: boolean
                        example: true
                      points_applied:
                        type: integer
                        example: 500
                        description: Number of points applied to the cart
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Currency value of applied points
                      customer_total_points:
                        type: integer
                        example: 1000
                        description: Customer's total available points balance
                      customer_total_points_in_currency:
                        type: number
                        example: 10
                        description: Currency value of available points
                      remaining_customer_points:
                        type: integer
                        example: 500
                        description: Customer's remaining points after cart redemption
                      remaining_customer_points_amount_in_currency:
                        type: number
                        example: 5
                        description: >-
                          Currency value of remaining points after cart
                          redemption
                      remaining_cart_amount_after_points:
                        type: number
                        example: 95
                        description: Amount to charge to card after points redemption
                      remaining_cart_amount_after_points_in_currency:
                        type:
                          - string
                        example: $95.00
                        description: >-
                          Amount in currency to charge to card after points
                          redemption
                      max_applicable_points:
                        type: integer
                        example: 500
                        description: Maximum points that can be applied to this cart
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      checkout_url:
                        type: string
                        example: https://checkout.fluid.com/checkout?jwt=abc123
                      shop_url:
                        type: string
                        example: https://myco.fluid.app
        '410':
          description: cart is in authorized enrollment state
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Cart is in authorized state and cannot be modified
                  errors:
                    type: object
                    example:
                      cart:
                        - is in authorized state and cannot be modified
                  meta:
                    type: object
                    properties:
                      shop_url:
                        type: string
                        example: https://example.myshopify.com
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      cart:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 123
                          state:
                            type: string
                            example: start
                          processed:
                            type: boolean
                            example: false
                            description: >-
                              Determines if a cart payment has been processed or
                              not.
                          valid_for_checkout:
                            type: boolean
                            example: true
                          buyer_rep_id:
                            type:
                              - integer
                              - 'null'
                            example: 1
                          buyer_rep:
                            oneOf:
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 2
                                  email:
                                    type:
                                      - string
                                      - 'null'
                                    example: buyer.rep@example.com
                                  full_name:
                                    type:
                                      - string
                                      - 'null'
                                    example: John Doe
                                  image_url:
                                    type:
                                      - string
                                      - 'null'
                                    example: https://example.com/image.png
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: '123241'
                                required:
                                  - id
                              - type: 'null'
                          volume_rep:
                            oneOf:
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 2
                                  email:
                                    type:
                                      - string
                                      - 'null'
                                    example: volume.rep@example.com
                                  full_name:
                                    type:
                                      - string
                                      - 'null'
                                    example: John Doe
                                  image_url:
                                    type:
                                      - string
                                      - 'null'
                                    example: https://example.com/image.png
                                required:
                                  - id
                              - type: 'null'
                          currency_symbol:
                            type: string
                            example: $
                          currency_code:
                            type: string
                            example: USD
                          shipping_total_for_display:
                            type: string
                            example: Free
                          phone:
                            type:
                              - string
                              - 'null'
                            example: '4035551212'
                          payment_method_auto_assignable:
                            type: boolean
                            example: true
                            description: >-
                              Determines if a payment method can be
                              auto-assigned to the cart.
                          attribution:
                            oneOf:
                              - type: object
                                oneOf:
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      share_guid:
                                        type: string
                                        example: james-bond007
                                    required:
                                      - id
                                      - share_guid
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      email:
                                        type: string
                                        example: james.bond@gmail.com
                                    required:
                                      - id
                                      - email
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      username:
                                        type: string
                                        example: jaamball234
                                    required:
                                      - id
                                      - username
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      fluid_rep_id:
                                        type: integer
                                        example: 23493
                                    required:
                                      - id
                                      - fluid_rep_id
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      external_id:
                                        type:
                                          - string
                                          - 'null'
                                        example: w3sdf92
                                    required:
                                      - id
                              - type: 'null'
                            default:
                              id: 456
                              share_guid: james-bond007
                          agreements:
                            type: array
                            items:
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                  example: 1
                                required:
                                  type: boolean
                                  example: true
                                title:
                                  type: string
                                  example: Terms and Conditions
                                show_path:
                                  type: string
                                  example: /terms
                                enrollment_pack_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                          amount_total:
                            type: string
                            example: '121.65'
                          amount_total_in_currency:
                            type: string
                            example: $121.65 (USD)
                          sub_total:
                            type: string
                            example: '100.00'
                          sub_total_in_currency:
                            type: string
                            example: $100.00 (USD)
                          subtotal_after_discounts:
                            type: string
                            example: '90.00'
                          tax_total:
                            type: string
                            example: '20.00'
                          tax_total_in_currency:
                            type: string
                            example: $20.00 (USD)
                          shipping_total:
                            type:
                              - string
                              - 'null'
                            example: '1.65'
                          shipping_total_in_currency:
                            type: string
                            example: $1.65 (USD)
                          shipping_discount:
                            type: number
                            example: 10.25
                          discount_total:
                            type: string
                            example: '2.99'
                          discount_total_in_currency:
                            type: string
                            example: $2.99 (USD)
                          discount_breakdown:
                            type: object
                            properties:
                              internal_discounts:
                                type: number
                                example: 15
                              external_discounts:
                                type: number
                                example: 10
                              total_discounts:
                                type: number
                                example: 25
                          external_discount:
                            type: object
                            properties:
                              total:
                                type: number
                                example: 10
                              calculated_at:
                                type:
                                  - string
                                  - 'null'
                                format: date-time
                                example: '2024-01-10T15:30:00Z'
                              sources:
                                type: object
                                additionalProperties:
                                  type: object
                                  properties:
                                    amount:
                                      type: number
                                      example: 6
                                    description:
                                      type: string
                                      example: Gold tier discount
                                    metadata:
                                      type: object
                                  required:
                                    - amount
                                    - description
                          transaction_fee:
                            type:
                              - number
                              - string
                            example: '1.90'
                          transaction_fee_in_currency:
                            type: string
                            example: $1.90 (USD)
                          cv_total:
                            type: integer
                            example: 10
                          qv_total:
                            type: integer
                            example: 15
                          company:
                            type: object
                            properties:
                              id:
                                type: integer
                              name:
                                type: string
                              primary_domain_hostname:
                                type:
                                  - string
                                  - 'null'
                                example: fluid.com
                              subdomain:
                                type:
                                  - string
                                  - 'null'
                                example: myco
                              logo_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/logo.png
                              fluid_shop:
                                type:
                                  - string
                                  - 'null'
                                example: https://fluid-sample-shop.fluid.com
                              collect_phone:
                                type: boolean
                                example: true
                              require_phone:
                                type: boolean
                                example: false
                              require_billing_zip:
                                type: boolean
                                example: false
                              checkout_primary_button_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#000000'
                              checkout_primary_text_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#FFFFFF'
                              checkout_secondary_button_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#FFFFFF'
                              checkout_secondary_text_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#000000'
                              favicon_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/favicon.ico
                              order_on_behalf:
                                type: boolean
                                example: false
                              use_juspay_gateway:
                                type: boolean
                                example: false
                              reward_points_enabled:
                                type: boolean
                                example: false
                          payment_account:
                            type:
                              - string
                              - 'null'
                            example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                          payment_method:
                            oneOf:
                              - type: 'null'
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: CreditCard
                                  payment_method_type:
                                    type: string
                                    example: visa
                                  last_four:
                                    type: string
                                    example: '1234'
                                  exp_month:
                                    type: string
                                    example: '12'
                                  exp_year:
                                    type: string
                                    example: '2025'
                                  logo_url:
                                    type: string
                                    example: https://example.com/image.svg
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Paypal
                                  status:
                                    type: string
                                    example: active
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Affirm
                                  affirm_id:
                                    type: string
                                    example: affirm_123
                                  status:
                                    type: string
                                    example: authorized
                                  checkout_id:
                                    type: string
                                    example: checkout_456
                                  created:
                                    type: string
                                    example: '2025-01-01T00:00:00Z'
                                  auth_expiration:
                                    type: string
                                    example: '2025-01-02T00:00:00Z'
                                  currency:
                                    type: string
                                    example: USD
                                  amount:
                                    type: string
                                    example: '100.00'
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Klarna
                                  session_id:
                                    type: string
                                    example: klarna_session_789
                                  intent:
                                    type: string
                                    example: buy
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Droplet
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: SomeCitcon
                          email:
                            type:
                              - string
                              - 'null'
                            example: user@example.com
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: '10.45'
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.45
                          discount_codes:
                            type: array
                            items:
                              type: string
                            example:
                              - DISCOUNT10
                              - DISCOUNT11
                          language_iso:
                            type:
                              - string
                              - 'null'
                            example: en
                          cart_token:
                            type: string
                            example: abc123
                          immutable_items:
                            type: boolean
                            example: false
                          digital_only:
                            type: boolean
                            example: false
                          requires_3ds:
                            type: boolean
                            example: false
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 101
                                price:
                                  type: string
                                  example: '43.41'
                                price_in_currency:
                                  type: string
                                  example: $43.41
                                tax:
                                  type: string
                                  example: '2.99'
                                tax_in_currency:
                                  type: string
                                  example: $2.99
                                cv:
                                  type: integer
                                  example: 5
                                cv_total:
                                  type: integer
                                  example: 15
                                qv:
                                  type: integer
                                  example: 7
                                qv_total:
                                  type: integer
                                  example: 21
                                discount_amount:
                                  type: string
                                  example: '10'
                                free_item:
                                  type: boolean
                                  example: false
                                discount_amount_in_currency:
                                  type: string
                                  example: $10.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                enrollment_pack_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                display_to_customer:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                product_title:
                                  type:
                                    - string
                                    - 'null'
                                  example: Sample Product
                                quantity:
                                  type: integer
                                  example: 3
                                subscription:
                                  type: boolean
                                  example: true
                                enrollment:
                                  type: boolean
                                  example: false
                                allow_subscription:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_only:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_price:
                                  type:
                                    - number
                                    - string
                                    - 'null'
                                  example: 10.5
                                subscription_price_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $10.50
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-02-12'
                                subscribe_and_save:
                                  type:
                                    - number
                                    - string
                                    - 'null'
                                  example: 2.99
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $2.99
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $2.99
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: Surcharge
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                product:
                                  oneOf:
                                    - type: object
                                      properties:
                                        id:
                                          type: integer
                                          example: 1
                                        title:
                                          type: string
                                          example: Sample Product
                                        introduction:
                                          type:
                                            - string
                                            - 'null'
                                          example: Sample Product Description
                                        cv:
                                          type: integer
                                          example: 10
                                        external_id:
                                          type:
                                            - string
                                            - 'null'
                                          example: ext-prod-123
                                        image_path:
                                          type:
                                            - string
                                            - 'null'
                                          example: /images/product.png
                                        image_url:
                                          type:
                                            - string
                                            - 'null'
                                          example: https://example.com/images/product.png
                                        price:
                                          type: string
                                          example: '29.99'
                                        price_in_currency:
                                          type: string
                                          example: $29.99
                                        sku:
                                          type:
                                            - string
                                            - 'null'
                                          example: SKU12345
                                        tax:
                                          type: string
                                          example: '2.99'
                                        tax_in_currency:
                                          type: string
                                          example: $2.99
                                        metadata:
                                          type: object
                                          example:
                                            shopify_product_id: 9876054868270
                                        metafields:
                                          type: array
                                          items:
                                            title: LegacyMetafield
                                            type: object
                                            properties:
                                              namespace:
                                                description: >-
                                                  A container for related metafields.
                                                  Commonly used to group metafields by app
                                                  or functionality.
                                                example: custom
                                                type: string
                                                maxLength: 20
                                                pattern: ^[a-zA-Z0-9_]+$
                                              key:
                                                description: >-
                                                  The unique identifier for the metafield
                                                  within its namespace. Must be unique per
                                                  namespace and owner.
                                                example: material
                                                type: string
                                                maxLength: 30
                                                pattern: ^[a-zA-Z0-9_]+$
                                              value:
                                                description: >-
                                                  The actual data stored in the metafield.
                                                  Type depends on value_type.
                                                example: cotton
                                                type:
                                                  - string
                                                  - integer
                                                  - object
                                                  - boolean
                                                  - number
                                              value_type:
                                                description: >-
                                                  The data type that defines how the value
                                                  should be interpreted and validated.
                                                example: single_line_text_field
                                                type: string
                                              description:
                                                description: >-
                                                  Optional human-readable description
                                                  explaining the purpose of this
                                                  metafield.
                                                example: >-
                                                  The primary material used in this
                                                  product
                                                type:
                                                  - string
                                                  - 'null'
                                              created_at:
                                                description: >-
                                                  Timestamp when the metafield was
                                                  created.
                                                example: '2021-01-01T00:00:00Z'
                                                type: string
                                                format: date-time
                                              updated_at:
                                                description: >-
                                                  Timestamp when the metafield was last
                                                  updated.
                                                example: '2021-01-01T00:00:00Z'
                                                type: string
                                                format: date-time
                                              locked:
                                                description: >-
                                                  Whether this metafield is locked and
                                                  cannot be updated or deleted directly.
                                                example: false
                                                type:
                                                  - boolean
                                                  - 'null'
                                                  - 'null'
                                              metafield_definition:
                                                description: >-
                                                  The definition that defines validation
                                                  rules and structure for this metafield
                                                type:
                                                  - 'null'
                                                  - object
                                            required:
                                              - namespace
                                              - key
                                              - value
                                              - value_type
                                              - description
                                              - created_at
                                              - updated_at
                                              - metafield_definition
                                    - type: 'null'
                                variant:
                                  oneOf:
                                    - type: object
                                      properties:
                                        id:
                                          type: integer
                                          example: 1
                                        title:
                                          type:
                                            - string
                                            - 'null'
                                          example: Sample Variant
                                        image_path:
                                          type:
                                            - string
                                            - 'null'
                                          example: /images/sample.png
                                        image_url:
                                          type:
                                            - string
                                            - 'null'
                                          example: https://example.com/images/sample.png
                                        primary_image:
                                          type:
                                            - string
                                            - 'null'
                                          example: https://example.com/images/primary.png
                                        price:
                                          type:
                                            - string
                                            - 'null'
                                          example: '34.44'
                                        price_in_currency:
                                          type:
                                            - string
                                            - 'null'
                                          example: $34.44
                                        sku:
                                          type:
                                            - string
                                            - 'null'
                                          example: SKU12345
                                        options:
                                          type: array
                                          items:
                                            type: object
                                            properties:
                                              title:
                                                type: string
                                                example: Size
                                              value:
                                                type: string
                                                example: XL
                                        physical:
                                          type:
                                            - boolean
                                            - 'null'
                                          example: true
                                        unit_of_size:
                                          type:
                                            - string
                                            - 'null'
                                          example: cm
                                        height:
                                          type:
                                            - number
                                            - 'null'
                                          example: 13
                                        width:
                                          type:
                                            - number
                                            - 'null'
                                          example: 6
                                        length:
                                          type:
                                            - number
                                            - 'null'
                                          example: 12
                                        unit_of_weight:
                                          type:
                                            - string
                                            - 'null'
                                          example: kg
                                        weight:
                                          type:
                                            - string
                                            - 'null'
                                          example: '3.2'
                                        hs_code:
                                          type:
                                            - string
                                            - 'null'
                                          example: '3.2'
                                    - type: 'null'
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                                bundled_items:
                                  type: array
                                  items:
                                    type: object
                                    description: Bundled items for bundle products
                                    properties:
                                      variant_id:
                                        type: integer
                                        example: 1
                                      product_id:
                                        type: integer
                                        example: 1
                                      product_title:
                                        type: string
                                        example: Product Title
                                      variant_title:
                                        type: string
                                        example: Variant Title
                                      option_titles:
                                        type: array
                                        example:
                                          - Option 1
                                          - Option 2
                                      quantity:
                                        type: integer
                                        example: 1
                                      display_to_customer:
                                        type: boolean
                                        example: true
                          ship_to:
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                                example: 1
                              name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              first_name:
                                type:
                                  - string
                                  - 'null'
                                example: John
                              last_name:
                                type:
                                  - string
                                  - 'null'
                                example: Doe
                              address1:
                                type: string
                                example: 123 Main St
                              address2:
                                type:
                                  - string
                                  - 'null'
                                example: Apt 4B
                              address3:
                                type:
                                  - string
                                  - 'null'
                                example: Building 5
                              city:
                                type: string
                                example: New York
                              state:
                                type: string
                                example: NY
                              postal_code:
                                type: string
                                example: '10001'
                              country_code:
                                type: string
                                example: US
                                description: >-
                                  country_id takes precedence if both country_id
                                  and country_code provided.
                              subdivision_code:
                                type:
                                  - string
                                  - 'null'
                                example: NY
                              default:
                                type: boolean
                                example: true
                          bill_to:
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                                example: 1
                              name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              first_name:
                                type:
                                  - string
                                  - 'null'
                                example: John
                              last_name:
                                type:
                                  - string
                                  - 'null'
                                example: Doe
                              address1:
                                type: string
                                example: 123 Main St
                              address2:
                                type:
                                  - string
                                  - 'null'
                                example: Apt 4B
                              address3:
                                type:
                                  - string
                                  - 'null'
                                example: Building 5
                              city:
                                type: string
                                example: New York
                              state:
                                type: string
                                example: NY
                              postal_code:
                                type: string
                                example: '10001'
                              country_code:
                                type: string
                                example: US
                                description: >-
                                  country_id takes precedence if both country_id
                                  and country_code provided.
                              subdivision_code:
                                type:
                                  - string
                                  - 'null'
                                example: NY
                              default:
                                type: boolean
                                example: true
                          shipping_method:
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: string
                                example: standard-shipping
                              name:
                                type: string
                                example: Standard Shipping
                          available_shipping_methods:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                  example: standard-shipping
                                title:
                                  type: string
                                  example: Standard Shipping
                                price:
                                  type:
                                    - number
                                    - string
                                  example: 5.99
                                price_label:
                                  type: string
                                  example: $5.99
                                delivery_time_estimate:
                                  type: string
                                  example: 3-5 business days
                          available_payment_methods:
                            type: array
                            items:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1337
                                    uuid:
                                      type: string
                                      example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                    type:
                                      type: string
                                      enum:
                                        - credit_card
                                    name:
                                      type: string
                                      example: Credit Card
                                    image_url:
                                      type: string
                                      example: https://example.com/image.png
                                    test:
                                      type: boolean
                                      example: true
                                      description: >-
                                        Determines if payment method is test
                                        instance or not. By default, set to
                                        `true`
                                    sandbox:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method is sandbox
                                        instance or not. By default, set to
                                        `false`
                                    apple_pay:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method supports
                                        ApplePay or not 
                                    bogus_gateway:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method is a Bogus
                                        instance or not.
                                    tokenize_path:
                                      type:
                                        - string
                                        - 'null'
                                      description: Path to tokenize, if applicable.
                                    token_provider:
                                      type: string
                                      enum:
                                        - spreedly
                                        - vgs
                                      description: >-
                                        Determines if payment tokenization is
                                        via spreedly or VGS
                                    apple_pay_merchant_identifier:
                                      type:
                                        - string
                                        - 'null'
                                      example: merchant.mycompany.com
                                      description: >-
                                        If ApplePay is supported, returns the
                                        merchant identifier registered with
                                        Apple, else returns nil
                                    supported_brands:
                                      type: array
                                      items:
                                        type: string
                                      example:
                                        - visa
                                        - master
                                        - american_express
                                        - discover
                                    publishable_key:
                                      type:
                                        - string
                                        - 'null'
                                      example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                      description: >-
                                        If publishable key is set for
                                        Hyperswitch, returns the publishable
                                        key, else returns nil
                                    customer_details_schema:
                                      type: object
                                      example: {}
                                      description: >-
                                        Schema defining required customer
                                        details for this payment method
                                  required:
                                    - id
                                    - type
                                    - name
                                    - supported_brands
                                    - test
                                    - sandbox
                                    - apple_pay
                                    - apple_pay_merchant_identifier
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1337
                                    uuid:
                                      type: string
                                      example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                    type:
                                      type: string
                                      enum:
                                        - klarna
                                    name:
                                      type: string
                                      example: Klarna
                                    image_url:
                                      type: string
                                      example: https://example.com/image.png
                                    test:
                                      type: boolean
                                      example: true
                                      description: >-
                                        Determines if payment method is test
                                        instance or not. By default, set to
                                        `true`
                                    sandbox:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method is sandbox
                                        instance or not. By default, set to
                                        `false`
                                    customer_details_schema:
                                      type: object
                                      example: {}
                                      description: >-
                                        Schema defining required customer
                                        details for this payment method
                          country:
                            type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              iso:
                                type: string
                                example: US
                              name:
                                type: string
                                example: United States
                              iso_name:
                                type: string
                                example: UNITED STATES
                              iso3:
                                type: string
                                example: USA
                              currency_code:
                                type: string
                                example: USD
                              currency_symbol:
                                type: string
                                example: $
                              province_required:
                                type: boolean
                                example: false
                              tax_enabled:
                                type:
                                  - boolean
                                  - 'null'
                                example: true
                              price_inclusive_of_tax:
                                type: boolean
                                example: false
                              price_inclusive_tax_name:
                                type:
                                  - string
                                  - 'null'
                                example: VAT
                          type:
                            type: string
                            enum:
                              - regular
                              - enrollment
                            example: regular
                          enrollment_pack_id:
                            type:
                              - integer
                              - 'null'
                            example: 1
                          enrollment_pack:
                            type:
                              - object
                              - 'null'
                            properties:
                              enrollment_pack_id:
                                type: integer
                                example: 1
                              additional_volume:
                                type:
                                  - integer
                                  - 'null'
                                example: 10
                              slug:
                                type: string
                                example: test-enrollment-pack
                              description:
                                type:
                                  - object
                                  - 'null'
                                  - string
                                properties:
                                  id:
                                    type: integer
                                    example: 111
                                  name:
                                    type: string
                                    example: description
                                  body:
                                    type: string
                                    example: >-
                                      <div>Try the latest and greatest of our
                                      sugar zip packs. Guaranteed to make you
                                      skinner and cure cancer.</div>
                                  record_type:
                                    type: string
                                    example: EnrollmentPack
                                  record_id:
                                    type: integer
                                    example: 1
                                  created_at:
                                    type: string
                                    format: date_time
                                    example: '2025-01-16T04:22:43.809Z'
                                  updated_at:
                                    type: string
                                    format: date_time
                                    example: '2025-01-22T10:23:52.941Z'
                                  locale:
                                    type: string
                                    example: en
                              enrollment_fee:
                                type:
                                  - number
                                  - string
                                example: 10
                              enrollment_fee_in_currency:
                                type: string
                                example: $10.00
                              images:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 2
                                    relateable_type:
                                      type: string
                                      example: EnrollmentPack
                                    relateable_id:
                                      type: integer
                                      example: 1
                                    image_url:
                                      type: string
                                      example: >-
                                        https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                    image_path:
                                      type: string
                                      example: jITWaU14QGe0y5AFgY7P_00179.svg
                                    position:
                                      type: integer
                                      example: 1
                                    shopify_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: null
                                    created_at:
                                      type: string
                                      format: date_time
                                      example: '2025-01-16T04:22:44.870Z'
                                    updated_at:
                                      type: string
                                      format: date_time
                                      example: '2025-01-16T04:22:44.870Z'
                                    external_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: null
                              items:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 625
                                    allow_subscription:
                                      type: boolean
                                      example: true
                                    cv:
                                      type:
                                        - number
                                        - string
                                      example: 0
                                    cv_in_currency:
                                      type: string
                                      example: $0.00
                                    cv_total:
                                      type: integer
                                      example: 0
                                    enrollment:
                                      type: boolean
                                      example: true
                                    enrollment_pack_id:
                                      type: integer
                                      example: 1
                                    price:
                                      type: string
                                      example: '11.13'
                                    price_in_currency:
                                      type: string
                                      example: $11.13
                                    product_title:
                                      type: string
                                      example: Zip Pack Sample Pack (30)
                                    quantity:
                                      type: integer
                                      example: 1
                                    qv:
                                      type:
                                        - number
                                        - string
                                      example: 0
                                    qv_in_currency:
                                      type: string
                                      example: $0.00
                                    qv_total:
                                      type: integer
                                      example: 0
                                    subscribe_and_save:
                                      type:
                                        - string
                                        - 'null'
                                      example: '-1988.87'
                                    subscribe_and_save_for_display:
                                      type:
                                        - string
                                        - 'null'
                                      example: Subscribe and save $-1,988.87
                                    subscribe_and_save_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $-1,988.87
                                    subscription:
                                      type: boolean
                                      example: false
                                    subscription_interval:
                                      type:
                                        - integer
                                        - 'null'
                                      example: 1
                                    subscription_interval_unit:
                                      type:
                                        - string
                                        - 'null'
                                      example: month
                                    subscription_only:
                                      type: boolean
                                      example: false
                                    subscription_plan_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: 1
                                    subscription_plans:
                                      oneOf:
                                        - type: array
                                          items:
                                            title: Commerce::SubscriptionPlan
                                            type: object
                                            properties:
                                              id:
                                                type: integer
                                              name:
                                                example: Test Subscription Plan
                                                type: string
                                              billing_interval:
                                                example: 1
                                                type: integer
                                                default: 1
                                                minimum: 1
                                                maximum: 29
                                              billing_interval_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type: string
                                                default: month
                                              billing_frequency_in_words:
                                                example: 2 Months
                                                type: string
                                              shipping_interval:
                                                example: 1
                                                type: integer
                                                default: 1
                                                minimum: 1
                                                maximum: 29
                                              shipping_interval_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type: string
                                                default: month
                                              volume_interval:
                                                example: 1
                                                type: integer
                                                default: 1
                                                minimum: 1
                                                maximum: 29
                                              volume_interval_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type: string
                                                default: month
                                              trial_period:
                                                example: 1
                                                type:
                                                  - integer
                                                  - 'null'
                                                minimum: 1
                                              trial_period_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type:
                                                  - string
                                                  - 'null'
                                              split_volume:
                                                example: true
                                                type: boolean
                                                default: false
                                              allow_max_billing_cycles:
                                                example: true
                                                type: boolean
                                                default: false
                                              max_billing_cycles:
                                                example: 3
                                                type:
                                                  - integer
                                                  - 'null'
                                              company_default:
                                                example: false
                                                type:
                                                  - boolean
                                                  - 'null'
                                                default: false
                                              products_count:
                                                example: 10
                                                type:
                                                  - integer
                                                  - 'null'
                                              subscribers_count:
                                                example: 10
                                                type:
                                                  - integer
                                                  - 'null'
                                              price:
                                                type: string
                                              price_in_currency:
                                                type: string
                                              subscription_start:
                                                type: string
                                              subscribe_and_save:
                                                type:
                                                  - string
                                                  - 'null'
                                              subscribe_and_save_in_currency:
                                                type:
                                                  - string
                                                  - 'null'
                                              subscribe_and_save_for_display:
                                                type:
                                                  - string
                                                  - 'null'
                                            required:
                                              - id
                                              - name
                                              - billing_interval
                                              - billing_interval_unit
                                              - billing_frequency_in_words
                                              - shipping_interval
                                              - shipping_interval_unit
                                              - volume_interval
                                              - volume_interval_unit
                                              - split_volume
                                              - allow_max_billing_cycles
                                              - price
                                              - price_in_currency
                                              - subscription_start
                                              - subscribe_and_save
                                              - subscribe_and_save_in_currency
                                              - subscribe_and_save_for_display
                                        - type: 'null'
                                    subscription_price:
                                      type: string
                                      example: '2000.0'
                                    subscription_price_in_currency:
                                      type: string
                                      example: $2,000.00
                                    subscription_start:
                                      type:
                                        - string
                                        - 'null'
                                      format: date
                                      example: '2025-02-28'
                                    tax:
                                      type: string
                                      example: '0.0'
                                    tax_in_currency:
                                      type: string
                                      example: $0.00
                                    total_after_discounts:
                                      type: string
                                      example: '90.00'
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: null
                                    display_to_customer:
                                      type: boolean
                                      example: false
                                    metadata:
                                      type: object
                                      description: >-
                                        A JSON object that can store any custom
                                        data structure
                                      example: {}
                                    errors:
                                      oneOf:
                                        - type: 'null'
                                        - type: array
                                          items:
                                            type: object
                                          example:
                                            - country:
                                                - >-
                                                  This product is not available for this
                                                  country. Please change your country
                              price:
                                type: string
                                example: '11.13'
                              price_in_currency:
                                type: string
                                example: $11.13
                              subscription_price:
                                type:
                                  - string
                                  - integer
                                example: 2000
                              subscription_price_in_currency:
                                type: string
                                example: $2,000.00
                              title:
                                type: string
                                example: enroll product
                              token:
                                type: string
                                example: NxL22AqLRRisfyF9LqxxWRak
                          metadata:
                            type: object
                            description: >-
                              A JSON object that can store any custom data
                              structure.
                          recurring:
                            oneOf:
                              - type: array
                                items:
                                  type: object
                                  properties:
                                    subtotal:
                                      type: string
                                      example: '10.0'
                                    subtotal_in_currency:
                                      type: string
                                      example: $10.0
                                    interval:
                                      type: integer
                                      example: 1
                                    interval_unit:
                                      type: string
                                      example: month
                                    subtotal_for_display:
                                      type: string
                                      example: $10.00 every 1 month
                                    start_date:
                                      type:
                                        - string
                                        - 'null'
                                      example: '2025-05-27'
                              - type: 'null'
                            default:
                              - subtotal: '10.0'
                                subtotal_in_currency: $10.0
                                interval: 1
                                interval_unit: month
                                subtotal_for_display: $10.00 every 1 month
                                start_date: '2025-05-27'
                          messages:
                            type: object
                            additionalProperties: true
                            example:
                              errors:
                                - Insufficient inventory
                                - Product no longer available
                              warnings:
                                - Low stock warning
                                - Shipping delays expected
                              info:
                                - Free shipping available
                                - Volume discount applied
                          points_enabled:
                            type: boolean
                            example: true
                          points_applied:
                            type: integer
                            example: 500
                            description: Number of points applied to the cart
                          points_applied_amount_in_currency:
                            type: number
                            example: 5
                            description: Currency value of applied points
                          customer_total_points:
                            type: integer
                            example: 1000
                            description: Customer's total available points balance
                          customer_total_points_in_currency:
                            type: number
                            example: 10
                            description: Currency value of available points
                          remaining_customer_points:
                            type: integer
                            example: 500
                            description: Customer's remaining points after cart redemption
                          remaining_customer_points_amount_in_currency:
                            type: number
                            example: 5
                            description: >-
                              Currency value of remaining points after cart
                              redemption
                          remaining_cart_amount_after_points:
                            type: number
                            example: 95
                            description: Amount to charge to card after points redemption
                          remaining_cart_amount_after_points_in_currency:
                            type:
                              - string
                            example: $95.00
                            description: >-
                              Amount in currency to charge to card after points
                              redemption
                          max_applicable_points:
                            type: integer
                            example: 500
                            description: Maximum points that can be applied to this cart
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - shipping_method_id
              properties:
                shipping_method_id:
                  type: string
                  example: 10
                  description: ID of the shipping method to use
  /api/carts/{cart_token}/checkout:
    post:
      summary: Completes cart checkout
      tags:
        - Carts
      operationId: checkoutCart
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: checkout completed
          content:
            application/json:
              schema:
                type: object
                properties:
                  order:
                    type: object
                    properties:
                      id:
                        type: integer
                      first_name:
                        type:
                          - string
                          - 'null'
                      last_name:
                        type:
                          - string
                          - 'null'
                      external_id:
                        type:
                          - string
                          - 'null'
                      email:
                        type: string
                      phone:
                        type:
                          - string
                          - 'null'
                      order_number:
                        type: string
                      token:
                        type: string
                      status:
                        type: string
                      order_status:
                        type: string
                      financial_status:
                        type: string
                      fulfillment_status:
                        type: string
                      warehouse_id:
                        type:
                          - integer
                          - 'null'
                      order_type:
                        type:
                          - string
                          - 'null'
                      amount:
                        type: string
                      amount_in_base:
                        type: string
                        example: '10.0'
                      base_to_currency_rate:
                        type:
                          - string
                          - 'null'
                        example: '1.35'
                      refundable_amount:
                        type:
                          - number
                          - string
                        format: float
                        example: 10.5
                      note:
                        oneOf:
                          - type: 'null'
                          - type: string
                      recurring:
                        oneOf:
                          - type: array
                            items:
                              type: object
                              properties:
                                subtotal:
                                  type:
                                    - number
                                    - string
                                  example: '10.0'
                                subtotal_in_currency:
                                  type: string
                                  example: $10.0
                                interval:
                                  type: integer
                                  example: 1
                                interval_unit:
                                  type: string
                                  example: month
                                subtotal_for_display:
                                  type: string
                                  example: $10.00 every 1 month
                                start_date:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-05-27'
                          - type: 'null'
                        default:
                          - subtotal: '10.0'
                            subtotal_in_currency: $10.0
                            interval: 1
                            interval_unit: month
                            subtotal_for_display: $10.00 every 1 month
                            start_date: '2025-05-27'
                      order_confirmation_url:
                        type:
                          - string
                          - 'null'
                      currency_code:
                        type: string
                      created_at:
                        type: string
                      updated_at:
                        type: string
                      metadata:
                        type:
                          - object
                          - 'null'
                      enrollment_pack:
                        type:
                          - object
                          - 'null'
                        properties:
                          enrollment_pack_id:
                            type: integer
                            example: 1
                          additional_volume:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          slug:
                            type: string
                            example: test-enrollment-pack
                          description:
                            type:
                              - object
                              - 'null'
                              - string
                            properties:
                              id:
                                type: integer
                                example: 111
                              name:
                                type: string
                                example: description
                              body:
                                type: string
                                example: >-
                                  <div>Try the latest and greatest of our sugar
                                  zip packs. Guaranteed to make you skinner and
                                  cure cancer.</div>
                              record_type:
                                type: string
                                example: EnrollmentPack
                              record_id:
                                type: integer
                                example: 1
                              created_at:
                                type: string
                                format: date_time
                                example: '2025-01-16T04:22:43.809Z'
                              updated_at:
                                type: string
                                format: date_time
                                example: '2025-01-22T10:23:52.941Z'
                              locale:
                                type: string
                                example: en
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: 10
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.00
                          images:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2
                                relateable_type:
                                  type: string
                                  example: EnrollmentPack
                                relateable_id:
                                  type: integer
                                  example: 1
                                image_url:
                                  type: string
                                  example: >-
                                    https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                image_path:
                                  type: string
                                  example: jITWaU14QGe0y5AFgY7P_00179.svg
                                position:
                                  type: integer
                                  example: 1
                                shopify_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                                created_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                updated_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                external_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 625
                                allow_subscription:
                                  type: boolean
                                  example: true
                                cv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                cv_in_currency:
                                  type: string
                                  example: $0.00
                                cv_total:
                                  type: integer
                                  example: 0
                                enrollment:
                                  type: boolean
                                  example: true
                                enrollment_pack_id:
                                  type: integer
                                  example: 1
                                price:
                                  type: string
                                  example: '11.13'
                                price_in_currency:
                                  type: string
                                  example: $11.13
                                product_title:
                                  type: string
                                  example: Zip Pack Sample Pack (30)
                                quantity:
                                  type: integer
                                  example: 1
                                qv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                qv_in_currency:
                                  type: string
                                  example: $0.00
                                qv_total:
                                  type: integer
                                  example: 0
                                subscribe_and_save:
                                  type:
                                    - string
                                    - 'null'
                                  example: '-1988.87'
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $-1,988.87
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $-1,988.87
                                subscription:
                                  type: boolean
                                  example: false
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_only:
                                  type: boolean
                                  example: false
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_price:
                                  type: string
                                  example: '2000.0'
                                subscription_price_in_currency:
                                  type: string
                                  example: $2,000.00
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  format: date
                                  example: '2025-02-28'
                                tax:
                                  type: string
                                  example: '0.0'
                                tax_in_currency:
                                  type: string
                                  example: $0.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: null
                                display_to_customer:
                                  type: boolean
                                  example: false
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                          price:
                            type: string
                            example: '11.13'
                          price_in_currency:
                            type: string
                            example: $11.13
                          subscription_price:
                            type:
                              - string
                              - integer
                            example: 2000
                          subscription_price_in_currency:
                            type: string
                            example: $2,000.00
                          title:
                            type: string
                            example: enroll product
                          token:
                            type: string
                            example: NxL22AqLRRisfyF9LqxxWRak
                      source:
                        type: string
                        example: web
                        enum:
                          - mobile
                          - web
                          - admin
                          - backoffice
                          - subscription
                      split_payment:
                        type:
                          - object
                          - 'null'
                        description: Details about split payment if points were used
                      points_applied:
                        type: integer
                        example: 500
                        description: Number of points applied to the order
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Currency value of applied points
                      order_total_after_points_redemption:
                        type: number
                        example: 95
                        description: Order total after points redemption
                      free_shipping:
                        type: boolean
                        example: false
                        description: Whether the order has free shipping
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT1
                          - DISCOUNT2
                        description: Discount codes applied to the order
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                      shop_url:
                        type: string
                        example: https://example.com
        '202':
          description: enrollment created with pre purchase
          content:
            application/json:
              schema:
                type: object
                properties:
                  enrollment:
                    type: object
                    properties:
                      cart_token:
                        type: string
                        example: CART_TOKEN
                      state:
                        type: string
                        example: incomplete
                      token:
                        type: string
                        example: ENROLLMENT_TOKEN
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '302':
          description: Payment requires redirect
          content:
            application/json:
              schema:
                type: object
                properties:
                  redirect_url:
                    type: string
                    example: https://example.com/payment
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: checkout declined
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: unprocessable entity
                  errors:
                    type: object
                    example:
                      base: Something went wrong
                    properties:
                      payment:
                        type: array
                        items:
                          type: string
                          example: >-
                            Payment declined: Unable to process the authorize
                            transaction.
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type:
                - object
                - 'null'
              properties:
                payment_uuid:
                  type:
                    - string
                    - 'null'
                  example: 123e4567-e89b-12d3-a456-426614174000
                kount_session_id:
                  type:
                    - string
                    - 'null'
                  example: 123e4567-e89b-12d3-a456-426614174000
                browser_info:
                  type:
                    - object
                    - 'null'
                  properties:
                    color_depth:
                      type:
                        - integer
                        - 'null'
                      example: 100
                    screen_height:
                      type:
                        - integer
                        - 'null'
                      example: 100
                    screen_width:
                      type:
                        - integer
                        - 'null'
                      example: 100
                    time_zone:
                      type:
                        - integer
                        - 'null'
                      example: 100
                    java_enabled:
                      type:
                        - boolean
                        - 'null'
                      example: true
                    java_script_enabled:
                      type:
                        - boolean
                        - 'null'
                      example: true
                    language:
                      type:
                        - string
                        - 'null'
                      example: en
              required: []
  /api/carts/{cart_token}/cart_info:
    get:
      summary: Retrieves cart company information
      tags:
        - Carts
      operationId: retrieveCartInfo
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: company info found
          content:
            application/json:
              schema:
                type: object
                properties:
                  languages:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 1
                        name:
                          type: string
                          example: English
                        iso:
                          type: string
                          example: en
                  countries:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 1
                        iso:
                          type: string
                          example: US
                        name:
                          type: string
                          example: United States
        '410':
          description: Cart is processed and cannot be modified
  /api/carts/{cart_token}/change_language:
    patch:
      summary: Updates the language of a cart
      tags:
        - Carts
      operationId: changeCartLanguage
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: cart's language_iso changed
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      state:
                        type: string
                        example: start
                      processed:
                        type: boolean
                        example: false
                        description: >-
                          Determines if a cart payment has been processed or
                          not.
                      valid_for_checkout:
                        type: boolean
                        example: true
                      buyer_rep_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      buyer_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: buyer.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                              external_id:
                                type:
                                  - string
                                  - 'null'
                                example: '123241'
                            required:
                              - id
                          - type: 'null'
                      volume_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: volume.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                            required:
                              - id
                          - type: 'null'
                      currency_symbol:
                        type: string
                        example: $
                      currency_code:
                        type: string
                        example: USD
                      shipping_total_for_display:
                        type: string
                        example: Free
                      phone:
                        type:
                          - string
                          - 'null'
                        example: '4035551212'
                      payment_method_auto_assignable:
                        type: boolean
                        example: true
                        description: >-
                          Determines if a payment method can be auto-assigned to
                          the cart.
                      attribution:
                        oneOf:
                          - type: object
                            oneOf:
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  share_guid:
                                    type: string
                                    example: james-bond007
                                required:
                                  - id
                                  - share_guid
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  email:
                                    type: string
                                    example: james.bond@gmail.com
                                required:
                                  - id
                                  - email
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  username:
                                    type: string
                                    example: jaamball234
                                required:
                                  - id
                                  - username
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  fluid_rep_id:
                                    type: integer
                                    example: 23493
                                required:
                                  - id
                                  - fluid_rep_id
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: w3sdf92
                                required:
                                  - id
                          - type: 'null'
                        default:
                          id: 456
                          share_guid: james-bond007
                      agreements:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            required:
                              type: boolean
                              example: true
                            title:
                              type: string
                              example: Terms and Conditions
                            show_path:
                              type: string
                              example: /terms
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                      amount_total:
                        type: string
                        example: '121.65'
                      amount_total_in_currency:
                        type: string
                        example: $121.65 (USD)
                      sub_total:
                        type: string
                        example: '100.00'
                      sub_total_in_currency:
                        type: string
                        example: $100.00 (USD)
                      subtotal_after_discounts:
                        type: string
                        example: '90.00'
                      tax_total:
                        type: string
                        example: '20.00'
                      tax_total_in_currency:
                        type: string
                        example: $20.00 (USD)
                      shipping_total:
                        type:
                          - string
                          - 'null'
                        example: '1.65'
                      shipping_total_in_currency:
                        type: string
                        example: $1.65 (USD)
                      shipping_discount:
                        type: number
                        example: 10.25
                      discount_total:
                        type: string
                        example: '2.99'
                      discount_total_in_currency:
                        type: string
                        example: $2.99 (USD)
                      discount_breakdown:
                        type: object
                        properties:
                          internal_discounts:
                            type: number
                            example: 15
                          external_discounts:
                            type: number
                            example: 10
                          total_discounts:
                            type: number
                            example: 25
                      external_discount:
                        type: object
                        properties:
                          total:
                            type: number
                            example: 10
                          calculated_at:
                            type:
                              - string
                              - 'null'
                            format: date-time
                            example: '2024-01-10T15:30:00Z'
                          sources:
                            type: object
                            additionalProperties:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 6
                                description:
                                  type: string
                                  example: Gold tier discount
                                metadata:
                                  type: object
                              required:
                                - amount
                                - description
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: '1.90'
                      transaction_fee_in_currency:
                        type: string
                        example: $1.90 (USD)
                      cv_total:
                        type: integer
                        example: 10
                      qv_total:
                        type: integer
                        example: 15
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      payment_account:
                        type:
                          - string
                          - 'null'
                        example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                      payment_method:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: CreditCard
                              payment_method_type:
                                type: string
                                example: visa
                              last_four:
                                type: string
                                example: '1234'
                              exp_month:
                                type: string
                                example: '12'
                              exp_year:
                                type: string
                                example: '2025'
                              logo_url:
                                type: string
                                example: https://example.com/image.svg
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Paypal
                              status:
                                type: string
                                example: active
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Affirm
                              affirm_id:
                                type: string
                                example: affirm_123
                              status:
                                type: string
                                example: authorized
                              checkout_id:
                                type: string
                                example: checkout_456
                              created:
                                type: string
                                example: '2025-01-01T00:00:00Z'
                              auth_expiration:
                                type: string
                                example: '2025-01-02T00:00:00Z'
                              currency:
                                type: string
                                example: USD
                              amount:
                                type: string
                                example: '100.00'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Klarna
                              session_id:
                                type: string
                                example: klarna_session_789
                              intent:
                                type: string
                                example: buy
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Droplet
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: SomeCitcon
                      email:
                        type:
                          - string
                          - 'null'
                        example: user@example.com
                      enrollment_fee:
                        type:
                          - number
                          - string
                        example: '10.45'
                      enrollment_fee_in_currency:
                        type: string
                        example: $10.45
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT10
                          - DISCOUNT11
                      language_iso:
                        type:
                          - string
                          - 'null'
                        example: en
                      cart_token:
                        type: string
                        example: abc123
                      immutable_items:
                        type: boolean
                        example: false
                      digital_only:
                        type: boolean
                        example: false
                      requires_3ds:
                        type: boolean
                        example: false
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 101
                            price:
                              type: string
                              example: '43.41'
                            price_in_currency:
                              type: string
                              example: $43.41
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            cv:
                              type: integer
                              example: 5
                            cv_total:
                              type: integer
                              example: 15
                            qv:
                              type: integer
                              example: 7
                            qv_total:
                              type: integer
                              example: 21
                            discount_amount:
                              type: string
                              example: '10'
                            free_item:
                              type: boolean
                              example: false
                            discount_amount_in_currency:
                              type: string
                              example: $10.00
                            total_after_discounts:
                              type: string
                              example: '90.00'
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            product_title:
                              type:
                                - string
                                - 'null'
                              example: Sample Product
                            quantity:
                              type: integer
                              example: 3
                            subscription:
                              type: boolean
                              example: true
                            enrollment:
                              type: boolean
                              example: false
                            allow_subscription:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_plan_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_plans:
                              oneOf:
                                - type: array
                                  items:
                                    title: Commerce::SubscriptionPlan
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        example: Test Subscription Plan
                                        type: string
                                      billing_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      billing_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      billing_frequency_in_words:
                                        example: 2 Months
                                        type: string
                                      shipping_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      shipping_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      volume_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      volume_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      trial_period:
                                        example: 1
                                        type:
                                          - integer
                                          - 'null'
                                        minimum: 1
                                      trial_period_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type:
                                          - string
                                          - 'null'
                                      split_volume:
                                        example: true
                                        type: boolean
                                        default: false
                                      allow_max_billing_cycles:
                                        example: true
                                        type: boolean
                                        default: false
                                      max_billing_cycles:
                                        example: 3
                                        type:
                                          - integer
                                          - 'null'
                                      company_default:
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                        default: false
                                      products_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      subscribers_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      price:
                                        type: string
                                      price_in_currency:
                                        type: string
                                      subscription_start:
                                        type: string
                                      subscribe_and_save:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_in_currency:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_for_display:
                                        type:
                                          - string
                                          - 'null'
                                    required:
                                      - id
                                      - name
                                      - billing_interval
                                      - billing_interval_unit
                                      - billing_frequency_in_words
                                      - shipping_interval
                                      - shipping_interval_unit
                                      - volume_interval
                                      - volume_interval_unit
                                      - split_volume
                                      - allow_max_billing_cycles
                                      - price
                                      - price_in_currency
                                      - subscription_start
                                      - subscribe_and_save
                                      - subscribe_and_save_in_currency
                                      - subscribe_and_save_for_display
                                - type: 'null'
                            subscription_only:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_interval:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_interval_unit:
                              type:
                                - string
                                - 'null'
                              example: month
                            subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 10.5
                            subscription_price_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $10.50
                            subscription_start:
                              type:
                                - string
                                - 'null'
                              example: '2025-02-12'
                            subscribe_and_save:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 2.99
                            subscribe_and_save_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $2.99
                            subscribe_and_save_for_display:
                              type:
                                - string
                                - 'null'
                              example: Subscribe and save $2.99
                            title:
                              type:
                                - string
                                - 'null'
                              example: Surcharge
                            metadata:
                              type: object
                              description: >-
                                A JSON object that can store any custom data
                                structure
                              example: {}
                            product:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type: string
                                      example: Sample Product
                                    introduction:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Product Description
                                    cv:
                                      type: integer
                                      example: 10
                                    external_id:
                                      type:
                                        - string
                                        - 'null'
                                      example: ext-prod-123
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/product.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/product.png
                                    price:
                                      type: string
                                      example: '29.99'
                                    price_in_currency:
                                      type: string
                                      example: $29.99
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    tax:
                                      type: string
                                      example: '2.99'
                                    tax_in_currency:
                                      type: string
                                      example: $2.99
                                    metadata:
                                      type: object
                                      example:
                                        shopify_product_id: 9876054868270
                                    metafields:
                                      type: array
                                      items:
                                        title: LegacyMetafield
                                        type: object
                                        properties:
                                          namespace:
                                            description: >-
                                              A container for related metafields.
                                              Commonly used to group metafields by app
                                              or functionality.
                                            example: custom
                                            type: string
                                            maxLength: 20
                                            pattern: ^[a-zA-Z0-9_]+$
                                          key:
                                            description: >-
                                              The unique identifier for the metafield
                                              within its namespace. Must be unique per
                                              namespace and owner.
                                            example: material
                                            type: string
                                            maxLength: 30
                                            pattern: ^[a-zA-Z0-9_]+$
                                          value:
                                            description: >-
                                              The actual data stored in the metafield.
                                              Type depends on value_type.
                                            example: cotton
                                            type:
                                              - string
                                              - integer
                                              - object
                                              - boolean
                                              - number
                                          value_type:
                                            description: >-
                                              The data type that defines how the value
                                              should be interpreted and validated.
                                            example: single_line_text_field
                                            type: string
                                          description:
                                            description: >-
                                              Optional human-readable description
                                              explaining the purpose of this
                                              metafield.
                                            example: >-
                                              The primary material used in this
                                              product
                                            type:
                                              - string
                                              - 'null'
                                          created_at:
                                            description: >-
                                              Timestamp when the metafield was
                                              created.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          updated_at:
                                            description: >-
                                              Timestamp when the metafield was last
                                              updated.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          locked:
                                            description: >-
                                              Whether this metafield is locked and
                                              cannot be updated or deleted directly.
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                              - 'null'
                                          metafield_definition:
                                            description: >-
                                              The definition that defines validation
                                              rules and structure for this metafield
                                            type:
                                              - 'null'
                                              - object
                                        required:
                                          - namespace
                                          - key
                                          - value
                                          - value_type
                                          - description
                                          - created_at
                                          - updated_at
                                          - metafield_definition
                                - type: 'null'
                            variant:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Variant
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/sample.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/sample.png
                                    primary_image:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/primary.png
                                    price:
                                      type:
                                        - string
                                        - 'null'
                                      example: '34.44'
                                    price_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $34.44
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    options:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          title:
                                            type: string
                                            example: Size
                                          value:
                                            type: string
                                            example: XL
                                    physical:
                                      type:
                                        - boolean
                                        - 'null'
                                      example: true
                                    unit_of_size:
                                      type:
                                        - string
                                        - 'null'
                                      example: cm
                                    height:
                                      type:
                                        - number
                                        - 'null'
                                      example: 13
                                    width:
                                      type:
                                        - number
                                        - 'null'
                                      example: 6
                                    length:
                                      type:
                                        - number
                                        - 'null'
                                      example: 12
                                    unit_of_weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: kg
                                    weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                    hs_code:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                - type: 'null'
                            errors:
                              oneOf:
                                - type: 'null'
                                - type: array
                                  items:
                                    type: object
                                  example:
                                    - country:
                                        - >-
                                          This product is not available for this
                                          country. Please change your country
                            bundled_items:
                              type: array
                              items:
                                type: object
                                description: Bundled items for bundle products
                                properties:
                                  variant_id:
                                    type: integer
                                    example: 1
                                  product_id:
                                    type: integer
                                    example: 1
                                  product_title:
                                    type: string
                                    example: Product Title
                                  variant_title:
                                    type: string
                                    example: Variant Title
                                  option_titles:
                                    type: array
                                    example:
                                      - Option 1
                                      - Option 2
                                  quantity:
                                    type: integer
                                    example: 1
                                  display_to_customer:
                                    type: boolean
                                    example: true
                      ship_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      bill_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      shipping_method:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: string
                            example: standard-shipping
                          name:
                            type: string
                            example: Standard Shipping
                      available_shipping_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: standard-shipping
                            title:
                              type: string
                              example: Standard Shipping
                            price:
                              type:
                                - number
                                - string
                              example: 5.99
                            price_label:
                              type: string
                              example: $5.99
                            delivery_time_estimate:
                              type: string
                              example: 3-5 business days
                      available_payment_methods:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - credit_card
                                name:
                                  type: string
                                  example: Credit Card
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                apple_pay:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method supports
                                    ApplePay or not 
                                bogus_gateway:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is a Bogus
                                    instance or not.
                                tokenize_path:
                                  type:
                                    - string
                                    - 'null'
                                  description: Path to tokenize, if applicable.
                                token_provider:
                                  type: string
                                  enum:
                                    - spreedly
                                    - vgs
                                  description: >-
                                    Determines if payment tokenization is via
                                    spreedly or VGS
                                apple_pay_merchant_identifier:
                                  type:
                                    - string
                                    - 'null'
                                  example: merchant.mycompany.com
                                  description: >-
                                    If ApplePay is supported, returns the
                                    merchant identifier registered with Apple,
                                    else returns nil
                                supported_brands:
                                  type: array
                                  items:
                                    type: string
                                  example:
                                    - visa
                                    - master
                                    - american_express
                                    - discover
                                publishable_key:
                                  type:
                                    - string
                                    - 'null'
                                  example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                  description: >-
                                    If publishable key is set for Hyperswitch,
                                    returns the publishable key, else returns
                                    nil
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                              required:
                                - id
                                - type
                                - name
                                - supported_brands
                                - test
                                - sandbox
                                - apple_pay
                                - apple_pay_merchant_identifier
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - klarna
                                name:
                                  type: string
                                  example: Klarna
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                      country:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          iso:
                            type: string
                            example: US
                          name:
                            type: string
                            example: United States
                          iso_name:
                            type: string
                            example: UNITED STATES
                          iso3:
                            type: string
                            example: USA
                          currency_code:
                            type: string
                            example: USD
                          currency_symbol:
                            type: string
                            example: $
                          province_required:
                            type: boolean
                            example: false
                          tax_enabled:
                            type:
                              - boolean
                              - 'null'
                            example: true
                          price_inclusive_of_tax:
                            type: boolean
                            example: false
                          price_inclusive_tax_name:
                            type:
                              - string
                              - 'null'
                            example: VAT
                      type:
                        type: string
                        enum:
                          - regular
                          - enrollment
                        example: regular
                      enrollment_pack_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      enrollment_pack:
                        type:
                          - object
                          - 'null'
                        properties:
                          enrollment_pack_id:
                            type: integer
                            example: 1
                          additional_volume:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          slug:
                            type: string
                            example: test-enrollment-pack
                          description:
                            type:
                              - object
                              - 'null'
                              - string
                            properties:
                              id:
                                type: integer
                                example: 111
                              name:
                                type: string
                                example: description
                              body:
                                type: string
                                example: >-
                                  <div>Try the latest and greatest of our sugar
                                  zip packs. Guaranteed to make you skinner and
                                  cure cancer.</div>
                              record_type:
                                type: string
                                example: EnrollmentPack
                              record_id:
                                type: integer
                                example: 1
                              created_at:
                                type: string
                                format: date_time
                                example: '2025-01-16T04:22:43.809Z'
                              updated_at:
                                type: string
                                format: date_time
                                example: '2025-01-22T10:23:52.941Z'
                              locale:
                                type: string
                                example: en
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: 10
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.00
                          images:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2
                                relateable_type:
                                  type: string
                                  example: EnrollmentPack
                                relateable_id:
                                  type: integer
                                  example: 1
                                image_url:
                                  type: string
                                  example: >-
                                    https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                image_path:
                                  type: string
                                  example: jITWaU14QGe0y5AFgY7P_00179.svg
                                position:
                                  type: integer
                                  example: 1
                                shopify_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                                created_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                updated_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                external_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 625
                                allow_subscription:
                                  type: boolean
                                  example: true
                                cv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                cv_in_currency:
                                  type: string
                                  example: $0.00
                                cv_total:
                                  type: integer
                                  example: 0
                                enrollment:
                                  type: boolean
                                  example: true
                                enrollment_pack_id:
                                  type: integer
                                  example: 1
                                price:
                                  type: string
                                  example: '11.13'
                                price_in_currency:
                                  type: string
                                  example: $11.13
                                product_title:
                                  type: string
                                  example: Zip Pack Sample Pack (30)
                                quantity:
                                  type: integer
                                  example: 1
                                qv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                qv_in_currency:
                                  type: string
                                  example: $0.00
                                qv_total:
                                  type: integer
                                  example: 0
                                subscribe_and_save:
                                  type:
                                    - string
                                    - 'null'
                                  example: '-1988.87'
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $-1,988.87
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $-1,988.87
                                subscription:
                                  type: boolean
                                  example: false
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_only:
                                  type: boolean
                                  example: false
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_price:
                                  type: string
                                  example: '2000.0'
                                subscription_price_in_currency:
                                  type: string
                                  example: $2,000.00
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  format: date
                                  example: '2025-02-28'
                                tax:
                                  type: string
                                  example: '0.0'
                                tax_in_currency:
                                  type: string
                                  example: $0.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: null
                                display_to_customer:
                                  type: boolean
                                  example: false
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                          price:
                            type: string
                            example: '11.13'
                          price_in_currency:
                            type: string
                            example: $11.13
                          subscription_price:
                            type:
                              - string
                              - integer
                            example: 2000
                          subscription_price_in_currency:
                            type: string
                            example: $2,000.00
                          title:
                            type: string
                            example: enroll product
                          token:
                            type: string
                            example: NxL22AqLRRisfyF9LqxxWRak
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      recurring:
                        oneOf:
                          - type: array
                            items:
                              type: object
                              properties:
                                subtotal:
                                  type: string
                                  example: '10.0'
                                subtotal_in_currency:
                                  type: string
                                  example: $10.0
                                interval:
                                  type: integer
                                  example: 1
                                interval_unit:
                                  type: string
                                  example: month
                                subtotal_for_display:
                                  type: string
                                  example: $10.00 every 1 month
                                start_date:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-05-27'
                          - type: 'null'
                        default:
                          - subtotal: '10.0'
                            subtotal_in_currency: $10.0
                            interval: 1
                            interval_unit: month
                            subtotal_for_display: $10.00 every 1 month
                            start_date: '2025-05-27'
                      messages:
                        type: object
                        additionalProperties: true
                        example:
                          errors:
                            - Insufficient inventory
                            - Product no longer available
                          warnings:
                            - Low stock warning
                            - Shipping delays expected
                          info:
                            - Free shipping available
                            - Volume discount applied
                      points_enabled:
                        type: boolean
                        example: true
                      points_applied:
                        type: integer
                        example: 500
                        description: Number of points applied to the cart
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Currency value of applied points
                      customer_total_points:
                        type: integer
                        example: 1000
                        description: Customer's total available points balance
                      customer_total_points_in_currency:
                        type: number
                        example: 10
                        description: Currency value of available points
                      remaining_customer_points:
                        type: integer
                        example: 500
                        description: Customer's remaining points after cart redemption
                      remaining_customer_points_amount_in_currency:
                        type: number
                        example: 5
                        description: >-
                          Currency value of remaining points after cart
                          redemption
                      remaining_cart_amount_after_points:
                        type: number
                        example: 95
                        description: Amount to charge to card after points redemption
                      remaining_cart_amount_after_points_in_currency:
                        type:
                          - string
                        example: $95.00
                        description: >-
                          Amount in currency to charge to card after points
                          redemption
                      max_applicable_points:
                        type: integer
                        example: 500
                        description: Maximum points that can be applied to this cart
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      checkout_url:
                        type: string
                        example: https://checkout.fluid.com/checkout?jwt=abc123
                      shop_url:
                        type: string
                        example: https://myco.fluid.app
        '400':
          description: unavailable locale for the company
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Language not supported
        '410':
          description: Cart is processed and cannot be modified
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                language_iso:
                  type: string
                  example: en
        required: true
        description: List of valid iso are at `/api/carts/{cart_token}/cart_info`
  /api/carts/{cart_token}/update_country:
    patch:
      summary: Updates the country of a cart, also updates the currency code
      tags:
        - Carts
      operationId: changeCartCountry
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: cart's country and currency code changed
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      state:
                        type: string
                        example: start
                      processed:
                        type: boolean
                        example: false
                        description: >-
                          Determines if a cart payment has been processed or
                          not.
                      valid_for_checkout:
                        type: boolean
                        example: true
                      buyer_rep_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      buyer_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: buyer.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                              external_id:
                                type:
                                  - string
                                  - 'null'
                                example: '123241'
                            required:
                              - id
                          - type: 'null'
                      volume_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: volume.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                            required:
                              - id
                          - type: 'null'
                      currency_symbol:
                        type: string
                        example: $
                      currency_code:
                        type: string
                        example: USD
                      shipping_total_for_display:
                        type: string
                        example: Free
                      phone:
                        type:
                          - string
                          - 'null'
                        example: '4035551212'
                      payment_method_auto_assignable:
                        type: boolean
                        example: true
                        description: >-
                          Determines if a payment method can be auto-assigned to
                          the cart.
                      attribution:
                        oneOf:
                          - type: object
                            oneOf:
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  share_guid:
                                    type: string
                                    example: james-bond007
                                required:
                                  - id
                                  - share_guid
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  email:
                                    type: string
                                    example: james.bond@gmail.com
                                required:
                                  - id
                                  - email
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  username:
                                    type: string
                                    example: jaamball234
                                required:
                                  - id
                                  - username
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  fluid_rep_id:
                                    type: integer
                                    example: 23493
                                required:
                                  - id
                                  - fluid_rep_id
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: w3sdf92
                                required:
                                  - id
                          - type: 'null'
                        default:
                          id: 456
                          share_guid: james-bond007
                      agreements:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            required:
                              type: boolean
                              example: true
                            title:
                              type: string
                              example: Terms and Conditions
                            show_path:
                              type: string
                              example: /terms
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                      amount_total:
                        type: string
                        example: '121.65'
                      amount_total_in_currency:
                        type: string
                        example: $121.65 (USD)
                      sub_total:
                        type: string
                        example: '100.00'
                      sub_total_in_currency:
                        type: string
                        example: $100.00 (USD)
                      subtotal_after_discounts:
                        type: string
                        example: '90.00'
                      tax_total:
                        type: string
                        example: '20.00'
                      tax_total_in_currency:
                        type: string
                        example: $20.00 (USD)
                      shipping_total:
                        type:
                          - string
                          - 'null'
                        example: '1.65'
                      shipping_total_in_currency:
                        type: string
                        example: $1.65 (USD)
                      shipping_discount:
                        type: number
                        example: 10.25
                      discount_total:
                        type: string
                        example: '2.99'
                      discount_total_in_currency:
                        type: string
                        example: $2.99 (USD)
                      discount_breakdown:
                        type: object
                        properties:
                          internal_discounts:
                            type: number
                            example: 15
                          external_discounts:
                            type: number
                            example: 10
                          total_discounts:
                            type: number
                            example: 25
                      external_discount:
                        type: object
                        properties:
                          total:
                            type: number
                            example: 10
                          calculated_at:
                            type:
                              - string
                              - 'null'
                            format: date-time
                            example: '2024-01-10T15:30:00Z'
                          sources:
                            type: object
                            additionalProperties:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 6
                                description:
                                  type: string
                                  example: Gold tier discount
                                metadata:
                                  type: object
                              required:
                                - amount
                                - description
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: '1.90'
                      transaction_fee_in_currency:
                        type: string
                        example: $1.90 (USD)
                      cv_total:
                        type: integer
                        example: 10
                      qv_total:
                        type: integer
                        example: 15
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      payment_account:
                        type:
                          - string
                          - 'null'
                        example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                      payment_method:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: CreditCard
                              payment_method_type:
                                type: string
                                example: visa
                              last_four:
                                type: string
                                example: '1234'
                              exp_month:
                                type: string
                                example: '12'
                              exp_year:
                                type: string
                                example: '2025'
                              logo_url:
                                type: string
                                example: https://example.com/image.svg
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Paypal
                              status:
                                type: string
                                example: active
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Affirm
                              affirm_id:
                                type: string
                                example: affirm_123
                              status:
                                type: string
                                example: authorized
                              checkout_id:
                                type: string
                                example: checkout_456
                              created:
                                type: string
                                example: '2025-01-01T00:00:00Z'
                              auth_expiration:
                                type: string
                                example: '2025-01-02T00:00:00Z'
                              currency:
                                type: string
                                example: USD
                              amount:
                                type: string
                                example: '100.00'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Klarna
                              session_id:
                                type: string
                                example: klarna_session_789
                              intent:
                                type: string
                                example: buy
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Droplet
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: SomeCitcon
                      email:
                        type:
                          - string
                          - 'null'
                        example: user@example.com
                      enrollment_fee:
                        type:
                          - number
                          - string
                        example: '10.45'
                      enrollment_fee_in_currency:
                        type: string
                        example: $10.45
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT10
                          - DISCOUNT11
                      language_iso:
                        type:
                          - string
                          - 'null'
                        example: en
                      cart_token:
                        type: string
                        example: abc123
                      immutable_items:
                        type: boolean
                        example: false
                      digital_only:
                        type: boolean
                        example: false
                      requires_3ds:
                        type: boolean
                        example: false
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 101
                            price:
                              type: string
                              example: '43.41'
                            price_in_currency:
                              type: string
                              example: $43.41
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            cv:
                              type: integer
                              example: 5
                            cv_total:
                              type: integer
                              example: 15
                            qv:
                              type: integer
                              example: 7
                            qv_total:
                              type: integer
                              example: 21
                            discount_amount:
                              type: string
                              example: '10'
                            free_item:
                              type: boolean
                              example: false
                            discount_amount_in_currency:
                              type: string
                              example: $10.00
                            total_after_discounts:
                              type: string
                              example: '90.00'
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            product_title:
                              type:
                                - string
                                - 'null'
                              example: Sample Product
                            quantity:
                              type: integer
                              example: 3
                            subscription:
                              type: boolean
                              example: true
                            enrollment:
                              type: boolean
                              example: false
                            allow_subscription:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_plan_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_plans:
                              oneOf:
                                - type: array
                                  items:
                                    title: Commerce::SubscriptionPlan
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        example: Test Subscription Plan
                                        type: string
                                      billing_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      billing_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      billing_frequency_in_words:
                                        example: 2 Months
                                        type: string
                                      shipping_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      shipping_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      volume_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      volume_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      trial_period:
                                        example: 1
                                        type:
                                          - integer
                                          - 'null'
                                        minimum: 1
                                      trial_period_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type:
                                          - string
                                          - 'null'
                                      split_volume:
                                        example: true
                                        type: boolean
                                        default: false
                                      allow_max_billing_cycles:
                                        example: true
                                        type: boolean
                                        default: false
                                      max_billing_cycles:
                                        example: 3
                                        type:
                                          - integer
                                          - 'null'
                                      company_default:
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                        default: false
                                      products_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      subscribers_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      price:
                                        type: string
                                      price_in_currency:
                                        type: string
                                      subscription_start:
                                        type: string
                                      subscribe_and_save:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_in_currency:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_for_display:
                                        type:
                                          - string
                                          - 'null'
                                    required:
                                      - id
                                      - name
                                      - billing_interval
                                      - billing_interval_unit
                                      - billing_frequency_in_words
                                      - shipping_interval
                                      - shipping_interval_unit
                                      - volume_interval
                                      - volume_interval_unit
                                      - split_volume
                                      - allow_max_billing_cycles
                                      - price
                                      - price_in_currency
                                      - subscription_start
                                      - subscribe_and_save
                                      - subscribe_and_save_in_currency
                                      - subscribe_and_save_for_display
                                - type: 'null'
                            subscription_only:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_interval:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_interval_unit:
                              type:
                                - string
                                - 'null'
                              example: month
                            subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 10.5
                            subscription_price_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $10.50
                            subscription_start:
                              type:
                                - string
                                - 'null'
                              example: '2025-02-12'
                            subscribe_and_save:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 2.99
                            subscribe_and_save_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $2.99
                            subscribe_and_save_for_display:
                              type:
                                - string
                                - 'null'
                              example: Subscribe and save $2.99
                            title:
                              type:
                                - string
                                - 'null'
                              example: Surcharge
                            metadata:
                              type: object
                              description: >-
                                A JSON object that can store any custom data
                                structure
                              example: {}
                            product:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type: string
                                      example: Sample Product
                                    introduction:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Product Description
                                    cv:
                                      type: integer
                                      example: 10
                                    external_id:
                                      type:
                                        - string
                                        - 'null'
                                      example: ext-prod-123
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/product.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/product.png
                                    price:
                                      type: string
                                      example: '29.99'
                                    price_in_currency:
                                      type: string
                                      example: $29.99
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    tax:
                                      type: string
                                      example: '2.99'
                                    tax_in_currency:
                                      type: string
                                      example: $2.99
                                    metadata:
                                      type: object
                                      example:
                                        shopify_product_id: 9876054868270
                                    metafields:
                                      type: array
                                      items:
                                        title: LegacyMetafield
                                        type: object
                                        properties:
                                          namespace:
                                            description: >-
                                              A container for related metafields.
                                              Commonly used to group metafields by app
                                              or functionality.
                                            example: custom
                                            type: string
                                            maxLength: 20
                                            pattern: ^[a-zA-Z0-9_]+$
                                          key:
                                            description: >-
                                              The unique identifier for the metafield
                                              within its namespace. Must be unique per
                                              namespace and owner.
                                            example: material
                                            type: string
                                            maxLength: 30
                                            pattern: ^[a-zA-Z0-9_]+$
                                          value:
                                            description: >-
                                              The actual data stored in the metafield.
                                              Type depends on value_type.
                                            example: cotton
                                            type:
                                              - string
                                              - integer
                                              - object
                                              - boolean
                                              - number
                                          value_type:
                                            description: >-
                                              The data type that defines how the value
                                              should be interpreted and validated.
                                            example: single_line_text_field
                                            type: string
                                          description:
                                            description: >-
                                              Optional human-readable description
                                              explaining the purpose of this
                                              metafield.
                                            example: >-
                                              The primary material used in this
                                              product
                                            type:
                                              - string
                                              - 'null'
                                          created_at:
                                            description: >-
                                              Timestamp when the metafield was
                                              created.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          updated_at:
                                            description: >-
                                              Timestamp when the metafield was last
                                              updated.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          locked:
                                            description: >-
                                              Whether this metafield is locked and
                                              cannot be updated or deleted directly.
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                              - 'null'
                                          metafield_definition:
                                            description: >-
                                              The definition that defines validation
                                              rules and structure for this metafield
                                            type:
                                              - 'null'
                                              - object
                                        required:
                                          - namespace
                                          - key
                                          - value
                                          - value_type
                                          - description
                                          - created_at
                                          - updated_at
                                          - metafield_definition
                                - type: 'null'
                            variant:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Variant
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/sample.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/sample.png
                                    primary_image:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/primary.png
                                    price:
                                      type:
                                        - string
                                        - 'null'
                                      example: '34.44'
                                    price_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $34.44
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    options:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          title:
                                            type: string
                                            example: Size
                                          value:
                                            type: string
                                            example: XL
                                    physical:
                                      type:
                                        - boolean
                                        - 'null'
                                      example: true
                                    unit_of_size:
                                      type:
                                        - string
                                        - 'null'
                                      example: cm
                                    height:
                                      type:
                                        - number
                                        - 'null'
                                      example: 13
                                    width:
                                      type:
                                        - number
                                        - 'null'
                                      example: 6
                                    length:
                                      type:
                                        - number
                                        - 'null'
                                      example: 12
                                    unit_of_weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: kg
                                    weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                    hs_code:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                - type: 'null'
                            errors:
                              oneOf:
                                - type: 'null'
                                - type: array
                                  items:
                                    type: object
                                  example:
                                    - country:
                                        - >-
                                          This product is not available for this
                                          country. Please change your country
                            bundled_items:
                              type: array
                              items:
                                type: object
                                description: Bundled items for bundle products
                                properties:
                                  variant_id:
                                    type: integer
                                    example: 1
                                  product_id:
                                    type: integer
                                    example: 1
                                  product_title:
                                    type: string
                                    example: Product Title
                                  variant_title:
                                    type: string
                                    example: Variant Title
                                  option_titles:
                                    type: array
                                    example:
                                      - Option 1
                                      - Option 2
                                  quantity:
                                    type: integer
                                    example: 1
                                  display_to_customer:
                                    type: boolean
                                    example: true
                      ship_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      bill_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      shipping_method:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: string
                            example: standard-shipping
                          name:
                            type: string
                            example: Standard Shipping
                      available_shipping_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: standard-shipping
                            title:
                              type: string
                              example: Standard Shipping
                            price:
                              type:
                                - number
                                - string
                              example: 5.99
                            price_label:
                              type: string
                              example: $5.99
                            delivery_time_estimate:
                              type: string
                              example: 3-5 business days
                      available_payment_methods:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - credit_card
                                name:
                                  type: string
                                  example: Credit Card
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                apple_pay:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method supports
                                    ApplePay or not 
                                bogus_gateway:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is a Bogus
                                    instance or not.
                                tokenize_path:
                                  type:
                                    - string
                                    - 'null'
                                  description: Path to tokenize, if applicable.
                                token_provider:
                                  type: string
                                  enum:
                                    - spreedly
                                    - vgs
                                  description: >-
                                    Determines if payment tokenization is via
                                    spreedly or VGS
                                apple_pay_merchant_identifier:
                                  type:
                                    - string
                                    - 'null'
                                  example: merchant.mycompany.com
                                  description: >-
                                    If ApplePay is supported, returns the
                                    merchant identifier registered with Apple,
                                    else returns nil
                                supported_brands:
                                  type: array
                                  items:
                                    type: string
                                  example:
                                    - visa
                                    - master
                                    - american_express
                                    - discover
                                publishable_key:
                                  type:
                                    - string
                                    - 'null'
                                  example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                  description: >-
                                    If publishable key is set for Hyperswitch,
                                    returns the publishable key, else returns
                                    nil
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                              required:
                                - id
                                - type
                                - name
                                - supported_brands
                                - test
                                - sandbox
                                - apple_pay
                                - apple_pay_merchant_identifier
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - klarna
                                name:
                                  type: string
                                  example: Klarna
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                      country:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          iso:
                            type: string
                            example: US
                          name:
                            type: string
                            example: United States
                          iso_name:
                            type: string
                            example: UNITED STATES
                          iso3:
                            type: string
                            example: USA
                          currency_code:
                            type: string
                            example: USD
                          currency_symbol:
                            type: string
                            example: $
                          province_required:
                            type: boolean
                            example: false
                          tax_enabled:
                            type:
                              - boolean
                              - 'null'
                            example: true
                          price_inclusive_of_tax:
                            type: boolean
                            example: false
                          price_inclusive_tax_name:
                            type:
                              - string
                              - 'null'
                            example: VAT
                      type:
                        type: string
                        enum:
                          - regular
                          - enrollment
                        example: regular
                      enrollment_pack_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      enrollment_pack:
                        type:
                          - object
                          - 'null'
                        properties:
                          enrollment_pack_id:
                            type: integer
                            example: 1
                          additional_volume:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          slug:
                            type: string
                            example: test-enrollment-pack
                          description:
                            type:
                              - object
                              - 'null'
                              - string
                            properties:
                              id:
                                type: integer
                                example: 111
                              name:
                                type: string
                                example: description
                              body:
                                type: string
                                example: >-
                                  <div>Try the latest and greatest of our sugar
                                  zip packs. Guaranteed to make you skinner and
                                  cure cancer.</div>
                              record_type:
                                type: string
                                example: EnrollmentPack
                              record_id:
                                type: integer
                                example: 1
                              created_at:
                                type: string
                                format: date_time
                                example: '2025-01-16T04:22:43.809Z'
                              updated_at:
                                type: string
                                format: date_time
                                example: '2025-01-22T10:23:52.941Z'
                              locale:
                                type: string
                                example: en
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: 10
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.00
                          images:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2
                                relateable_type:
                                  type: string
                                  example: EnrollmentPack
                                relateable_id:
                                  type: integer
                                  example: 1
                                image_url:
                                  type: string
                                  example: >-
                                    https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                image_path:
                                  type: string
                                  example: jITWaU14QGe0y5AFgY7P_00179.svg
                                position:
                                  type: integer
                                  example: 1
                                shopify_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                                created_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                updated_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                external_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 625
                                allow_subscription:
                                  type: boolean
                                  example: true
                                cv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                cv_in_currency:
                                  type: string
                                  example: $0.00
                                cv_total:
                                  type: integer
                                  example: 0
                                enrollment:
                                  type: boolean
                                  example: true
                                enrollment_pack_id:
                                  type: integer
                                  example: 1
                                price:
                                  type: string
                                  example: '11.13'
                                price_in_currency:
                                  type: string
                                  example: $11.13
                                product_title:
                                  type: string
                                  example: Zip Pack Sample Pack (30)
                                quantity:
                                  type: integer
                                  example: 1
                                qv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                qv_in_currency:
                                  type: string
                                  example: $0.00
                                qv_total:
                                  type: integer
                                  example: 0
                                subscribe_and_save:
                                  type:
                                    - string
                                    - 'null'
                                  example: '-1988.87'
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $-1,988.87
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $-1,988.87
                                subscription:
                                  type: boolean
                                  example: false
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_only:
                                  type: boolean
                                  example: false
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_price:
                                  type: string
                                  example: '2000.0'
                                subscription_price_in_currency:
                                  type: string
                                  example: $2,000.00
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  format: date
                                  example: '2025-02-28'
                                tax:
                                  type: string
                                  example: '0.0'
                                tax_in_currency:
                                  type: string
                                  example: $0.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: null
                                display_to_customer:
                                  type: boolean
                                  example: false
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                          price:
                            type: string
                            example: '11.13'
                          price_in_currency:
                            type: string
                            example: $11.13
                          subscription_price:
                            type:
                              - string
                              - integer
                            example: 2000
                          subscription_price_in_currency:
                            type: string
                            example: $2,000.00
                          title:
                            type: string
                            example: enroll product
                          token:
                            type: string
                            example: NxL22AqLRRisfyF9LqxxWRak
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      recurring:
                        oneOf:
                          - type: array
                            items:
                              type: object
                              properties:
                                subtotal:
                                  type: string
                                  example: '10.0'
                                subtotal_in_currency:
                                  type: string
                                  example: $10.0
                                interval:
                                  type: integer
                                  example: 1
                                interval_unit:
                                  type: string
                                  example: month
                                subtotal_for_display:
                                  type: string
                                  example: $10.00 every 1 month
                                start_date:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-05-27'
                          - type: 'null'
                        default:
                          - subtotal: '10.0'
                            subtotal_in_currency: $10.0
                            interval: 1
                            interval_unit: month
                            subtotal_for_display: $10.00 every 1 month
                            start_date: '2025-05-27'
                      messages:
                        type: object
                        additionalProperties: true
                        example:
                          errors:
                            - Insufficient inventory
                            - Product no longer available
                          warnings:
                            - Low stock warning
                            - Shipping delays expected
                          info:
                            - Free shipping available
                            - Volume discount applied
                      points_enabled:
                        type: boolean
                        example: true
                      points_applied:
                        type: integer
                        example: 500
                        description: Number of points applied to the cart
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Currency value of applied points
                      customer_total_points:
                        type: integer
                        example: 1000
                        description: Customer's total available points balance
                      customer_total_points_in_currency:
                        type: number
                        example: 10
                        description: Currency value of available points
                      remaining_customer_points:
                        type: integer
                        example: 500
                        description: Customer's remaining points after cart redemption
                      remaining_customer_points_amount_in_currency:
                        type: number
                        example: 5
                        description: >-
                          Currency value of remaining points after cart
                          redemption
                      remaining_cart_amount_after_points:
                        type: number
                        example: 95
                        description: Amount to charge to card after points redemption
                      remaining_cart_amount_after_points_in_currency:
                        type:
                          - string
                        example: $95.00
                        description: >-
                          Amount in currency to charge to card after points
                          redemption
                      max_applicable_points:
                        type: integer
                        example: 500
                        description: Maximum points that can be applied to this cart
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '404':
          description: country not supported by company
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Country not found or not supported by this company
                  errors:
                    type: object
                    example:
                      country_code:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '410':
          description: Cart is processed and cannot be modified
      requestBody:
        content:
          application/json:
            schema:
              required:
                - country_code
              type: object
              properties:
                country_code:
                  type: string
                  example: US
        description: ISO country code to update the cart to
  /api/carts/{cart_token}/magic_link:
    post:
      summary: Create magic link for cart
      tags:
        - Carts
      operationId: createCartMagicLink
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
      responses:
        '201':
          description: magic link created
          content:
            application/json:
              schema:
                type: object
                properties:
                  multi_factor_authentication:
                    type: object
                    properties:
                      uuid:
                        type: string
                      authenticated:
                        type: boolean
                      verification_channel:
                        type: string
                      verification_code_expires_at:
                        type: string
                        format: date-time
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
        '410':
          description: Cart is processed and cannot be modified
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                email:
                  type: string
                  example: example@gmail.com
                fluid_shop:
                  type: string
                  example: fluid.app
                lookup_only:
                  type: boolean
                  example: true
              required:
                - email
                - fluid_shop
  /api/carts/{cart_token}/confirm_magic_link:
    post:
      summary: Confirm magic link for cart
      tags:
        - Carts
      operationId: confirmCartMagicLink
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: magic link confirmed
          content:
            application/json:
              schema:
                type: object
                properties:
                  jwt:
                    type: string
                  authenticated:
                    type: boolean
                  auth_type:
                    type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '410':
          description: Cart is processed and cannot be modified
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                uuid:
                  type: string
                multi_factor_authentication:
                  type: object
                  properties:
                    verification_code:
                      type: string
                  required:
                    - verification_code
              required:
                - uuid
                - multi_factor_authentication
  /api/carts/{cart_token}/enrollment:
    post:
      summary: Add enrollment to existing cart
      tags:
        - Carts
      operationId: addEnrollmentToCart
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Enrollment pack added to cart
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      state:
                        type: string
                        example: start
                      processed:
                        type: boolean
                        example: false
                        description: >-
                          Determines if a cart payment has been processed or
                          not.
                      valid_for_checkout:
                        type: boolean
                        example: true
                      buyer_rep_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      buyer_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: buyer.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                              external_id:
                                type:
                                  - string
                                  - 'null'
                                example: '123241'
                            required:
                              - id
                          - type: 'null'
                      volume_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: volume.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                            required:
                              - id
                          - type: 'null'
                      currency_symbol:
                        type: string
                        example: $
                      currency_code:
                        type: string
                        example: USD
                      shipping_total_for_display:
                        type: string
                        example: Free
                      phone:
                        type:
                          - string
                          - 'null'
                        example: '4035551212'
                      payment_method_auto_assignable:
                        type: boolean
                        example: true
                        description: >-
                          Determines if a payment method can be auto-assigned to
                          the cart.
                      attribution:
                        oneOf:
                          - type: object
                            oneOf:
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  share_guid:
                                    type: string
                                    example: james-bond007
                                required:
                                  - id
                                  - share_guid
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  email:
                                    type: string
                                    example: james.bond@gmail.com
                                required:
                                  - id
                                  - email
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  username:
                                    type: string
                                    example: jaamball234
                                required:
                                  - id
                                  - username
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  fluid_rep_id:
                                    type: integer
                                    example: 23493
                                required:
                                  - id
                                  - fluid_rep_id
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: w3sdf92
                                required:
                                  - id
                          - type: 'null'
                        default:
                          id: 456
                          share_guid: james-bond007
                      agreements:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            required:
                              type: boolean
                              example: true
                            title:
                              type: string
                              example: Terms and Conditions
                            show_path:
                              type: string
                              example: /terms
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                      amount_total:
                        type: string
                        example: '121.65'
                      amount_total_in_currency:
                        type: string
                        example: $121.65 (USD)
                      sub_total:
                        type: string
                        example: '100.00'
                      sub_total_in_currency:
                        type: string
                        example: $100.00 (USD)
                      subtotal_after_discounts:
                        type: string
                        example: '90.00'
                      tax_total:
                        type: string
                        example: '20.00'
                      tax_total_in_currency:
                        type: string
                        example: $20.00 (USD)
                      shipping_total:
                        type:
                          - string
                          - 'null'
                        example: '1.65'
                      shipping_total_in_currency:
                        type: string
                        example: $1.65 (USD)
                      shipping_discount:
                        type: number
                        example: 10.25
                      discount_total:
                        type: string
                        example: '2.99'
                      discount_total_in_currency:
                        type: string
                        example: $2.99 (USD)
                      discount_breakdown:
                        type: object
                        properties:
                          internal_discounts:
                            type: number
                            example: 15
                          external_discounts:
                            type: number
                            example: 10
                          total_discounts:
                            type: number
                            example: 25
                      external_discount:
                        type: object
                        properties:
                          total:
                            type: number
                            example: 10
                          calculated_at:
                            type:
                              - string
                              - 'null'
                            format: date-time
                            example: '2024-01-10T15:30:00Z'
                          sources:
                            type: object
                            additionalProperties:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 6
                                description:
                                  type: string
                                  example: Gold tier discount
                                metadata:
                                  type: object
                              required:
                                - amount
                                - description
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: '1.90'
                      transaction_fee_in_currency:
                        type: string
                        example: $1.90 (USD)
                      cv_total:
                        type: integer
                        example: 10
                      qv_total:
                        type: integer
                        example: 15
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      payment_account:
                        type:
                          - string
                          - 'null'
                        example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                      payment_method:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: CreditCard
                              payment_method_type:
                                type: string
                                example: visa
                              last_four:
                                type: string
                                example: '1234'
                              exp_month:
                                type: string
                                example: '12'
                              exp_year:
                                type: string
                                example: '2025'
                              logo_url:
                                type: string
                                example: https://example.com/image.svg
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Paypal
                              status:
                                type: string
                                example: active
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Affirm
                              affirm_id:
                                type: string
                                example: affirm_123
                              status:
                                type: string
                                example: authorized
                              checkout_id:
                                type: string
                                example: checkout_456
                              created:
                                type: string
                                example: '2025-01-01T00:00:00Z'
                              auth_expiration:
                                type: string
                                example: '2025-01-02T00:00:00Z'
                              currency:
                                type: string
                                example: USD
                              amount:
                                type: string
                                example: '100.00'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Klarna
                              session_id:
                                type: string
                                example: klarna_session_789
                              intent:
                                type: string
                                example: buy
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Droplet
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: SomeCitcon
                      email:
                        type:
                          - string
                          - 'null'
                        example: user@example.com
                      enrollment_fee:
                        type:
                          - number
                          - string
                        example: '10.45'
                      enrollment_fee_in_currency:
                        type: string
                        example: $10.45
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT10
                          - DISCOUNT11
                      language_iso:
                        type:
                          - string
                          - 'null'
                        example: en
                      cart_token:
                        type: string
                        example: abc123
                      immutable_items:
                        type: boolean
                        example: false
                      digital_only:
                        type: boolean
                        example: false
                      requires_3ds:
                        type: boolean
                        example: false
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 101
                            price:
                              type: string
                              example: '43.41'
                            price_in_currency:
                              type: string
                              example: $43.41
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            cv:
                              type: integer
                              example: 5
                            cv_total:
                              type: integer
                              example: 15
                            qv:
                              type: integer
                              example: 7
                            qv_total:
                              type: integer
                              example: 21
                            discount_amount:
                              type: string
                              example: '10'
                            free_item:
                              type: boolean
                              example: false
                            discount_amount_in_currency:
                              type: string
                              example: $10.00
                            total_after_discounts:
                              type: string
                              example: '90.00'
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            product_title:
                              type:
                                - string
                                - 'null'
                              example: Sample Product
                            quantity:
                              type: integer
                              example: 3
                            subscription:
                              type: boolean
                              example: true
                            enrollment:
                              type: boolean
                              example: false
                            allow_subscription:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_plan_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_plans:
                              oneOf:
                                - type: array
                                  items:
                                    title: Commerce::SubscriptionPlan
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        example: Test Subscription Plan
                                        type: string
                                      billing_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      billing_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      billing_frequency_in_words:
                                        example: 2 Months
                                        type: string
                                      shipping_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      shipping_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      volume_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      volume_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      trial_period:
                                        example: 1
                                        type:
                                          - integer
                                          - 'null'
                                        minimum: 1
                                      trial_period_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type:
                                          - string
                                          - 'null'
                                      split_volume:
                                        example: true
                                        type: boolean
                                        default: false
                                      allow_max_billing_cycles:
                                        example: true
                                        type: boolean
                                        default: false
                                      max_billing_cycles:
                                        example: 3
                                        type:
                                          - integer
                                          - 'null'
                                      company_default:
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                        default: false
                                      products_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      subscribers_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      price:
                                        type: string
                                      price_in_currency:
                                        type: string
                                      subscription_start:
                                        type: string
                                      subscribe_and_save:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_in_currency:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_for_display:
                                        type:
                                          - string
                                          - 'null'
                                    required:
                                      - id
                                      - name
                                      - billing_interval
                                      - billing_interval_unit
                                      - billing_frequency_in_words
                                      - shipping_interval
                                      - shipping_interval_unit
                                      - volume_interval
                                      - volume_interval_unit
                                      - split_volume
                                      - allow_max_billing_cycles
                                      - price
                                      - price_in_currency
                                      - subscription_start
                                      - subscribe_and_save
                                      - subscribe_and_save_in_currency
                                      - subscribe_and_save_for_display
                                - type: 'null'
                            subscription_only:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_interval:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_interval_unit:
                              type:
                                - string
                                - 'null'
                              example: month
                            subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 10.5
                            subscription_price_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $10.50
                            subscription_start:
                              type:
                                - string
                                - 'null'
                              example: '2025-02-12'
                            subscribe_and_save:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 2.99
                            subscribe_and_save_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $2.99
                            subscribe_and_save_for_display:
                              type:
                                - string
                                - 'null'
                              example: Subscribe and save $2.99
                            title:
                              type:
                                - string
                                - 'null'
                              example: Surcharge
                            metadata:
                              type: object
                              description: >-
                                A JSON object that can store any custom data
                                structure
                              example: {}
                            product:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type: string
                                      example: Sample Product
                                    introduction:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Product Description
                                    cv:
                                      type: integer
                                      example: 10
                                    external_id:
                                      type:
                                        - string
                                        - 'null'
                                      example: ext-prod-123
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/product.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/product.png
                                    price:
                                      type: string
                                      example: '29.99'
                                    price_in_currency:
                                      type: string
                                      example: $29.99
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    tax:
                                      type: string
                                      example: '2.99'
                                    tax_in_currency:
                                      type: string
                                      example: $2.99
                                    metadata:
                                      type: object
                                      example:
                                        shopify_product_id: 9876054868270
                                    metafields:
                                      type: array
                                      items:
                                        title: LegacyMetafield
                                        type: object
                                        properties:
                                          namespace:
                                            description: >-
                                              A container for related metafields.
                                              Commonly used to group metafields by app
                                              or functionality.
                                            example: custom
                                            type: string
                                            maxLength: 20
                                            pattern: ^[a-zA-Z0-9_]+$
                                          key:
                                            description: >-
                                              The unique identifier for the metafield
                                              within its namespace. Must be unique per
                                              namespace and owner.
                                            example: material
                                            type: string
                                            maxLength: 30
                                            pattern: ^[a-zA-Z0-9_]+$
                                          value:
                                            description: >-
                                              The actual data stored in the metafield.
                                              Type depends on value_type.
                                            example: cotton
                                            type:
                                              - string
                                              - integer
                                              - object
                                              - boolean
                                              - number
                                          value_type:
                                            description: >-
                                              The data type that defines how the value
                                              should be interpreted and validated.
                                            example: single_line_text_field
                                            type: string
                                          description:
                                            description: >-
                                              Optional human-readable description
                                              explaining the purpose of this
                                              metafield.
                                            example: >-
                                              The primary material used in this
                                              product
                                            type:
                                              - string
                                              - 'null'
                                          created_at:
                                            description: >-
                                              Timestamp when the metafield was
                                              created.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          updated_at:
                                            description: >-
                                              Timestamp when the metafield was last
                                              updated.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          locked:
                                            description: >-
                                              Whether this metafield is locked and
                                              cannot be updated or deleted directly.
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                              - 'null'
                                          metafield_definition:
                                            description: >-
                                              The definition that defines validation
                                              rules and structure for this metafield
                                            type:
                                              - 'null'
                                              - object
                                        required:
                                          - namespace
                                          - key
                                          - value
                                          - value_type
                                          - description
                                          - created_at
                                          - updated_at
                                          - metafield_definition
                                - type: 'null'
                            variant:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Variant
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/sample.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/sample.png
                                    primary_image:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/primary.png
                                    price:
                                      type:
                                        - string
                                        - 'null'
                                      example: '34.44'
                                    price_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $34.44
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    options:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          title:
                                            type: string
                                            example: Size
                                          value:
                                            type: string
                                            example: XL
                                    physical:
                                      type:
                                        - boolean
                                        - 'null'
                                      example: true
                                    unit_of_size:
                                      type:
                                        - string
                                        - 'null'
                                      example: cm
                                    height:
                                      type:
                                        - number
                                        - 'null'
                                      example: 13
                                    width:
                                      type:
                                        - number
                                        - 'null'
                                      example: 6
                                    length:
                                      type:
                                        - number
                                        - 'null'
                                      example: 12
                                    unit_of_weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: kg
                                    weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                    hs_code:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                - type: 'null'
                            errors:
                              oneOf:
                                - type: 'null'
                                - type: array
                                  items:
                                    type: object
                                  example:
                                    - country:
                                        - >-
                                          This product is not available for this
                                          country. Please change your country
                            bundled_items:
                              type: array
                              items:
                                type: object
                                description: Bundled items for bundle products
                                properties:
                                  variant_id:
                                    type: integer
                                    example: 1
                                  product_id:
                                    type: integer
                                    example: 1
                                  product_title:
                                    type: string
                                    example: Product Title
                                  variant_title:
                                    type: string
                                    example: Variant Title
                                  option_titles:
                                    type: array
                                    example:
                                      - Option 1
                                      - Option 2
                                  quantity:
                                    type: integer
                                    example: 1
                                  display_to_customer:
                                    type: boolean
                                    example: true
                      ship_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      bill_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      shipping_method:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: string
                            example: standard-shipping
                          name:
                            type: string
                            example: Standard Shipping
                      available_shipping_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: standard-shipping
                            title:
                              type: string
                              example: Standard Shipping
                            price:
                              type:
                                - number
                                - string
                              example: 5.99
                            price_label:
                              type: string
                              example: $5.99
                            delivery_time_estimate:
                              type: string
                              example: 3-5 business days
                      available_payment_methods:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - credit_card
                                name:
                                  type: string
                                  example: Credit Card
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                apple_pay:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method supports
                                    ApplePay or not 
                                bogus_gateway:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is a Bogus
                                    instance or not.
                                tokenize_path:
                                  type:
                                    - string
                                    - 'null'
                                  description: Path to tokenize, if applicable.
                                token_provider:
                                  type: string
                                  enum:
                                    - spreedly
                                    - vgs
                                  description: >-
                                    Determines if payment tokenization is via
                                    spreedly or VGS
                                apple_pay_merchant_identifier:
                                  type:
                                    - string
                                    - 'null'
                                  example: merchant.mycompany.com
                                  description: >-
                                    If ApplePay is supported, returns the
                                    merchant identifier registered with Apple,
                                    else returns nil
                                supported_brands:
                                  type: array
                                  items:
                                    type: string
                                  example:
                                    - visa
                                    - master
                                    - american_express
                                    - discover
                                publishable_key:
                                  type:
                                    - string
                                    - 'null'
                                  example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                  description: >-
                                    If publishable key is set for Hyperswitch,
                                    returns the publishable key, else returns
                                    nil
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                              required:
                                - id
                                - type
                                - name
                                - supported_brands
                                - test
                                - sandbox
                                - apple_pay
                                - apple_pay_merchant_identifier
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - klarna
                                name:
                                  type: string
                                  example: Klarna
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                      country:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          iso:
                            type: string
                            example: US
                          name:
                            type: string
                            example: United States
                          iso_name:
                            type: string
                            example: UNITED STATES
                          iso3:
                            type: string
                            example: USA
                          currency_code:
                            type: string
                            example: USD
                          currency_symbol:
                            type: string
                            example: $
                          province_required:
                            type: boolean
                            example: false
                          tax_enabled:
                            type:
                              - boolean
                              - 'null'
                            example: true
                          price_inclusive_of_tax:
                            type: boolean
                            example: false
                          price_inclusive_tax_name:
                            type:
                              - string
                              - 'null'
                            example: VAT
                      type:
                        type: string
                        enum:
                          - regular
                          - enrollment
                        example: regular
                      enrollment_pack_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      enrollment_pack:
                        type:
                          - object
                          - 'null'
                        properties:
                          enrollment_pack_id:
                            type: integer
                            example: 1
                          additional_volume:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          slug:
                            type: string
                            example: test-enrollment-pack
                          description:
                            type:
                              - object
                              - 'null'
                              - string
                            properties:
                              id:
                                type: integer
                                example: 111
                              name:
                                type: string
                                example: description
                              body:
                                type: string
                                example: >-
                                  <div>Try the latest and greatest of our sugar
                                  zip packs. Guaranteed to make you skinner and
                                  cure cancer.</div>
                              record_type:
                                type: string
                                example: EnrollmentPack
                              record_id:
                                type: integer
                                example: 1
                              created_at:
                                type: string
                                format: date_time
                                example: '2025-01-16T04:22:43.809Z'
                              updated_at:
                                type: string
                                format: date_time
                                example: '2025-01-22T10:23:52.941Z'
                              locale:
                                type: string
                                example: en
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: 10
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.00
                          images:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2
                                relateable_type:
                                  type: string
                                  example: EnrollmentPack
                                relateable_id:
                                  type: integer
                                  example: 1
                                image_url:
                                  type: string
                                  example: >-
                                    https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                image_path:
                                  type: string
                                  example: jITWaU14QGe0y5AFgY7P_00179.svg
                                position:
                                  type: integer
                                  example: 1
                                shopify_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                                created_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                updated_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                external_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 625
                                allow_subscription:
                                  type: boolean
                                  example: true
                                cv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                cv_in_currency:
                                  type: string
                                  example: $0.00
                                cv_total:
                                  type: integer
                                  example: 0
                                enrollment:
                                  type: boolean
                                  example: true
                                enrollment_pack_id:
                                  type: integer
                                  example: 1
                                price:
                                  type: string
                                  example: '11.13'
                                price_in_currency:
                                  type: string
                                  example: $11.13
                                product_title:
                                  type: string
                                  example: Zip Pack Sample Pack (30)
                                quantity:
                                  type: integer
                                  example: 1
                                qv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                qv_in_currency:
                                  type: string
                                  example: $0.00
                                qv_total:
                                  type: integer
                                  example: 0
                                subscribe_and_save:
                                  type:
                                    - string
                                    - 'null'
                                  example: '-1988.87'
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $-1,988.87
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $-1,988.87
                                subscription:
                                  type: boolean
                                  example: false
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_only:
                                  type: boolean
                                  example: false
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_price:
                                  type: string
                                  example: '2000.0'
                                subscription_price_in_currency:
                                  type: string
                                  example: $2,000.00
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  format: date
                                  example: '2025-02-28'
                                tax:
                                  type: string
                                  example: '0.0'
                                tax_in_currency:
                                  type: string
                                  example: $0.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: null
                                display_to_customer:
                                  type: boolean
                                  example: false
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                          price:
                            type: string
                            example: '11.13'
                          price_in_currency:
                            type: string
                            example: $11.13
                          subscription_price:
                            type:
                              - string
                              - integer
                            example: 2000
                          subscription_price_in_currency:
                            type: string
                            example: $2,000.00
                          title:
                            type: string
                            example: enroll product
                          token:
                            type: string
                            example: NxL22AqLRRisfyF9LqxxWRak
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      recurring:
                        oneOf:
                          - type: array
                            items:
                              type: object
                              properties:
                                subtotal:
                                  type: string
                                  example: '10.0'
                                subtotal_in_currency:
                                  type: string
                                  example: $10.0
                                interval:
                                  type: integer
                                  example: 1
                                interval_unit:
                                  type: string
                                  example: month
                                subtotal_for_display:
                                  type: string
                                  example: $10.00 every 1 month
                                start_date:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-05-27'
                          - type: 'null'
                        default:
                          - subtotal: '10.0'
                            subtotal_in_currency: $10.0
                            interval: 1
                            interval_unit: month
                            subtotal_for_display: $10.00 every 1 month
                            start_date: '2025-05-27'
                      messages:
                        type: object
                        additionalProperties: true
                        example:
                          errors:
                            - Insufficient inventory
                            - Product no longer available
                          warnings:
                            - Low stock warning
                            - Shipping delays expected
                          info:
                            - Free shipping available
                            - Volume discount applied
                      points_enabled:
                        type: boolean
                        example: true
                      points_applied:
                        type: integer
                        example: 500
                        description: Number of points applied to the cart
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Currency value of applied points
                      customer_total_points:
                        type: integer
                        example: 1000
                        description: Customer's total available points balance
                      customer_total_points_in_currency:
                        type: number
                        example: 10
                        description: Currency value of available points
                      remaining_customer_points:
                        type: integer
                        example: 500
                        description: Customer's remaining points after cart redemption
                      remaining_customer_points_amount_in_currency:
                        type: number
                        example: 5
                        description: >-
                          Currency value of remaining points after cart
                          redemption
                      remaining_cart_amount_after_points:
                        type: number
                        example: 95
                        description: Amount to charge to card after points redemption
                      remaining_cart_amount_after_points_in_currency:
                        type:
                          - string
                        example: $95.00
                        description: >-
                          Amount in currency to charge to card after points
                          redemption
                      max_applicable_points:
                        type: integer
                        example: 500
                        description: Maximum points that can be applied to this cart
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Enrollment pack already exists in cart
                  errors:
                    type: object
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '404':
          description: Enrollment pack not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Enrollment pack with id 1 not found
                  errors:
                    type: object
                    example:
                      enrollment_pack_id:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: Unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameters
                  errors:
                    type: object
                    example:
                      enrollment_pack_id:
                        - is missing
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                enrollment_pack_id:
                  type: integer
              required:
                - enrollment_pack_id
  /api/carts/{cart_token}/items/{item_id}/subscribe:
    post:
      summary: Adds subscribe:true to cart item
      tags:
        - Carts
      operationId: addSubscriptionInCartItem
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
        - name: item_id
          in: path
          required: true
          schema:
            type: string
        - name: subscription_plan_id
          in: query
          description: ID of the subscription plan to use
          example: 123
          schema:
            type: integer
      responses:
        '200':
          description: subscription true updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      state:
                        type: string
                        example: start
                      processed:
                        type: boolean
                        example: false
                        description: >-
                          Determines if a cart payment has been processed or
                          not.
                      valid_for_checkout:
                        type: boolean
                        example: true
                      buyer_rep_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      buyer_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: buyer.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                              external_id:
                                type:
                                  - string
                                  - 'null'
                                example: '123241'
                            required:
                              - id
                          - type: 'null'
                      volume_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: volume.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                            required:
                              - id
                          - type: 'null'
                      currency_symbol:
                        type: string
                        example: $
                      currency_code:
                        type: string
                        example: USD
                      shipping_total_for_display:
                        type: string
                        example: Free
                      phone:
                        type:
                          - string
                          - 'null'
                        example: '4035551212'
                      payment_method_auto_assignable:
                        type: boolean
                        example: true
                        description: >-
                          Determines if a payment method can be auto-assigned to
                          the cart.
                      attribution:
                        oneOf:
                          - type: object
                            oneOf:
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  share_guid:
                                    type: string
                                    example: james-bond007
                                required:
                                  - id
                                  - share_guid
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  email:
                                    type: string
                                    example: james.bond@gmail.com
                                required:
                                  - id
                                  - email
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  username:
                                    type: string
                                    example: jaamball234
                                required:
                                  - id
                                  - username
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  fluid_rep_id:
                                    type: integer
                                    example: 23493
                                required:
                                  - id
                                  - fluid_rep_id
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: w3sdf92
                                required:
                                  - id
                          - type: 'null'
                        default:
                          id: 456
                          share_guid: james-bond007
                      agreements:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            required:
                              type: boolean
                              example: true
                            title:
                              type: string
                              example: Terms and Conditions
                            show_path:
                              type: string
                              example: /terms
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                      amount_total:
                        type: string
                        example: '121.65'
                      amount_total_in_currency:
                        type: string
                        example: $121.65 (USD)
                      sub_total:
                        type: string
                        example: '100.00'
                      sub_total_in_currency:
                        type: string
                        example: $100.00 (USD)
                      subtotal_after_discounts:
                        type: string
                        example: '90.00'
                      tax_total:
                        type: string
                        example: '20.00'
                      tax_total_in_currency:
                        type: string
                        example: $20.00 (USD)
                      shipping_total:
                        type:
                          - string
                          - 'null'
                        example: '1.65'
                      shipping_total_in_currency:
                        type: string
                        example: $1.65 (USD)
                      shipping_discount:
                        type: number
                        example: 10.25
                      discount_total:
                        type: string
                        example: '2.99'
                      discount_total_in_currency:
                        type: string
                        example: $2.99 (USD)
                      discount_breakdown:
                        type: object
                        properties:
                          internal_discounts:
                            type: number
                            example: 15
                          external_discounts:
                            type: number
                            example: 10
                          total_discounts:
                            type: number
                            example: 25
                      external_discount:
                        type: object
                        properties:
                          total:
                            type: number
                            example: 10
                          calculated_at:
                            type:
                              - string
                              - 'null'
                            format: date-time
                            example: '2024-01-10T15:30:00Z'
                          sources:
                            type: object
                            additionalProperties:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 6
                                description:
                                  type: string
                                  example: Gold tier discount
                                metadata:
                                  type: object
                              required:
                                - amount
                                - description
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: '1.90'
                      transaction_fee_in_currency:
                        type: string
                        example: $1.90 (USD)
                      cv_total:
                        type: integer
                        example: 10
                      qv_total:
                        type: integer
                        example: 15
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      payment_account:
                        type:
                          - string
                          - 'null'
                        example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                      payment_method:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: CreditCard
                              payment_method_type:
                                type: string
                                example: visa
                              last_four:
                                type: string
                                example: '1234'
                              exp_month:
                                type: string
                                example: '12'
                              exp_year:
                                type: string
                                example: '2025'
                              logo_url:
                                type: string
                                example: https://example.com/image.svg
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Paypal
                              status:
                                type: string
                                example: active
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Affirm
                              affirm_id:
                                type: string
                                example: affirm_123
                              status:
                                type: string
                                example: authorized
                              checkout_id:
                                type: string
                                example: checkout_456
                              created:
                                type: string
                                example: '2025-01-01T00:00:00Z'
                              auth_expiration:
                                type: string
                                example: '2025-01-02T00:00:00Z'
                              currency:
                                type: string
                                example: USD
                              amount:
                                type: string
                                example: '100.00'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Klarna
                              session_id:
                                type: string
                                example: klarna_session_789
                              intent:
                                type: string
                                example: buy
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Droplet
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: SomeCitcon
                      email:
                        type:
                          - string
                          - 'null'
                        example: user@example.com
                      enrollment_fee:
                        type:
                          - number
                          - string
                        example: '10.45'
                      enrollment_fee_in_currency:
                        type: string
                        example: $10.45
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT10
                          - DISCOUNT11
                      language_iso:
                        type:
                          - string
                          - 'null'
                        example: en
                      cart_token:
                        type: string
                        example: abc123
                      immutable_items:
                        type: boolean
                        example: false
                      digital_only:
                        type: boolean
                        example: false
                      requires_3ds:
                        type: boolean
                        example: false
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 101
                            price:
                              type: string
                              example: '43.41'
                            price_in_currency:
                              type: string
                              example: $43.41
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            cv:
                              type: integer
                              example: 5
                            cv_total:
                              type: integer
                              example: 15
                            qv:
                              type: integer
                              example: 7
                            qv_total:
                              type: integer
                              example: 21
                            discount_amount:
                              type: string
                              example: '10'
                            free_item:
                              type: boolean
                              example: false
                            discount_amount_in_currency:
                              type: string
                              example: $10.00
                            total_after_discounts:
                              type: string
                              example: '90.00'
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            product_title:
                              type:
                                - string
                                - 'null'
                              example: Sample Product
                            quantity:
                              type: integer
                              example: 3
                            subscription:
                              type: boolean
                              example: true
                            enrollment:
                              type: boolean
                              example: false
                            allow_subscription:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_plan_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_plans:
                              oneOf:
                                - type: array
                                  items:
                                    title: Commerce::SubscriptionPlan
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        example: Test Subscription Plan
                                        type: string
                                      billing_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      billing_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      billing_frequency_in_words:
                                        example: 2 Months
                                        type: string
                                      shipping_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      shipping_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      volume_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      volume_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      trial_period:
                                        example: 1
                                        type:
                                          - integer
                                          - 'null'
                                        minimum: 1
                                      trial_period_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type:
                                          - string
                                          - 'null'
                                      split_volume:
                                        example: true
                                        type: boolean
                                        default: false
                                      allow_max_billing_cycles:
                                        example: true
                                        type: boolean
                                        default: false
                                      max_billing_cycles:
                                        example: 3
                                        type:
                                          - integer
                                          - 'null'
                                      company_default:
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                        default: false
                                      products_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      subscribers_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      price:
                                        type: string
                                      price_in_currency:
                                        type: string
                                      subscription_start:
                                        type: string
                                      subscribe_and_save:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_in_currency:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_for_display:
                                        type:
                                          - string
                                          - 'null'
                                    required:
                                      - id
                                      - name
                                      - billing_interval
                                      - billing_interval_unit
                                      - billing_frequency_in_words
                                      - shipping_interval
                                      - shipping_interval_unit
                                      - volume_interval
                                      - volume_interval_unit
                                      - split_volume
                                      - allow_max_billing_cycles
                                      - price
                                      - price_in_currency
                                      - subscription_start
                                      - subscribe_and_save
                                      - subscribe_and_save_in_currency
                                      - subscribe_and_save_for_display
                                - type: 'null'
                            subscription_only:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_interval:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_interval_unit:
                              type:
                                - string
                                - 'null'
                              example: month
                            subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 10.5
                            subscription_price_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $10.50
                            subscription_start:
                              type:
                                - string
                                - 'null'
                              example: '2025-02-12'
                            subscribe_and_save:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 2.99
                            subscribe_and_save_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $2.99
                            subscribe_and_save_for_display:
                              type:
                                - string
                                - 'null'
                              example: Subscribe and save $2.99
                            title:
                              type:
                                - string
                                - 'null'
                              example: Surcharge
                            metadata:
                              type: object
                              description: >-
                                A JSON object that can store any custom data
                                structure
                              example: {}
                            product:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type: string
                                      example: Sample Product
                                    introduction:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Product Description
                                    cv:
                                      type: integer
                                      example: 10
                                    external_id:
                                      type:
                                        - string
                                        - 'null'
                                      example: ext-prod-123
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/product.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/product.png
                                    price:
                                      type: string
                                      example: '29.99'
                                    price_in_currency:
                                      type: string
                                      example: $29.99
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    tax:
                                      type: string
                                      example: '2.99'
                                    tax_in_currency:
                                      type: string
                                      example: $2.99
                                    metadata:
                                      type: object
                                      example:
                                        shopify_product_id: 9876054868270
                                    metafields:
                                      type: array
                                      items:
                                        title: LegacyMetafield
                                        type: object
                                        properties:
                                          namespace:
                                            description: >-
                                              A container for related metafields.
                                              Commonly used to group metafields by app
                                              or functionality.
                                            example: custom
                                            type: string
                                            maxLength: 20
                                            pattern: ^[a-zA-Z0-9_]+$
                                          key:
                                            description: >-
                                              The unique identifier for the metafield
                                              within its namespace. Must be unique per
                                              namespace and owner.
                                            example: material
                                            type: string
                                            maxLength: 30
                                            pattern: ^[a-zA-Z0-9_]+$
                                          value:
                                            description: >-
                                              The actual data stored in the metafield.
                                              Type depends on value_type.
                                            example: cotton
                                            type:
                                              - string
                                              - integer
                                              - object
                                              - boolean
                                              - number
                                          value_type:
                                            description: >-
                                              The data type that defines how the value
                                              should be interpreted and validated.
                                            example: single_line_text_field
                                            type: string
                                          description:
                                            description: >-
                                              Optional human-readable description
                                              explaining the purpose of this
                                              metafield.
                                            example: >-
                                              The primary material used in this
                                              product
                                            type:
                                              - string
                                              - 'null'
                                          created_at:
                                            description: >-
                                              Timestamp when the metafield was
                                              created.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          updated_at:
                                            description: >-
                                              Timestamp when the metafield was last
                                              updated.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          locked:
                                            description: >-
                                              Whether this metafield is locked and
                                              cannot be updated or deleted directly.
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                              - 'null'
                                          metafield_definition:
                                            description: >-
                                              The definition that defines validation
                                              rules and structure for this metafield
                                            type:
                                              - 'null'
                                              - object
                                        required:
                                          - namespace
                                          - key
                                          - value
                                          - value_type
                                          - description
                                          - created_at
                                          - updated_at
                                          - metafield_definition
                                - type: 'null'
                            variant:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Variant
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/sample.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/sample.png
                                    primary_image:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/primary.png
                                    price:
                                      type:
                                        - string
                                        - 'null'
                                      example: '34.44'
                                    price_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $34.44
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    options:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          title:
                                            type: string
                                            example: Size
                                          value:
                                            type: string
                                            example: XL
                                    physical:
                                      type:
                                        - boolean
                                        - 'null'
                                      example: true
                                    unit_of_size:
                                      type:
                                        - string
                                        - 'null'
                                      example: cm
                                    height:
                                      type:
                                        - number
                                        - 'null'
                                      example: 13
                                    width:
                                      type:
                                        - number
                                        - 'null'
                                      example: 6
                                    length:
                                      type:
                                        - number
                                        - 'null'
                                      example: 12
                                    unit_of_weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: kg
                                    weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                    hs_code:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                - type: 'null'
                            errors:
                              oneOf:
                                - type: 'null'
                                - type: array
                                  items:
                                    type: object
                                  example:
                                    - country:
                                        - >-
                                          This product is not available for this
                                          country. Please change your country
                            bundled_items:
                              type: array
                              items:
                                type: object
                                description: Bundled items for bundle products
                                properties:
                                  variant_id:
                                    type: integer
                                    example: 1
                                  product_id:
                                    type: integer
                                    example: 1
                                  product_title:
                                    type: string
                                    example: Product Title
                                  variant_title:
                                    type: string
                                    example: Variant Title
                                  option_titles:
                                    type: array
                                    example:
                                      - Option 1
                                      - Option 2
                                  quantity:
                                    type: integer
                                    example: 1
                                  display_to_customer:
                                    type: boolean
                                    example: true
                      ship_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      bill_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      shipping_method:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: string
                            example: standard-shipping
                          name:
                            type: string
                            example: Standard Shipping
                      available_shipping_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: standard-shipping
                            title:
                              type: string
                              example: Standard Shipping
                            price:
                              type:
                                - number
                                - string
                              example: 5.99
                            price_label:
                              type: string
                              example: $5.99
                            delivery_time_estimate:
                              type: string
                              example: 3-5 business days
                      available_payment_methods:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - credit_card
                                name:
                                  type: string
                                  example: Credit Card
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                apple_pay:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method supports
                                    ApplePay or not 
                                bogus_gateway:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is a Bogus
                                    instance or not.
                                tokenize_path:
                                  type:
                                    - string
                                    - 'null'
                                  description: Path to tokenize, if applicable.
                                token_provider:
                                  type: string
                                  enum:
                                    - spreedly
                                    - vgs
                                  description: >-
                                    Determines if payment tokenization is via
                                    spreedly or VGS
                                apple_pay_merchant_identifier:
                                  type:
                                    - string
                                    - 'null'
                                  example: merchant.mycompany.com
                                  description: >-
                                    If ApplePay is supported, returns the
                                    merchant identifier registered with Apple,
                                    else returns nil
                                supported_brands:
                                  type: array
                                  items:
                                    type: string
                                  example:
                                    - visa
                                    - master
                                    - american_express
                                    - discover
                                publishable_key:
                                  type:
                                    - string
                                    - 'null'
                                  example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                  description: >-
                                    If publishable key is set for Hyperswitch,
                                    returns the publishable key, else returns
                                    nil
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                              required:
                                - id
                                - type
                                - name
                                - supported_brands
                                - test
                                - sandbox
                                - apple_pay
                                - apple_pay_merchant_identifier
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - klarna
                                name:
                                  type: string
                                  example: Klarna
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                      country:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          iso:
                            type: string
                            example: US
                          name:
                            type: string
                            example: United States
                          iso_name:
                            type: string
                            example: UNITED STATES
                          iso3:
                            type: string
                            example: USA
                          currency_code:
                            type: string
                            example: USD
                          currency_symbol:
                            type: string
                            example: $
                          province_required:
                            type: boolean
                            example: false
                          tax_enabled:
                            type:
                              - boolean
                              - 'null'
                            example: true
                          price_inclusive_of_tax:
                            type: boolean
                            example: false
                          price_inclusive_tax_name:
                            type:
                              - string
                              - 'null'
                            example: VAT
                      type:
                        type: string
                        enum:
                          - regular
                          - enrollment
                        example: regular
                      enrollment_pack_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      enrollment_pack:
                        type:
                          - object
                          - 'null'
                        properties:
                          enrollment_pack_id:
                            type: integer
                            example: 1
                          additional_volume:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          slug:
                            type: string
                            example: test-enrollment-pack
                          description:
                            type:
                              - object
                              - 'null'
                              - string
                            properties:
                              id:
                                type: integer
                                example: 111
                              name:
                                type: string
                                example: description
                              body:
                                type: string
                                example: >-
                                  <div>Try the latest and greatest of our sugar
                                  zip packs. Guaranteed to make you skinner and
                                  cure cancer.</div>
                              record_type:
                                type: string
                                example: EnrollmentPack
                              record_id:
                                type: integer
                                example: 1
                              created_at:
                                type: string
                                format: date_time
                                example: '2025-01-16T04:22:43.809Z'
                              updated_at:
                                type: string
                                format: date_time
                                example: '2025-01-22T10:23:52.941Z'
                              locale:
                                type: string
                                example: en
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: 10
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.00
                          images:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2
                                relateable_type:
                                  type: string
                                  example: EnrollmentPack
                                relateable_id:
                                  type: integer
                                  example: 1
                                image_url:
                                  type: string
                                  example: >-
                                    https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                image_path:
                                  type: string
                                  example: jITWaU14QGe0y5AFgY7P_00179.svg
                                position:
                                  type: integer
                                  example: 1
                                shopify_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                                created_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                updated_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                external_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 625
                                allow_subscription:
                                  type: boolean
                                  example: true
                                cv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                cv_in_currency:
                                  type: string
                                  example: $0.00
                                cv_total:
                                  type: integer
                                  example: 0
                                enrollment:
                                  type: boolean
                                  example: true
                                enrollment_pack_id:
                                  type: integer
                                  example: 1
                                price:
                                  type: string
                                  example: '11.13'
                                price_in_currency:
                                  type: string
                                  example: $11.13
                                product_title:
                                  type: string
                                  example: Zip Pack Sample Pack (30)
                                quantity:
                                  type: integer
                                  example: 1
                                qv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                qv_in_currency:
                                  type: string
                                  example: $0.00
                                qv_total:
                                  type: integer
                                  example: 0
                                subscribe_and_save:
                                  type:
                                    - string
                                    - 'null'
                                  example: '-1988.87'
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $-1,988.87
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $-1,988.87
                                subscription:
                                  type: boolean
                                  example: false
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_only:
                                  type: boolean
                                  example: false
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_price:
                                  type: string
                                  example: '2000.0'
                                subscription_price_in_currency:
                                  type: string
                                  example: $2,000.00
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  format: date
                                  example: '2025-02-28'
                                tax:
                                  type: string
                                  example: '0.0'
                                tax_in_currency:
                                  type: string
                                  example: $0.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: null
                                display_to_customer:
                                  type: boolean
                                  example: false
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                          price:
                            type: string
                            example: '11.13'
                          price_in_currency:
                            type: string
                            example: $11.13
                          subscription_price:
                            type:
                              - string
                              - integer
                            example: 2000
                          subscription_price_in_currency:
                            type: string
                            example: $2,000.00
                          title:
                            type: string
                            example: enroll product
                          token:
                            type: string
                            example: NxL22AqLRRisfyF9LqxxWRak
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      recurring:
                        oneOf:
                          - type: array
                            items:
                              type: object
                              properties:
                                subtotal:
                                  type: string
                                  example: '10.0'
                                subtotal_in_currency:
                                  type: string
                                  example: $10.0
                                interval:
                                  type: integer
                                  example: 1
                                interval_unit:
                                  type: string
                                  example: month
                                subtotal_for_display:
                                  type: string
                                  example: $10.00 every 1 month
                                start_date:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-05-27'
                          - type: 'null'
                        default:
                          - subtotal: '10.0'
                            subtotal_in_currency: $10.0
                            interval: 1
                            interval_unit: month
                            subtotal_for_display: $10.00 every 1 month
                            start_date: '2025-05-27'
                      messages:
                        type: object
                        additionalProperties: true
                        example:
                          errors:
                            - Insufficient inventory
                            - Product no longer available
                          warnings:
                            - Low stock warning
                            - Shipping delays expected
                          info:
                            - Free shipping available
                            - Volume discount applied
                      points_enabled:
                        type: boolean
                        example: true
                      points_applied:
                        type: integer
                        example: 500
                        description: Number of points applied to the cart
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Currency value of applied points
                      customer_total_points:
                        type: integer
                        example: 1000
                        description: Customer's total available points balance
                      customer_total_points_in_currency:
                        type: number
                        example: 10
                        description: Currency value of available points
                      remaining_customer_points:
                        type: integer
                        example: 500
                        description: Customer's remaining points after cart redemption
                      remaining_customer_points_amount_in_currency:
                        type: number
                        example: 5
                        description: >-
                          Currency value of remaining points after cart
                          redemption
                      remaining_cart_amount_after_points:
                        type: number
                        example: 95
                        description: Amount to charge to card after points redemption
                      remaining_cart_amount_after_points_in_currency:
                        type:
                          - string
                        example: $95.00
                        description: >-
                          Amount in currency to charge to card after points
                          redemption
                      max_applicable_points:
                        type: integer
                        example: 500
                        description: Maximum points that can be applied to this cart
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      checkout_url:
                        type: string
                        example: https://checkout.fluid.com/checkout?jwt=abc123
                      shop_url:
                        type: string
                        example: https://myco.fluid.app
        '410':
          description: Cart is processed and cannot be modified
        '422':
          description: cannot subscribe items
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: unprocessable entity
                  errors:
                    type: object
                    example:
                      subscription:
                        - is not allowed
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
    delete:
      summary: Updates subscribe:false to cart item
      tags:
        - Carts
      operationId: deleteSubscriptionInCartItem
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
        - name: item_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: subscription false updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      state:
                        type: string
                        example: start
                      processed:
                        type: boolean
                        example: false
                        description: >-
                          Determines if a cart payment has been processed or
                          not.
                      valid_for_checkout:
                        type: boolean
                        example: true
                      buyer_rep_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      buyer_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: buyer.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                              external_id:
                                type:
                                  - string
                                  - 'null'
                                example: '123241'
                            required:
                              - id
                          - type: 'null'
                      volume_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: volume.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                            required:
                              - id
                          - type: 'null'
                      currency_symbol:
                        type: string
                        example: $
                      currency_code:
                        type: string
                        example: USD
                      shipping_total_for_display:
                        type: string
                        example: Free
                      phone:
                        type:
                          - string
                          - 'null'
                        example: '4035551212'
                      payment_method_auto_assignable:
                        type: boolean
                        example: true
                        description: >-
                          Determines if a payment method can be auto-assigned to
                          the cart.
                      attribution:
                        oneOf:
                          - type: object
                            oneOf:
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  share_guid:
                                    type: string
                                    example: james-bond007
                                required:
                                  - id
                                  - share_guid
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  email:
                                    type: string
                                    example: james.bond@gmail.com
                                required:
                                  - id
                                  - email
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  username:
                                    type: string
                                    example: jaamball234
                                required:
                                  - id
                                  - username
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  fluid_rep_id:
                                    type: integer
                                    example: 23493
                                required:
                                  - id
                                  - fluid_rep_id
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: w3sdf92
                                required:
                                  - id
                          - type: 'null'
                        default:
                          id: 456
                          share_guid: james-bond007
                      agreements:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            required:
                              type: boolean
                              example: true
                            title:
                              type: string
                              example: Terms and Conditions
                            show_path:
                              type: string
                              example: /terms
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                      amount_total:
                        type: string
                        example: '121.65'
                      amount_total_in_currency:
                        type: string
                        example: $121.65 (USD)
                      sub_total:
                        type: string
                        example: '100.00'
                      sub_total_in_currency:
                        type: string
                        example: $100.00 (USD)
                      subtotal_after_discounts:
                        type: string
                        example: '90.00'
                      tax_total:
                        type: string
                        example: '20.00'
                      tax_total_in_currency:
                        type: string
                        example: $20.00 (USD)
                      shipping_total:
                        type:
                          - string
                          - 'null'
                        example: '1.65'
                      shipping_total_in_currency:
                        type: string
                        example: $1.65 (USD)
                      shipping_discount:
                        type: number
                        example: 10.25
                      discount_total:
                        type: string
                        example: '2.99'
                      discount_total_in_currency:
                        type: string
                        example: $2.99 (USD)
                      discount_breakdown:
                        type: object
                        properties:
                          internal_discounts:
                            type: number
                            example: 15
                          external_discounts:
                            type: number
                            example: 10
                          total_discounts:
                            type: number
                            example: 25
                      external_discount:
                        type: object
                        properties:
                          total:
                            type: number
                            example: 10
                          calculated_at:
                            type:
                              - string
                              - 'null'
                            format: date-time
                            example: '2024-01-10T15:30:00Z'
                          sources:
                            type: object
                            additionalProperties:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 6
                                description:
                                  type: string
                                  example: Gold tier discount
                                metadata:
                                  type: object
                              required:
                                - amount
                                - description
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: '1.90'
                      transaction_fee_in_currency:
                        type: string
                        example: $1.90 (USD)
                      cv_total:
                        type: integer
                        example: 10
                      qv_total:
                        type: integer
                        example: 15
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      payment_account:
                        type:
                          - string
                          - 'null'
                        example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                      payment_method:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: CreditCard
                              payment_method_type:
                                type: string
                                example: visa
                              last_four:
                                type: string
                                example: '1234'
                              exp_month:
                                type: string
                                example: '12'
                              exp_year:
                                type: string
                                example: '2025'
                              logo_url:
                                type: string
                                example: https://example.com/image.svg
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Paypal
                              status:
                                type: string
                                example: active
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Affirm
                              affirm_id:
                                type: string
                                example: affirm_123
                              status:
                                type: string
                                example: authorized
                              checkout_id:
                                type: string
                                example: checkout_456
                              created:
                                type: string
                                example: '2025-01-01T00:00:00Z'
                              auth_expiration:
                                type: string
                                example: '2025-01-02T00:00:00Z'
                              currency:
                                type: string
                                example: USD
                              amount:
                                type: string
                                example: '100.00'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Klarna
                              session_id:
                                type: string
                                example: klarna_session_789
                              intent:
                                type: string
                                example: buy
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Droplet
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: SomeCitcon
                      email:
                        type:
                          - string
                          - 'null'
                        example: user@example.com
                      enrollment_fee:
                        type:
                          - number
                          - string
                        example: '10.45'
                      enrollment_fee_in_currency:
                        type: string
                        example: $10.45
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT10
                          - DISCOUNT11
                      language_iso:
                        type:
                          - string
                          - 'null'
                        example: en
                      cart_token:
                        type: string
                        example: abc123
                      immutable_items:
                        type: boolean
                        example: false
                      digital_only:
                        type: boolean
                        example: false
                      requires_3ds:
                        type: boolean
                        example: false
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 101
                            price:
                              type: string
                              example: '43.41'
                            price_in_currency:
                              type: string
                              example: $43.41
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            cv:
                              type: integer
                              example: 5
                            cv_total:
                              type: integer
                              example: 15
                            qv:
                              type: integer
                              example: 7
                            qv_total:
                              type: integer
                              example: 21
                            discount_amount:
                              type: string
                              example: '10'
                            free_item:
                              type: boolean
                              example: false
                            discount_amount_in_currency:
                              type: string
                              example: $10.00
                            total_after_discounts:
                              type: string
                              example: '90.00'
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            product_title:
                              type:
                                - string
                                - 'null'
                              example: Sample Product
                            quantity:
                              type: integer
                              example: 3
                            subscription:
                              type: boolean
                              example: true
                            enrollment:
                              type: boolean
                              example: false
                            allow_subscription:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_plan_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_plans:
                              oneOf:
                                - type: array
                                  items:
                                    title: Commerce::SubscriptionPlan
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        example: Test Subscription Plan
                                        type: string
                                      billing_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      billing_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      billing_frequency_in_words:
                                        example: 2 Months
                                        type: string
                                      shipping_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      shipping_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      volume_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      volume_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      trial_period:
                                        example: 1
                                        type:
                                          - integer
                                          - 'null'
                                        minimum: 1
                                      trial_period_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type:
                                          - string
                                          - 'null'
                                      split_volume:
                                        example: true
                                        type: boolean
                                        default: false
                                      allow_max_billing_cycles:
                                        example: true
                                        type: boolean
                                        default: false
                                      max_billing_cycles:
                                        example: 3
                                        type:
                                          - integer
                                          - 'null'
                                      company_default:
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                        default: false
                                      products_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      subscribers_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      price:
                                        type: string
                                      price_in_currency:
                                        type: string
                                      subscription_start:
                                        type: string
                                      subscribe_and_save:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_in_currency:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_for_display:
                                        type:
                                          - string
                                          - 'null'
                                    required:
                                      - id
                                      - name
                                      - billing_interval
                                      - billing_interval_unit
                                      - billing_frequency_in_words
                                      - shipping_interval
                                      - shipping_interval_unit
                                      - volume_interval
                                      - volume_interval_unit
                                      - split_volume
                                      - allow_max_billing_cycles
                                      - price
                                      - price_in_currency
                                      - subscription_start
                                      - subscribe_and_save
                                      - subscribe_and_save_in_currency
                                      - subscribe_and_save_for_display
                                - type: 'null'
                            subscription_only:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_interval:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_interval_unit:
                              type:
                                - string
                                - 'null'
                              example: month
                            subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 10.5
                            subscription_price_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $10.50
                            subscription_start:
                              type:
                                - string
                                - 'null'
                              example: '2025-02-12'
                            subscribe_and_save:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 2.99
                            subscribe_and_save_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $2.99
                            subscribe_and_save_for_display:
                              type:
                                - string
                                - 'null'
                              example: Subscribe and save $2.99
                            title:
                              type:
                                - string
                                - 'null'
                              example: Surcharge
                            metadata:
                              type: object
                              description: >-
                                A JSON object that can store any custom data
                                structure
                              example: {}
                            product:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type: string
                                      example: Sample Product
                                    introduction:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Product Description
                                    cv:
                                      type: integer
                                      example: 10
                                    external_id:
                                      type:
                                        - string
                                        - 'null'
                                      example: ext-prod-123
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/product.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/product.png
                                    price:
                                      type: string
                                      example: '29.99'
                                    price_in_currency:
                                      type: string
                                      example: $29.99
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    tax:
                                      type: string
                                      example: '2.99'
                                    tax_in_currency:
                                      type: string
                                      example: $2.99
                                    metadata:
                                      type: object
                                      example:
                                        shopify_product_id: 9876054868270
                                    metafields:
                                      type: array
                                      items:
                                        title: LegacyMetafield
                                        type: object
                                        properties:
                                          namespace:
                                            description: >-
                                              A container for related metafields.
                                              Commonly used to group metafields by app
                                              or functionality.
                                            example: custom
                                            type: string
                                            maxLength: 20
                                            pattern: ^[a-zA-Z0-9_]+$
                                          key:
                                            description: >-
                                              The unique identifier for the metafield
                                              within its namespace. Must be unique per
                                              namespace and owner.
                                            example: material
                                            type: string
                                            maxLength: 30
                                            pattern: ^[a-zA-Z0-9_]+$
                                          value:
                                            description: >-
                                              The actual data stored in the metafield.
                                              Type depends on value_type.
                                            example: cotton
                                            type:
                                              - string
                                              - integer
                                              - object
                                              - boolean
                                              - number
                                          value_type:
                                            description: >-
                                              The data type that defines how the value
                                              should be interpreted and validated.
                                            example: single_line_text_field
                                            type: string
                                          description:
                                            description: >-
                                              Optional human-readable description
                                              explaining the purpose of this
                                              metafield.
                                            example: >-
                                              The primary material used in this
                                              product
                                            type:
                                              - string
                                              - 'null'
                                          created_at:
                                            description: >-
                                              Timestamp when the metafield was
                                              created.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          updated_at:
                                            description: >-
                                              Timestamp when the metafield was last
                                              updated.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          locked:
                                            description: >-
                                              Whether this metafield is locked and
                                              cannot be updated or deleted directly.
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                              - 'null'
                                          metafield_definition:
                                            description: >-
                                              The definition that defines validation
                                              rules and structure for this metafield
                                            type:
                                              - 'null'
                                              - object
                                        required:
                                          - namespace
                                          - key
                                          - value
                                          - value_type
                                          - description
                                          - created_at
                                          - updated_at
                                          - metafield_definition
                                - type: 'null'
                            variant:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Variant
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/sample.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/sample.png
                                    primary_image:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/primary.png
                                    price:
                                      type:
                                        - string
                                        - 'null'
                                      example: '34.44'
                                    price_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $34.44
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    options:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          title:
                                            type: string
                                            example: Size
                                          value:
                                            type: string
                                            example: XL
                                    physical:
                                      type:
                                        - boolean
                                        - 'null'
                                      example: true
                                    unit_of_size:
                                      type:
                                        - string
                                        - 'null'
                                      example: cm
                                    height:
                                      type:
                                        - number
                                        - 'null'
                                      example: 13
                                    width:
                                      type:
                                        - number
                                        - 'null'
                                      example: 6
                                    length:
                                      type:
                                        - number
                                        - 'null'
                                      example: 12
                                    unit_of_weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: kg
                                    weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                    hs_code:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                - type: 'null'
                            errors:
                              oneOf:
                                - type: 'null'
                                - type: array
                                  items:
                                    type: object
                                  example:
                                    - country:
                                        - >-
                                          This product is not available for this
                                          country. Please change your country
                            bundled_items:
                              type: array
                              items:
                                type: object
                                description: Bundled items for bundle products
                                properties:
                                  variant_id:
                                    type: integer
                                    example: 1
                                  product_id:
                                    type: integer
                                    example: 1
                                  product_title:
                                    type: string
                                    example: Product Title
                                  variant_title:
                                    type: string
                                    example: Variant Title
                                  option_titles:
                                    type: array
                                    example:
                                      - Option 1
                                      - Option 2
                                  quantity:
                                    type: integer
                                    example: 1
                                  display_to_customer:
                                    type: boolean
                                    example: true
                      ship_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      bill_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      shipping_method:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: string
                            example: standard-shipping
                          name:
                            type: string
                            example: Standard Shipping
                      available_shipping_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: standard-shipping
                            title:
                              type: string
                              example: Standard Shipping
                            price:
                              type:
                                - number
                                - string
                              example: 5.99
                            price_label:
                              type: string
                              example: $5.99
                            delivery_time_estimate:
                              type: string
                              example: 3-5 business days
                      available_payment_methods:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - credit_card
                                name:
                                  type: string
                                  example: Credit Card
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                apple_pay:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method supports
                                    ApplePay or not 
                                bogus_gateway:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is a Bogus
                                    instance or not.
                                tokenize_path:
                                  type:
                                    - string
                                    - 'null'
                                  description: Path to tokenize, if applicable.
                                token_provider:
                                  type: string
                                  enum:
                                    - spreedly
                                    - vgs
                                  description: >-
                                    Determines if payment tokenization is via
                                    spreedly or VGS
                                apple_pay_merchant_identifier:
                                  type:
                                    - string
                                    - 'null'
                                  example: merchant.mycompany.com
                                  description: >-
                                    If ApplePay is supported, returns the
                                    merchant identifier registered with Apple,
                                    else returns nil
                                supported_brands:
                                  type: array
                                  items:
                                    type: string
                                  example:
                                    - visa
                                    - master
                                    - american_express
                                    - discover
                                publishable_key:
                                  type:
                                    - string
                                    - 'null'
                                  example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                  description: >-
                                    If publishable key is set for Hyperswitch,
                                    returns the publishable key, else returns
                                    nil
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                              required:
                                - id
                                - type
                                - name
                                - supported_brands
                                - test
                                - sandbox
                                - apple_pay
                                - apple_pay_merchant_identifier
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - klarna
                                name:
                                  type: string
                                  example: Klarna
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                      country:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          iso:
                            type: string
                            example: US
                          name:
                            type: string
                            example: United States
                          iso_name:
                            type: string
                            example: UNITED STATES
                          iso3:
                            type: string
                            example: USA
                          currency_code:
                            type: string
                            example: USD
                          currency_symbol:
                            type: string
                            example: $
                          province_required:
                            type: boolean
                            example: false
                          tax_enabled:
                            type:
                              - boolean
                              - 'null'
                            example: true
                          price_inclusive_of_tax:
                            type: boolean
                            example: false
                          price_inclusive_tax_name:
                            type:
                              - string
                              - 'null'
                            example: VAT
                      type:
                        type: string
                        enum:
                          - regular
                          - enrollment
                        example: regular
                      enrollment_pack_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      enrollment_pack:
                        type:
                          - object
                          - 'null'
                        properties:
                          enrollment_pack_id:
                            type: integer
                            example: 1
                          additional_volume:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          slug:
                            type: string
                            example: test-enrollment-pack
                          description:
                            type:
                              - object
                              - 'null'
                              - string
                            properties:
                              id:
                                type: integer
                                example: 111
                              name:
                                type: string
                                example: description
                              body:
                                type: string
                                example: >-
                                  <div>Try the latest and greatest of our sugar
                                  zip packs. Guaranteed to make you skinner and
                                  cure cancer.</div>
                              record_type:
                                type: string
                                example: EnrollmentPack
                              record_id:
                                type: integer
                                example: 1
                              created_at:
                                type: string
                                format: date_time
                                example: '2025-01-16T04:22:43.809Z'
                              updated_at:
                                type: string
                                format: date_time
                                example: '2025-01-22T10:23:52.941Z'
                              locale:
                                type: string
                                example: en
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: 10
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.00
                          images:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2
                                relateable_type:
                                  type: string
                                  example: EnrollmentPack
                                relateable_id:
                                  type: integer
                                  example: 1
                                image_url:
                                  type: string
                                  example: >-
                                    https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                image_path:
                                  type: string
                                  example: jITWaU14QGe0y5AFgY7P_00179.svg
                                position:
                                  type: integer
                                  example: 1
                                shopify_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                                created_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                updated_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                external_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 625
                                allow_subscription:
                                  type: boolean
                                  example: true
                                cv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                cv_in_currency:
                                  type: string
                                  example: $0.00
                                cv_total:
                                  type: integer
                                  example: 0
                                enrollment:
                                  type: boolean
                                  example: true
                                enrollment_pack_id:
                                  type: integer
                                  example: 1
                                price:
                                  type: string
                                  example: '11.13'
                                price_in_currency:
                                  type: string
                                  example: $11.13
                                product_title:
                                  type: string
                                  example: Zip Pack Sample Pack (30)
                                quantity:
                                  type: integer
                                  example: 1
                                qv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                qv_in_currency:
                                  type: string
                                  example: $0.00
                                qv_total:
                                  type: integer
                                  example: 0
                                subscribe_and_save:
                                  type:
                                    - string
                                    - 'null'
                                  example: '-1988.87'
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $-1,988.87
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $-1,988.87
                                subscription:
                                  type: boolean
                                  example: false
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_only:
                                  type: boolean
                                  example: false
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_price:
                                  type: string
                                  example: '2000.0'
                                subscription_price_in_currency:
                                  type: string
                                  example: $2,000.00
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  format: date
                                  example: '2025-02-28'
                                tax:
                                  type: string
                                  example: '0.0'
                                tax_in_currency:
                                  type: string
                                  example: $0.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: null
                                display_to_customer:
                                  type: boolean
                                  example: false
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                          price:
                            type: string
                            example: '11.13'
                          price_in_currency:
                            type: string
                            example: $11.13
                          subscription_price:
                            type:
                              - string
                              - integer
                            example: 2000
                          subscription_price_in_currency:
                            type: string
                            example: $2,000.00
                          title:
                            type: string
                            example: enroll product
                          token:
                            type: string
                            example: NxL22AqLRRisfyF9LqxxWRak
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      recurring:
                        oneOf:
                          - type: array
                            items:
                              type: object
                              properties:
                                subtotal:
                                  type: string
                                  example: '10.0'
                                subtotal_in_currency:
                                  type: string
                                  example: $10.0
                                interval:
                                  type: integer
                                  example: 1
                                interval_unit:
                                  type: string
                                  example: month
                                subtotal_for_display:
                                  type: string
                                  example: $10.00 every 1 month
                                start_date:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-05-27'
                          - type: 'null'
                        default:
                          - subtotal: '10.0'
                            subtotal_in_currency: $10.0
                            interval: 1
                            interval_unit: month
                            subtotal_for_display: $10.00 every 1 month
                            start_date: '2025-05-27'
                      messages:
                        type: object
                        additionalProperties: true
                        example:
                          errors:
                            - Insufficient inventory
                            - Product no longer available
                          warnings:
                            - Low stock warning
                            - Shipping delays expected
                          info:
                            - Free shipping available
                            - Volume discount applied
                      points_enabled:
                        type: boolean
                        example: true
                      points_applied:
                        type: integer
                        example: 500
                        description: Number of points applied to the cart
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Currency value of applied points
                      customer_total_points:
                        type: integer
                        example: 1000
                        description: Customer's total available points balance
                      customer_total_points_in_currency:
                        type: number
                        example: 10
                        description: Currency value of available points
                      remaining_customer_points:
                        type: integer
                        example: 500
                        description: Customer's remaining points after cart redemption
                      remaining_customer_points_amount_in_currency:
                        type: number
                        example: 5
                        description: >-
                          Currency value of remaining points after cart
                          redemption
                      remaining_cart_amount_after_points:
                        type: number
                        example: 95
                        description: Amount to charge to card after points redemption
                      remaining_cart_amount_after_points_in_currency:
                        type:
                          - string
                        example: $95.00
                        description: >-
                          Amount in currency to charge to card after points
                          redemption
                      max_applicable_points:
                        type: integer
                        example: 500
                        description: Maximum points that can be applied to this cart
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      checkout_url:
                        type: string
                        example: https://checkout.fluid.com/checkout?jwt=abc123
                      shop_url:
                        type: string
                        example: https://myco.fluid.app
        '410':
          description: Cart is processed and cannot be modified
        '422':
          description: cannot be unsubscribed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: unprocessable entity
                  errors:
                    type: object
                    example:
                      subscription:
                        - cannot be disabled
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/carts/{cart_token}/items/{item_id}/bundled_items:
    patch:
      summary: Updates bundled items metadata for a cart item
      tags:
        - Carts
      description: >-
        Updates the bundled_items metadata for a specific cart item. Accepts
        minimal input (variant_id, quantity, display_to_customer) and
        automatically fetches additional product information from the database.
        Items with quantity 0 will be removed from the bundled items metadata.
        Returns errors for invalid variant IDs but continues processing valid
        ones.
      operationId: updateCartItemBundledItems
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
        - name: item_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: bundled items updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      state:
                        type: string
                        example: start
                      processed:
                        type: boolean
                        example: false
                        description: >-
                          Determines if a cart payment has been processed or
                          not.
                      valid_for_checkout:
                        type: boolean
                        example: true
                      buyer_rep_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      buyer_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: buyer.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                              external_id:
                                type:
                                  - string
                                  - 'null'
                                example: '123241'
                            required:
                              - id
                          - type: 'null'
                      volume_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: volume.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                            required:
                              - id
                          - type: 'null'
                      currency_symbol:
                        type: string
                        example: $
                      currency_code:
                        type: string
                        example: USD
                      shipping_total_for_display:
                        type: string
                        example: Free
                      phone:
                        type:
                          - string
                          - 'null'
                        example: '4035551212'
                      payment_method_auto_assignable:
                        type: boolean
                        example: true
                        description: >-
                          Determines if a payment method can be auto-assigned to
                          the cart.
                      attribution:
                        oneOf:
                          - type: object
                            oneOf:
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  share_guid:
                                    type: string
                                    example: james-bond007
                                required:
                                  - id
                                  - share_guid
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  email:
                                    type: string
                                    example: james.bond@gmail.com
                                required:
                                  - id
                                  - email
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  username:
                                    type: string
                                    example: jaamball234
                                required:
                                  - id
                                  - username
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  fluid_rep_id:
                                    type: integer
                                    example: 23493
                                required:
                                  - id
                                  - fluid_rep_id
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: w3sdf92
                                required:
                                  - id
                          - type: 'null'
                        default:
                          id: 456
                          share_guid: james-bond007
                      agreements:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            required:
                              type: boolean
                              example: true
                            title:
                              type: string
                              example: Terms and Conditions
                            show_path:
                              type: string
                              example: /terms
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                      amount_total:
                        type: string
                        example: '121.65'
                      amount_total_in_currency:
                        type: string
                        example: $121.65 (USD)
                      sub_total:
                        type: string
                        example: '100.00'
                      sub_total_in_currency:
                        type: string
                        example: $100.00 (USD)
                      subtotal_after_discounts:
                        type: string
                        example: '90.00'
                      tax_total:
                        type: string
                        example: '20.00'
                      tax_total_in_currency:
                        type: string
                        example: $20.00 (USD)
                      shipping_total:
                        type:
                          - string
                          - 'null'
                        example: '1.65'
                      shipping_total_in_currency:
                        type: string
                        example: $1.65 (USD)
                      shipping_discount:
                        type: number
                        example: 10.25
                      discount_total:
                        type: string
                        example: '2.99'
                      discount_total_in_currency:
                        type: string
                        example: $2.99 (USD)
                      discount_breakdown:
                        type: object
                        properties:
                          internal_discounts:
                            type: number
                            example: 15
                          external_discounts:
                            type: number
                            example: 10
                          total_discounts:
                            type: number
                            example: 25
                      external_discount:
                        type: object
                        properties:
                          total:
                            type: number
                            example: 10
                          calculated_at:
                            type:
                              - string
                              - 'null'
                            format: date-time
                            example: '2024-01-10T15:30:00Z'
                          sources:
                            type: object
                            additionalProperties:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 6
                                description:
                                  type: string
                                  example: Gold tier discount
                                metadata:
                                  type: object
                              required:
                                - amount
                                - description
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: '1.90'
                      transaction_fee_in_currency:
                        type: string
                        example: $1.90 (USD)
                      cv_total:
                        type: integer
                        example: 10
                      qv_total:
                        type: integer
                        example: 15
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      payment_account:
                        type:
                          - string
                          - 'null'
                        example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                      payment_method:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: CreditCard
                              payment_method_type:
                                type: string
                                example: visa
                              last_four:
                                type: string
                                example: '1234'
                              exp_month:
                                type: string
                                example: '12'
                              exp_year:
                                type: string
                                example: '2025'
                              logo_url:
                                type: string
                                example: https://example.com/image.svg
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Paypal
                              status:
                                type: string
                                example: active
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Affirm
                              affirm_id:
                                type: string
                                example: affirm_123
                              status:
                                type: string
                                example: authorized
                              checkout_id:
                                type: string
                                example: checkout_456
                              created:
                                type: string
                                example: '2025-01-01T00:00:00Z'
                              auth_expiration:
                                type: string
                                example: '2025-01-02T00:00:00Z'
                              currency:
                                type: string
                                example: USD
                              amount:
                                type: string
                                example: '100.00'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Klarna
                              session_id:
                                type: string
                                example: klarna_session_789
                              intent:
                                type: string
                                example: buy
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Droplet
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: SomeCitcon
                      email:
                        type:
                          - string
                          - 'null'
                        example: user@example.com
                      enrollment_fee:
                        type:
                          - number
                          - string
                        example: '10.45'
                      enrollment_fee_in_currency:
                        type: string
                        example: $10.45
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT10
                          - DISCOUNT11
                      language_iso:
                        type:
                          - string
                          - 'null'
                        example: en
                      cart_token:
                        type: string
                        example: abc123
                      immutable_items:
                        type: boolean
                        example: false
                      digital_only:
                        type: boolean
                        example: false
                      requires_3ds:
                        type: boolean
                        example: false
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 101
                            price:
                              type: string
                              example: '43.41'
                            price_in_currency:
                              type: string
                              example: $43.41
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            cv:
                              type: integer
                              example: 5
                            cv_total:
                              type: integer
                              example: 15
                            qv:
                              type: integer
                              example: 7
                            qv_total:
                              type: integer
                              example: 21
                            discount_amount:
                              type: string
                              example: '10'
                            free_item:
                              type: boolean
                              example: false
                            discount_amount_in_currency:
                              type: string
                              example: $10.00
                            total_after_discounts:
                              type: string
                              example: '90.00'
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            product_title:
                              type:
                                - string
                                - 'null'
                              example: Sample Product
                            quantity:
                              type: integer
                              example: 3
                            subscription:
                              type: boolean
                              example: true
                            enrollment:
                              type: boolean
                              example: false
                            allow_subscription:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_plan_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_plans:
                              oneOf:
                                - type: array
                                  items:
                                    title: Commerce::SubscriptionPlan
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        example: Test Subscription Plan
                                        type: string
                                      billing_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      billing_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      billing_frequency_in_words:
                                        example: 2 Months
                                        type: string
                                      shipping_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      shipping_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      volume_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      volume_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      trial_period:
                                        example: 1
                                        type:
                                          - integer
                                          - 'null'
                                        minimum: 1
                                      trial_period_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type:
                                          - string
                                          - 'null'
                                      split_volume:
                                        example: true
                                        type: boolean
                                        default: false
                                      allow_max_billing_cycles:
                                        example: true
                                        type: boolean
                                        default: false
                                      max_billing_cycles:
                                        example: 3
                                        type:
                                          - integer
                                          - 'null'
                                      company_default:
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                        default: false
                                      products_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      subscribers_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      price:
                                        type: string
                                      price_in_currency:
                                        type: string
                                      subscription_start:
                                        type: string
                                      subscribe_and_save:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_in_currency:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_for_display:
                                        type:
                                          - string
                                          - 'null'
                                    required:
                                      - id
                                      - name
                                      - billing_interval
                                      - billing_interval_unit
                                      - billing_frequency_in_words
                                      - shipping_interval
                                      - shipping_interval_unit
                                      - volume_interval
                                      - volume_interval_unit
                                      - split_volume
                                      - allow_max_billing_cycles
                                      - price
                                      - price_in_currency
                                      - subscription_start
                                      - subscribe_and_save
                                      - subscribe_and_save_in_currency
                                      - subscribe_and_save_for_display
                                - type: 'null'
                            subscription_only:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_interval:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_interval_unit:
                              type:
                                - string
                                - 'null'
                              example: month
                            subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 10.5
                            subscription_price_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $10.50
                            subscription_start:
                              type:
                                - string
                                - 'null'
                              example: '2025-02-12'
                            subscribe_and_save:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 2.99
                            subscribe_and_save_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $2.99
                            subscribe_and_save_for_display:
                              type:
                                - string
                                - 'null'
                              example: Subscribe and save $2.99
                            title:
                              type:
                                - string
                                - 'null'
                              example: Surcharge
                            metadata:
                              type: object
                              description: >-
                                A JSON object that can store any custom data
                                structure
                              example: {}
                            product:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type: string
                                      example: Sample Product
                                    introduction:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Product Description
                                    cv:
                                      type: integer
                                      example: 10
                                    external_id:
                                      type:
                                        - string
                                        - 'null'
                                      example: ext-prod-123
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/product.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/product.png
                                    price:
                                      type: string
                                      example: '29.99'
                                    price_in_currency:
                                      type: string
                                      example: $29.99
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    tax:
                                      type: string
                                      example: '2.99'
                                    tax_in_currency:
                                      type: string
                                      example: $2.99
                                    metadata:
                                      type: object
                                      example:
                                        shopify_product_id: 9876054868270
                                    metafields:
                                      type: array
                                      items:
                                        title: LegacyMetafield
                                        type: object
                                        properties:
                                          namespace:
                                            description: >-
                                              A container for related metafields.
                                              Commonly used to group metafields by app
                                              or functionality.
                                            example: custom
                                            type: string
                                            maxLength: 20
                                            pattern: ^[a-zA-Z0-9_]+$
                                          key:
                                            description: >-
                                              The unique identifier for the metafield
                                              within its namespace. Must be unique per
                                              namespace and owner.
                                            example: material
                                            type: string
                                            maxLength: 30
                                            pattern: ^[a-zA-Z0-9_]+$
                                          value:
                                            description: >-
                                              The actual data stored in the metafield.
                                              Type depends on value_type.
                                            example: cotton
                                            type:
                                              - string
                                              - integer
                                              - object
                                              - boolean
                                              - number
                                          value_type:
                                            description: >-
                                              The data type that defines how the value
                                              should be interpreted and validated.
                                            example: single_line_text_field
                                            type: string
                                          description:
                                            description: >-
                                              Optional human-readable description
                                              explaining the purpose of this
                                              metafield.
                                            example: >-
                                              The primary material used in this
                                              product
                                            type:
                                              - string
                                              - 'null'
                                          created_at:
                                            description: >-
                                              Timestamp when the metafield was
                                              created.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          updated_at:
                                            description: >-
                                              Timestamp when the metafield was last
                                              updated.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          locked:
                                            description: >-
                                              Whether this metafield is locked and
                                              cannot be updated or deleted directly.
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                              - 'null'
                                          metafield_definition:
                                            description: >-
                                              The definition that defines validation
                                              rules and structure for this metafield
                                            type:
                                              - 'null'
                                              - object
                                        required:
                                          - namespace
                                          - key
                                          - value
                                          - value_type
                                          - description
                                          - created_at
                                          - updated_at
                                          - metafield_definition
                                - type: 'null'
                            variant:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Variant
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/sample.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/sample.png
                                    primary_image:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/primary.png
                                    price:
                                      type:
                                        - string
                                        - 'null'
                                      example: '34.44'
                                    price_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $34.44
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    options:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          title:
                                            type: string
                                            example: Size
                                          value:
                                            type: string
                                            example: XL
                                    physical:
                                      type:
                                        - boolean
                                        - 'null'
                                      example: true
                                    unit_of_size:
                                      type:
                                        - string
                                        - 'null'
                                      example: cm
                                    height:
                                      type:
                                        - number
                                        - 'null'
                                      example: 13
                                    width:
                                      type:
                                        - number
                                        - 'null'
                                      example: 6
                                    length:
                                      type:
                                        - number
                                        - 'null'
                                      example: 12
                                    unit_of_weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: kg
                                    weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                    hs_code:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                - type: 'null'
                            errors:
                              oneOf:
                                - type: 'null'
                                - type: array
                                  items:
                                    type: object
                                  example:
                                    - country:
                                        - >-
                                          This product is not available for this
                                          country. Please change your country
                            bundled_items:
                              type: array
                              items:
                                type: object
                                description: Bundled items for bundle products
                                properties:
                                  variant_id:
                                    type: integer
                                    example: 1
                                  product_id:
                                    type: integer
                                    example: 1
                                  product_title:
                                    type: string
                                    example: Product Title
                                  variant_title:
                                    type: string
                                    example: Variant Title
                                  option_titles:
                                    type: array
                                    example:
                                      - Option 1
                                      - Option 2
                                  quantity:
                                    type: integer
                                    example: 1
                                  display_to_customer:
                                    type: boolean
                                    example: true
                      ship_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      bill_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      shipping_method:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: string
                            example: standard-shipping
                          name:
                            type: string
                            example: Standard Shipping
                      available_shipping_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: standard-shipping
                            title:
                              type: string
                              example: Standard Shipping
                            price:
                              type:
                                - number
                                - string
                              example: 5.99
                            price_label:
                              type: string
                              example: $5.99
                            delivery_time_estimate:
                              type: string
                              example: 3-5 business days
                      available_payment_methods:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - credit_card
                                name:
                                  type: string
                                  example: Credit Card
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                apple_pay:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method supports
                                    ApplePay or not 
                                bogus_gateway:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is a Bogus
                                    instance or not.
                                tokenize_path:
                                  type:
                                    - string
                                    - 'null'
                                  description: Path to tokenize, if applicable.
                                token_provider:
                                  type: string
                                  enum:
                                    - spreedly
                                    - vgs
                                  description: >-
                                    Determines if payment tokenization is via
                                    spreedly or VGS
                                apple_pay_merchant_identifier:
                                  type:
                                    - string
                                    - 'null'
                                  example: merchant.mycompany.com
                                  description: >-
                                    If ApplePay is supported, returns the
                                    merchant identifier registered with Apple,
                                    else returns nil
                                supported_brands:
                                  type: array
                                  items:
                                    type: string
                                  example:
                                    - visa
                                    - master
                                    - american_express
                                    - discover
                                publishable_key:
                                  type:
                                    - string
                                    - 'null'
                                  example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                  description: >-
                                    If publishable key is set for Hyperswitch,
                                    returns the publishable key, else returns
                                    nil
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                              required:
                                - id
                                - type
                                - name
                                - supported_brands
                                - test
                                - sandbox
                                - apple_pay
                                - apple_pay_merchant_identifier
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - klarna
                                name:
                                  type: string
                                  example: Klarna
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                      country:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          iso:
                            type: string
                            example: US
                          name:
                            type: string
                            example: United States
                          iso_name:
                            type: string
                            example: UNITED STATES
                          iso3:
                            type: string
                            example: USA
                          currency_code:
                            type: string
                            example: USD
                          currency_symbol:
                            type: string
                            example: $
                          province_required:
                            type: boolean
                            example: false
                          tax_enabled:
                            type:
                              - boolean
                              - 'null'
                            example: true
                          price_inclusive_of_tax:
                            type: boolean
                            example: false
                          price_inclusive_tax_name:
                            type:
                              - string
                              - 'null'
                            example: VAT
                      type:
                        type: string
                        enum:
                          - regular
                          - enrollment
                        example: regular
                      enrollment_pack_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      enrollment_pack:
                        type:
                          - object
                          - 'null'
                        properties:
                          enrollment_pack_id:
                            type: integer
                            example: 1
                          additional_volume:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          slug:
                            type: string
                            example: test-enrollment-pack
                          description:
                            type:
                              - object
                              - 'null'
                              - string
                            properties:
                              id:
                                type: integer
                                example: 111
                              name:
                                type: string
                                example: description
                              body:
                                type: string
                                example: >-
                                  <div>Try the latest and greatest of our sugar
                                  zip packs. Guaranteed to make you skinner and
                                  cure cancer.</div>
                              record_type:
                                type: string
                                example: EnrollmentPack
                              record_id:
                                type: integer
                                example: 1
                              created_at:
                                type: string
                                format: date_time
                                example: '2025-01-16T04:22:43.809Z'
                              updated_at:
                                type: string
                                format: date_time
                                example: '2025-01-22T10:23:52.941Z'
                              locale:
                                type: string
                                example: en
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: 10
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.00
                          images:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2
                                relateable_type:
                                  type: string
                                  example: EnrollmentPack
                                relateable_id:
                                  type: integer
                                  example: 1
                                image_url:
                                  type: string
                                  example: >-
                                    https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                image_path:
                                  type: string
                                  example: jITWaU14QGe0y5AFgY7P_00179.svg
                                position:
                                  type: integer
                                  example: 1
                                shopify_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                                created_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                updated_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                external_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 625
                                allow_subscription:
                                  type: boolean
                                  example: true
                                cv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                cv_in_currency:
                                  type: string
                                  example: $0.00
                                cv_total:
                                  type: integer
                                  example: 0
                                enrollment:
                                  type: boolean
                                  example: true
                                enrollment_pack_id:
                                  type: integer
                                  example: 1
                                price:
                                  type: string
                                  example: '11.13'
                                price_in_currency:
                                  type: string
                                  example: $11.13
                                product_title:
                                  type: string
                                  example: Zip Pack Sample Pack (30)
                                quantity:
                                  type: integer
                                  example: 1
                                qv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                qv_in_currency:
                                  type: string
                                  example: $0.00
                                qv_total:
                                  type: integer
                                  example: 0
                                subscribe_and_save:
                                  type:
                                    - string
                                    - 'null'
                                  example: '-1988.87'
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $-1,988.87
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $-1,988.87
                                subscription:
                                  type: boolean
                                  example: false
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_only:
                                  type: boolean
                                  example: false
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_price:
                                  type: string
                                  example: '2000.0'
                                subscription_price_in_currency:
                                  type: string
                                  example: $2,000.00
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  format: date
                                  example: '2025-02-28'
                                tax:
                                  type: string
                                  example: '0.0'
                                tax_in_currency:
                                  type: string
                                  example: $0.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: null
                                display_to_customer:
                                  type: boolean
                                  example: false
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                          price:
                            type: string
                            example: '11.13'
                          price_in_currency:
                            type: string
                            example: $11.13
                          subscription_price:
                            type:
                              - string
                              - integer
                            example: 2000
                          subscription_price_in_currency:
                            type: string
                            example: $2,000.00
                          title:
                            type: string
                            example: enroll product
                          token:
                            type: string
                            example: NxL22AqLRRisfyF9LqxxWRak
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      recurring:
                        oneOf:
                          - type: array
                            items:
                              type: object
                              properties:
                                subtotal:
                                  type: string
                                  example: '10.0'
                                subtotal_in_currency:
                                  type: string
                                  example: $10.0
                                interval:
                                  type: integer
                                  example: 1
                                interval_unit:
                                  type: string
                                  example: month
                                subtotal_for_display:
                                  type: string
                                  example: $10.00 every 1 month
                                start_date:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-05-27'
                          - type: 'null'
                        default:
                          - subtotal: '10.0'
                            subtotal_in_currency: $10.0
                            interval: 1
                            interval_unit: month
                            subtotal_for_display: $10.00 every 1 month
                            start_date: '2025-05-27'
                      messages:
                        type: object
                        additionalProperties: true
                        example:
                          errors:
                            - Insufficient inventory
                            - Product no longer available
                          warnings:
                            - Low stock warning
                            - Shipping delays expected
                          info:
                            - Free shipping available
                            - Volume discount applied
                      points_enabled:
                        type: boolean
                        example: true
                      points_applied:
                        type: integer
                        example: 500
                        description: Number of points applied to the cart
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Currency value of applied points
                      customer_total_points:
                        type: integer
                        example: 1000
                        description: Customer's total available points balance
                      customer_total_points_in_currency:
                        type: number
                        example: 10
                        description: Currency value of available points
                      remaining_customer_points:
                        type: integer
                        example: 500
                        description: Customer's remaining points after cart redemption
                      remaining_customer_points_amount_in_currency:
                        type: number
                        example: 5
                        description: >-
                          Currency value of remaining points after cart
                          redemption
                      remaining_cart_amount_after_points:
                        type: number
                        example: 95
                        description: Amount to charge to card after points redemption
                      remaining_cart_amount_after_points_in_currency:
                        type:
                          - string
                        example: $95.00
                        description: >-
                          Amount in currency to charge to card after points
                          redemption
                      max_applicable_points:
                        type: integer
                        example: 500
                        description: Maximum points that can be applied to this cart
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      checkout_url:
                        type: string
                        example: https://checkout.fluid.com/checkout?jwt=abc123
                      shop_url:
                        type: string
                        example: https://myco.fluid.app
        '404':
          description: cart not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
                      example:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '410':
          description: Cart is processed and cannot be modified
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - bundled_items
              properties:
                bundled_items:
                  type: array
                  description: >-
                    Array of bundled items with minimal data - additional fields
                    are fetched automatically
                  items:
                    type: object
                    required:
                      - variant_id
                      - quantity
                      - display_to_customer
                    properties:
                      variant_id:
                        type: integer
                        description: ID of the variant to include in bundle
                        example: 66894
                      quantity:
                        type: integer
                        description: Quantity of this bundled item
                        example: 2
                      display_to_customer:
                        type: boolean
                        description: Whether to display this bundled item to the customer
                        example: true
  /api/carts/{cart_token}/items/{item_id}/update_volumes:
    patch:
      summary: Updates a cart item's volume totals
      tags:
        - Carts
      description: >
        Updates the cv_total and/or qv_total of a cart item.

        Only the attributes that are passed in the request will be updated.

        The cart's cv_total and qv_total will be automatically recalculated as
        the sum of all cart items' volume totals.
      operationId: updateCartItemVolumes
      security:
        - bearer_auth: []
      parameters:
        - name: cart_token
          in: path
          required: true
          description: The cart token
          example: abc123def456
          schema:
            type: string
        - name: item_id
          in: path
          required: true
          description: The cart item ID
          example: 123
          schema:
            type: integer
      responses:
        '200':
          description: Volume totals updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      state:
                        type: string
                        example: start
                      processed:
                        type: boolean
                        example: false
                        description: >-
                          Determines if a cart payment has been processed or
                          not.
                      valid_for_checkout:
                        type: boolean
                        example: true
                      buyer_rep_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      buyer_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: buyer.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                              external_id:
                                type:
                                  - string
                                  - 'null'
                                example: '123241'
                            required:
                              - id
                          - type: 'null'
                      volume_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: volume.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                            required:
                              - id
                          - type: 'null'
                      currency_symbol:
                        type: string
                        example: $
                      currency_code:
                        type: string
                        example: USD
                      shipping_total_for_display:
                        type: string
                        example: Free
                      phone:
                        type:
                          - string
                          - 'null'
                        example: '4035551212'
                      payment_method_auto_assignable:
                        type: boolean
                        example: true
                        description: >-
                          Determines if a payment method can be auto-assigned to
                          the cart.
                      attribution:
                        oneOf:
                          - type: object
                            oneOf:
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  share_guid:
                                    type: string
                                    example: james-bond007
                                required:
                                  - id
                                  - share_guid
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  email:
                                    type: string
                                    example: james.bond@gmail.com
                                required:
                                  - id
                                  - email
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  username:
                                    type: string
                                    example: jaamball234
                                required:
                                  - id
                                  - username
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  fluid_rep_id:
                                    type: integer
                                    example: 23493
                                required:
                                  - id
                                  - fluid_rep_id
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: w3sdf92
                                required:
                                  - id
                          - type: 'null'
                        default:
                          id: 456
                          share_guid: james-bond007
                      agreements:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            required:
                              type: boolean
                              example: true
                            title:
                              type: string
                              example: Terms and Conditions
                            show_path:
                              type: string
                              example: /terms
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                      amount_total:
                        type: string
                        example: '121.65'
                      amount_total_in_currency:
                        type: string
                        example: $121.65 (USD)
                      sub_total:
                        type: string
                        example: '100.00'
                      sub_total_in_currency:
                        type: string
                        example: $100.00 (USD)
                      subtotal_after_discounts:
                        type: string
                        example: '90.00'
                      tax_total:
                        type: string
                        example: '20.00'
                      tax_total_in_currency:
                        type: string
                        example: $20.00 (USD)
                      shipping_total:
                        type:
                          - string
                          - 'null'
                        example: '1.65'
                      shipping_total_in_currency:
                        type: string
                        example: $1.65 (USD)
                      shipping_discount:
                        type: number
                        example: 10.25
                      discount_total:
                        type: string
                        example: '2.99'
                      discount_total_in_currency:
                        type: string
                        example: $2.99 (USD)
                      discount_breakdown:
                        type: object
                        properties:
                          internal_discounts:
                            type: number
                            example: 15
                          external_discounts:
                            type: number
                            example: 10
                          total_discounts:
                            type: number
                            example: 25
                      external_discount:
                        type: object
                        properties:
                          total:
                            type: number
                            example: 10
                          calculated_at:
                            type:
                              - string
                              - 'null'
                            format: date-time
                            example: '2024-01-10T15:30:00Z'
                          sources:
                            type: object
                            additionalProperties:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 6
                                description:
                                  type: string
                                  example: Gold tier discount
                                metadata:
                                  type: object
                              required:
                                - amount
                                - description
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: '1.90'
                      transaction_fee_in_currency:
                        type: string
                        example: $1.90 (USD)
                      cv_total:
                        type: integer
                        example: 10
                      qv_total:
                        type: integer
                        example: 15
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      payment_account:
                        type:
                          - string
                          - 'null'
                        example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                      payment_method:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: CreditCard
                              payment_method_type:
                                type: string
                                example: visa
                              last_four:
                                type: string
                                example: '1234'
                              exp_month:
                                type: string
                                example: '12'
                              exp_year:
                                type: string
                                example: '2025'
                              logo_url:
                                type: string
                                example: https://example.com/image.svg
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Paypal
                              status:
                                type: string
                                example: active
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Affirm
                              affirm_id:
                                type: string
                                example: affirm_123
                              status:
                                type: string
                                example: authorized
                              checkout_id:
                                type: string
                                example: checkout_456
                              created:
                                type: string
                                example: '2025-01-01T00:00:00Z'
                              auth_expiration:
                                type: string
                                example: '2025-01-02T00:00:00Z'
                              currency:
                                type: string
                                example: USD
                              amount:
                                type: string
                                example: '100.00'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Klarna
                              session_id:
                                type: string
                                example: klarna_session_789
                              intent:
                                type: string
                                example: buy
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Droplet
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: SomeCitcon
                      email:
                        type:
                          - string
                          - 'null'
                        example: user@example.com
                      enrollment_fee:
                        type:
                          - number
                          - string
                        example: '10.45'
                      enrollment_fee_in_currency:
                        type: string
                        example: $10.45
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT10
                          - DISCOUNT11
                      language_iso:
                        type:
                          - string
                          - 'null'
                        example: en
                      cart_token:
                        type: string
                        example: abc123
                      immutable_items:
                        type: boolean
                        example: false
                      digital_only:
                        type: boolean
                        example: false
                      requires_3ds:
                        type: boolean
                        example: false
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 101
                            price:
                              type: string
                              example: '43.41'
                            price_in_currency:
                              type: string
                              example: $43.41
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            cv:
                              type: integer
                              example: 5
                            cv_total:
                              type: integer
                              example: 15
                            qv:
                              type: integer
                              example: 7
                            qv_total:
                              type: integer
                              example: 21
                            discount_amount:
                              type: string
                              example: '10'
                            free_item:
                              type: boolean
                              example: false
                            discount_amount_in_currency:
                              type: string
                              example: $10.00
                            total_after_discounts:
                              type: string
                              example: '90.00'
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            product_title:
                              type:
                                - string
                                - 'null'
                              example: Sample Product
                            quantity:
                              type: integer
                              example: 3
                            subscription:
                              type: boolean
                              example: true
                            enrollment:
                              type: boolean
                              example: false
                            allow_subscription:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_plan_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_plans:
                              oneOf:
                                - type: array
                                  items:
                                    title: Commerce::SubscriptionPlan
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        example: Test Subscription Plan
                                        type: string
                                      billing_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      billing_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      billing_frequency_in_words:
                                        example: 2 Months
                                        type: string
                                      shipping_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      shipping_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      volume_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      volume_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      trial_period:
                                        example: 1
                                        type:
                                          - integer
                                          - 'null'
                                        minimum: 1
                                      trial_period_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type:
                                          - string
                                          - 'null'
                                      split_volume:
                                        example: true
                                        type: boolean
                                        default: false
                                      allow_max_billing_cycles:
                                        example: true
                                        type: boolean
                                        default: false
                                      max_billing_cycles:
                                        example: 3
                                        type:
                                          - integer
                                          - 'null'
                                      company_default:
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                        default: false
                                      products_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      subscribers_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      price:
                                        type: string
                                      price_in_currency:
                                        type: string
                                      subscription_start:
                                        type: string
                                      subscribe_and_save:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_in_currency:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_for_display:
                                        type:
                                          - string
                                          - 'null'
                                    required:
                                      - id
                                      - name
                                      - billing_interval
                                      - billing_interval_unit
                                      - billing_frequency_in_words
                                      - shipping_interval
                                      - shipping_interval_unit
                                      - volume_interval
                                      - volume_interval_unit
                                      - split_volume
                                      - allow_max_billing_cycles
                                      - price
                                      - price_in_currency
                                      - subscription_start
                                      - subscribe_and_save
                                      - subscribe_and_save_in_currency
                                      - subscribe_and_save_for_display
                                - type: 'null'
                            subscription_only:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_interval:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_interval_unit:
                              type:
                                - string
                                - 'null'
                              example: month
                            subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 10.5
                            subscription_price_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $10.50
                            subscription_start:
                              type:
                                - string
                                - 'null'
                              example: '2025-02-12'
                            subscribe_and_save:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 2.99
                            subscribe_and_save_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $2.99
                            subscribe_and_save_for_display:
                              type:
                                - string
                                - 'null'
                              example: Subscribe and save $2.99
                            title:
                              type:
                                - string
                                - 'null'
                              example: Surcharge
                            metadata:
                              type: object
                              description: >-
                                A JSON object that can store any custom data
                                structure
                              example: {}
                            product:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type: string
                                      example: Sample Product
                                    introduction:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Product Description
                                    cv:
                                      type: integer
                                      example: 10
                                    external_id:
                                      type:
                                        - string
                                        - 'null'
                                      example: ext-prod-123
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/product.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/product.png
                                    price:
                                      type: string
                                      example: '29.99'
                                    price_in_currency:
                                      type: string
                                      example: $29.99
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    tax:
                                      type: string
                                      example: '2.99'
                                    tax_in_currency:
                                      type: string
                                      example: $2.99
                                    metadata:
                                      type: object
                                      example:
                                        shopify_product_id: 9876054868270
                                    metafields:
                                      type: array
                                      items:
                                        title: LegacyMetafield
                                        type: object
                                        properties:
                                          namespace:
                                            description: >-
                                              A container for related metafields.
                                              Commonly used to group metafields by app
                                              or functionality.
                                            example: custom
                                            type: string
                                            maxLength: 20
                                            pattern: ^[a-zA-Z0-9_]+$
                                          key:
                                            description: >-
                                              The unique identifier for the metafield
                                              within its namespace. Must be unique per
                                              namespace and owner.
                                            example: material
                                            type: string
                                            maxLength: 30
                                            pattern: ^[a-zA-Z0-9_]+$
                                          value:
                                            description: >-
                                              The actual data stored in the metafield.
                                              Type depends on value_type.
                                            example: cotton
                                            type:
                                              - string
                                              - integer
                                              - object
                                              - boolean
                                              - number
                                          value_type:
                                            description: >-
                                              The data type that defines how the value
                                              should be interpreted and validated.
                                            example: single_line_text_field
                                            type: string
                                          description:
                                            description: >-
                                              Optional human-readable description
                                              explaining the purpose of this
                                              metafield.
                                            example: >-
                                              The primary material used in this
                                              product
                                            type:
                                              - string
                                              - 'null'
                                          created_at:
                                            description: >-
                                              Timestamp when the metafield was
                                              created.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          updated_at:
                                            description: >-
                                              Timestamp when the metafield was last
                                              updated.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          locked:
                                            description: >-
                                              Whether this metafield is locked and
                                              cannot be updated or deleted directly.
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                              - 'null'
                                          metafield_definition:
                                            description: >-
                                              The definition that defines validation
                                              rules and structure for this metafield
                                            type:
                                              - 'null'
                                              - object
                                        required:
                                          - namespace
                                          - key
                                          - value
                                          - value_type
                                          - description
                                          - created_at
                                          - updated_at
                                          - metafield_definition
                                - type: 'null'
                            variant:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Variant
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/sample.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/sample.png
                                    primary_image:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/primary.png
                                    price:
                                      type:
                                        - string
                                        - 'null'
                                      example: '34.44'
                                    price_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $34.44
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    options:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          title:
                                            type: string
                                            example: Size
                                          value:
                                            type: string
                                            example: XL
                                    physical:
                                      type:
                                        - boolean
                                        - 'null'
                                      example: true
                                    unit_of_size:
                                      type:
                                        - string
                                        - 'null'
                                      example: cm
                                    height:
                                      type:
                                        - number
                                        - 'null'
                                      example: 13
                                    width:
                                      type:
                                        - number
                                        - 'null'
                                      example: 6
                                    length:
                                      type:
                                        - number
                                        - 'null'
                                      example: 12
                                    unit_of_weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: kg
                                    weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                    hs_code:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                - type: 'null'
                            errors:
                              oneOf:
                                - type: 'null'
                                - type: array
                                  items:
                                    type: object
                                  example:
                                    - country:
                                        - >-
                                          This product is not available for this
                                          country. Please change your country
                            bundled_items:
                              type: array
                              items:
                                type: object
                                description: Bundled items for bundle products
                                properties:
                                  variant_id:
                                    type: integer
                                    example: 1
                                  product_id:
                                    type: integer
                                    example: 1
                                  product_title:
                                    type: string
                                    example: Product Title
                                  variant_title:
                                    type: string
                                    example: Variant Title
                                  option_titles:
                                    type: array
                                    example:
                                      - Option 1
                                      - Option 2
                                  quantity:
                                    type: integer
                                    example: 1
                                  display_to_customer:
                                    type: boolean
                                    example: true
                      ship_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      bill_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      shipping_method:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: string
                            example: standard-shipping
                          name:
                            type: string
                            example: Standard Shipping
                      available_shipping_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: standard-shipping
                            title:
                              type: string
                              example: Standard Shipping
                            price:
                              type:
                                - number
                                - string
                              example: 5.99
                            price_label:
                              type: string
                              example: $5.99
                            delivery_time_estimate:
                              type: string
                              example: 3-5 business days
                      available_payment_methods:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - credit_card
                                name:
                                  type: string
                                  example: Credit Card
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                apple_pay:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method supports
                                    ApplePay or not 
                                bogus_gateway:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is a Bogus
                                    instance or not.
                                tokenize_path:
                                  type:
                                    - string
                                    - 'null'
                                  description: Path to tokenize, if applicable.
                                token_provider:
                                  type: string
                                  enum:
                                    - spreedly
                                    - vgs
                                  description: >-
                                    Determines if payment tokenization is via
                                    spreedly or VGS
                                apple_pay_merchant_identifier:
                                  type:
                                    - string
                                    - 'null'
                                  example: merchant.mycompany.com
                                  description: >-
                                    If ApplePay is supported, returns the
                                    merchant identifier registered with Apple,
                                    else returns nil
                                supported_brands:
                                  type: array
                                  items:
                                    type: string
                                  example:
                                    - visa
                                    - master
                                    - american_express
                                    - discover
                                publishable_key:
                                  type:
                                    - string
                                    - 'null'
                                  example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                  description: >-
                                    If publishable key is set for Hyperswitch,
                                    returns the publishable key, else returns
                                    nil
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                              required:
                                - id
                                - type
                                - name
                                - supported_brands
                                - test
                                - sandbox
                                - apple_pay
                                - apple_pay_merchant_identifier
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - klarna
                                name:
                                  type: string
                                  example: Klarna
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                      country:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          iso:
                            type: string
                            example: US
                          name:
                            type: string
                            example: United States
                          iso_name:
                            type: string
                            example: UNITED STATES
                          iso3:
                            type: string
                            example: USA
                          currency_code:
                            type: string
                            example: USD
                          currency_symbol:
                            type: string
                            example: $
                          province_required:
                            type: boolean
                            example: false
                          tax_enabled:
                            type:
                              - boolean
                              - 'null'
                            example: true
                          price_inclusive_of_tax:
                            type: boolean
                            example: false
                          price_inclusive_tax_name:
                            type:
                              - string
                              - 'null'
                            example: VAT
                      type:
                        type: string
                        enum:
                          - regular
                          - enrollment
                        example: regular
                      enrollment_pack_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      enrollment_pack:
                        type:
                          - object
                          - 'null'
                        properties:
                          enrollment_pack_id:
                            type: integer
                            example: 1
                          additional_volume:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          slug:
                            type: string
                            example: test-enrollment-pack
                          description:
                            type:
                              - object
                              - 'null'
                              - string
                            properties:
                              id:
                                type: integer
                                example: 111
                              name:
                                type: string
                                example: description
                              body:
                                type: string
                                example: >-
                                  <div>Try the latest and greatest of our sugar
                                  zip packs. Guaranteed to make you skinner and
                                  cure cancer.</div>
                              record_type:
                                type: string
                                example: EnrollmentPack
                              record_id:
                                type: integer
                                example: 1
                              created_at:
                                type: string
                                format: date_time
                                example: '2025-01-16T04:22:43.809Z'
                              updated_at:
                                type: string
                                format: date_time
                                example: '2025-01-22T10:23:52.941Z'
                              locale:
                                type: string
                                example: en
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: 10
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.00
                          images:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2
                                relateable_type:
                                  type: string
                                  example: EnrollmentPack
                                relateable_id:
                                  type: integer
                                  example: 1
                                image_url:
                                  type: string
                                  example: >-
                                    https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                image_path:
                                  type: string
                                  example: jITWaU14QGe0y5AFgY7P_00179.svg
                                position:
                                  type: integer
                                  example: 1
                                shopify_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                                created_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                updated_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                external_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 625
                                allow_subscription:
                                  type: boolean
                                  example: true
                                cv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                cv_in_currency:
                                  type: string
                                  example: $0.00
                                cv_total:
                                  type: integer
                                  example: 0
                                enrollment:
                                  type: boolean
                                  example: true
                                enrollment_pack_id:
                                  type: integer
                                  example: 1
                                price:
                                  type: string
                                  example: '11.13'
                                price_in_currency:
                                  type: string
                                  example: $11.13
                                product_title:
                                  type: string
                                  example: Zip Pack Sample Pack (30)
                                quantity:
                                  type: integer
                                  example: 1
                                qv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                qv_in_currency:
                                  type: string
                                  example: $0.00
                                qv_total:
                                  type: integer
                                  example: 0
                                subscribe_and_save:
                                  type:
                                    - string
                                    - 'null'
                                  example: '-1988.87'
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $-1,988.87
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $-1,988.87
                                subscription:
                                  type: boolean
                                  example: false
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_only:
                                  type: boolean
                                  example: false
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_price:
                                  type: string
                                  example: '2000.0'
                                subscription_price_in_currency:
                                  type: string
                                  example: $2,000.00
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  format: date
                                  example: '2025-02-28'
                                tax:
                                  type: string
                                  example: '0.0'
                                tax_in_currency:
                                  type: string
                                  example: $0.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: null
                                display_to_customer:
                                  type: boolean
                                  example: false
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                          price:
                            type: string
                            example: '11.13'
                          price_in_currency:
                            type: string
                            example: $11.13
                          subscription_price:
                            type:
                              - string
                              - integer
                            example: 2000
                          subscription_price_in_currency:
                            type: string
                            example: $2,000.00
                          title:
                            type: string
                            example: enroll product
                          token:
                            type: string
                            example: NxL22AqLRRisfyF9LqxxWRak
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      recurring:
                        oneOf:
                          - type: array
                            items:
                              type: object
                              properties:
                                subtotal:
                                  type: string
                                  example: '10.0'
                                subtotal_in_currency:
                                  type: string
                                  example: $10.0
                                interval:
                                  type: integer
                                  example: 1
                                interval_unit:
                                  type: string
                                  example: month
                                subtotal_for_display:
                                  type: string
                                  example: $10.00 every 1 month
                                start_date:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-05-27'
                          - type: 'null'
                        default:
                          - subtotal: '10.0'
                            subtotal_in_currency: $10.0
                            interval: 1
                            interval_unit: month
                            subtotal_for_display: $10.00 every 1 month
                            start_date: '2025-05-27'
                      messages:
                        type: object
                        additionalProperties: true
                        example:
                          errors:
                            - Insufficient inventory
                            - Product no longer available
                          warnings:
                            - Low stock warning
                            - Shipping delays expected
                          info:
                            - Free shipping available
                            - Volume discount applied
                      points_enabled:
                        type: boolean
                        example: true
                      points_applied:
                        type: integer
                        example: 500
                        description: Number of points applied to the cart
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Currency value of applied points
                      customer_total_points:
                        type: integer
                        example: 1000
                        description: Customer's total available points balance
                      customer_total_points_in_currency:
                        type: number
                        example: 10
                        description: Currency value of available points
                      remaining_customer_points:
                        type: integer
                        example: 500
                        description: Customer's remaining points after cart redemption
                      remaining_customer_points_amount_in_currency:
                        type: number
                        example: 5
                        description: >-
                          Currency value of remaining points after cart
                          redemption
                      remaining_cart_amount_after_points:
                        type: number
                        example: 95
                        description: Amount to charge to card after points redemption
                      remaining_cart_amount_after_points_in_currency:
                        type:
                          - string
                        example: $95.00
                        description: >-
                          Amount in currency to charge to card after points
                          redemption
                      max_applicable_points:
                        type: integer
                        example: 500
                        description: Maximum points that can be applied to this cart
                  meta:
                    type: object
                    properties:
                      shop_url:
                        type: string
                        example: https://myco.fluid.app
                      checkout_url:
                        type: string
                        example: https://checkout.fluid.com/checkout?jwt=abc123
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                    required:
                      - shop_url
                      - checkout_url
                      - request_id
                      - timestamp
                required:
                  - cart
                  - meta
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: No volume fields provided for update
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - error_message
                  - errors
        '422':
          description: Unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                cv_total:
                  type: integer
                  description: 'Optional: New CV total for the cart item'
                  example: 20
                qv_total:
                  type: integer
                  description: 'Optional: New QV total for the cart item'
                  example: 15
        required: true
        description: Volume update parameters
  /api/carts/{cart_token}/logout:
    delete:
      summary: Removes rep_buyer and customer for the cart
      tags:
        - Carts
      operationId: cartLogout
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Logout successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      state:
                        type: string
                        example: start
                      processed:
                        type: boolean
                        example: false
                        description: >-
                          Determines if a cart payment has been processed or
                          not.
                      valid_for_checkout:
                        type: boolean
                        example: true
                      buyer_rep_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      buyer_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: buyer.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                              external_id:
                                type:
                                  - string
                                  - 'null'
                                example: '123241'
                            required:
                              - id
                          - type: 'null'
                      volume_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: volume.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                            required:
                              - id
                          - type: 'null'
                      currency_symbol:
                        type: string
                        example: $
                      currency_code:
                        type: string
                        example: USD
                      shipping_total_for_display:
                        type: string
                        example: Free
                      phone:
                        type:
                          - string
                          - 'null'
                        example: '4035551212'
                      payment_method_auto_assignable:
                        type: boolean
                        example: true
                        description: >-
                          Determines if a payment method can be auto-assigned to
                          the cart.
                      attribution:
                        oneOf:
                          - type: object
                            oneOf:
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  share_guid:
                                    type: string
                                    example: james-bond007
                                required:
                                  - id
                                  - share_guid
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  email:
                                    type: string
                                    example: james.bond@gmail.com
                                required:
                                  - id
                                  - email
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  username:
                                    type: string
                                    example: jaamball234
                                required:
                                  - id
                                  - username
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  fluid_rep_id:
                                    type: integer
                                    example: 23493
                                required:
                                  - id
                                  - fluid_rep_id
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: w3sdf92
                                required:
                                  - id
                          - type: 'null'
                        default:
                          id: 456
                          share_guid: james-bond007
                      agreements:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            required:
                              type: boolean
                              example: true
                            title:
                              type: string
                              example: Terms and Conditions
                            show_path:
                              type: string
                              example: /terms
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                      amount_total:
                        type: string
                        example: '121.65'
                      amount_total_in_currency:
                        type: string
                        example: $121.65 (USD)
                      sub_total:
                        type: string
                        example: '100.00'
                      sub_total_in_currency:
                        type: string
                        example: $100.00 (USD)
                      subtotal_after_discounts:
                        type: string
                        example: '90.00'
                      tax_total:
                        type: string
                        example: '20.00'
                      tax_total_in_currency:
                        type: string
                        example: $20.00 (USD)
                      shipping_total:
                        type:
                          - string
                          - 'null'
                        example: '1.65'
                      shipping_total_in_currency:
                        type: string
                        example: $1.65 (USD)
                      shipping_discount:
                        type: number
                        example: 10.25
                      discount_total:
                        type: string
                        example: '2.99'
                      discount_total_in_currency:
                        type: string
                        example: $2.99 (USD)
                      discount_breakdown:
                        type: object
                        properties:
                          internal_discounts:
                            type: number
                            example: 15
                          external_discounts:
                            type: number
                            example: 10
                          total_discounts:
                            type: number
                            example: 25
                      external_discount:
                        type: object
                        properties:
                          total:
                            type: number
                            example: 10
                          calculated_at:
                            type:
                              - string
                              - 'null'
                            format: date-time
                            example: '2024-01-10T15:30:00Z'
                          sources:
                            type: object
                            additionalProperties:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 6
                                description:
                                  type: string
                                  example: Gold tier discount
                                metadata:
                                  type: object
                              required:
                                - amount
                                - description
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: '1.90'
                      transaction_fee_in_currency:
                        type: string
                        example: $1.90 (USD)
                      cv_total:
                        type: integer
                        example: 10
                      qv_total:
                        type: integer
                        example: 15
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      payment_account:
                        type:
                          - string
                          - 'null'
                        example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                      payment_method:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: CreditCard
                              payment_method_type:
                                type: string
                                example: visa
                              last_four:
                                type: string
                                example: '1234'
                              exp_month:
                                type: string
                                example: '12'
                              exp_year:
                                type: string
                                example: '2025'
                              logo_url:
                                type: string
                                example: https://example.com/image.svg
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Paypal
                              status:
                                type: string
                                example: active
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Affirm
                              affirm_id:
                                type: string
                                example: affirm_123
                              status:
                                type: string
                                example: authorized
                              checkout_id:
                                type: string
                                example: checkout_456
                              created:
                                type: string
                                example: '2025-01-01T00:00:00Z'
                              auth_expiration:
                                type: string
                                example: '2025-01-02T00:00:00Z'
                              currency:
                                type: string
                                example: USD
                              amount:
                                type: string
                                example: '100.00'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Klarna
                              session_id:
                                type: string
                                example: klarna_session_789
                              intent:
                                type: string
                                example: buy
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Droplet
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: SomeCitcon
                      email:
                        type:
                          - string
                          - 'null'
                        example: user@example.com
                      enrollment_fee:
                        type:
                          - number
                          - string
                        example: '10.45'
                      enrollment_fee_in_currency:
                        type: string
                        example: $10.45
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT10
                          - DISCOUNT11
                      language_iso:
                        type:
                          - string
                          - 'null'
                        example: en
                      cart_token:
                        type: string
                        example: abc123
                      immutable_items:
                        type: boolean
                        example: false
                      digital_only:
                        type: boolean
                        example: false
                      requires_3ds:
                        type: boolean
                        example: false
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 101
                            price:
                              type: string
                              example: '43.41'
                            price_in_currency:
                              type: string
                              example: $43.41
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            cv:
                              type: integer
                              example: 5
                            cv_total:
                              type: integer
                              example: 15
                            qv:
                              type: integer
                              example: 7
                            qv_total:
                              type: integer
                              example: 21
                            discount_amount:
                              type: string
                              example: '10'
                            free_item:
                              type: boolean
                              example: false
                            discount_amount_in_currency:
                              type: string
                              example: $10.00
                            total_after_discounts:
                              type: string
                              example: '90.00'
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            product_title:
                              type:
                                - string
                                - 'null'
                              example: Sample Product
                            quantity:
                              type: integer
                              example: 3
                            subscription:
                              type: boolean
                              example: true
                            enrollment:
                              type: boolean
                              example: false
                            allow_subscription:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_plan_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_plans:
                              oneOf:
                                - type: array
                                  items:
                                    title: Commerce::SubscriptionPlan
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        example: Test Subscription Plan
                                        type: string
                                      billing_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      billing_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      billing_frequency_in_words:
                                        example: 2 Months
                                        type: string
                                      shipping_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      shipping_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      volume_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      volume_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      trial_period:
                                        example: 1
                                        type:
                                          - integer
                                          - 'null'
                                        minimum: 1
                                      trial_period_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type:
                                          - string
                                          - 'null'
                                      split_volume:
                                        example: true
                                        type: boolean
                                        default: false
                                      allow_max_billing_cycles:
                                        example: true
                                        type: boolean
                                        default: false
                                      max_billing_cycles:
                                        example: 3
                                        type:
                                          - integer
                                          - 'null'
                                      company_default:
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                        default: false
                                      products_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      subscribers_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      price:
                                        type: string
                                      price_in_currency:
                                        type: string
                                      subscription_start:
                                        type: string
                                      subscribe_and_save:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_in_currency:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_for_display:
                                        type:
                                          - string
                                          - 'null'
                                    required:
                                      - id
                                      - name
                                      - billing_interval
                                      - billing_interval_unit
                                      - billing_frequency_in_words
                                      - shipping_interval
                                      - shipping_interval_unit
                                      - volume_interval
                                      - volume_interval_unit
                                      - split_volume
                                      - allow_max_billing_cycles
                                      - price
                                      - price_in_currency
                                      - subscription_start
                                      - subscribe_and_save
                                      - subscribe_and_save_in_currency
                                      - subscribe_and_save_for_display
                                - type: 'null'
                            subscription_only:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_interval:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_interval_unit:
                              type:
                                - string
                                - 'null'
                              example: month
                            subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 10.5
                            subscription_price_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $10.50
                            subscription_start:
                              type:
                                - string
                                - 'null'
                              example: '2025-02-12'
                            subscribe_and_save:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 2.99
                            subscribe_and_save_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $2.99
                            subscribe_and_save_for_display:
                              type:
                                - string
                                - 'null'
                              example: Subscribe and save $2.99
                            title:
                              type:
                                - string
                                - 'null'
                              example: Surcharge
                            metadata:
                              type: object
                              description: >-
                                A JSON object that can store any custom data
                                structure
                              example: {}
                            product:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type: string
                                      example: Sample Product
                                    introduction:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Product Description
                                    cv:
                                      type: integer
                                      example: 10
                                    external_id:
                                      type:
                                        - string
                                        - 'null'
                                      example: ext-prod-123
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/product.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/product.png
                                    price:
                                      type: string
                                      example: '29.99'
                                    price_in_currency:
                                      type: string
                                      example: $29.99
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    tax:
                                      type: string
                                      example: '2.99'
                                    tax_in_currency:
                                      type: string
                                      example: $2.99
                                    metadata:
                                      type: object
                                      example:
                                        shopify_product_id: 9876054868270
                                    metafields:
                                      type: array
                                      items:
                                        title: LegacyMetafield
                                        type: object
                                        properties:
                                          namespace:
                                            description: >-
                                              A container for related metafields.
                                              Commonly used to group metafields by app
                                              or functionality.
                                            example: custom
                                            type: string
                                            maxLength: 20
                                            pattern: ^[a-zA-Z0-9_]+$
                                          key:
                                            description: >-
                                              The unique identifier for the metafield
                                              within its namespace. Must be unique per
                                              namespace and owner.
                                            example: material
                                            type: string
                                            maxLength: 30
                                            pattern: ^[a-zA-Z0-9_]+$
                                          value:
                                            description: >-
                                              The actual data stored in the metafield.
                                              Type depends on value_type.
                                            example: cotton
                                            type:
                                              - string
                                              - integer
                                              - object
                                              - boolean
                                              - number
                                          value_type:
                                            description: >-
                                              The data type that defines how the value
                                              should be interpreted and validated.
                                            example: single_line_text_field
                                            type: string
                                          description:
                                            description: >-
                                              Optional human-readable description
                                              explaining the purpose of this
                                              metafield.
                                            example: >-
                                              The primary material used in this
                                              product
                                            type:
                                              - string
                                              - 'null'
                                          created_at:
                                            description: >-
                                              Timestamp when the metafield was
                                              created.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          updated_at:
                                            description: >-
                                              Timestamp when the metafield was last
                                              updated.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          locked:
                                            description: >-
                                              Whether this metafield is locked and
                                              cannot be updated or deleted directly.
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                              - 'null'
                                          metafield_definition:
                                            description: >-
                                              The definition that defines validation
                                              rules and structure for this metafield
                                            type:
                                              - 'null'
                                              - object
                                        required:
                                          - namespace
                                          - key
                                          - value
                                          - value_type
                                          - description
                                          - created_at
                                          - updated_at
                                          - metafield_definition
                                - type: 'null'
                            variant:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Variant
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/sample.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/sample.png
                                    primary_image:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/primary.png
                                    price:
                                      type:
                                        - string
                                        - 'null'
                                      example: '34.44'
                                    price_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $34.44
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    options:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          title:
                                            type: string
                                            example: Size
                                          value:
                                            type: string
                                            example: XL
                                    physical:
                                      type:
                                        - boolean
                                        - 'null'
                                      example: true
                                    unit_of_size:
                                      type:
                                        - string
                                        - 'null'
                                      example: cm
                                    height:
                                      type:
                                        - number
                                        - 'null'
                                      example: 13
                                    width:
                                      type:
                                        - number
                                        - 'null'
                                      example: 6
                                    length:
                                      type:
                                        - number
                                        - 'null'
                                      example: 12
                                    unit_of_weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: kg
                                    weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                    hs_code:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                - type: 'null'
                            errors:
                              oneOf:
                                - type: 'null'
                                - type: array
                                  items:
                                    type: object
                                  example:
                                    - country:
                                        - >-
                                          This product is not available for this
                                          country. Please change your country
                            bundled_items:
                              type: array
                              items:
                                type: object
                                description: Bundled items for bundle products
                                properties:
                                  variant_id:
                                    type: integer
                                    example: 1
                                  product_id:
                                    type: integer
                                    example: 1
                                  product_title:
                                    type: string
                                    example: Product Title
                                  variant_title:
                                    type: string
                                    example: Variant Title
                                  option_titles:
                                    type: array
                                    example:
                                      - Option 1
                                      - Option 2
                                  quantity:
                                    type: integer
                                    example: 1
                                  display_to_customer:
                                    type: boolean
                                    example: true
                      ship_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      bill_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      shipping_method:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: string
                            example: standard-shipping
                          name:
                            type: string
                            example: Standard Shipping
                      available_shipping_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: standard-shipping
                            title:
                              type: string
                              example: Standard Shipping
                            price:
                              type:
                                - number
                                - string
                              example: 5.99
                            price_label:
                              type: string
                              example: $5.99
                            delivery_time_estimate:
                              type: string
                              example: 3-5 business days
                      available_payment_methods:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - credit_card
                                name:
                                  type: string
                                  example: Credit Card
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                apple_pay:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method supports
                                    ApplePay or not 
                                bogus_gateway:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is a Bogus
                                    instance or not.
                                tokenize_path:
                                  type:
                                    - string
                                    - 'null'
                                  description: Path to tokenize, if applicable.
                                token_provider:
                                  type: string
                                  enum:
                                    - spreedly
                                    - vgs
                                  description: >-
                                    Determines if payment tokenization is via
                                    spreedly or VGS
                                apple_pay_merchant_identifier:
                                  type:
                                    - string
                                    - 'null'
                                  example: merchant.mycompany.com
                                  description: >-
                                    If ApplePay is supported, returns the
                                    merchant identifier registered with Apple,
                                    else returns nil
                                supported_brands:
                                  type: array
                                  items:
                                    type: string
                                  example:
                                    - visa
                                    - master
                                    - american_express
                                    - discover
                                publishable_key:
                                  type:
                                    - string
                                    - 'null'
                                  example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                  description: >-
                                    If publishable key is set for Hyperswitch,
                                    returns the publishable key, else returns
                                    nil
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                              required:
                                - id
                                - type
                                - name
                                - supported_brands
                                - test
                                - sandbox
                                - apple_pay
                                - apple_pay_merchant_identifier
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - klarna
                                name:
                                  type: string
                                  example: Klarna
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                      country:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          iso:
                            type: string
                            example: US
                          name:
                            type: string
                            example: United States
                          iso_name:
                            type: string
                            example: UNITED STATES
                          iso3:
                            type: string
                            example: USA
                          currency_code:
                            type: string
                            example: USD
                          currency_symbol:
                            type: string
                            example: $
                          province_required:
                            type: boolean
                            example: false
                          tax_enabled:
                            type:
                              - boolean
                              - 'null'
                            example: true
                          price_inclusive_of_tax:
                            type: boolean
                            example: false
                          price_inclusive_tax_name:
                            type:
                              - string
                              - 'null'
                            example: VAT
                      type:
                        type: string
                        enum:
                          - regular
                          - enrollment
                        example: regular
                      enrollment_pack_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      enrollment_pack:
                        type:
                          - object
                          - 'null'
                        properties:
                          enrollment_pack_id:
                            type: integer
                            example: 1
                          additional_volume:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          slug:
                            type: string
                            example: test-enrollment-pack
                          description:
                            type:
                              - object
                              - 'null'
                              - string
                            properties:
                              id:
                                type: integer
                                example: 111
                              name:
                                type: string
                                example: description
                              body:
                                type: string
                                example: >-
                                  <div>Try the latest and greatest of our sugar
                                  zip packs. Guaranteed to make you skinner and
                                  cure cancer.</div>
                              record_type:
                                type: string
                                example: EnrollmentPack
                              record_id:
                                type: integer
                                example: 1
                              created_at:
                                type: string
                                format: date_time
                                example: '2025-01-16T04:22:43.809Z'
                              updated_at:
                                type: string
                                format: date_time
                                example: '2025-01-22T10:23:52.941Z'
                              locale:
                                type: string
                                example: en
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: 10
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.00
                          images:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2
                                relateable_type:
                                  type: string
                                  example: EnrollmentPack
                                relateable_id:
                                  type: integer
                                  example: 1
                                image_url:
                                  type: string
                                  example: >-
                                    https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                image_path:
                                  type: string
                                  example: jITWaU14QGe0y5AFgY7P_00179.svg
                                position:
                                  type: integer
                                  example: 1
                                shopify_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                                created_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                updated_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                external_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 625
                                allow_subscription:
                                  type: boolean
                                  example: true
                                cv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                cv_in_currency:
                                  type: string
                                  example: $0.00
                                cv_total:
                                  type: integer
                                  example: 0
                                enrollment:
                                  type: boolean
                                  example: true
                                enrollment_pack_id:
                                  type: integer
                                  example: 1
                                price:
                                  type: string
                                  example: '11.13'
                                price_in_currency:
                                  type: string
                                  example: $11.13
                                product_title:
                                  type: string
                                  example: Zip Pack Sample Pack (30)
                                quantity:
                                  type: integer
                                  example: 1
                                qv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                qv_in_currency:
                                  type: string
                                  example: $0.00
                                qv_total:
                                  type: integer
                                  example: 0
                                subscribe_and_save:
                                  type:
                                    - string
                                    - 'null'
                                  example: '-1988.87'
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $-1,988.87
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $-1,988.87
                                subscription:
                                  type: boolean
                                  example: false
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_only:
                                  type: boolean
                                  example: false
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_price:
                                  type: string
                                  example: '2000.0'
                                subscription_price_in_currency:
                                  type: string
                                  example: $2,000.00
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  format: date
                                  example: '2025-02-28'
                                tax:
                                  type: string
                                  example: '0.0'
                                tax_in_currency:
                                  type: string
                                  example: $0.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: null
                                display_to_customer:
                                  type: boolean
                                  example: false
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                          price:
                            type: string
                            example: '11.13'
                          price_in_currency:
                            type: string
                            example: $11.13
                          subscription_price:
                            type:
                              - string
                              - integer
                            example: 2000
                          subscription_price_in_currency:
                            type: string
                            example: $2,000.00
                          title:
                            type: string
                            example: enroll product
                          token:
                            type: string
                            example: NxL22AqLRRisfyF9LqxxWRak
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      recurring:
                        oneOf:
                          - type: array
                            items:
                              type: object
                              properties:
                                subtotal:
                                  type: string
                                  example: '10.0'
                                subtotal_in_currency:
                                  type: string
                                  example: $10.0
                                interval:
                                  type: integer
                                  example: 1
                                interval_unit:
                                  type: string
                                  example: month
                                subtotal_for_display:
                                  type: string
                                  example: $10.00 every 1 month
                                start_date:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-05-27'
                          - type: 'null'
                        default:
                          - subtotal: '10.0'
                            subtotal_in_currency: $10.0
                            interval: 1
                            interval_unit: month
                            subtotal_for_display: $10.00 every 1 month
                            start_date: '2025-05-27'
                      messages:
                        type: object
                        additionalProperties: true
                        example:
                          errors:
                            - Insufficient inventory
                            - Product no longer available
                          warnings:
                            - Low stock warning
                            - Shipping delays expected
                          info:
                            - Free shipping available
                            - Volume discount applied
                      points_enabled:
                        type: boolean
                        example: true
                      points_applied:
                        type: integer
                        example: 500
                        description: Number of points applied to the cart
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Currency value of applied points
                      customer_total_points:
                        type: integer
                        example: 1000
                        description: Customer's total available points balance
                      customer_total_points_in_currency:
                        type: number
                        example: 10
                        description: Currency value of available points
                      remaining_customer_points:
                        type: integer
                        example: 500
                        description: Customer's remaining points after cart redemption
                      remaining_customer_points_amount_in_currency:
                        type: number
                        example: 5
                        description: >-
                          Currency value of remaining points after cart
                          redemption
                      remaining_cart_amount_after_points:
                        type: number
                        example: 95
                        description: Amount to charge to card after points redemption
                      remaining_cart_amount_after_points_in_currency:
                        type:
                          - string
                        example: $95.00
                        description: >-
                          Amount in currency to charge to card after points
                          redemption
                      max_applicable_points:
                        type: integer
                        example: 500
                        description: Maximum points that can be applied to this cart
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      checkout_url:
                        type: string
                        example: https://checkout.fluid.com/checkout?jwt=abc123
                      shop_url:
                        type: string
                        example: https://myco.fluid.app
        '404':
          description: cart not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Cart not found
                  errors:
                    type: object
                    example:
                      cart:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '410':
          description: Cart is processed and cannot be modified
  /api/carts/{cart_token}/attribution:
    patch:
      summary: Updates cart attribution
      tags:
        - Carts
      description: Updates attribution data for a cart
      operationId: updateCartAttribution
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: attribution updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      state:
                        type: string
                        example: start
                      processed:
                        type: boolean
                        example: false
                        description: >-
                          Determines if a cart payment has been processed or
                          not.
                      valid_for_checkout:
                        type: boolean
                        example: true
                      buyer_rep_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      buyer_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: buyer.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                              external_id:
                                type:
                                  - string
                                  - 'null'
                                example: '123241'
                            required:
                              - id
                          - type: 'null'
                      volume_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: volume.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                            required:
                              - id
                          - type: 'null'
                      currency_symbol:
                        type: string
                        example: $
                      currency_code:
                        type: string
                        example: USD
                      shipping_total_for_display:
                        type: string
                        example: Free
                      phone:
                        type:
                          - string
                          - 'null'
                        example: '4035551212'
                      payment_method_auto_assignable:
                        type: boolean
                        example: true
                        description: >-
                          Determines if a payment method can be auto-assigned to
                          the cart.
                      attribution:
                        oneOf:
                          - type: object
                            oneOf:
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  share_guid:
                                    type: string
                                    example: james-bond007
                                required:
                                  - id
                                  - share_guid
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  email:
                                    type: string
                                    example: james.bond@gmail.com
                                required:
                                  - id
                                  - email
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  username:
                                    type: string
                                    example: jaamball234
                                required:
                                  - id
                                  - username
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  fluid_rep_id:
                                    type: integer
                                    example: 23493
                                required:
                                  - id
                                  - fluid_rep_id
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: w3sdf92
                                required:
                                  - id
                          - type: 'null'
                        default:
                          id: 456
                          share_guid: james-bond007
                      agreements:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            required:
                              type: boolean
                              example: true
                            title:
                              type: string
                              example: Terms and Conditions
                            show_path:
                              type: string
                              example: /terms
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                      amount_total:
                        type: string
                        example: '121.65'
                      amount_total_in_currency:
                        type: string
                        example: $121.65 (USD)
                      sub_total:
                        type: string
                        example: '100.00'
                      sub_total_in_currency:
                        type: string
                        example: $100.00 (USD)
                      subtotal_after_discounts:
                        type: string
                        example: '90.00'
                      tax_total:
                        type: string
                        example: '20.00'
                      tax_total_in_currency:
                        type: string
                        example: $20.00 (USD)
                      shipping_total:
                        type:
                          - string
                          - 'null'
                        example: '1.65'
                      shipping_total_in_currency:
                        type: string
                        example: $1.65 (USD)
                      shipping_discount:
                        type: number
                        example: 10.25
                      discount_total:
                        type: string
                        example: '2.99'
                      discount_total_in_currency:
                        type: string
                        example: $2.99 (USD)
                      discount_breakdown:
                        type: object
                        properties:
                          internal_discounts:
                            type: number
                            example: 15
                          external_discounts:
                            type: number
                            example: 10
                          total_discounts:
                            type: number
                            example: 25
                      external_discount:
                        type: object
                        properties:
                          total:
                            type: number
                            example: 10
                          calculated_at:
                            type:
                              - string
                              - 'null'
                            format: date-time
                            example: '2024-01-10T15:30:00Z'
                          sources:
                            type: object
                            additionalProperties:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 6
                                description:
                                  type: string
                                  example: Gold tier discount
                                metadata:
                                  type: object
                              required:
                                - amount
                                - description
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: '1.90'
                      transaction_fee_in_currency:
                        type: string
                        example: $1.90 (USD)
                      cv_total:
                        type: integer
                        example: 10
                      qv_total:
                        type: integer
                        example: 15
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      payment_account:
                        type:
                          - string
                          - 'null'
                        example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                      payment_method:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: CreditCard
                              payment_method_type:
                                type: string
                                example: visa
                              last_four:
                                type: string
                                example: '1234'
                              exp_month:
                                type: string
                                example: '12'
                              exp_year:
                                type: string
                                example: '2025'
                              logo_url:
                                type: string
                                example: https://example.com/image.svg
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Paypal
                              status:
                                type: string
                                example: active
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Affirm
                              affirm_id:
                                type: string
                                example: affirm_123
                              status:
                                type: string
                                example: authorized
                              checkout_id:
                                type: string
                                example: checkout_456
                              created:
                                type: string
                                example: '2025-01-01T00:00:00Z'
                              auth_expiration:
                                type: string
                                example: '2025-01-02T00:00:00Z'
                              currency:
                                type: string
                                example: USD
                              amount:
                                type: string
                                example: '100.00'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Klarna
                              session_id:
                                type: string
                                example: klarna_session_789
                              intent:
                                type: string
                                example: buy
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Droplet
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: SomeCitcon
                      email:
                        type:
                          - string
                          - 'null'
                        example: user@example.com
                      enrollment_fee:
                        type:
                          - number
                          - string
                        example: '10.45'
                      enrollment_fee_in_currency:
                        type: string
                        example: $10.45
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT10
                          - DISCOUNT11
                      language_iso:
                        type:
                          - string
                          - 'null'
                        example: en
                      cart_token:
                        type: string
                        example: abc123
                      immutable_items:
                        type: boolean
                        example: false
                      digital_only:
                        type: boolean
                        example: false
                      requires_3ds:
                        type: boolean
                        example: false
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 101
                            price:
                              type: string
                              example: '43.41'
                            price_in_currency:
                              type: string
                              example: $43.41
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            cv:
                              type: integer
                              example: 5
                            cv_total:
                              type: integer
                              example: 15
                            qv:
                              type: integer
                              example: 7
                            qv_total:
                              type: integer
                              example: 21
                            discount_amount:
                              type: string
                              example: '10'
                            free_item:
                              type: boolean
                              example: false
                            discount_amount_in_currency:
                              type: string
                              example: $10.00
                            total_after_discounts:
                              type: string
                              example: '90.00'
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            product_title:
                              type:
                                - string
                                - 'null'
                              example: Sample Product
                            quantity:
                              type: integer
                              example: 3
                            subscription:
                              type: boolean
                              example: true
                            enrollment:
                              type: boolean
                              example: false
                            allow_subscription:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_plan_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_plans:
                              oneOf:
                                - type: array
                                  items:
                                    title: Commerce::SubscriptionPlan
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        example: Test Subscription Plan
                                        type: string
                                      billing_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      billing_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      billing_frequency_in_words:
                                        example: 2 Months
                                        type: string
                                      shipping_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      shipping_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      volume_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      volume_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      trial_period:
                                        example: 1
                                        type:
                                          - integer
                                          - 'null'
                                        minimum: 1
                                      trial_period_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type:
                                          - string
                                          - 'null'
                                      split_volume:
                                        example: true
                                        type: boolean
                                        default: false
                                      allow_max_billing_cycles:
                                        example: true
                                        type: boolean
                                        default: false
                                      max_billing_cycles:
                                        example: 3
                                        type:
                                          - integer
                                          - 'null'
                                      company_default:
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                        default: false
                                      products_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      subscribers_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      price:
                                        type: string
                                      price_in_currency:
                                        type: string
                                      subscription_start:
                                        type: string
                                      subscribe_and_save:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_in_currency:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_for_display:
                                        type:
                                          - string
                                          - 'null'
                                    required:
                                      - id
                                      - name
                                      - billing_interval
                                      - billing_interval_unit
                                      - billing_frequency_in_words
                                      - shipping_interval
                                      - shipping_interval_unit
                                      - volume_interval
                                      - volume_interval_unit
                                      - split_volume
                                      - allow_max_billing_cycles
                                      - price
                                      - price_in_currency
                                      - subscription_start
                                      - subscribe_and_save
                                      - subscribe_and_save_in_currency
                                      - subscribe_and_save_for_display
                                - type: 'null'
                            subscription_only:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_interval:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_interval_unit:
                              type:
                                - string
                                - 'null'
                              example: month
                            subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 10.5
                            subscription_price_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $10.50
                            subscription_start:
                              type:
                                - string
                                - 'null'
                              example: '2025-02-12'
                            subscribe_and_save:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 2.99
                            subscribe_and_save_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $2.99
                            subscribe_and_save_for_display:
                              type:
                                - string
                                - 'null'
                              example: Subscribe and save $2.99
                            title:
                              type:
                                - string
                                - 'null'
                              example: Surcharge
                            metadata:
                              type: object
                              description: >-
                                A JSON object that can store any custom data
                                structure
                              example: {}
                            product:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type: string
                                      example: Sample Product
                                    introduction:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Product Description
                                    cv:
                                      type: integer
                                      example: 10
                                    external_id:
                                      type:
                                        - string
                                        - 'null'
                                      example: ext-prod-123
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/product.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/product.png
                                    price:
                                      type: string
                                      example: '29.99'
                                    price_in_currency:
                                      type: string
                                      example: $29.99
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    tax:
                                      type: string
                                      example: '2.99'
                                    tax_in_currency:
                                      type: string
                                      example: $2.99
                                    metadata:
                                      type: object
                                      example:
                                        shopify_product_id: 9876054868270
                                    metafields:
                                      type: array
                                      items:
                                        title: LegacyMetafield
                                        type: object
                                        properties:
                                          namespace:
                                            description: >-
                                              A container for related metafields.
                                              Commonly used to group metafields by app
                                              or functionality.
                                            example: custom
                                            type: string
                                            maxLength: 20
                                            pattern: ^[a-zA-Z0-9_]+$
                                          key:
                                            description: >-
                                              The unique identifier for the metafield
                                              within its namespace. Must be unique per
                                              namespace and owner.
                                            example: material
                                            type: string
                                            maxLength: 30
                                            pattern: ^[a-zA-Z0-9_]+$
                                          value:
                                            description: >-
                                              The actual data stored in the metafield.
                                              Type depends on value_type.
                                            example: cotton
                                            type:
                                              - string
                                              - integer
                                              - object
                                              - boolean
                                              - number
                                          value_type:
                                            description: >-
                                              The data type that defines how the value
                                              should be interpreted and validated.
                                            example: single_line_text_field
                                            type: string
                                          description:
                                            description: >-
                                              Optional human-readable description
                                              explaining the purpose of this
                                              metafield.
                                            example: >-
                                              The primary material used in this
                                              product
                                            type:
                                              - string
                                              - 'null'
                                          created_at:
                                            description: >-
                                              Timestamp when the metafield was
                                              created.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          updated_at:
                                            description: >-
                                              Timestamp when the metafield was last
                                              updated.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          locked:
                                            description: >-
                                              Whether this metafield is locked and
                                              cannot be updated or deleted directly.
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                              - 'null'
                                          metafield_definition:
                                            description: >-
                                              The definition that defines validation
                                              rules and structure for this metafield
                                            type:
                                              - 'null'
                                              - object
                                        required:
                                          - namespace
                                          - key
                                          - value
                                          - value_type
                                          - description
                                          - created_at
                                          - updated_at
                                          - metafield_definition
                                - type: 'null'
                            variant:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Variant
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/sample.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/sample.png
                                    primary_image:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/primary.png
                                    price:
                                      type:
                                        - string
                                        - 'null'
                                      example: '34.44'
                                    price_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $34.44
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    options:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          title:
                                            type: string
                                            example: Size
                                          value:
                                            type: string
                                            example: XL
                                    physical:
                                      type:
                                        - boolean
                                        - 'null'
                                      example: true
                                    unit_of_size:
                                      type:
                                        - string
                                        - 'null'
                                      example: cm
                                    height:
                                      type:
                                        - number
                                        - 'null'
                                      example: 13
                                    width:
                                      type:
                                        - number
                                        - 'null'
                                      example: 6
                                    length:
                                      type:
                                        - number
                                        - 'null'
                                      example: 12
                                    unit_of_weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: kg
                                    weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                    hs_code:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                - type: 'null'
                            errors:
                              oneOf:
                                - type: 'null'
                                - type: array
                                  items:
                                    type: object
                                  example:
                                    - country:
                                        - >-
                                          This product is not available for this
                                          country. Please change your country
                            bundled_items:
                              type: array
                              items:
                                type: object
                                description: Bundled items for bundle products
                                properties:
                                  variant_id:
                                    type: integer
                                    example: 1
                                  product_id:
                                    type: integer
                                    example: 1
                                  product_title:
                                    type: string
                                    example: Product Title
                                  variant_title:
                                    type: string
                                    example: Variant Title
                                  option_titles:
                                    type: array
                                    example:
                                      - Option 1
                                      - Option 2
                                  quantity:
                                    type: integer
                                    example: 1
                                  display_to_customer:
                                    type: boolean
                                    example: true
                      ship_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      bill_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      shipping_method:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: string
                            example: standard-shipping
                          name:
                            type: string
                            example: Standard Shipping
                      available_shipping_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: standard-shipping
                            title:
                              type: string
                              example: Standard Shipping
                            price:
                              type:
                                - number
                                - string
                              example: 5.99
                            price_label:
                              type: string
                              example: $5.99
                            delivery_time_estimate:
                              type: string
                              example: 3-5 business days
                      available_payment_methods:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - credit_card
                                name:
                                  type: string
                                  example: Credit Card
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                apple_pay:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method supports
                                    ApplePay or not 
                                bogus_gateway:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is a Bogus
                                    instance or not.
                                tokenize_path:
                                  type:
                                    - string
                                    - 'null'
                                  description: Path to tokenize, if applicable.
                                token_provider:
                                  type: string
                                  enum:
                                    - spreedly
                                    - vgs
                                  description: >-
                                    Determines if payment tokenization is via
                                    spreedly or VGS
                                apple_pay_merchant_identifier:
                                  type:
                                    - string
                                    - 'null'
                                  example: merchant.mycompany.com
                                  description: >-
                                    If ApplePay is supported, returns the
                                    merchant identifier registered with Apple,
                                    else returns nil
                                supported_brands:
                                  type: array
                                  items:
                                    type: string
                                  example:
                                    - visa
                                    - master
                                    - american_express
                                    - discover
                                publishable_key:
                                  type:
                                    - string
                                    - 'null'
                                  example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                  description: >-
                                    If publishable key is set for Hyperswitch,
                                    returns the publishable key, else returns
                                    nil
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                              required:
                                - id
                                - type
                                - name
                                - supported_brands
                                - test
                                - sandbox
                                - apple_pay
                                - apple_pay_merchant_identifier
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - klarna
                                name:
                                  type: string
                                  example: Klarna
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                      country:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          iso:
                            type: string
                            example: US
                          name:
                            type: string
                            example: United States
                          iso_name:
                            type: string
                            example: UNITED STATES
                          iso3:
                            type: string
                            example: USA
                          currency_code:
                            type: string
                            example: USD
                          currency_symbol:
                            type: string
                            example: $
                          province_required:
                            type: boolean
                            example: false
                          tax_enabled:
                            type:
                              - boolean
                              - 'null'
                            example: true
                          price_inclusive_of_tax:
                            type: boolean
                            example: false
                          price_inclusive_tax_name:
                            type:
                              - string
                              - 'null'
                            example: VAT
                      type:
                        type: string
                        enum:
                          - regular
                          - enrollment
                        example: regular
                      enrollment_pack_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      enrollment_pack:
                        type:
                          - object
                          - 'null'
                        properties:
                          enrollment_pack_id:
                            type: integer
                            example: 1
                          additional_volume:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          slug:
                            type: string
                            example: test-enrollment-pack
                          description:
                            type:
                              - object
                              - 'null'
                              - string
                            properties:
                              id:
                                type: integer
                                example: 111
                              name:
                                type: string
                                example: description
                              body:
                                type: string
                                example: >-
                                  <div>Try the latest and greatest of our sugar
                                  zip packs. Guaranteed to make you skinner and
                                  cure cancer.</div>
                              record_type:
                                type: string
                                example: EnrollmentPack
                              record_id:
                                type: integer
                                example: 1
                              created_at:
                                type: string
                                format: date_time
                                example: '2025-01-16T04:22:43.809Z'
                              updated_at:
                                type: string
                                format: date_time
                                example: '2025-01-22T10:23:52.941Z'
                              locale:
                                type: string
                                example: en
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: 10
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.00
                          images:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2
                                relateable_type:
                                  type: string
                                  example: EnrollmentPack
                                relateable_id:
                                  type: integer
                                  example: 1
                                image_url:
                                  type: string
                                  example: >-
                                    https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                image_path:
                                  type: string
                                  example: jITWaU14QGe0y5AFgY7P_00179.svg
                                position:
                                  type: integer
                                  example: 1
                                shopify_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                                created_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                updated_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                external_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 625
                                allow_subscription:
                                  type: boolean
                                  example: true
                                cv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                cv_in_currency:
                                  type: string
                                  example: $0.00
                                cv_total:
                                  type: integer
                                  example: 0
                                enrollment:
                                  type: boolean
                                  example: true
                                enrollment_pack_id:
                                  type: integer
                                  example: 1
                                price:
                                  type: string
                                  example: '11.13'
                                price_in_currency:
                                  type: string
                                  example: $11.13
                                product_title:
                                  type: string
                                  example: Zip Pack Sample Pack (30)
                                quantity:
                                  type: integer
                                  example: 1
                                qv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                qv_in_currency:
                                  type: string
                                  example: $0.00
                                qv_total:
                                  type: integer
                                  example: 0
                                subscribe_and_save:
                                  type:
                                    - string
                                    - 'null'
                                  example: '-1988.87'
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $-1,988.87
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $-1,988.87
                                subscription:
                                  type: boolean
                                  example: false
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_only:
                                  type: boolean
                                  example: false
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_price:
                                  type: string
                                  example: '2000.0'
                                subscription_price_in_currency:
                                  type: string
                                  example: $2,000.00
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  format: date
                                  example: '2025-02-28'
                                tax:
                                  type: string
                                  example: '0.0'
                                tax_in_currency:
                                  type: string
                                  example: $0.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: null
                                display_to_customer:
                                  type: boolean
                                  example: false
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                          price:
                            type: string
                            example: '11.13'
                          price_in_currency:
                            type: string
                            example: $11.13
                          subscription_price:
                            type:
                              - string
                              - integer
                            example: 2000
                          subscription_price_in_currency:
                            type: string
                            example: $2,000.00
                          title:
                            type: string
                            example: enroll product
                          token:
                            type: string
                            example: NxL22AqLRRisfyF9LqxxWRak
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      recurring:
                        oneOf:
                          - type: array
                            items:
                              type: object
                              properties:
                                subtotal:
                                  type: string
                                  example: '10.0'
                                subtotal_in_currency:
                                  type: string
                                  example: $10.0
                                interval:
                                  type: integer
                                  example: 1
                                interval_unit:
                                  type: string
                                  example: month
                                subtotal_for_display:
                                  type: string
                                  example: $10.00 every 1 month
                                start_date:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-05-27'
                          - type: 'null'
                        default:
                          - subtotal: '10.0'
                            subtotal_in_currency: $10.0
                            interval: 1
                            interval_unit: month
                            subtotal_for_display: $10.00 every 1 month
                            start_date: '2025-05-27'
                      messages:
                        type: object
                        additionalProperties: true
                        example:
                          errors:
                            - Insufficient inventory
                            - Product no longer available
                          warnings:
                            - Low stock warning
                            - Shipping delays expected
                          info:
                            - Free shipping available
                            - Volume discount applied
                      points_enabled:
                        type: boolean
                        example: true
                      points_applied:
                        type: integer
                        example: 500
                        description: Number of points applied to the cart
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Currency value of applied points
                      customer_total_points:
                        type: integer
                        example: 1000
                        description: Customer's total available points balance
                      customer_total_points_in_currency:
                        type: number
                        example: 10
                        description: Currency value of available points
                      remaining_customer_points:
                        type: integer
                        example: 500
                        description: Customer's remaining points after cart redemption
                      remaining_customer_points_amount_in_currency:
                        type: number
                        example: 5
                        description: >-
                          Currency value of remaining points after cart
                          redemption
                      remaining_cart_amount_after_points:
                        type: number
                        example: 95
                        description: Amount to charge to card after points redemption
                      remaining_cart_amount_after_points_in_currency:
                        type:
                          - string
                        example: $95.00
                        description: >-
                          Amount in currency to charge to card after points
                          redemption
                      max_applicable_points:
                        type: integer
                        example: 500
                        description: Maximum points that can be applied to this cart
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '404':
          description: cart not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
                      example:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '410':
          description: cart is processed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Cart is processed
                  errors:
                    type: object
                    example:
                      cart: Cart is processed
                  meta:
                    type: object
                    properties:
                      shop_url:
                        type: string
                        example: https://example.myshopify.com
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      cart:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 123
                          state:
                            type: string
                            example: start
                          processed:
                            type: boolean
                            example: false
                            description: >-
                              Determines if a cart payment has been processed or
                              not.
                          valid_for_checkout:
                            type: boolean
                            example: true
                          buyer_rep_id:
                            type:
                              - integer
                              - 'null'
                            example: 1
                          buyer_rep:
                            oneOf:
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 2
                                  email:
                                    type:
                                      - string
                                      - 'null'
                                    example: buyer.rep@example.com
                                  full_name:
                                    type:
                                      - string
                                      - 'null'
                                    example: John Doe
                                  image_url:
                                    type:
                                      - string
                                      - 'null'
                                    example: https://example.com/image.png
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: '123241'
                                required:
                                  - id
                              - type: 'null'
                          volume_rep:
                            oneOf:
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 2
                                  email:
                                    type:
                                      - string
                                      - 'null'
                                    example: volume.rep@example.com
                                  full_name:
                                    type:
                                      - string
                                      - 'null'
                                    example: John Doe
                                  image_url:
                                    type:
                                      - string
                                      - 'null'
                                    example: https://example.com/image.png
                                required:
                                  - id
                              - type: 'null'
                          currency_symbol:
                            type: string
                            example: $
                          currency_code:
                            type: string
                            example: USD
                          shipping_total_for_display:
                            type: string
                            example: Free
                          phone:
                            type:
                              - string
                              - 'null'
                            example: '4035551212'
                          payment_method_auto_assignable:
                            type: boolean
                            example: true
                            description: >-
                              Determines if a payment method can be
                              auto-assigned to the cart.
                          attribution:
                            oneOf:
                              - type: object
                                oneOf:
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      share_guid:
                                        type: string
                                        example: james-bond007
                                    required:
                                      - id
                                      - share_guid
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      email:
                                        type: string
                                        example: james.bond@gmail.com
                                    required:
                                      - id
                                      - email
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      username:
                                        type: string
                                        example: jaamball234
                                    required:
                                      - id
                                      - username
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      fluid_rep_id:
                                        type: integer
                                        example: 23493
                                    required:
                                      - id
                                      - fluid_rep_id
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      external_id:
                                        type:
                                          - string
                                          - 'null'
                                        example: w3sdf92
                                    required:
                                      - id
                              - type: 'null'
                            default:
                              id: 456
                              share_guid: james-bond007
                          agreements:
                            type: array
                            items:
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                  example: 1
                                required:
                                  type: boolean
                                  example: true
                                title:
                                  type: string
                                  example: Terms and Conditions
                                show_path:
                                  type: string
                                  example: /terms
                                enrollment_pack_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                          amount_total:
                            type: string
                            example: '121.65'
                          amount_total_in_currency:
                            type: string
                            example: $121.65 (USD)
                          sub_total:
                            type: string
                            example: '100.00'
                          sub_total_in_currency:
                            type: string
                            example: $100.00 (USD)
                          subtotal_after_discounts:
                            type: string
                            example: '90.00'
                          tax_total:
                            type: string
                            example: '20.00'
                          tax_total_in_currency:
                            type: string
                            example: $20.00 (USD)
                          shipping_total:
                            type:
                              - string
                              - 'null'
                            example: '1.65'
                          shipping_total_in_currency:
                            type: string
                            example: $1.65 (USD)
                          shipping_discount:
                            type: number
                            example: 10.25
                          discount_total:
                            type: string
                            example: '2.99'
                          discount_total_in_currency:
                            type: string
                            example: $2.99 (USD)
                          discount_breakdown:
                            type: object
                            properties:
                              internal_discounts:
                                type: number
                                example: 15
                              external_discounts:
                                type: number
                                example: 10
                              total_discounts:
                                type: number
                                example: 25
                          external_discount:
                            type: object
                            properties:
                              total:
                                type: number
                                example: 10
                              calculated_at:
                                type:
                                  - string
                                  - 'null'
                                format: date-time
                                example: '2024-01-10T15:30:00Z'
                              sources:
                                type: object
                                additionalProperties:
                                  type: object
                                  properties:
                                    amount:
                                      type: number
                                      example: 6
                                    description:
                                      type: string
                                      example: Gold tier discount
                                    metadata:
                                      type: object
                                  required:
                                    - amount
                                    - description
                          transaction_fee:
                            type:
                              - number
                              - string
                            example: '1.90'
                          transaction_fee_in_currency:
                            type: string
                            example: $1.90 (USD)
                          cv_total:
                            type: integer
                            example: 10
                          qv_total:
                            type: integer
                            example: 15
                          company:
                            type: object
                            properties:
                              id:
                                type: integer
                              name:
                                type: string
                              primary_domain_hostname:
                                type:
                                  - string
                                  - 'null'
                                example: fluid.com
                              subdomain:
                                type:
                                  - string
                                  - 'null'
                                example: myco
                              logo_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/logo.png
                              fluid_shop:
                                type:
                                  - string
                                  - 'null'
                                example: https://fluid-sample-shop.fluid.com
                              collect_phone:
                                type: boolean
                                example: true
                              require_phone:
                                type: boolean
                                example: false
                              require_billing_zip:
                                type: boolean
                                example: false
                              checkout_primary_button_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#000000'
                              checkout_primary_text_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#FFFFFF'
                              checkout_secondary_button_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#FFFFFF'
                              checkout_secondary_text_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#000000'
                              favicon_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/favicon.ico
                              order_on_behalf:
                                type: boolean
                                example: false
                              use_juspay_gateway:
                                type: boolean
                                example: false
                              reward_points_enabled:
                                type: boolean
                                example: false
                          payment_account:
                            type:
                              - string
                              - 'null'
                            example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                          payment_method:
                            oneOf:
                              - type: 'null'
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: CreditCard
                                  payment_method_type:
                                    type: string
                                    example: visa
                                  last_four:
                                    type: string
                                    example: '1234'
                                  exp_month:
                                    type: string
                                    example: '12'
                                  exp_year:
                                    type: string
                                    example: '2025'
                                  logo_url:
                                    type: string
                                    example: https://example.com/image.svg
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Paypal
                                  status:
                                    type: string
                                    example: active
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Affirm
                                  affirm_id:
                                    type: string
                                    example: affirm_123
                                  status:
                                    type: string
                                    example: authorized
                                  checkout_id:
                                    type: string
                                    example: checkout_456
                                  created:
                                    type: string
                                    example: '2025-01-01T00:00:00Z'
                                  auth_expiration:
                                    type: string
                                    example: '2025-01-02T00:00:00Z'
                                  currency:
                                    type: string
                                    example: USD
                                  amount:
                                    type: string
                                    example: '100.00'
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Klarna
                                  session_id:
                                    type: string
                                    example: klarna_session_789
                                  intent:
                                    type: string
                                    example: buy
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Droplet
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: SomeCitcon
                          email:
                            type:
                              - string
                              - 'null'
                            example: user@example.com
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: '10.45'
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.45
                          discount_codes:
                            type: array
                            items:
                              type: string
                            example:
                              - DISCOUNT10
                              - DISCOUNT11
                          language_iso:
                            type:
                              - string
                              - 'null'
                            example: en
                          cart_token:
                            type: string
                            example: abc123
                          immutable_items:
                            type: boolean
                            example: false
                          digital_only:
                            type: boolean
                            example: false
                          requires_3ds:
                            type: boolean
                            example: false
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 101
                                price:
                                  type: string
                                  example: '43.41'
                                price_in_currency:
                                  type: string
                                  example: $43.41
                                tax:
                                  type: string
                                  example: '2.99'
                                tax_in_currency:
                                  type: string
                                  example: $2.99
                                cv:
                                  type: integer
                                  example: 5
                                cv_total:
                                  type: integer
                                  example: 15
                                qv:
                                  type: integer
                                  example: 7
                                qv_total:
                                  type: integer
                                  example: 21
                                discount_amount:
                                  type: string
                                  example: '10'
                                free_item:
                                  type: boolean
                                  example: false
                                discount_amount_in_currency:
                                  type: string
                                  example: $10.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                enrollment_pack_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                display_to_customer:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                product_title:
                                  type:
                                    - string
                                    - 'null'
                                  example: Sample Product
                                quantity:
                                  type: integer
                                  example: 3
                                subscription:
                                  type: boolean
                                  example: true
                                enrollment:
                                  type: boolean
                                  example: false
                                allow_subscription:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_only:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_price:
                                  type:
                                    - number
                                    - string
                                    - 'null'
                                  example: 10.5
                                subscription_price_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $10.50
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-02-12'
                                subscribe_and_save:
                                  type:
                                    - number
                                    - string
                                    - 'null'
                                  example: 2.99
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $2.99
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $2.99
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: Surcharge
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                product:
                                  oneOf:
                                    - type: object
                                      properties:
                                        id:
                                          type: integer
                                          example: 1
                                        title:
                                          type: string
                                          example: Sample Product
                                        introduction:
                                          type:
                                            - string
                                            - 'null'
                                          example: Sample Product Description
                                        cv:
                                          type: integer
                                          example: 10
                                        external_id:
                                          type:
                                            - string
                                            - 'null'
                                          example: ext-prod-123
                                        image_path:
                                          type:
                                            - string
                                            - 'null'
                                          example: /images/product.png
                                        image_url:
                                          type:
                                            - string
                                            - 'null'
                                          example: https://example.com/images/product.png
                                        price:
                                          type: string
                                          example: '29.99'
                                        price_in_currency:
                                          type: string
                                          example: $29.99
                                        sku:
                                          type:
                                            - string
                                            - 'null'
                                          example: SKU12345
                                        tax:
                                          type: string
                                          example: '2.99'
                                        tax_in_currency:
                                          type: string
                                          example: $2.99
                                        metadata:
                                          type: object
                                          example:
                                            shopify_product_id: 9876054868270
                                        metafields:
                                          type: array
                                          items:
                                            title: LegacyMetafield
                                            type: object
                                            properties:
                                              namespace:
                                                description: >-
                                                  A container for related metafields.
                                                  Commonly used to group metafields by app
                                                  or functionality.
                                                example: custom
                                                type: string
                                                maxLength: 20
                                                pattern: ^[a-zA-Z0-9_]+$
                                              key:
                                                description: >-
                                                  The unique identifier for the metafield
                                                  within its namespace. Must be unique per
                                                  namespace and owner.
                                                example: material
                                                type: string
                                                maxLength: 30
                                                pattern: ^[a-zA-Z0-9_]+$
                                              value:
                                                description: >-
                                                  The actual data stored in the metafield.
                                                  Type depends on value_type.
                                                example: cotton
                                                type:
                                                  - string
                                                  - integer
                                                  - object
                                                  - boolean
                                                  - number
                                              value_type:
                                                description: >-
                                                  The data type that defines how the value
                                                  should be interpreted and validated.
                                                example: single_line_text_field
                                                type: string
                                              description:
                                                description: >-
                                                  Optional human-readable description
                                                  explaining the purpose of this
                                                  metafield.
                                                example: >-
                                                  The primary material used in this
                                                  product
                                                type:
                                                  - string
                                                  - 'null'
                                              created_at:
                                                description: >-
                                                  Timestamp when the metafield was
                                                  created.
                                                example: '2021-01-01T00:00:00Z'
                                                type: string
                                                format: date-time
                                              updated_at:
                                                description: >-
                                                  Timestamp when the metafield was last
                                                  updated.
                                                example: '2021-01-01T00:00:00Z'
                                                type: string
                                                format: date-time
                                              locked:
                                                description: >-
                                                  Whether this metafield is locked and
                                                  cannot be updated or deleted directly.
                                                example: false
                                                type:
                                                  - boolean
                                                  - 'null'
                                                  - 'null'
                                              metafield_definition:
                                                description: >-
                                                  The definition that defines validation
                                                  rules and structure for this metafield
                                                type:
                                                  - 'null'
                                                  - object
                                            required:
                                              - namespace
                                              - key
                                              - value
                                              - value_type
                                              - description
                                              - created_at
                                              - updated_at
                                              - metafield_definition
                                    - type: 'null'
                                variant:
                                  oneOf:
                                    - type: object
                                      properties:
                                        id:
                                          type: integer
                                          example: 1
                                        title:
                                          type:
                                            - string
                                            - 'null'
                                          example: Sample Variant
                                        image_path:
                                          type:
                                            - string
                                            - 'null'
                                          example: /images/sample.png
                                        image_url:
                                          type:
                                            - string
                                            - 'null'
                                          example: https://example.com/images/sample.png
                                        primary_image:
                                          type:
                                            - string
                                            - 'null'
                                          example: https://example.com/images/primary.png
                                        price:
                                          type:
                                            - string
                                            - 'null'
                                          example: '34.44'
                                        price_in_currency:
                                          type:
                                            - string
                                            - 'null'
                                          example: $34.44
                                        sku:
                                          type:
                                            - string
                                            - 'null'
                                          example: SKU12345
                                        options:
                                          type: array
                                          items:
                                            type: object
                                            properties:
                                              title:
                                                type: string
                                                example: Size
                                              value:
                                                type: string
                                                example: XL
                                        physical:
                                          type:
                                            - boolean
                                            - 'null'
                                          example: true
                                        unit_of_size:
                                          type:
                                            - string
                                            - 'null'
                                          example: cm
                                        height:
                                          type:
                                            - number
                                            - 'null'
                                          example: 13
                                        width:
                                          type:
                                            - number
                                            - 'null'
                                          example: 6
                                        length:
                                          type:
                                            - number
                                            - 'null'
                                          example: 12
                                        unit_of_weight:
                                          type:
                                            - string
                                            - 'null'
                                          example: kg
                                        weight:
                                          type:
                                            - string
                                            - 'null'
                                          example: '3.2'
                                        hs_code:
                                          type:
                                            - string
                                            - 'null'
                                          example: '3.2'
                                    - type: 'null'
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                                bundled_items:
                                  type: array
                                  items:
                                    type: object
                                    description: Bundled items for bundle products
                                    properties:
                                      variant_id:
                                        type: integer
                                        example: 1
                                      product_id:
                                        type: integer
                                        example: 1
                                      product_title:
                                        type: string
                                        example: Product Title
                                      variant_title:
                                        type: string
                                        example: Variant Title
                                      option_titles:
                                        type: array
                                        example:
                                          - Option 1
                                          - Option 2
                                      quantity:
                                        type: integer
                                        example: 1
                                      display_to_customer:
                                        type: boolean
                                        example: true
                          ship_to:
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                                example: 1
                              name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              first_name:
                                type:
                                  - string
                                  - 'null'
                                example: John
                              last_name:
                                type:
                                  - string
                                  - 'null'
                                example: Doe
                              address1:
                                type: string
                                example: 123 Main St
                              address2:
                                type:
                                  - string
                                  - 'null'
                                example: Apt 4B
                              address3:
                                type:
                                  - string
                                  - 'null'
                                example: Building 5
                              city:
                                type: string
                                example: New York
                              state:
                                type: string
                                example: NY
                              postal_code:
                                type: string
                                example: '10001'
                              country_code:
                                type: string
                                example: US
                                description: >-
                                  country_id takes precedence if both country_id
                                  and country_code provided.
                              subdivision_code:
                                type:
                                  - string
                                  - 'null'
                                example: NY
                              default:
                                type: boolean
                                example: true
                          bill_to:
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                                example: 1
                              name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              first_name:
                                type:
                                  - string
                                  - 'null'
                                example: John
                              last_name:
                                type:
                                  - string
                                  - 'null'
                                example: Doe
                              address1:
                                type: string
                                example: 123 Main St
                              address2:
                                type:
                                  - string
                                  - 'null'
                                example: Apt 4B
                              address3:
                                type:
                                  - string
                                  - 'null'
                                example: Building 5
                              city:
                                type: string
                                example: New York
                              state:
                                type: string
                                example: NY
                              postal_code:
                                type: string
                                example: '10001'
                              country_code:
                                type: string
                                example: US
                                description: >-
                                  country_id takes precedence if both country_id
                                  and country_code provided.
                              subdivision_code:
                                type:
                                  - string
                                  - 'null'
                                example: NY
                              default:
                                type: boolean
                                example: true
                          shipping_method:
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: string
                                example: standard-shipping
                              name:
                                type: string
                                example: Standard Shipping
                          available_shipping_methods:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                  example: standard-shipping
                                title:
                                  type: string
                                  example: Standard Shipping
                                price:
                                  type:
                                    - number
                                    - string
                                  example: 5.99
                                price_label:
                                  type: string
                                  example: $5.99
                                delivery_time_estimate:
                                  type: string
                                  example: 3-5 business days
                          available_payment_methods:
                            type: array
                            items:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1337
                                    uuid:
                                      type: string
                                      example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                    type:
                                      type: string
                                      enum:
                                        - credit_card
                                    name:
                                      type: string
                                      example: Credit Card
                                    image_url:
                                      type: string
                                      example: https://example.com/image.png
                                    test:
                                      type: boolean
                                      example: true
                                      description: >-
                                        Determines if payment method is test
                                        instance or not. By default, set to
                                        `true`
                                    sandbox:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method is sandbox
                                        instance or not. By default, set to
                                        `false`
                                    apple_pay:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method supports
                                        ApplePay or not 
                                    bogus_gateway:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method is a Bogus
                                        instance or not.
                                    tokenize_path:
                                      type:
                                        - string
                                        - 'null'
                                      description: Path to tokenize, if applicable.
                                    token_provider:
                                      type: string
                                      enum:
                                        - spreedly
                                        - vgs
                                      description: >-
                                        Determines if payment tokenization is
                                        via spreedly or VGS
                                    apple_pay_merchant_identifier:
                                      type:
                                        - string
                                        - 'null'
                                      example: merchant.mycompany.com
                                      description: >-
                                        If ApplePay is supported, returns the
                                        merchant identifier registered with
                                        Apple, else returns nil
                                    supported_brands:
                                      type: array
                                      items:
                                        type: string
                                      example:
                                        - visa
                                        - master
                                        - american_express
                                        - discover
                                    publishable_key:
                                      type:
                                        - string
                                        - 'null'
                                      example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                      description: >-
                                        If publishable key is set for
                                        Hyperswitch, returns the publishable
                                        key, else returns nil
                                    customer_details_schema:
                                      type: object
                                      example: {}
                                      description: >-
                                        Schema defining required customer
                                        details for this payment method
                                  required:
                                    - id
                                    - type
                                    - name
                                    - supported_brands
                                    - test
                                    - sandbox
                                    - apple_pay
                                    - apple_pay_merchant_identifier
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1337
                                    uuid:
                                      type: string
                                      example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                    type:
                                      type: string
                                      enum:
                                        - klarna
                                    name:
                                      type: string
                                      example: Klarna
                                    image_url:
                                      type: string
                                      example: https://example.com/image.png
                                    test:
                                      type: boolean
                                      example: true
                                      description: >-
                                        Determines if payment method is test
                                        instance or not. By default, set to
                                        `true`
                                    sandbox:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method is sandbox
                                        instance or not. By default, set to
                                        `false`
                                    customer_details_schema:
                                      type: object
                                      example: {}
                                      description: >-
                                        Schema defining required customer
                                        details for this payment method
                          country:
                            type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              iso:
                                type: string
                                example: US
                              name:
                                type: string
                                example: United States
                              iso_name:
                                type: string
                                example: UNITED STATES
                              iso3:
                                type: string
                                example: USA
                              currency_code:
                                type: string
                                example: USD
                              currency_symbol:
                                type: string
                                example: $
                              province_required:
                                type: boolean
                                example: false
                              tax_enabled:
                                type:
                                  - boolean
                                  - 'null'
                                example: true
                              price_inclusive_of_tax:
                                type: boolean
                                example: false
                              price_inclusive_tax_name:
                                type:
                                  - string
                                  - 'null'
                                example: VAT
                          type:
                            type: string
                            enum:
                              - regular
                              - enrollment
                            example: regular
                          enrollment_pack_id:
                            type:
                              - integer
                              - 'null'
                            example: 1
                          enrollment_pack:
                            type:
                              - object
                              - 'null'
                            properties:
                              enrollment_pack_id:
                                type: integer
                                example: 1
                              additional_volume:
                                type:
                                  - integer
                                  - 'null'
                                example: 10
                              slug:
                                type: string
                                example: test-enrollment-pack
                              description:
                                type:
                                  - object
                                  - 'null'
                                  - string
                                properties:
                                  id:
                                    type: integer
                                    example: 111
                                  name:
                                    type: string
                                    example: description
                                  body:
                                    type: string
                                    example: >-
                                      <div>Try the latest and greatest of our
                                      sugar zip packs. Guaranteed to make you
                                      skinner and cure cancer.</div>
                                  record_type:
                                    type: string
                                    example: EnrollmentPack
                                  record_id:
                                    type: integer
                                    example: 1
                                  created_at:
                                    type: string
                                    format: date_time
                                    example: '2025-01-16T04:22:43.809Z'
                                  updated_at:
                                    type: string
                                    format: date_time
                                    example: '2025-01-22T10:23:52.941Z'
                                  locale:
                                    type: string
                                    example: en
                              enrollment_fee:
                                type:
                                  - number
                                  - string
                                example: 10
                              enrollment_fee_in_currency:
                                type: string
                                example: $10.00
                              images:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 2
                                    relateable_type:
                                      type: string
                                      example: EnrollmentPack
                                    relateable_id:
                                      type: integer
                                      example: 1
                                    image_url:
                                      type: string
                                      example: >-
                                        https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                    image_path:
                                      type: string
                                      example: jITWaU14QGe0y5AFgY7P_00179.svg
                                    position:
                                      type: integer
                                      example: 1
                                    shopify_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: null
                                    created_at:
                                      type: string
                                      format: date_time
                                      example: '2025-01-16T04:22:44.870Z'
                                    updated_at:
                                      type: string
                                      format: date_time
                                      example: '2025-01-16T04:22:44.870Z'
                                    external_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: null
                              items:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 625
                                    allow_subscription:
                                      type: boolean
                                      example: true
                                    cv:
                                      type:
                                        - number
                                        - string
                                      example: 0
                                    cv_in_currency:
                                      type: string
                                      example: $0.00
                                    cv_total:
                                      type: integer
                                      example: 0
                                    enrollment:
                                      type: boolean
                                      example: true
                                    enrollment_pack_id:
                                      type: integer
                                      example: 1
                                    price:
                                      type: string
                                      example: '11.13'
                                    price_in_currency:
                                      type: string
                                      example: $11.13
                                    product_title:
                                      type: string
                                      example: Zip Pack Sample Pack (30)
                                    quantity:
                                      type: integer
                                      example: 1
                                    qv:
                                      type:
                                        - number
                                        - string
                                      example: 0
                                    qv_in_currency:
                                      type: string
                                      example: $0.00
                                    qv_total:
                                      type: integer
                                      example: 0
                                    subscribe_and_save:
                                      type:
                                        - string
                                        - 'null'
                                      example: '-1988.87'
                                    subscribe_and_save_for_display:
                                      type:
                                        - string
                                        - 'null'
                                      example: Subscribe and save $-1,988.87
                                    subscribe_and_save_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $-1,988.87
                                    subscription:
                                      type: boolean
                                      example: false
                                    subscription_interval:
                                      type:
                                        - integer
                                        - 'null'
                                      example: 1
                                    subscription_interval_unit:
                                      type:
                                        - string
                                        - 'null'
                                      example: month
                                    subscription_only:
                                      type: boolean
                                      example: false
                                    subscription_plan_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: 1
                                    subscription_plans:
                                      oneOf:
                                        - type: array
                                          items:
                                            title: Commerce::SubscriptionPlan
                                            type: object
                                            properties:
                                              id:
                                                type: integer
                                              name:
                                                example: Test Subscription Plan
                                                type: string
                                              billing_interval:
                                                example: 1
                                                type: integer
                                                default: 1
                                                minimum: 1
                                                maximum: 29
                                              billing_interval_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type: string
                                                default: month
                                              billing_frequency_in_words:
                                                example: 2 Months
                                                type: string
                                              shipping_interval:
                                                example: 1
                                                type: integer
                                                default: 1
                                                minimum: 1
                                                maximum: 29
                                              shipping_interval_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type: string
                                                default: month
                                              volume_interval:
                                                example: 1
                                                type: integer
                                                default: 1
                                                minimum: 1
                                                maximum: 29
                                              volume_interval_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type: string
                                                default: month
                                              trial_period:
                                                example: 1
                                                type:
                                                  - integer
                                                  - 'null'
                                                minimum: 1
                                              trial_period_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type:
                                                  - string
                                                  - 'null'
                                              split_volume:
                                                example: true
                                                type: boolean
                                                default: false
                                              allow_max_billing_cycles:
                                                example: true
                                                type: boolean
                                                default: false
                                              max_billing_cycles:
                                                example: 3
                                                type:
                                                  - integer
                                                  - 'null'
                                              company_default:
                                                example: false
                                                type:
                                                  - boolean
                                                  - 'null'
                                                default: false
                                              products_count:
                                                example: 10
                                                type:
                                                  - integer
                                                  - 'null'
                                              subscribers_count:
                                                example: 10
                                                type:
                                                  - integer
                                                  - 'null'
                                              price:
                                                type: string
                                              price_in_currency:
                                                type: string
                                              subscription_start:
                                                type: string
                                              subscribe_and_save:
                                                type:
                                                  - string
                                                  - 'null'
                                              subscribe_and_save_in_currency:
                                                type:
                                                  - string
                                                  - 'null'
                                              subscribe_and_save_for_display:
                                                type:
                                                  - string
                                                  - 'null'
                                            required:
                                              - id
                                              - name
                                              - billing_interval
                                              - billing_interval_unit
                                              - billing_frequency_in_words
                                              - shipping_interval
                                              - shipping_interval_unit
                                              - volume_interval
                                              - volume_interval_unit
                                              - split_volume
                                              - allow_max_billing_cycles
                                              - price
                                              - price_in_currency
                                              - subscription_start
                                              - subscribe_and_save
                                              - subscribe_and_save_in_currency
                                              - subscribe_and_save_for_display
                                        - type: 'null'
                                    subscription_price:
                                      type: string
                                      example: '2000.0'
                                    subscription_price_in_currency:
                                      type: string
                                      example: $2,000.00
                                    subscription_start:
                                      type:
                                        - string
                                        - 'null'
                                      format: date
                                      example: '2025-02-28'
                                    tax:
                                      type: string
                                      example: '0.0'
                                    tax_in_currency:
                                      type: string
                                      example: $0.00
                                    total_after_discounts:
                                      type: string
                                      example: '90.00'
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: null
                                    display_to_customer:
                                      type: boolean
                                      example: false
                                    metadata:
                                      type: object
                                      description: >-
                                        A JSON object that can store any custom
                                        data structure
                                      example: {}
                                    errors:
                                      oneOf:
                                        - type: 'null'
                                        - type: array
                                          items:
                                            type: object
                                          example:
                                            - country:
                                                - >-
                                                  This product is not available for this
                                                  country. Please change your country
                              price:
                                type: string
                                example: '11.13'
                              price_in_currency:
                                type: string
                                example: $11.13
                              subscription_price:
                                type:
                                  - string
                                  - integer
                                example: 2000
                              subscription_price_in_currency:
                                type: string
                                example: $2,000.00
                              title:
                                type: string
                                example: enroll product
                              token:
                                type: string
                                example: NxL22AqLRRisfyF9LqxxWRak
                          metadata:
                            type: object
                            description: >-
                              A JSON object that can store any custom data
                              structure.
                          recurring:
                            oneOf:
                              - type: array
                                items:
                                  type: object
                                  properties:
                                    subtotal:
                                      type: string
                                      example: '10.0'
                                    subtotal_in_currency:
                                      type: string
                                      example: $10.0
                                    interval:
                                      type: integer
                                      example: 1
                                    interval_unit:
                                      type: string
                                      example: month
                                    subtotal_for_display:
                                      type: string
                                      example: $10.00 every 1 month
                                    start_date:
                                      type:
                                        - string
                                        - 'null'
                                      example: '2025-05-27'
                              - type: 'null'
                            default:
                              - subtotal: '10.0'
                                subtotal_in_currency: $10.0
                                interval: 1
                                interval_unit: month
                                subtotal_for_display: $10.00 every 1 month
                                start_date: '2025-05-27'
                          messages:
                            type: object
                            additionalProperties: true
                            example:
                              errors:
                                - Insufficient inventory
                                - Product no longer available
                              warnings:
                                - Low stock warning
                                - Shipping delays expected
                              info:
                                - Free shipping available
                                - Volume discount applied
                          points_enabled:
                            type: boolean
                            example: true
                          points_applied:
                            type: integer
                            example: 500
                            description: Number of points applied to the cart
                          points_applied_amount_in_currency:
                            type: number
                            example: 5
                            description: Currency value of applied points
                          customer_total_points:
                            type: integer
                            example: 1000
                            description: Customer's total available points balance
                          customer_total_points_in_currency:
                            type: number
                            example: 10
                            description: Currency value of available points
                          remaining_customer_points:
                            type: integer
                            example: 500
                            description: Customer's remaining points after cart redemption
                          remaining_customer_points_amount_in_currency:
                            type: number
                            example: 5
                            description: >-
                              Currency value of remaining points after cart
                              redemption
                          remaining_cart_amount_after_points:
                            type: number
                            example: 95
                            description: Amount to charge to card after points redemption
                          remaining_cart_amount_after_points_in_currency:
                            type:
                              - string
                            example: $95.00
                            description: >-
                              Amount in currency to charge to card after points
                              redemption
                          max_applicable_points:
                            type: integer
                            example: 500
                            description: Maximum points that can be applied to this cart
        '422':
          description: invalid attribution
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                attribution:
                  type: object
                  oneOf:
                    - properties:
                        share_guid:
                          type: string
                          example: james-bond007
                      required:
                        - share_guid
                    - properties:
                        email:
                          type: string
                          format: email
                          example: user@example.com
                      required:
                        - email
                    - properties:
                        external_id:
                          type:
                            - string
                            - 'null'
                          example: ext_12345
                    - properties:
                        username:
                          type: string
                          example: username123
                      required:
                        - username
                    - properties:
                        fluid_rep_id:
                          type:
                            - string
                            - integer
                          example: 456
                      required:
                        - fluid_rep_id
              required:
                - attribution
  /api/carts/{cart_token}/buyer_rep:
    patch:
      summary: Updates the buyer rep for the cart
      tags:
        - Carts
      description: Updates the buyer rep of a cart based on the provided customer_id
      operationId: updateCartBuyerRep
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: buyer rep updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      state:
                        type: string
                        example: start
                      processed:
                        type: boolean
                        example: false
                        description: >-
                          Determines if a cart payment has been processed or
                          not.
                      valid_for_checkout:
                        type: boolean
                        example: true
                      buyer_rep_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      buyer_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: buyer.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                              external_id:
                                type:
                                  - string
                                  - 'null'
                                example: '123241'
                            required:
                              - id
                          - type: 'null'
                      volume_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: volume.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                            required:
                              - id
                          - type: 'null'
                      currency_symbol:
                        type: string
                        example: $
                      currency_code:
                        type: string
                        example: USD
                      shipping_total_for_display:
                        type: string
                        example: Free
                      phone:
                        type:
                          - string
                          - 'null'
                        example: '4035551212'
                      payment_method_auto_assignable:
                        type: boolean
                        example: true
                        description: >-
                          Determines if a payment method can be auto-assigned to
                          the cart.
                      attribution:
                        oneOf:
                          - type: object
                            oneOf:
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  share_guid:
                                    type: string
                                    example: james-bond007
                                required:
                                  - id
                                  - share_guid
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  email:
                                    type: string
                                    example: james.bond@gmail.com
                                required:
                                  - id
                                  - email
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  username:
                                    type: string
                                    example: jaamball234
                                required:
                                  - id
                                  - username
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  fluid_rep_id:
                                    type: integer
                                    example: 23493
                                required:
                                  - id
                                  - fluid_rep_id
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: w3sdf92
                                required:
                                  - id
                          - type: 'null'
                        default:
                          id: 456
                          share_guid: james-bond007
                      agreements:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            required:
                              type: boolean
                              example: true
                            title:
                              type: string
                              example: Terms and Conditions
                            show_path:
                              type: string
                              example: /terms
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                      amount_total:
                        type: string
                        example: '121.65'
                      amount_total_in_currency:
                        type: string
                        example: $121.65 (USD)
                      sub_total:
                        type: string
                        example: '100.00'
                      sub_total_in_currency:
                        type: string
                        example: $100.00 (USD)
                      subtotal_after_discounts:
                        type: string
                        example: '90.00'
                      tax_total:
                        type: string
                        example: '20.00'
                      tax_total_in_currency:
                        type: string
                        example: $20.00 (USD)
                      shipping_total:
                        type:
                          - string
                          - 'null'
                        example: '1.65'
                      shipping_total_in_currency:
                        type: string
                        example: $1.65 (USD)
                      shipping_discount:
                        type: number
                        example: 10.25
                      discount_total:
                        type: string
                        example: '2.99'
                      discount_total_in_currency:
                        type: string
                        example: $2.99 (USD)
                      discount_breakdown:
                        type: object
                        properties:
                          internal_discounts:
                            type: number
                            example: 15
                          external_discounts:
                            type: number
                            example: 10
                          total_discounts:
                            type: number
                            example: 25
                      external_discount:
                        type: object
                        properties:
                          total:
                            type: number
                            example: 10
                          calculated_at:
                            type:
                              - string
                              - 'null'
                            format: date-time
                            example: '2024-01-10T15:30:00Z'
                          sources:
                            type: object
                            additionalProperties:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 6
                                description:
                                  type: string
                                  example: Gold tier discount
                                metadata:
                                  type: object
                              required:
                                - amount
                                - description
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: '1.90'
                      transaction_fee_in_currency:
                        type: string
                        example: $1.90 (USD)
                      cv_total:
                        type: integer
                        example: 10
                      qv_total:
                        type: integer
                        example: 15
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      payment_account:
                        type:
                          - string
                          - 'null'
                        example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                      payment_method:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: CreditCard
                              payment_method_type:
                                type: string
                                example: visa
                              last_four:
                                type: string
                                example: '1234'
                              exp_month:
                                type: string
                                example: '12'
                              exp_year:
                                type: string
                                example: '2025'
                              logo_url:
                                type: string
                                example: https://example.com/image.svg
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Paypal
                              status:
                                type: string
                                example: active
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Affirm
                              affirm_id:
                                type: string
                                example: affirm_123
                              status:
                                type: string
                                example: authorized
                              checkout_id:
                                type: string
                                example: checkout_456
                              created:
                                type: string
                                example: '2025-01-01T00:00:00Z'
                              auth_expiration:
                                type: string
                                example: '2025-01-02T00:00:00Z'
                              currency:
                                type: string
                                example: USD
                              amount:
                                type: string
                                example: '100.00'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Klarna
                              session_id:
                                type: string
                                example: klarna_session_789
                              intent:
                                type: string
                                example: buy
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Droplet
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: SomeCitcon
                      email:
                        type:
                          - string
                          - 'null'
                        example: user@example.com
                      enrollment_fee:
                        type:
                          - number
                          - string
                        example: '10.45'
                      enrollment_fee_in_currency:
                        type: string
                        example: $10.45
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT10
                          - DISCOUNT11
                      language_iso:
                        type:
                          - string
                          - 'null'
                        example: en
                      cart_token:
                        type: string
                        example: abc123
                      immutable_items:
                        type: boolean
                        example: false
                      digital_only:
                        type: boolean
                        example: false
                      requires_3ds:
                        type: boolean
                        example: false
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 101
                            price:
                              type: string
                              example: '43.41'
                            price_in_currency:
                              type: string
                              example: $43.41
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            cv:
                              type: integer
                              example: 5
                            cv_total:
                              type: integer
                              example: 15
                            qv:
                              type: integer
                              example: 7
                            qv_total:
                              type: integer
                              example: 21
                            discount_amount:
                              type: string
                              example: '10'
                            free_item:
                              type: boolean
                              example: false
                            discount_amount_in_currency:
                              type: string
                              example: $10.00
                            total_after_discounts:
                              type: string
                              example: '90.00'
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            product_title:
                              type:
                                - string
                                - 'null'
                              example: Sample Product
                            quantity:
                              type: integer
                              example: 3
                            subscription:
                              type: boolean
                              example: true
                            enrollment:
                              type: boolean
                              example: false
                            allow_subscription:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_plan_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_plans:
                              oneOf:
                                - type: array
                                  items:
                                    title: Commerce::SubscriptionPlan
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        example: Test Subscription Plan
                                        type: string
                                      billing_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      billing_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      billing_frequency_in_words:
                                        example: 2 Months
                                        type: string
                                      shipping_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      shipping_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      volume_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      volume_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      trial_period:
                                        example: 1
                                        type:
                                          - integer
                                          - 'null'
                                        minimum: 1
                                      trial_period_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type:
                                          - string
                                          - 'null'
                                      split_volume:
                                        example: true
                                        type: boolean
                                        default: false
                                      allow_max_billing_cycles:
                                        example: true
                                        type: boolean
                                        default: false
                                      max_billing_cycles:
                                        example: 3
                                        type:
                                          - integer
                                          - 'null'
                                      company_default:
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                        default: false
                                      products_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      subscribers_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      price:
                                        type: string
                                      price_in_currency:
                                        type: string
                                      subscription_start:
                                        type: string
                                      subscribe_and_save:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_in_currency:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_for_display:
                                        type:
                                          - string
                                          - 'null'
                                    required:
                                      - id
                                      - name
                                      - billing_interval
                                      - billing_interval_unit
                                      - billing_frequency_in_words
                                      - shipping_interval
                                      - shipping_interval_unit
                                      - volume_interval
                                      - volume_interval_unit
                                      - split_volume
                                      - allow_max_billing_cycles
                                      - price
                                      - price_in_currency
                                      - subscription_start
                                      - subscribe_and_save
                                      - subscribe_and_save_in_currency
                                      - subscribe_and_save_for_display
                                - type: 'null'
                            subscription_only:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_interval:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_interval_unit:
                              type:
                                - string
                                - 'null'
                              example: month
                            subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 10.5
                            subscription_price_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $10.50
                            subscription_start:
                              type:
                                - string
                                - 'null'
                              example: '2025-02-12'
                            subscribe_and_save:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 2.99
                            subscribe_and_save_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $2.99
                            subscribe_and_save_for_display:
                              type:
                                - string
                                - 'null'
                              example: Subscribe and save $2.99
                            title:
                              type:
                                - string
                                - 'null'
                              example: Surcharge
                            metadata:
                              type: object
                              description: >-
                                A JSON object that can store any custom data
                                structure
                              example: {}
                            product:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type: string
                                      example: Sample Product
                                    introduction:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Product Description
                                    cv:
                                      type: integer
                                      example: 10
                                    external_id:
                                      type:
                                        - string
                                        - 'null'
                                      example: ext-prod-123
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/product.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/product.png
                                    price:
                                      type: string
                                      example: '29.99'
                                    price_in_currency:
                                      type: string
                                      example: $29.99
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    tax:
                                      type: string
                                      example: '2.99'
                                    tax_in_currency:
                                      type: string
                                      example: $2.99
                                    metadata:
                                      type: object
                                      example:
                                        shopify_product_id: 9876054868270
                                    metafields:
                                      type: array
                                      items:
                                        title: LegacyMetafield
                                        type: object
                                        properties:
                                          namespace:
                                            description: >-
                                              A container for related metafields.
                                              Commonly used to group metafields by app
                                              or functionality.
                                            example: custom
                                            type: string
                                            maxLength: 20
                                            pattern: ^[a-zA-Z0-9_]+$
                                          key:
                                            description: >-
                                              The unique identifier for the metafield
                                              within its namespace. Must be unique per
                                              namespace and owner.
                                            example: material
                                            type: string
                                            maxLength: 30
                                            pattern: ^[a-zA-Z0-9_]+$
                                          value:
                                            description: >-
                                              The actual data stored in the metafield.
                                              Type depends on value_type.
                                            example: cotton
                                            type:
                                              - string
                                              - integer
                                              - object
                                              - boolean
                                              - number
                                          value_type:
                                            description: >-
                                              The data type that defines how the value
                                              should be interpreted and validated.
                                            example: single_line_text_field
                                            type: string
                                          description:
                                            description: >-
                                              Optional human-readable description
                                              explaining the purpose of this
                                              metafield.
                                            example: >-
                                              The primary material used in this
                                              product
                                            type:
                                              - string
                                              - 'null'
                                          created_at:
                                            description: >-
                                              Timestamp when the metafield was
                                              created.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          updated_at:
                                            description: >-
                                              Timestamp when the metafield was last
                                              updated.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          locked:
                                            description: >-
                                              Whether this metafield is locked and
                                              cannot be updated or deleted directly.
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                              - 'null'
                                          metafield_definition:
                                            description: >-
                                              The definition that defines validation
                                              rules and structure for this metafield
                                            type:
                                              - 'null'
                                              - object
                                        required:
                                          - namespace
                                          - key
                                          - value
                                          - value_type
                                          - description
                                          - created_at
                                          - updated_at
                                          - metafield_definition
                                - type: 'null'
                            variant:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Variant
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/sample.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/sample.png
                                    primary_image:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/primary.png
                                    price:
                                      type:
                                        - string
                                        - 'null'
                                      example: '34.44'
                                    price_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $34.44
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    options:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          title:
                                            type: string
                                            example: Size
                                          value:
                                            type: string
                                            example: XL
                                    physical:
                                      type:
                                        - boolean
                                        - 'null'
                                      example: true
                                    unit_of_size:
                                      type:
                                        - string
                                        - 'null'
                                      example: cm
                                    height:
                                      type:
                                        - number
                                        - 'null'
                                      example: 13
                                    width:
                                      type:
                                        - number
                                        - 'null'
                                      example: 6
                                    length:
                                      type:
                                        - number
                                        - 'null'
                                      example: 12
                                    unit_of_weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: kg
                                    weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                    hs_code:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                - type: 'null'
                            errors:
                              oneOf:
                                - type: 'null'
                                - type: array
                                  items:
                                    type: object
                                  example:
                                    - country:
                                        - >-
                                          This product is not available for this
                                          country. Please change your country
                            bundled_items:
                              type: array
                              items:
                                type: object
                                description: Bundled items for bundle products
                                properties:
                                  variant_id:
                                    type: integer
                                    example: 1
                                  product_id:
                                    type: integer
                                    example: 1
                                  product_title:
                                    type: string
                                    example: Product Title
                                  variant_title:
                                    type: string
                                    example: Variant Title
                                  option_titles:
                                    type: array
                                    example:
                                      - Option 1
                                      - Option 2
                                  quantity:
                                    type: integer
                                    example: 1
                                  display_to_customer:
                                    type: boolean
                                    example: true
                      ship_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      bill_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      shipping_method:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: string
                            example: standard-shipping
                          name:
                            type: string
                            example: Standard Shipping
                      available_shipping_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: standard-shipping
                            title:
                              type: string
                              example: Standard Shipping
                            price:
                              type:
                                - number
                                - string
                              example: 5.99
                            price_label:
                              type: string
                              example: $5.99
                            delivery_time_estimate:
                              type: string
                              example: 3-5 business days
                      available_payment_methods:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - credit_card
                                name:
                                  type: string
                                  example: Credit Card
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                apple_pay:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method supports
                                    ApplePay or not 
                                bogus_gateway:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is a Bogus
                                    instance or not.
                                tokenize_path:
                                  type:
                                    - string
                                    - 'null'
                                  description: Path to tokenize, if applicable.
                                token_provider:
                                  type: string
                                  enum:
                                    - spreedly
                                    - vgs
                                  description: >-
                                    Determines if payment tokenization is via
                                    spreedly or VGS
                                apple_pay_merchant_identifier:
                                  type:
                                    - string
                                    - 'null'
                                  example: merchant.mycompany.com
                                  description: >-
                                    If ApplePay is supported, returns the
                                    merchant identifier registered with Apple,
                                    else returns nil
                                supported_brands:
                                  type: array
                                  items:
                                    type: string
                                  example:
                                    - visa
                                    - master
                                    - american_express
                                    - discover
                                publishable_key:
                                  type:
                                    - string
                                    - 'null'
                                  example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                  description: >-
                                    If publishable key is set for Hyperswitch,
                                    returns the publishable key, else returns
                                    nil
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                              required:
                                - id
                                - type
                                - name
                                - supported_brands
                                - test
                                - sandbox
                                - apple_pay
                                - apple_pay_merchant_identifier
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - klarna
                                name:
                                  type: string
                                  example: Klarna
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                      country:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          iso:
                            type: string
                            example: US
                          name:
                            type: string
                            example: United States
                          iso_name:
                            type: string
                            example: UNITED STATES
                          iso3:
                            type: string
                            example: USA
                          currency_code:
                            type: string
                            example: USD
                          currency_symbol:
                            type: string
                            example: $
                          province_required:
                            type: boolean
                            example: false
                          tax_enabled:
                            type:
                              - boolean
                              - 'null'
                            example: true
                          price_inclusive_of_tax:
                            type: boolean
                            example: false
                          price_inclusive_tax_name:
                            type:
                              - string
                              - 'null'
                            example: VAT
                      type:
                        type: string
                        enum:
                          - regular
                          - enrollment
                        example: regular
                      enrollment_pack_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      enrollment_pack:
                        type:
                          - object
                          - 'null'
                        properties:
                          enrollment_pack_id:
                            type: integer
                            example: 1
                          additional_volume:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          slug:
                            type: string
                            example: test-enrollment-pack
                          description:
                            type:
                              - object
                              - 'null'
                              - string
                            properties:
                              id:
                                type: integer
                                example: 111
                              name:
                                type: string
                                example: description
                              body:
                                type: string
                                example: >-
                                  <div>Try the latest and greatest of our sugar
                                  zip packs. Guaranteed to make you skinner and
                                  cure cancer.</div>
                              record_type:
                                type: string
                                example: EnrollmentPack
                              record_id:
                                type: integer
                                example: 1
                              created_at:
                                type: string
                                format: date_time
                                example: '2025-01-16T04:22:43.809Z'
                              updated_at:
                                type: string
                                format: date_time
                                example: '2025-01-22T10:23:52.941Z'
                              locale:
                                type: string
                                example: en
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: 10
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.00
                          images:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2
                                relateable_type:
                                  type: string
                                  example: EnrollmentPack
                                relateable_id:
                                  type: integer
                                  example: 1
                                image_url:
                                  type: string
                                  example: >-
                                    https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                image_path:
                                  type: string
                                  example: jITWaU14QGe0y5AFgY7P_00179.svg
                                position:
                                  type: integer
                                  example: 1
                                shopify_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                                created_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                updated_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                external_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 625
                                allow_subscription:
                                  type: boolean
                                  example: true
                                cv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                cv_in_currency:
                                  type: string
                                  example: $0.00
                                cv_total:
                                  type: integer
                                  example: 0
                                enrollment:
                                  type: boolean
                                  example: true
                                enrollment_pack_id:
                                  type: integer
                                  example: 1
                                price:
                                  type: string
                                  example: '11.13'
                                price_in_currency:
                                  type: string
                                  example: $11.13
                                product_title:
                                  type: string
                                  example: Zip Pack Sample Pack (30)
                                quantity:
                                  type: integer
                                  example: 1
                                qv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                qv_in_currency:
                                  type: string
                                  example: $0.00
                                qv_total:
                                  type: integer
                                  example: 0
                                subscribe_and_save:
                                  type:
                                    - string
                                    - 'null'
                                  example: '-1988.87'
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $-1,988.87
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $-1,988.87
                                subscription:
                                  type: boolean
                                  example: false
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_only:
                                  type: boolean
                                  example: false
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_price:
                                  type: string
                                  example: '2000.0'
                                subscription_price_in_currency:
                                  type: string
                                  example: $2,000.00
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  format: date
                                  example: '2025-02-28'
                                tax:
                                  type: string
                                  example: '0.0'
                                tax_in_currency:
                                  type: string
                                  example: $0.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: null
                                display_to_customer:
                                  type: boolean
                                  example: false
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                          price:
                            type: string
                            example: '11.13'
                          price_in_currency:
                            type: string
                            example: $11.13
                          subscription_price:
                            type:
                              - string
                              - integer
                            example: 2000
                          subscription_price_in_currency:
                            type: string
                            example: $2,000.00
                          title:
                            type: string
                            example: enroll product
                          token:
                            type: string
                            example: NxL22AqLRRisfyF9LqxxWRak
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      recurring:
                        oneOf:
                          - type: array
                            items:
                              type: object
                              properties:
                                subtotal:
                                  type: string
                                  example: '10.0'
                                subtotal_in_currency:
                                  type: string
                                  example: $10.0
                                interval:
                                  type: integer
                                  example: 1
                                interval_unit:
                                  type: string
                                  example: month
                                subtotal_for_display:
                                  type: string
                                  example: $10.00 every 1 month
                                start_date:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-05-27'
                          - type: 'null'
                        default:
                          - subtotal: '10.0'
                            subtotal_in_currency: $10.0
                            interval: 1
                            interval_unit: month
                            subtotal_for_display: $10.00 every 1 month
                            start_date: '2025-05-27'
                      messages:
                        type: object
                        additionalProperties: true
                        example:
                          errors:
                            - Insufficient inventory
                            - Product no longer available
                          warnings:
                            - Low stock warning
                            - Shipping delays expected
                          info:
                            - Free shipping available
                            - Volume discount applied
                      points_enabled:
                        type: boolean
                        example: true
                      points_applied:
                        type: integer
                        example: 500
                        description: Number of points applied to the cart
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Currency value of applied points
                      customer_total_points:
                        type: integer
                        example: 1000
                        description: Customer's total available points balance
                      customer_total_points_in_currency:
                        type: number
                        example: 10
                        description: Currency value of available points
                      remaining_customer_points:
                        type: integer
                        example: 500
                        description: Customer's remaining points after cart redemption
                      remaining_customer_points_amount_in_currency:
                        type: number
                        example: 5
                        description: >-
                          Currency value of remaining points after cart
                          redemption
                      remaining_cart_amount_after_points:
                        type: number
                        example: 95
                        description: Amount to charge to card after points redemption
                      remaining_cart_amount_after_points_in_currency:
                        type:
                          - string
                        example: $95.00
                        description: >-
                          Amount in currency to charge to card after points
                          redemption
                      max_applicable_points:
                        type: integer
                        example: 500
                        description: Maximum points that can be applied to this cart
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '410':
          description: Cart is processed and cannot be modified
        '422':
          description: invalid record
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: unprocessable entity
                  errors:
                    type: object
                    example:
                      customer:
                        - is not a rep
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                customer_id:
                  type: integer
                  example: 123
                  description: ID of the customer to set as buyer rep
              required:
                - customer_id
  /api/carts/{cart_token}/volume_rep:
    patch:
      summary: Updates the volume rep for the cart
      tags:
        - Carts
      description: Updates the volume rep of a cart based on the provided volume_rep_id
      security:
        - bearer_auth: []
      operationId: updateCartVolumeRep
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: volume rep removed
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      state:
                        type: string
                        example: start
                      processed:
                        type: boolean
                        example: false
                        description: >-
                          Determines if a cart payment has been processed or
                          not.
                      valid_for_checkout:
                        type: boolean
                        example: true
                      buyer_rep_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      buyer_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: buyer.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                              external_id:
                                type:
                                  - string
                                  - 'null'
                                example: '123241'
                            required:
                              - id
                          - type: 'null'
                      volume_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: volume.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                            required:
                              - id
                          - type: 'null'
                      currency_symbol:
                        type: string
                        example: $
                      currency_code:
                        type: string
                        example: USD
                      shipping_total_for_display:
                        type: string
                        example: Free
                      phone:
                        type:
                          - string
                          - 'null'
                        example: '4035551212'
                      payment_method_auto_assignable:
                        type: boolean
                        example: true
                        description: >-
                          Determines if a payment method can be auto-assigned to
                          the cart.
                      attribution:
                        oneOf:
                          - type: object
                            oneOf:
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  share_guid:
                                    type: string
                                    example: james-bond007
                                required:
                                  - id
                                  - share_guid
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  email:
                                    type: string
                                    example: james.bond@gmail.com
                                required:
                                  - id
                                  - email
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  username:
                                    type: string
                                    example: jaamball234
                                required:
                                  - id
                                  - username
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  fluid_rep_id:
                                    type: integer
                                    example: 23493
                                required:
                                  - id
                                  - fluid_rep_id
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: w3sdf92
                                required:
                                  - id
                          - type: 'null'
                        default:
                          id: 456
                          share_guid: james-bond007
                      agreements:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            required:
                              type: boolean
                              example: true
                            title:
                              type: string
                              example: Terms and Conditions
                            show_path:
                              type: string
                              example: /terms
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                      amount_total:
                        type: string
                        example: '121.65'
                      amount_total_in_currency:
                        type: string
                        example: $121.65 (USD)
                      sub_total:
                        type: string
                        example: '100.00'
                      sub_total_in_currency:
                        type: string
                        example: $100.00 (USD)
                      subtotal_after_discounts:
                        type: string
                        example: '90.00'
                      tax_total:
                        type: string
                        example: '20.00'
                      tax_total_in_currency:
                        type: string
                        example: $20.00 (USD)
                      shipping_total:
                        type:
                          - string
                          - 'null'
                        example: '1.65'
                      shipping_total_in_currency:
                        type: string
                        example: $1.65 (USD)
                      shipping_discount:
                        type: number
                        example: 10.25
                      discount_total:
                        type: string
                        example: '2.99'
                      discount_total_in_currency:
                        type: string
                        example: $2.99 (USD)
                      discount_breakdown:
                        type: object
                        properties:
                          internal_discounts:
                            type: number
                            example: 15
                          external_discounts:
                            type: number
                            example: 10
                          total_discounts:
                            type: number
                            example: 25
                      external_discount:
                        type: object
                        properties:
                          total:
                            type: number
                            example: 10
                          calculated_at:
                            type:
                              - string
                              - 'null'
                            format: date-time
                            example: '2024-01-10T15:30:00Z'
                          sources:
                            type: object
                            additionalProperties:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 6
                                description:
                                  type: string
                                  example: Gold tier discount
                                metadata:
                                  type: object
                              required:
                                - amount
                                - description
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: '1.90'
                      transaction_fee_in_currency:
                        type: string
                        example: $1.90 (USD)
                      cv_total:
                        type: integer
                        example: 10
                      qv_total:
                        type: integer
                        example: 15
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      payment_account:
                        type:
                          - string
                          - 'null'
                        example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                      payment_method:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: CreditCard
                              payment_method_type:
                                type: string
                                example: visa
                              last_four:
                                type: string
                                example: '1234'
                              exp_month:
                                type: string
                                example: '12'
                              exp_year:
                                type: string
                                example: '2025'
                              logo_url:
                                type: string
                                example: https://example.com/image.svg
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Paypal
                              status:
                                type: string
                                example: active
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Affirm
                              affirm_id:
                                type: string
                                example: affirm_123
                              status:
                                type: string
                                example: authorized
                              checkout_id:
                                type: string
                                example: checkout_456
                              created:
                                type: string
                                example: '2025-01-01T00:00:00Z'
                              auth_expiration:
                                type: string
                                example: '2025-01-02T00:00:00Z'
                              currency:
                                type: string
                                example: USD
                              amount:
                                type: string
                                example: '100.00'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Klarna
                              session_id:
                                type: string
                                example: klarna_session_789
                              intent:
                                type: string
                                example: buy
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Droplet
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: SomeCitcon
                      email:
                        type:
                          - string
                          - 'null'
                        example: user@example.com
                      enrollment_fee:
                        type:
                          - number
                          - string
                        example: '10.45'
                      enrollment_fee_in_currency:
                        type: string
                        example: $10.45
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT10
                          - DISCOUNT11
                      language_iso:
                        type:
                          - string
                          - 'null'
                        example: en
                      cart_token:
                        type: string
                        example: abc123
                      immutable_items:
                        type: boolean
                        example: false
                      digital_only:
                        type: boolean
                        example: false
                      requires_3ds:
                        type: boolean
                        example: false
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 101
                            price:
                              type: string
                              example: '43.41'
                            price_in_currency:
                              type: string
                              example: $43.41
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            cv:
                              type: integer
                              example: 5
                            cv_total:
                              type: integer
                              example: 15
                            qv:
                              type: integer
                              example: 7
                            qv_total:
                              type: integer
                              example: 21
                            discount_amount:
                              type: string
                              example: '10'
                            free_item:
                              type: boolean
                              example: false
                            discount_amount_in_currency:
                              type: string
                              example: $10.00
                            total_after_discounts:
                              type: string
                              example: '90.00'
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            product_title:
                              type:
                                - string
                                - 'null'
                              example: Sample Product
                            quantity:
                              type: integer
                              example: 3
                            subscription:
                              type: boolean
                              example: true
                            enrollment:
                              type: boolean
                              example: false
                            allow_subscription:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_plan_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_plans:
                              oneOf:
                                - type: array
                                  items:
                                    title: Commerce::SubscriptionPlan
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        example: Test Subscription Plan
                                        type: string
                                      billing_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      billing_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      billing_frequency_in_words:
                                        example: 2 Months
                                        type: string
                                      shipping_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      shipping_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      volume_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      volume_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      trial_period:
                                        example: 1
                                        type:
                                          - integer
                                          - 'null'
                                        minimum: 1
                                      trial_period_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type:
                                          - string
                                          - 'null'
                                      split_volume:
                                        example: true
                                        type: boolean
                                        default: false
                                      allow_max_billing_cycles:
                                        example: true
                                        type: boolean
                                        default: false
                                      max_billing_cycles:
                                        example: 3
                                        type:
                                          - integer
                                          - 'null'
                                      company_default:
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                        default: false
                                      products_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      subscribers_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      price:
                                        type: string
                                      price_in_currency:
                                        type: string
                                      subscription_start:
                                        type: string
                                      subscribe_and_save:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_in_currency:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_for_display:
                                        type:
                                          - string
                                          - 'null'
                                    required:
                                      - id
                                      - name
                                      - billing_interval
                                      - billing_interval_unit
                                      - billing_frequency_in_words
                                      - shipping_interval
                                      - shipping_interval_unit
                                      - volume_interval
                                      - volume_interval_unit
                                      - split_volume
                                      - allow_max_billing_cycles
                                      - price
                                      - price_in_currency
                                      - subscription_start
                                      - subscribe_and_save
                                      - subscribe_and_save_in_currency
                                      - subscribe_and_save_for_display
                                - type: 'null'
                            subscription_only:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_interval:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_interval_unit:
                              type:
                                - string
                                - 'null'
                              example: month
                            subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 10.5
                            subscription_price_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $10.50
                            subscription_start:
                              type:
                                - string
                                - 'null'
                              example: '2025-02-12'
                            subscribe_and_save:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 2.99
                            subscribe_and_save_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $2.99
                            subscribe_and_save_for_display:
                              type:
                                - string
                                - 'null'
                              example: Subscribe and save $2.99
                            title:
                              type:
                                - string
                                - 'null'
                              example: Surcharge
                            metadata:
                              type: object
                              description: >-
                                A JSON object that can store any custom data
                                structure
                              example: {}
                            product:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type: string
                                      example: Sample Product
                                    introduction:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Product Description
                                    cv:
                                      type: integer
                                      example: 10
                                    external_id:
                                      type:
                                        - string
                                        - 'null'
                                      example: ext-prod-123
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/product.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/product.png
                                    price:
                                      type: string
                                      example: '29.99'
                                    price_in_currency:
                                      type: string
                                      example: $29.99
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    tax:
                                      type: string
                                      example: '2.99'
                                    tax_in_currency:
                                      type: string
                                      example: $2.99
                                    metadata:
                                      type: object
                                      example:
                                        shopify_product_id: 9876054868270
                                    metafields:
                                      type: array
                                      items:
                                        title: LegacyMetafield
                                        type: object
                                        properties:
                                          namespace:
                                            description: >-
                                              A container for related metafields.
                                              Commonly used to group metafields by app
                                              or functionality.
                                            example: custom
                                            type: string
                                            maxLength: 20
                                            pattern: ^[a-zA-Z0-9_]+$
                                          key:
                                            description: >-
                                              The unique identifier for the metafield
                                              within its namespace. Must be unique per
                                              namespace and owner.
                                            example: material
                                            type: string
                                            maxLength: 30
                                            pattern: ^[a-zA-Z0-9_]+$
                                          value:
                                            description: >-
                                              The actual data stored in the metafield.
                                              Type depends on value_type.
                                            example: cotton
                                            type:
                                              - string
                                              - integer
                                              - object
                                              - boolean
                                              - number
                                          value_type:
                                            description: >-
                                              The data type that defines how the value
                                              should be interpreted and validated.
                                            example: single_line_text_field
                                            type: string
                                          description:
                                            description: >-
                                              Optional human-readable description
                                              explaining the purpose of this
                                              metafield.
                                            example: >-
                                              The primary material used in this
                                              product
                                            type:
                                              - string
                                              - 'null'
                                          created_at:
                                            description: >-
                                              Timestamp when the metafield was
                                              created.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          updated_at:
                                            description: >-
                                              Timestamp when the metafield was last
                                              updated.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          locked:
                                            description: >-
                                              Whether this metafield is locked and
                                              cannot be updated or deleted directly.
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                              - 'null'
                                          metafield_definition:
                                            description: >-
                                              The definition that defines validation
                                              rules and structure for this metafield
                                            type:
                                              - 'null'
                                              - object
                                        required:
                                          - namespace
                                          - key
                                          - value
                                          - value_type
                                          - description
                                          - created_at
                                          - updated_at
                                          - metafield_definition
                                - type: 'null'
                            variant:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Variant
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/sample.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/sample.png
                                    primary_image:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/primary.png
                                    price:
                                      type:
                                        - string
                                        - 'null'
                                      example: '34.44'
                                    price_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $34.44
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    options:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          title:
                                            type: string
                                            example: Size
                                          value:
                                            type: string
                                            example: XL
                                    physical:
                                      type:
                                        - boolean
                                        - 'null'
                                      example: true
                                    unit_of_size:
                                      type:
                                        - string
                                        - 'null'
                                      example: cm
                                    height:
                                      type:
                                        - number
                                        - 'null'
                                      example: 13
                                    width:
                                      type:
                                        - number
                                        - 'null'
                                      example: 6
                                    length:
                                      type:
                                        - number
                                        - 'null'
                                      example: 12
                                    unit_of_weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: kg
                                    weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                    hs_code:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                - type: 'null'
                            errors:
                              oneOf:
                                - type: 'null'
                                - type: array
                                  items:
                                    type: object
                                  example:
                                    - country:
                                        - >-
                                          This product is not available for this
                                          country. Please change your country
                            bundled_items:
                              type: array
                              items:
                                type: object
                                description: Bundled items for bundle products
                                properties:
                                  variant_id:
                                    type: integer
                                    example: 1
                                  product_id:
                                    type: integer
                                    example: 1
                                  product_title:
                                    type: string
                                    example: Product Title
                                  variant_title:
                                    type: string
                                    example: Variant Title
                                  option_titles:
                                    type: array
                                    example:
                                      - Option 1
                                      - Option 2
                                  quantity:
                                    type: integer
                                    example: 1
                                  display_to_customer:
                                    type: boolean
                                    example: true
                      ship_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      bill_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      shipping_method:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: string
                            example: standard-shipping
                          name:
                            type: string
                            example: Standard Shipping
                      available_shipping_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: standard-shipping
                            title:
                              type: string
                              example: Standard Shipping
                            price:
                              type:
                                - number
                                - string
                              example: 5.99
                            price_label:
                              type: string
                              example: $5.99
                            delivery_time_estimate:
                              type: string
                              example: 3-5 business days
                      available_payment_methods:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - credit_card
                                name:
                                  type: string
                                  example: Credit Card
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                apple_pay:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method supports
                                    ApplePay or not 
                                bogus_gateway:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is a Bogus
                                    instance or not.
                                tokenize_path:
                                  type:
                                    - string
                                    - 'null'
                                  description: Path to tokenize, if applicable.
                                token_provider:
                                  type: string
                                  enum:
                                    - spreedly
                                    - vgs
                                  description: >-
                                    Determines if payment tokenization is via
                                    spreedly or VGS
                                apple_pay_merchant_identifier:
                                  type:
                                    - string
                                    - 'null'
                                  example: merchant.mycompany.com
                                  description: >-
                                    If ApplePay is supported, returns the
                                    merchant identifier registered with Apple,
                                    else returns nil
                                supported_brands:
                                  type: array
                                  items:
                                    type: string
                                  example:
                                    - visa
                                    - master
                                    - american_express
                                    - discover
                                publishable_key:
                                  type:
                                    - string
                                    - 'null'
                                  example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                  description: >-
                                    If publishable key is set for Hyperswitch,
                                    returns the publishable key, else returns
                                    nil
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                              required:
                                - id
                                - type
                                - name
                                - supported_brands
                                - test
                                - sandbox
                                - apple_pay
                                - apple_pay_merchant_identifier
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - klarna
                                name:
                                  type: string
                                  example: Klarna
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                      country:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          iso:
                            type: string
                            example: US
                          name:
                            type: string
                            example: United States
                          iso_name:
                            type: string
                            example: UNITED STATES
                          iso3:
                            type: string
                            example: USA
                          currency_code:
                            type: string
                            example: USD
                          currency_symbol:
                            type: string
                            example: $
                          province_required:
                            type: boolean
                            example: false
                          tax_enabled:
                            type:
                              - boolean
                              - 'null'
                            example: true
                          price_inclusive_of_tax:
                            type: boolean
                            example: false
                          price_inclusive_tax_name:
                            type:
                              - string
                              - 'null'
                            example: VAT
                      type:
                        type: string
                        enum:
                          - regular
                          - enrollment
                        example: regular
                      enrollment_pack_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      enrollment_pack:
                        type:
                          - object
                          - 'null'
                        properties:
                          enrollment_pack_id:
                            type: integer
                            example: 1
                          additional_volume:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          slug:
                            type: string
                            example: test-enrollment-pack
                          description:
                            type:
                              - object
                              - 'null'
                              - string
                            properties:
                              id:
                                type: integer
                                example: 111
                              name:
                                type: string
                                example: description
                              body:
                                type: string
                                example: >-
                                  <div>Try the latest and greatest of our sugar
                                  zip packs. Guaranteed to make you skinner and
                                  cure cancer.</div>
                              record_type:
                                type: string
                                example: EnrollmentPack
                              record_id:
                                type: integer
                                example: 1
                              created_at:
                                type: string
                                format: date_time
                                example: '2025-01-16T04:22:43.809Z'
                              updated_at:
                                type: string
                                format: date_time
                                example: '2025-01-22T10:23:52.941Z'
                              locale:
                                type: string
                                example: en
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: 10
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.00
                          images:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2
                                relateable_type:
                                  type: string
                                  example: EnrollmentPack
                                relateable_id:
                                  type: integer
                                  example: 1
                                image_url:
                                  type: string
                                  example: >-
                                    https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                image_path:
                                  type: string
                                  example: jITWaU14QGe0y5AFgY7P_00179.svg
                                position:
                                  type: integer
                                  example: 1
                                shopify_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                                created_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                updated_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                external_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 625
                                allow_subscription:
                                  type: boolean
                                  example: true
                                cv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                cv_in_currency:
                                  type: string
                                  example: $0.00
                                cv_total:
                                  type: integer
                                  example: 0
                                enrollment:
                                  type: boolean
                                  example: true
                                enrollment_pack_id:
                                  type: integer
                                  example: 1
                                price:
                                  type: string
                                  example: '11.13'
                                price_in_currency:
                                  type: string
                                  example: $11.13
                                product_title:
                                  type: string
                                  example: Zip Pack Sample Pack (30)
                                quantity:
                                  type: integer
                                  example: 1
                                qv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                qv_in_currency:
                                  type: string
                                  example: $0.00
                                qv_total:
                                  type: integer
                                  example: 0
                                subscribe_and_save:
                                  type:
                                    - string
                                    - 'null'
                                  example: '-1988.87'
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $-1,988.87
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $-1,988.87
                                subscription:
                                  type: boolean
                                  example: false
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_only:
                                  type: boolean
                                  example: false
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_price:
                                  type: string
                                  example: '2000.0'
                                subscription_price_in_currency:
                                  type: string
                                  example: $2,000.00
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  format: date
                                  example: '2025-02-28'
                                tax:
                                  type: string
                                  example: '0.0'
                                tax_in_currency:
                                  type: string
                                  example: $0.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: null
                                display_to_customer:
                                  type: boolean
                                  example: false
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                          price:
                            type: string
                            example: '11.13'
                          price_in_currency:
                            type: string
                            example: $11.13
                          subscription_price:
                            type:
                              - string
                              - integer
                            example: 2000
                          subscription_price_in_currency:
                            type: string
                            example: $2,000.00
                          title:
                            type: string
                            example: enroll product
                          token:
                            type: string
                            example: NxL22AqLRRisfyF9LqxxWRak
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      recurring:
                        oneOf:
                          - type: array
                            items:
                              type: object
                              properties:
                                subtotal:
                                  type: string
                                  example: '10.0'
                                subtotal_in_currency:
                                  type: string
                                  example: $10.0
                                interval:
                                  type: integer
                                  example: 1
                                interval_unit:
                                  type: string
                                  example: month
                                subtotal_for_display:
                                  type: string
                                  example: $10.00 every 1 month
                                start_date:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-05-27'
                          - type: 'null'
                        default:
                          - subtotal: '10.0'
                            subtotal_in_currency: $10.0
                            interval: 1
                            interval_unit: month
                            subtotal_for_display: $10.00 every 1 month
                            start_date: '2025-05-27'
                      messages:
                        type: object
                        additionalProperties: true
                        example:
                          errors:
                            - Insufficient inventory
                            - Product no longer available
                          warnings:
                            - Low stock warning
                            - Shipping delays expected
                          info:
                            - Free shipping available
                            - Volume discount applied
                      points_enabled:
                        type: boolean
                        example: true
                      points_applied:
                        type: integer
                        example: 500
                        description: Number of points applied to the cart
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Currency value of applied points
                      customer_total_points:
                        type: integer
                        example: 1000
                        description: Customer's total available points balance
                      customer_total_points_in_currency:
                        type: number
                        example: 10
                        description: Currency value of available points
                      remaining_customer_points:
                        type: integer
                        example: 500
                        description: Customer's remaining points after cart redemption
                      remaining_customer_points_amount_in_currency:
                        type: number
                        example: 5
                        description: >-
                          Currency value of remaining points after cart
                          redemption
                      remaining_cart_amount_after_points:
                        type: number
                        example: 95
                        description: Amount to charge to card after points redemption
                      remaining_cart_amount_after_points_in_currency:
                        type:
                          - string
                        example: $95.00
                        description: >-
                          Amount in currency to charge to card after points
                          redemption
                      max_applicable_points:
                        type: integer
                        example: 500
                        description: Maximum points that can be applied to this cart
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '410':
          description: Cart is processed and cannot be modified
        '422':
          description: invalid record
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: unprocessable entity
                  errors:
                    type: object
                    example:
                      base:
                        - Volume rep must belong to the same company
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                volume_rep_id:
                  type:
                    - integer
                    - 'null'
                  example: 123
                  description: ID of the user company to set as volume rep
                order_on_behalf_of:
                  type: boolean
                  example: true
                  description: Whether the order is on behalf of another volume rep
  /api/carts/{cart_token}/messages:
    post:
      summary: Updates cart messages
      tags:
        - Carts
      description: >-
        Add or update error, warning, and info messages on a cart. These
        messages can be used to prevent checkout or provide feedback to users.
        Supports setting errors (which prevent checkout), warnings, and
        informational messages.
      operationId: updateCartMessages
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: messages updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      state:
                        type: string
                        example: start
                      processed:
                        type: boolean
                        example: false
                        description: >-
                          Determines if a cart payment has been processed or
                          not.
                      valid_for_checkout:
                        type: boolean
                        example: true
                      buyer_rep_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      buyer_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: buyer.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                              external_id:
                                type:
                                  - string
                                  - 'null'
                                example: '123241'
                            required:
                              - id
                          - type: 'null'
                      volume_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: volume.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                            required:
                              - id
                          - type: 'null'
                      currency_symbol:
                        type: string
                        example: $
                      currency_code:
                        type: string
                        example: USD
                      shipping_total_for_display:
                        type: string
                        example: Free
                      phone:
                        type:
                          - string
                          - 'null'
                        example: '4035551212'
                      payment_method_auto_assignable:
                        type: boolean
                        example: true
                        description: >-
                          Determines if a payment method can be auto-assigned to
                          the cart.
                      attribution:
                        oneOf:
                          - type: object
                            oneOf:
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  share_guid:
                                    type: string
                                    example: james-bond007
                                required:
                                  - id
                                  - share_guid
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  email:
                                    type: string
                                    example: james.bond@gmail.com
                                required:
                                  - id
                                  - email
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  username:
                                    type: string
                                    example: jaamball234
                                required:
                                  - id
                                  - username
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  fluid_rep_id:
                                    type: integer
                                    example: 23493
                                required:
                                  - id
                                  - fluid_rep_id
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: w3sdf92
                                required:
                                  - id
                          - type: 'null'
                        default:
                          id: 456
                          share_guid: james-bond007
                      agreements:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            required:
                              type: boolean
                              example: true
                            title:
                              type: string
                              example: Terms and Conditions
                            show_path:
                              type: string
                              example: /terms
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                      amount_total:
                        type: string
                        example: '121.65'
                      amount_total_in_currency:
                        type: string
                        example: $121.65 (USD)
                      sub_total:
                        type: string
                        example: '100.00'
                      sub_total_in_currency:
                        type: string
                        example: $100.00 (USD)
                      subtotal_after_discounts:
                        type: string
                        example: '90.00'
                      tax_total:
                        type: string
                        example: '20.00'
                      tax_total_in_currency:
                        type: string
                        example: $20.00 (USD)
                      shipping_total:
                        type:
                          - string
                          - 'null'
                        example: '1.65'
                      shipping_total_in_currency:
                        type: string
                        example: $1.65 (USD)
                      shipping_discount:
                        type: number
                        example: 10.25
                      discount_total:
                        type: string
                        example: '2.99'
                      discount_total_in_currency:
                        type: string
                        example: $2.99 (USD)
                      discount_breakdown:
                        type: object
                        properties:
                          internal_discounts:
                            type: number
                            example: 15
                          external_discounts:
                            type: number
                            example: 10
                          total_discounts:
                            type: number
                            example: 25
                      external_discount:
                        type: object
                        properties:
                          total:
                            type: number
                            example: 10
                          calculated_at:
                            type:
                              - string
                              - 'null'
                            format: date-time
                            example: '2024-01-10T15:30:00Z'
                          sources:
                            type: object
                            additionalProperties:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 6
                                description:
                                  type: string
                                  example: Gold tier discount
                                metadata:
                                  type: object
                              required:
                                - amount
                                - description
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: '1.90'
                      transaction_fee_in_currency:
                        type: string
                        example: $1.90 (USD)
                      cv_total:
                        type: integer
                        example: 10
                      qv_total:
                        type: integer
                        example: 15
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      payment_account:
                        type:
                          - string
                          - 'null'
                        example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                      payment_method:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: CreditCard
                              payment_method_type:
                                type: string
                                example: visa
                              last_four:
                                type: string
                                example: '1234'
                              exp_month:
                                type: string
                                example: '12'
                              exp_year:
                                type: string
                                example: '2025'
                              logo_url:
                                type: string
                                example: https://example.com/image.svg
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Paypal
                              status:
                                type: string
                                example: active
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Affirm
                              affirm_id:
                                type: string
                                example: affirm_123
                              status:
                                type: string
                                example: authorized
                              checkout_id:
                                type: string
                                example: checkout_456
                              created:
                                type: string
                                example: '2025-01-01T00:00:00Z'
                              auth_expiration:
                                type: string
                                example: '2025-01-02T00:00:00Z'
                              currency:
                                type: string
                                example: USD
                              amount:
                                type: string
                                example: '100.00'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Klarna
                              session_id:
                                type: string
                                example: klarna_session_789
                              intent:
                                type: string
                                example: buy
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Droplet
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: SomeCitcon
                      email:
                        type:
                          - string
                          - 'null'
                        example: user@example.com
                      enrollment_fee:
                        type:
                          - number
                          - string
                        example: '10.45'
                      enrollment_fee_in_currency:
                        type: string
                        example: $10.45
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT10
                          - DISCOUNT11
                      language_iso:
                        type:
                          - string
                          - 'null'
                        example: en
                      cart_token:
                        type: string
                        example: abc123
                      immutable_items:
                        type: boolean
                        example: false
                      digital_only:
                        type: boolean
                        example: false
                      requires_3ds:
                        type: boolean
                        example: false
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 101
                            price:
                              type: string
                              example: '43.41'
                            price_in_currency:
                              type: string
                              example: $43.41
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            cv:
                              type: integer
                              example: 5
                            cv_total:
                              type: integer
                              example: 15
                            qv:
                              type: integer
                              example: 7
                            qv_total:
                              type: integer
                              example: 21
                            discount_amount:
                              type: string
                              example: '10'
                            free_item:
                              type: boolean
                              example: false
                            discount_amount_in_currency:
                              type: string
                              example: $10.00
                            total_after_discounts:
                              type: string
                              example: '90.00'
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            product_title:
                              type:
                                - string
                                - 'null'
                              example: Sample Product
                            quantity:
                              type: integer
                              example: 3
                            subscription:
                              type: boolean
                              example: true
                            enrollment:
                              type: boolean
                              example: false
                            allow_subscription:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_plan_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_plans:
                              oneOf:
                                - type: array
                                  items:
                                    title: Commerce::SubscriptionPlan
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        example: Test Subscription Plan
                                        type: string
                                      billing_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      billing_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      billing_frequency_in_words:
                                        example: 2 Months
                                        type: string
                                      shipping_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      shipping_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      volume_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      volume_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      trial_period:
                                        example: 1
                                        type:
                                          - integer
                                          - 'null'
                                        minimum: 1
                                      trial_period_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type:
                                          - string
                                          - 'null'
                                      split_volume:
                                        example: true
                                        type: boolean
                                        default: false
                                      allow_max_billing_cycles:
                                        example: true
                                        type: boolean
                                        default: false
                                      max_billing_cycles:
                                        example: 3
                                        type:
                                          - integer
                                          - 'null'
                                      company_default:
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                        default: false
                                      products_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      subscribers_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      price:
                                        type: string
                                      price_in_currency:
                                        type: string
                                      subscription_start:
                                        type: string
                                      subscribe_and_save:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_in_currency:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_for_display:
                                        type:
                                          - string
                                          - 'null'
                                    required:
                                      - id
                                      - name
                                      - billing_interval
                                      - billing_interval_unit
                                      - billing_frequency_in_words
                                      - shipping_interval
                                      - shipping_interval_unit
                                      - volume_interval
                                      - volume_interval_unit
                                      - split_volume
                                      - allow_max_billing_cycles
                                      - price
                                      - price_in_currency
                                      - subscription_start
                                      - subscribe_and_save
                                      - subscribe_and_save_in_currency
                                      - subscribe_and_save_for_display
                                - type: 'null'
                            subscription_only:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_interval:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_interval_unit:
                              type:
                                - string
                                - 'null'
                              example: month
                            subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 10.5
                            subscription_price_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $10.50
                            subscription_start:
                              type:
                                - string
                                - 'null'
                              example: '2025-02-12'
                            subscribe_and_save:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 2.99
                            subscribe_and_save_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $2.99
                            subscribe_and_save_for_display:
                              type:
                                - string
                                - 'null'
                              example: Subscribe and save $2.99
                            title:
                              type:
                                - string
                                - 'null'
                              example: Surcharge
                            metadata:
                              type: object
                              description: >-
                                A JSON object that can store any custom data
                                structure
                              example: {}
                            product:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type: string
                                      example: Sample Product
                                    introduction:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Product Description
                                    cv:
                                      type: integer
                                      example: 10
                                    external_id:
                                      type:
                                        - string
                                        - 'null'
                                      example: ext-prod-123
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/product.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/product.png
                                    price:
                                      type: string
                                      example: '29.99'
                                    price_in_currency:
                                      type: string
                                      example: $29.99
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    tax:
                                      type: string
                                      example: '2.99'
                                    tax_in_currency:
                                      type: string
                                      example: $2.99
                                    metadata:
                                      type: object
                                      example:
                                        shopify_product_id: 9876054868270
                                    metafields:
                                      type: array
                                      items:
                                        title: LegacyMetafield
                                        type: object
                                        properties:
                                          namespace:
                                            description: >-
                                              A container for related metafields.
                                              Commonly used to group metafields by app
                                              or functionality.
                                            example: custom
                                            type: string
                                            maxLength: 20
                                            pattern: ^[a-zA-Z0-9_]+$
                                          key:
                                            description: >-
                                              The unique identifier for the metafield
                                              within its namespace. Must be unique per
                                              namespace and owner.
                                            example: material
                                            type: string
                                            maxLength: 30
                                            pattern: ^[a-zA-Z0-9_]+$
                                          value:
                                            description: >-
                                              The actual data stored in the metafield.
                                              Type depends on value_type.
                                            example: cotton
                                            type:
                                              - string
                                              - integer
                                              - object
                                              - boolean
                                              - number
                                          value_type:
                                            description: >-
                                              The data type that defines how the value
                                              should be interpreted and validated.
                                            example: single_line_text_field
                                            type: string
                                          description:
                                            description: >-
                                              Optional human-readable description
                                              explaining the purpose of this
                                              metafield.
                                            example: >-
                                              The primary material used in this
                                              product
                                            type:
                                              - string
                                              - 'null'
                                          created_at:
                                            description: >-
                                              Timestamp when the metafield was
                                              created.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          updated_at:
                                            description: >-
                                              Timestamp when the metafield was last
                                              updated.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          locked:
                                            description: >-
                                              Whether this metafield is locked and
                                              cannot be updated or deleted directly.
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                              - 'null'
                                          metafield_definition:
                                            description: >-
                                              The definition that defines validation
                                              rules and structure for this metafield
                                            type:
                                              - 'null'
                                              - object
                                        required:
                                          - namespace
                                          - key
                                          - value
                                          - value_type
                                          - description
                                          - created_at
                                          - updated_at
                                          - metafield_definition
                                - type: 'null'
                            variant:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Variant
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/sample.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/sample.png
                                    primary_image:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/primary.png
                                    price:
                                      type:
                                        - string
                                        - 'null'
                                      example: '34.44'
                                    price_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $34.44
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    options:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          title:
                                            type: string
                                            example: Size
                                          value:
                                            type: string
                                            example: XL
                                    physical:
                                      type:
                                        - boolean
                                        - 'null'
                                      example: true
                                    unit_of_size:
                                      type:
                                        - string
                                        - 'null'
                                      example: cm
                                    height:
                                      type:
                                        - number
                                        - 'null'
                                      example: 13
                                    width:
                                      type:
                                        - number
                                        - 'null'
                                      example: 6
                                    length:
                                      type:
                                        - number
                                        - 'null'
                                      example: 12
                                    unit_of_weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: kg
                                    weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                    hs_code:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                - type: 'null'
                            errors:
                              oneOf:
                                - type: 'null'
                                - type: array
                                  items:
                                    type: object
                                  example:
                                    - country:
                                        - >-
                                          This product is not available for this
                                          country. Please change your country
                            bundled_items:
                              type: array
                              items:
                                type: object
                                description: Bundled items for bundle products
                                properties:
                                  variant_id:
                                    type: integer
                                    example: 1
                                  product_id:
                                    type: integer
                                    example: 1
                                  product_title:
                                    type: string
                                    example: Product Title
                                  variant_title:
                                    type: string
                                    example: Variant Title
                                  option_titles:
                                    type: array
                                    example:
                                      - Option 1
                                      - Option 2
                                  quantity:
                                    type: integer
                                    example: 1
                                  display_to_customer:
                                    type: boolean
                                    example: true
                      ship_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      bill_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      shipping_method:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: string
                            example: standard-shipping
                          name:
                            type: string
                            example: Standard Shipping
                      available_shipping_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: standard-shipping
                            title:
                              type: string
                              example: Standard Shipping
                            price:
                              type:
                                - number
                                - string
                              example: 5.99
                            price_label:
                              type: string
                              example: $5.99
                            delivery_time_estimate:
                              type: string
                              example: 3-5 business days
                      available_payment_methods:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - credit_card
                                name:
                                  type: string
                                  example: Credit Card
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                apple_pay:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method supports
                                    ApplePay or not 
                                bogus_gateway:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is a Bogus
                                    instance or not.
                                tokenize_path:
                                  type:
                                    - string
                                    - 'null'
                                  description: Path to tokenize, if applicable.
                                token_provider:
                                  type: string
                                  enum:
                                    - spreedly
                                    - vgs
                                  description: >-
                                    Determines if payment tokenization is via
                                    spreedly or VGS
                                apple_pay_merchant_identifier:
                                  type:
                                    - string
                                    - 'null'
                                  example: merchant.mycompany.com
                                  description: >-
                                    If ApplePay is supported, returns the
                                    merchant identifier registered with Apple,
                                    else returns nil
                                supported_brands:
                                  type: array
                                  items:
                                    type: string
                                  example:
                                    - visa
                                    - master
                                    - american_express
                                    - discover
                                publishable_key:
                                  type:
                                    - string
                                    - 'null'
                                  example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                  description: >-
                                    If publishable key is set for Hyperswitch,
                                    returns the publishable key, else returns
                                    nil
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                              required:
                                - id
                                - type
                                - name
                                - supported_brands
                                - test
                                - sandbox
                                - apple_pay
                                - apple_pay_merchant_identifier
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - klarna
                                name:
                                  type: string
                                  example: Klarna
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                      country:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          iso:
                            type: string
                            example: US
                          name:
                            type: string
                            example: United States
                          iso_name:
                            type: string
                            example: UNITED STATES
                          iso3:
                            type: string
                            example: USA
                          currency_code:
                            type: string
                            example: USD
                          currency_symbol:
                            type: string
                            example: $
                          province_required:
                            type: boolean
                            example: false
                          tax_enabled:
                            type:
                              - boolean
                              - 'null'
                            example: true
                          price_inclusive_of_tax:
                            type: boolean
                            example: false
                          price_inclusive_tax_name:
                            type:
                              - string
                              - 'null'
                            example: VAT
                      type:
                        type: string
                        enum:
                          - regular
                          - enrollment
                        example: regular
                      enrollment_pack_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      enrollment_pack:
                        type:
                          - object
                          - 'null'
                        properties:
                          enrollment_pack_id:
                            type: integer
                            example: 1
                          additional_volume:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          slug:
                            type: string
                            example: test-enrollment-pack
                          description:
                            type:
                              - object
                              - 'null'
                              - string
                            properties:
                              id:
                                type: integer
                                example: 111
                              name:
                                type: string
                                example: description
                              body:
                                type: string
                                example: >-
                                  <div>Try the latest and greatest of our sugar
                                  zip packs. Guaranteed to make you skinner and
                                  cure cancer.</div>
                              record_type:
                                type: string
                                example: EnrollmentPack
                              record_id:
                                type: integer
                                example: 1
                              created_at:
                                type: string
                                format: date_time
                                example: '2025-01-16T04:22:43.809Z'
                              updated_at:
                                type: string
                                format: date_time
                                example: '2025-01-22T10:23:52.941Z'
                              locale:
                                type: string
                                example: en
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: 10
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.00
                          images:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2
                                relateable_type:
                                  type: string
                                  example: EnrollmentPack
                                relateable_id:
                                  type: integer
                                  example: 1
                                image_url:
                                  type: string
                                  example: >-
                                    https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                image_path:
                                  type: string
                                  example: jITWaU14QGe0y5AFgY7P_00179.svg
                                position:
                                  type: integer
                                  example: 1
                                shopify_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                                created_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                updated_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                external_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 625
                                allow_subscription:
                                  type: boolean
                                  example: true
                                cv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                cv_in_currency:
                                  type: string
                                  example: $0.00
                                cv_total:
                                  type: integer
                                  example: 0
                                enrollment:
                                  type: boolean
                                  example: true
                                enrollment_pack_id:
                                  type: integer
                                  example: 1
                                price:
                                  type: string
                                  example: '11.13'
                                price_in_currency:
                                  type: string
                                  example: $11.13
                                product_title:
                                  type: string
                                  example: Zip Pack Sample Pack (30)
                                quantity:
                                  type: integer
                                  example: 1
                                qv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                qv_in_currency:
                                  type: string
                                  example: $0.00
                                qv_total:
                                  type: integer
                                  example: 0
                                subscribe_and_save:
                                  type:
                                    - string
                                    - 'null'
                                  example: '-1988.87'
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $-1,988.87
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $-1,988.87
                                subscription:
                                  type: boolean
                                  example: false
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_only:
                                  type: boolean
                                  example: false
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_price:
                                  type: string
                                  example: '2000.0'
                                subscription_price_in_currency:
                                  type: string
                                  example: $2,000.00
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  format: date
                                  example: '2025-02-28'
                                tax:
                                  type: string
                                  example: '0.0'
                                tax_in_currency:
                                  type: string
                                  example: $0.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: null
                                display_to_customer:
                                  type: boolean
                                  example: false
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                          price:
                            type: string
                            example: '11.13'
                          price_in_currency:
                            type: string
                            example: $11.13
                          subscription_price:
                            type:
                              - string
                              - integer
                            example: 2000
                          subscription_price_in_currency:
                            type: string
                            example: $2,000.00
                          title:
                            type: string
                            example: enroll product
                          token:
                            type: string
                            example: NxL22AqLRRisfyF9LqxxWRak
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      recurring:
                        oneOf:
                          - type: array
                            items:
                              type: object
                              properties:
                                subtotal:
                                  type: string
                                  example: '10.0'
                                subtotal_in_currency:
                                  type: string
                                  example: $10.0
                                interval:
                                  type: integer
                                  example: 1
                                interval_unit:
                                  type: string
                                  example: month
                                subtotal_for_display:
                                  type: string
                                  example: $10.00 every 1 month
                                start_date:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-05-27'
                          - type: 'null'
                        default:
                          - subtotal: '10.0'
                            subtotal_in_currency: $10.0
                            interval: 1
                            interval_unit: month
                            subtotal_for_display: $10.00 every 1 month
                            start_date: '2025-05-27'
                      messages:
                        type: object
                        additionalProperties: true
                        example:
                          errors:
                            - Insufficient inventory
                            - Product no longer available
                          warnings:
                            - Low stock warning
                            - Shipping delays expected
                          info:
                            - Free shipping available
                            - Volume discount applied
                      points_enabled:
                        type: boolean
                        example: true
                      points_applied:
                        type: integer
                        example: 500
                        description: Number of points applied to the cart
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Currency value of applied points
                      customer_total_points:
                        type: integer
                        example: 1000
                        description: Customer's total available points balance
                      customer_total_points_in_currency:
                        type: number
                        example: 10
                        description: Currency value of available points
                      remaining_customer_points:
                        type: integer
                        example: 500
                        description: Customer's remaining points after cart redemption
                      remaining_customer_points_amount_in_currency:
                        type: number
                        example: 5
                        description: >-
                          Currency value of remaining points after cart
                          redemption
                      remaining_cart_amount_after_points:
                        type: number
                        example: 95
                        description: Amount to charge to card after points redemption
                      remaining_cart_amount_after_points_in_currency:
                        type:
                          - string
                        example: $95.00
                        description: >-
                          Amount in currency to charge to card after points
                          redemption
                      max_applicable_points:
                        type: integer
                        example: 500
                        description: Maximum points that can be applied to this cart
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      checkout_url:
                        type: string
                        example: https://checkout.fluid.com/checkout?jwt=abc123
                      shop_url:
                        type: string
                        example: https://myco.fluid.app
        '404':
          description: cart not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
                      example:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid message parameters
                  errors:
                    type: object
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                errors:
                  type: array
                  items:
                    type: string
                  description: >-
                    Array of error messages. These messages prevent cart
                    checkout.
                  example:
                    - Insufficient inventory
                    - Product no longer available
                warnings:
                  type: array
                  items:
                    type: string
                  description: Array of warning messages for user awareness.
                  example:
                    - Low stock warning
                    - Shipping delays expected
                info:
                  type: array
                  items:
                    type: string
                  description: Array of informational messages.
                  example:
                    - Free shipping available
                    - Volume discount applied
    delete:
      summary: Clears cart messages
      tags:
        - Carts
      description: >-
        Clear all cart messages or specific message types (errors, warnings,
        info). If no message_types are specified, all messages are cleared.
      operationId: clearCartMessages
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: all messages cleared when no types specified
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      state:
                        type: string
                        example: start
                      processed:
                        type: boolean
                        example: false
                        description: >-
                          Determines if a cart payment has been processed or
                          not.
                      valid_for_checkout:
                        type: boolean
                        example: true
                      buyer_rep_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      buyer_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: buyer.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                              external_id:
                                type:
                                  - string
                                  - 'null'
                                example: '123241'
                            required:
                              - id
                          - type: 'null'
                      volume_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: volume.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                            required:
                              - id
                          - type: 'null'
                      currency_symbol:
                        type: string
                        example: $
                      currency_code:
                        type: string
                        example: USD
                      shipping_total_for_display:
                        type: string
                        example: Free
                      phone:
                        type:
                          - string
                          - 'null'
                        example: '4035551212'
                      payment_method_auto_assignable:
                        type: boolean
                        example: true
                        description: >-
                          Determines if a payment method can be auto-assigned to
                          the cart.
                      attribution:
                        oneOf:
                          - type: object
                            oneOf:
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  share_guid:
                                    type: string
                                    example: james-bond007
                                required:
                                  - id
                                  - share_guid
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  email:
                                    type: string
                                    example: james.bond@gmail.com
                                required:
                                  - id
                                  - email
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  username:
                                    type: string
                                    example: jaamball234
                                required:
                                  - id
                                  - username
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  fluid_rep_id:
                                    type: integer
                                    example: 23493
                                required:
                                  - id
                                  - fluid_rep_id
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: w3sdf92
                                required:
                                  - id
                          - type: 'null'
                        default:
                          id: 456
                          share_guid: james-bond007
                      agreements:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            required:
                              type: boolean
                              example: true
                            title:
                              type: string
                              example: Terms and Conditions
                            show_path:
                              type: string
                              example: /terms
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                      amount_total:
                        type: string
                        example: '121.65'
                      amount_total_in_currency:
                        type: string
                        example: $121.65 (USD)
                      sub_total:
                        type: string
                        example: '100.00'
                      sub_total_in_currency:
                        type: string
                        example: $100.00 (USD)
                      subtotal_after_discounts:
                        type: string
                        example: '90.00'
                      tax_total:
                        type: string
                        example: '20.00'
                      tax_total_in_currency:
                        type: string
                        example: $20.00 (USD)
                      shipping_total:
                        type:
                          - string
                          - 'null'
                        example: '1.65'
                      shipping_total_in_currency:
                        type: string
                        example: $1.65 (USD)
                      shipping_discount:
                        type: number
                        example: 10.25
                      discount_total:
                        type: string
                        example: '2.99'
                      discount_total_in_currency:
                        type: string
                        example: $2.99 (USD)
                      discount_breakdown:
                        type: object
                        properties:
                          internal_discounts:
                            type: number
                            example: 15
                          external_discounts:
                            type: number
                            example: 10
                          total_discounts:
                            type: number
                            example: 25
                      external_discount:
                        type: object
                        properties:
                          total:
                            type: number
                            example: 10
                          calculated_at:
                            type:
                              - string
                              - 'null'
                            format: date-time
                            example: '2024-01-10T15:30:00Z'
                          sources:
                            type: object
                            additionalProperties:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 6
                                description:
                                  type: string
                                  example: Gold tier discount
                                metadata:
                                  type: object
                              required:
                                - amount
                                - description
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: '1.90'
                      transaction_fee_in_currency:
                        type: string
                        example: $1.90 (USD)
                      cv_total:
                        type: integer
                        example: 10
                      qv_total:
                        type: integer
                        example: 15
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      payment_account:
                        type:
                          - string
                          - 'null'
                        example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                      payment_method:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: CreditCard
                              payment_method_type:
                                type: string
                                example: visa
                              last_four:
                                type: string
                                example: '1234'
                              exp_month:
                                type: string
                                example: '12'
                              exp_year:
                                type: string
                                example: '2025'
                              logo_url:
                                type: string
                                example: https://example.com/image.svg
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Paypal
                              status:
                                type: string
                                example: active
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Affirm
                              affirm_id:
                                type: string
                                example: affirm_123
                              status:
                                type: string
                                example: authorized
                              checkout_id:
                                type: string
                                example: checkout_456
                              created:
                                type: string
                                example: '2025-01-01T00:00:00Z'
                              auth_expiration:
                                type: string
                                example: '2025-01-02T00:00:00Z'
                              currency:
                                type: string
                                example: USD
                              amount:
                                type: string
                                example: '100.00'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Klarna
                              session_id:
                                type: string
                                example: klarna_session_789
                              intent:
                                type: string
                                example: buy
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Droplet
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: SomeCitcon
                      email:
                        type:
                          - string
                          - 'null'
                        example: user@example.com
                      enrollment_fee:
                        type:
                          - number
                          - string
                        example: '10.45'
                      enrollment_fee_in_currency:
                        type: string
                        example: $10.45
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT10
                          - DISCOUNT11
                      language_iso:
                        type:
                          - string
                          - 'null'
                        example: en
                      cart_token:
                        type: string
                        example: abc123
                      immutable_items:
                        type: boolean
                        example: false
                      digital_only:
                        type: boolean
                        example: false
                      requires_3ds:
                        type: boolean
                        example: false
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 101
                            price:
                              type: string
                              example: '43.41'
                            price_in_currency:
                              type: string
                              example: $43.41
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            cv:
                              type: integer
                              example: 5
                            cv_total:
                              type: integer
                              example: 15
                            qv:
                              type: integer
                              example: 7
                            qv_total:
                              type: integer
                              example: 21
                            discount_amount:
                              type: string
                              example: '10'
                            free_item:
                              type: boolean
                              example: false
                            discount_amount_in_currency:
                              type: string
                              example: $10.00
                            total_after_discounts:
                              type: string
                              example: '90.00'
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            product_title:
                              type:
                                - string
                                - 'null'
                              example: Sample Product
                            quantity:
                              type: integer
                              example: 3
                            subscription:
                              type: boolean
                              example: true
                            enrollment:
                              type: boolean
                              example: false
                            allow_subscription:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_plan_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_plans:
                              oneOf:
                                - type: array
                                  items:
                                    title: Commerce::SubscriptionPlan
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        example: Test Subscription Plan
                                        type: string
                                      billing_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      billing_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      billing_frequency_in_words:
                                        example: 2 Months
                                        type: string
                                      shipping_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      shipping_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      volume_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      volume_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      trial_period:
                                        example: 1
                                        type:
                                          - integer
                                          - 'null'
                                        minimum: 1
                                      trial_period_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type:
                                          - string
                                          - 'null'
                                      split_volume:
                                        example: true
                                        type: boolean
                                        default: false
                                      allow_max_billing_cycles:
                                        example: true
                                        type: boolean
                                        default: false
                                      max_billing_cycles:
                                        example: 3
                                        type:
                                          - integer
                                          - 'null'
                                      company_default:
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                        default: false
                                      products_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      subscribers_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      price:
                                        type: string
                                      price_in_currency:
                                        type: string
                                      subscription_start:
                                        type: string
                                      subscribe_and_save:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_in_currency:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_for_display:
                                        type:
                                          - string
                                          - 'null'
                                    required:
                                      - id
                                      - name
                                      - billing_interval
                                      - billing_interval_unit
                                      - billing_frequency_in_words
                                      - shipping_interval
                                      - shipping_interval_unit
                                      - volume_interval
                                      - volume_interval_unit
                                      - split_volume
                                      - allow_max_billing_cycles
                                      - price
                                      - price_in_currency
                                      - subscription_start
                                      - subscribe_and_save
                                      - subscribe_and_save_in_currency
                                      - subscribe_and_save_for_display
                                - type: 'null'
                            subscription_only:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_interval:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_interval_unit:
                              type:
                                - string
                                - 'null'
                              example: month
                            subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 10.5
                            subscription_price_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $10.50
                            subscription_start:
                              type:
                                - string
                                - 'null'
                              example: '2025-02-12'
                            subscribe_and_save:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 2.99
                            subscribe_and_save_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $2.99
                            subscribe_and_save_for_display:
                              type:
                                - string
                                - 'null'
                              example: Subscribe and save $2.99
                            title:
                              type:
                                - string
                                - 'null'
                              example: Surcharge
                            metadata:
                              type: object
                              description: >-
                                A JSON object that can store any custom data
                                structure
                              example: {}
                            product:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type: string
                                      example: Sample Product
                                    introduction:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Product Description
                                    cv:
                                      type: integer
                                      example: 10
                                    external_id:
                                      type:
                                        - string
                                        - 'null'
                                      example: ext-prod-123
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/product.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/product.png
                                    price:
                                      type: string
                                      example: '29.99'
                                    price_in_currency:
                                      type: string
                                      example: $29.99
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    tax:
                                      type: string
                                      example: '2.99'
                                    tax_in_currency:
                                      type: string
                                      example: $2.99
                                    metadata:
                                      type: object
                                      example:
                                        shopify_product_id: 9876054868270
                                    metafields:
                                      type: array
                                      items:
                                        title: LegacyMetafield
                                        type: object
                                        properties:
                                          namespace:
                                            description: >-
                                              A container for related metafields.
                                              Commonly used to group metafields by app
                                              or functionality.
                                            example: custom
                                            type: string
                                            maxLength: 20
                                            pattern: ^[a-zA-Z0-9_]+$
                                          key:
                                            description: >-
                                              The unique identifier for the metafield
                                              within its namespace. Must be unique per
                                              namespace and owner.
                                            example: material
                                            type: string
                                            maxLength: 30
                                            pattern: ^[a-zA-Z0-9_]+$
                                          value:
                                            description: >-
                                              The actual data stored in the metafield.
                                              Type depends on value_type.
                                            example: cotton
                                            type:
                                              - string
                                              - integer
                                              - object
                                              - boolean
                                              - number
                                          value_type:
                                            description: >-
                                              The data type that defines how the value
                                              should be interpreted and validated.
                                            example: single_line_text_field
                                            type: string
                                          description:
                                            description: >-
                                              Optional human-readable description
                                              explaining the purpose of this
                                              metafield.
                                            example: >-
                                              The primary material used in this
                                              product
                                            type:
                                              - string
                                              - 'null'
                                          created_at:
                                            description: >-
                                              Timestamp when the metafield was
                                              created.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          updated_at:
                                            description: >-
                                              Timestamp when the metafield was last
                                              updated.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          locked:
                                            description: >-
                                              Whether this metafield is locked and
                                              cannot be updated or deleted directly.
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                              - 'null'
                                          metafield_definition:
                                            description: >-
                                              The definition that defines validation
                                              rules and structure for this metafield
                                            type:
                                              - 'null'
                                              - object
                                        required:
                                          - namespace
                                          - key
                                          - value
                                          - value_type
                                          - description
                                          - created_at
                                          - updated_at
                                          - metafield_definition
                                - type: 'null'
                            variant:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Variant
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/sample.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/sample.png
                                    primary_image:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/primary.png
                                    price:
                                      type:
                                        - string
                                        - 'null'
                                      example: '34.44'
                                    price_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $34.44
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    options:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          title:
                                            type: string
                                            example: Size
                                          value:
                                            type: string
                                            example: XL
                                    physical:
                                      type:
                                        - boolean
                                        - 'null'
                                      example: true
                                    unit_of_size:
                                      type:
                                        - string
                                        - 'null'
                                      example: cm
                                    height:
                                      type:
                                        - number
                                        - 'null'
                                      example: 13
                                    width:
                                      type:
                                        - number
                                        - 'null'
                                      example: 6
                                    length:
                                      type:
                                        - number
                                        - 'null'
                                      example: 12
                                    unit_of_weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: kg
                                    weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                    hs_code:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                - type: 'null'
                            errors:
                              oneOf:
                                - type: 'null'
                                - type: array
                                  items:
                                    type: object
                                  example:
                                    - country:
                                        - >-
                                          This product is not available for this
                                          country. Please change your country
                            bundled_items:
                              type: array
                              items:
                                type: object
                                description: Bundled items for bundle products
                                properties:
                                  variant_id:
                                    type: integer
                                    example: 1
                                  product_id:
                                    type: integer
                                    example: 1
                                  product_title:
                                    type: string
                                    example: Product Title
                                  variant_title:
                                    type: string
                                    example: Variant Title
                                  option_titles:
                                    type: array
                                    example:
                                      - Option 1
                                      - Option 2
                                  quantity:
                                    type: integer
                                    example: 1
                                  display_to_customer:
                                    type: boolean
                                    example: true
                      ship_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      bill_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      shipping_method:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: string
                            example: standard-shipping
                          name:
                            type: string
                            example: Standard Shipping
                      available_shipping_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: standard-shipping
                            title:
                              type: string
                              example: Standard Shipping
                            price:
                              type:
                                - number
                                - string
                              example: 5.99
                            price_label:
                              type: string
                              example: $5.99
                            delivery_time_estimate:
                              type: string
                              example: 3-5 business days
                      available_payment_methods:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - credit_card
                                name:
                                  type: string
                                  example: Credit Card
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                apple_pay:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method supports
                                    ApplePay or not 
                                bogus_gateway:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is a Bogus
                                    instance or not.
                                tokenize_path:
                                  type:
                                    - string
                                    - 'null'
                                  description: Path to tokenize, if applicable.
                                token_provider:
                                  type: string
                                  enum:
                                    - spreedly
                                    - vgs
                                  description: >-
                                    Determines if payment tokenization is via
                                    spreedly or VGS
                                apple_pay_merchant_identifier:
                                  type:
                                    - string
                                    - 'null'
                                  example: merchant.mycompany.com
                                  description: >-
                                    If ApplePay is supported, returns the
                                    merchant identifier registered with Apple,
                                    else returns nil
                                supported_brands:
                                  type: array
                                  items:
                                    type: string
                                  example:
                                    - visa
                                    - master
                                    - american_express
                                    - discover
                                publishable_key:
                                  type:
                                    - string
                                    - 'null'
                                  example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                  description: >-
                                    If publishable key is set for Hyperswitch,
                                    returns the publishable key, else returns
                                    nil
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                              required:
                                - id
                                - type
                                - name
                                - supported_brands
                                - test
                                - sandbox
                                - apple_pay
                                - apple_pay_merchant_identifier
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - klarna
                                name:
                                  type: string
                                  example: Klarna
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                      country:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          iso:
                            type: string
                            example: US
                          name:
                            type: string
                            example: United States
                          iso_name:
                            type: string
                            example: UNITED STATES
                          iso3:
                            type: string
                            example: USA
                          currency_code:
                            type: string
                            example: USD
                          currency_symbol:
                            type: string
                            example: $
                          province_required:
                            type: boolean
                            example: false
                          tax_enabled:
                            type:
                              - boolean
                              - 'null'
                            example: true
                          price_inclusive_of_tax:
                            type: boolean
                            example: false
                          price_inclusive_tax_name:
                            type:
                              - string
                              - 'null'
                            example: VAT
                      type:
                        type: string
                        enum:
                          - regular
                          - enrollment
                        example: regular
                      enrollment_pack_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      enrollment_pack:
                        type:
                          - object
                          - 'null'
                        properties:
                          enrollment_pack_id:
                            type: integer
                            example: 1
                          additional_volume:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          slug:
                            type: string
                            example: test-enrollment-pack
                          description:
                            type:
                              - object
                              - 'null'
                              - string
                            properties:
                              id:
                                type: integer
                                example: 111
                              name:
                                type: string
                                example: description
                              body:
                                type: string
                                example: >-
                                  <div>Try the latest and greatest of our sugar
                                  zip packs. Guaranteed to make you skinner and
                                  cure cancer.</div>
                              record_type:
                                type: string
                                example: EnrollmentPack
                              record_id:
                                type: integer
                                example: 1
                              created_at:
                                type: string
                                format: date_time
                                example: '2025-01-16T04:22:43.809Z'
                              updated_at:
                                type: string
                                format: date_time
                                example: '2025-01-22T10:23:52.941Z'
                              locale:
                                type: string
                                example: en
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: 10
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.00
                          images:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2
                                relateable_type:
                                  type: string
                                  example: EnrollmentPack
                                relateable_id:
                                  type: integer
                                  example: 1
                                image_url:
                                  type: string
                                  example: >-
                                    https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                image_path:
                                  type: string
                                  example: jITWaU14QGe0y5AFgY7P_00179.svg
                                position:
                                  type: integer
                                  example: 1
                                shopify_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                                created_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                updated_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                external_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 625
                                allow_subscription:
                                  type: boolean
                                  example: true
                                cv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                cv_in_currency:
                                  type: string
                                  example: $0.00
                                cv_total:
                                  type: integer
                                  example: 0
                                enrollment:
                                  type: boolean
                                  example: true
                                enrollment_pack_id:
                                  type: integer
                                  example: 1
                                price:
                                  type: string
                                  example: '11.13'
                                price_in_currency:
                                  type: string
                                  example: $11.13
                                product_title:
                                  type: string
                                  example: Zip Pack Sample Pack (30)
                                quantity:
                                  type: integer
                                  example: 1
                                qv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                qv_in_currency:
                                  type: string
                                  example: $0.00
                                qv_total:
                                  type: integer
                                  example: 0
                                subscribe_and_save:
                                  type:
                                    - string
                                    - 'null'
                                  example: '-1988.87'
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $-1,988.87
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $-1,988.87
                                subscription:
                                  type: boolean
                                  example: false
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_only:
                                  type: boolean
                                  example: false
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_price:
                                  type: string
                                  example: '2000.0'
                                subscription_price_in_currency:
                                  type: string
                                  example: $2,000.00
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  format: date
                                  example: '2025-02-28'
                                tax:
                                  type: string
                                  example: '0.0'
                                tax_in_currency:
                                  type: string
                                  example: $0.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: null
                                display_to_customer:
                                  type: boolean
                                  example: false
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                          price:
                            type: string
                            example: '11.13'
                          price_in_currency:
                            type: string
                            example: $11.13
                          subscription_price:
                            type:
                              - string
                              - integer
                            example: 2000
                          subscription_price_in_currency:
                            type: string
                            example: $2,000.00
                          title:
                            type: string
                            example: enroll product
                          token:
                            type: string
                            example: NxL22AqLRRisfyF9LqxxWRak
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      recurring:
                        oneOf:
                          - type: array
                            items:
                              type: object
                              properties:
                                subtotal:
                                  type: string
                                  example: '10.0'
                                subtotal_in_currency:
                                  type: string
                                  example: $10.0
                                interval:
                                  type: integer
                                  example: 1
                                interval_unit:
                                  type: string
                                  example: month
                                subtotal_for_display:
                                  type: string
                                  example: $10.00 every 1 month
                                start_date:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-05-27'
                          - type: 'null'
                        default:
                          - subtotal: '10.0'
                            subtotal_in_currency: $10.0
                            interval: 1
                            interval_unit: month
                            subtotal_for_display: $10.00 every 1 month
                            start_date: '2025-05-27'
                      messages:
                        type: object
                        additionalProperties: true
                        example:
                          errors:
                            - Insufficient inventory
                            - Product no longer available
                          warnings:
                            - Low stock warning
                            - Shipping delays expected
                          info:
                            - Free shipping available
                            - Volume discount applied
                      points_enabled:
                        type: boolean
                        example: true
                      points_applied:
                        type: integer
                        example: 500
                        description: Number of points applied to the cart
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Currency value of applied points
                      customer_total_points:
                        type: integer
                        example: 1000
                        description: Customer's total available points balance
                      customer_total_points_in_currency:
                        type: number
                        example: 10
                        description: Currency value of available points
                      remaining_customer_points:
                        type: integer
                        example: 500
                        description: Customer's remaining points after cart redemption
                      remaining_customer_points_amount_in_currency:
                        type: number
                        example: 5
                        description: >-
                          Currency value of remaining points after cart
                          redemption
                      remaining_cart_amount_after_points:
                        type: number
                        example: 95
                        description: Amount to charge to card after points redemption
                      remaining_cart_amount_after_points_in_currency:
                        type:
                          - string
                        example: $95.00
                        description: >-
                          Amount in currency to charge to card after points
                          redemption
                      max_applicable_points:
                        type: integer
                        example: 500
                        description: Maximum points that can be applied to this cart
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      checkout_url:
                        type: string
                        example: https://checkout.fluid.com/checkout?jwt=abc123
                      shop_url:
                        type: string
                        example: https://myco.fluid.app
        '404':
          description: cart not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
                      example:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                message_types:
                  type: array
                  items:
                    type: string
                    enum:
                      - errors
                      - warnings
                      - info
                  description: >-
                    Specific message types to clear. If not provided, all
                    messages are cleared.
                  example:
                    - errors
                    - warnings
  /api/carts/{cart_token}/metadata:
    patch:
      summary: Updates cart metadata
      tags:
        - Carts
      description: >-
        Updates the metadata field of a cart with custom data. The provided
        metadata object will be merged with existing metadata. Note: The
        parameter is still named 'metadata' for backward compatibility.
      operationId: updateCartMetadata
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: metadata updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      state:
                        type: string
                        example: start
                      processed:
                        type: boolean
                        example: false
                        description: >-
                          Determines if a cart payment has been processed or
                          not.
                      valid_for_checkout:
                        type: boolean
                        example: true
                      buyer_rep_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      buyer_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: buyer.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                              external_id:
                                type:
                                  - string
                                  - 'null'
                                example: '123241'
                            required:
                              - id
                          - type: 'null'
                      volume_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: volume.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                            required:
                              - id
                          - type: 'null'
                      currency_symbol:
                        type: string
                        example: $
                      currency_code:
                        type: string
                        example: USD
                      shipping_total_for_display:
                        type: string
                        example: Free
                      phone:
                        type:
                          - string
                          - 'null'
                        example: '4035551212'
                      payment_method_auto_assignable:
                        type: boolean
                        example: true
                        description: >-
                          Determines if a payment method can be auto-assigned to
                          the cart.
                      attribution:
                        oneOf:
                          - type: object
                            oneOf:
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  share_guid:
                                    type: string
                                    example: james-bond007
                                required:
                                  - id
                                  - share_guid
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  email:
                                    type: string
                                    example: james.bond@gmail.com
                                required:
                                  - id
                                  - email
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  username:
                                    type: string
                                    example: jaamball234
                                required:
                                  - id
                                  - username
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  fluid_rep_id:
                                    type: integer
                                    example: 23493
                                required:
                                  - id
                                  - fluid_rep_id
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: w3sdf92
                                required:
                                  - id
                          - type: 'null'
                        default:
                          id: 456
                          share_guid: james-bond007
                      agreements:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            required:
                              type: boolean
                              example: true
                            title:
                              type: string
                              example: Terms and Conditions
                            show_path:
                              type: string
                              example: /terms
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                      amount_total:
                        type: string
                        example: '121.65'
                      amount_total_in_currency:
                        type: string
                        example: $121.65 (USD)
                      sub_total:
                        type: string
                        example: '100.00'
                      sub_total_in_currency:
                        type: string
                        example: $100.00 (USD)
                      subtotal_after_discounts:
                        type: string
                        example: '90.00'
                      tax_total:
                        type: string
                        example: '20.00'
                      tax_total_in_currency:
                        type: string
                        example: $20.00 (USD)
                      shipping_total:
                        type:
                          - string
                          - 'null'
                        example: '1.65'
                      shipping_total_in_currency:
                        type: string
                        example: $1.65 (USD)
                      shipping_discount:
                        type: number
                        example: 10.25
                      discount_total:
                        type: string
                        example: '2.99'
                      discount_total_in_currency:
                        type: string
                        example: $2.99 (USD)
                      discount_breakdown:
                        type: object
                        properties:
                          internal_discounts:
                            type: number
                            example: 15
                          external_discounts:
                            type: number
                            example: 10
                          total_discounts:
                            type: number
                            example: 25
                      external_discount:
                        type: object
                        properties:
                          total:
                            type: number
                            example: 10
                          calculated_at:
                            type:
                              - string
                              - 'null'
                            format: date-time
                            example: '2024-01-10T15:30:00Z'
                          sources:
                            type: object
                            additionalProperties:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 6
                                description:
                                  type: string
                                  example: Gold tier discount
                                metadata:
                                  type: object
                              required:
                                - amount
                                - description
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: '1.90'
                      transaction_fee_in_currency:
                        type: string
                        example: $1.90 (USD)
                      cv_total:
                        type: integer
                        example: 10
                      qv_total:
                        type: integer
                        example: 15
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      payment_account:
                        type:
                          - string
                          - 'null'
                        example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                      payment_method:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: CreditCard
                              payment_method_type:
                                type: string
                                example: visa
                              last_four:
                                type: string
                                example: '1234'
                              exp_month:
                                type: string
                                example: '12'
                              exp_year:
                                type: string
                                example: '2025'
                              logo_url:
                                type: string
                                example: https://example.com/image.svg
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Paypal
                              status:
                                type: string
                                example: active
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Affirm
                              affirm_id:
                                type: string
                                example: affirm_123
                              status:
                                type: string
                                example: authorized
                              checkout_id:
                                type: string
                                example: checkout_456
                              created:
                                type: string
                                example: '2025-01-01T00:00:00Z'
                              auth_expiration:
                                type: string
                                example: '2025-01-02T00:00:00Z'
                              currency:
                                type: string
                                example: USD
                              amount:
                                type: string
                                example: '100.00'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Klarna
                              session_id:
                                type: string
                                example: klarna_session_789
                              intent:
                                type: string
                                example: buy
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Droplet
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: SomeCitcon
                      email:
                        type:
                          - string
                          - 'null'
                        example: user@example.com
                      enrollment_fee:
                        type:
                          - number
                          - string
                        example: '10.45'
                      enrollment_fee_in_currency:
                        type: string
                        example: $10.45
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT10
                          - DISCOUNT11
                      language_iso:
                        type:
                          - string
                          - 'null'
                        example: en
                      cart_token:
                        type: string
                        example: abc123
                      immutable_items:
                        type: boolean
                        example: false
                      digital_only:
                        type: boolean
                        example: false
                      requires_3ds:
                        type: boolean
                        example: false
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 101
                            price:
                              type: string
                              example: '43.41'
                            price_in_currency:
                              type: string
                              example: $43.41
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            cv:
                              type: integer
                              example: 5
                            cv_total:
                              type: integer
                              example: 15
                            qv:
                              type: integer
                              example: 7
                            qv_total:
                              type: integer
                              example: 21
                            discount_amount:
                              type: string
                              example: '10'
                            free_item:
                              type: boolean
                              example: false
                            discount_amount_in_currency:
                              type: string
                              example: $10.00
                            total_after_discounts:
                              type: string
                              example: '90.00'
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            product_title:
                              type:
                                - string
                                - 'null'
                              example: Sample Product
                            quantity:
                              type: integer
                              example: 3
                            subscription:
                              type: boolean
                              example: true
                            enrollment:
                              type: boolean
                              example: false
                            allow_subscription:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_plan_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_plans:
                              oneOf:
                                - type: array
                                  items:
                                    title: Commerce::SubscriptionPlan
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        example: Test Subscription Plan
                                        type: string
                                      billing_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      billing_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      billing_frequency_in_words:
                                        example: 2 Months
                                        type: string
                                      shipping_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      shipping_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      volume_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      volume_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      trial_period:
                                        example: 1
                                        type:
                                          - integer
                                          - 'null'
                                        minimum: 1
                                      trial_period_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type:
                                          - string
                                          - 'null'
                                      split_volume:
                                        example: true
                                        type: boolean
                                        default: false
                                      allow_max_billing_cycles:
                                        example: true
                                        type: boolean
                                        default: false
                                      max_billing_cycles:
                                        example: 3
                                        type:
                                          - integer
                                          - 'null'
                                      company_default:
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                        default: false
                                      products_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      subscribers_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      price:
                                        type: string
                                      price_in_currency:
                                        type: string
                                      subscription_start:
                                        type: string
                                      subscribe_and_save:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_in_currency:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_for_display:
                                        type:
                                          - string
                                          - 'null'
                                    required:
                                      - id
                                      - name
                                      - billing_interval
                                      - billing_interval_unit
                                      - billing_frequency_in_words
                                      - shipping_interval
                                      - shipping_interval_unit
                                      - volume_interval
                                      - volume_interval_unit
                                      - split_volume
                                      - allow_max_billing_cycles
                                      - price
                                      - price_in_currency
                                      - subscription_start
                                      - subscribe_and_save
                                      - subscribe_and_save_in_currency
                                      - subscribe_and_save_for_display
                                - type: 'null'
                            subscription_only:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_interval:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_interval_unit:
                              type:
                                - string
                                - 'null'
                              example: month
                            subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 10.5
                            subscription_price_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $10.50
                            subscription_start:
                              type:
                                - string
                                - 'null'
                              example: '2025-02-12'
                            subscribe_and_save:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 2.99
                            subscribe_and_save_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $2.99
                            subscribe_and_save_for_display:
                              type:
                                - string
                                - 'null'
                              example: Subscribe and save $2.99
                            title:
                              type:
                                - string
                                - 'null'
                              example: Surcharge
                            metadata:
                              type: object
                              description: >-
                                A JSON object that can store any custom data
                                structure
                              example: {}
                            product:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type: string
                                      example: Sample Product
                                    introduction:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Product Description
                                    cv:
                                      type: integer
                                      example: 10
                                    external_id:
                                      type:
                                        - string
                                        - 'null'
                                      example: ext-prod-123
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/product.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/product.png
                                    price:
                                      type: string
                                      example: '29.99'
                                    price_in_currency:
                                      type: string
                                      example: $29.99
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    tax:
                                      type: string
                                      example: '2.99'
                                    tax_in_currency:
                                      type: string
                                      example: $2.99
                                    metadata:
                                      type: object
                                      example:
                                        shopify_product_id: 9876054868270
                                    metafields:
                                      type: array
                                      items:
                                        title: LegacyMetafield
                                        type: object
                                        properties:
                                          namespace:
                                            description: >-
                                              A container for related metafields.
                                              Commonly used to group metafields by app
                                              or functionality.
                                            example: custom
                                            type: string
                                            maxLength: 20
                                            pattern: ^[a-zA-Z0-9_]+$
                                          key:
                                            description: >-
                                              The unique identifier for the metafield
                                              within its namespace. Must be unique per
                                              namespace and owner.
                                            example: material
                                            type: string
                                            maxLength: 30
                                            pattern: ^[a-zA-Z0-9_]+$
                                          value:
                                            description: >-
                                              The actual data stored in the metafield.
                                              Type depends on value_type.
                                            example: cotton
                                            type:
                                              - string
                                              - integer
                                              - object
                                              - boolean
                                              - number
                                          value_type:
                                            description: >-
                                              The data type that defines how the value
                                              should be interpreted and validated.
                                            example: single_line_text_field
                                            type: string
                                          description:
                                            description: >-
                                              Optional human-readable description
                                              explaining the purpose of this
                                              metafield.
                                            example: >-
                                              The primary material used in this
                                              product
                                            type:
                                              - string
                                              - 'null'
                                          created_at:
                                            description: >-
                                              Timestamp when the metafield was
                                              created.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          updated_at:
                                            description: >-
                                              Timestamp when the metafield was last
                                              updated.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          locked:
                                            description: >-
                                              Whether this metafield is locked and
                                              cannot be updated or deleted directly.
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                              - 'null'
                                          metafield_definition:
                                            description: >-
                                              The definition that defines validation
                                              rules and structure for this metafield
                                            type:
                                              - 'null'
                                              - object
                                        required:
                                          - namespace
                                          - key
                                          - value
                                          - value_type
                                          - description
                                          - created_at
                                          - updated_at
                                          - metafield_definition
                                - type: 'null'
                            variant:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Variant
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/sample.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/sample.png
                                    primary_image:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/primary.png
                                    price:
                                      type:
                                        - string
                                        - 'null'
                                      example: '34.44'
                                    price_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $34.44
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    options:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          title:
                                            type: string
                                            example: Size
                                          value:
                                            type: string
                                            example: XL
                                    physical:
                                      type:
                                        - boolean
                                        - 'null'
                                      example: true
                                    unit_of_size:
                                      type:
                                        - string
                                        - 'null'
                                      example: cm
                                    height:
                                      type:
                                        - number
                                        - 'null'
                                      example: 13
                                    width:
                                      type:
                                        - number
                                        - 'null'
                                      example: 6
                                    length:
                                      type:
                                        - number
                                        - 'null'
                                      example: 12
                                    unit_of_weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: kg
                                    weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                    hs_code:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                - type: 'null'
                            errors:
                              oneOf:
                                - type: 'null'
                                - type: array
                                  items:
                                    type: object
                                  example:
                                    - country:
                                        - >-
                                          This product is not available for this
                                          country. Please change your country
                            bundled_items:
                              type: array
                              items:
                                type: object
                                description: Bundled items for bundle products
                                properties:
                                  variant_id:
                                    type: integer
                                    example: 1
                                  product_id:
                                    type: integer
                                    example: 1
                                  product_title:
                                    type: string
                                    example: Product Title
                                  variant_title:
                                    type: string
                                    example: Variant Title
                                  option_titles:
                                    type: array
                                    example:
                                      - Option 1
                                      - Option 2
                                  quantity:
                                    type: integer
                                    example: 1
                                  display_to_customer:
                                    type: boolean
                                    example: true
                      ship_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      bill_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      shipping_method:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: string
                            example: standard-shipping
                          name:
                            type: string
                            example: Standard Shipping
                      available_shipping_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: standard-shipping
                            title:
                              type: string
                              example: Standard Shipping
                            price:
                              type:
                                - number
                                - string
                              example: 5.99
                            price_label:
                              type: string
                              example: $5.99
                            delivery_time_estimate:
                              type: string
                              example: 3-5 business days
                      available_payment_methods:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - credit_card
                                name:
                                  type: string
                                  example: Credit Card
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                apple_pay:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method supports
                                    ApplePay or not 
                                bogus_gateway:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is a Bogus
                                    instance or not.
                                tokenize_path:
                                  type:
                                    - string
                                    - 'null'
                                  description: Path to tokenize, if applicable.
                                token_provider:
                                  type: string
                                  enum:
                                    - spreedly
                                    - vgs
                                  description: >-
                                    Determines if payment tokenization is via
                                    spreedly or VGS
                                apple_pay_merchant_identifier:
                                  type:
                                    - string
                                    - 'null'
                                  example: merchant.mycompany.com
                                  description: >-
                                    If ApplePay is supported, returns the
                                    merchant identifier registered with Apple,
                                    else returns nil
                                supported_brands:
                                  type: array
                                  items:
                                    type: string
                                  example:
                                    - visa
                                    - master
                                    - american_express
                                    - discover
                                publishable_key:
                                  type:
                                    - string
                                    - 'null'
                                  example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                  description: >-
                                    If publishable key is set for Hyperswitch,
                                    returns the publishable key, else returns
                                    nil
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                              required:
                                - id
                                - type
                                - name
                                - supported_brands
                                - test
                                - sandbox
                                - apple_pay
                                - apple_pay_merchant_identifier
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - klarna
                                name:
                                  type: string
                                  example: Klarna
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                      country:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          iso:
                            type: string
                            example: US
                          name:
                            type: string
                            example: United States
                          iso_name:
                            type: string
                            example: UNITED STATES
                          iso3:
                            type: string
                            example: USA
                          currency_code:
                            type: string
                            example: USD
                          currency_symbol:
                            type: string
                            example: $
                          province_required:
                            type: boolean
                            example: false
                          tax_enabled:
                            type:
                              - boolean
                              - 'null'
                            example: true
                          price_inclusive_of_tax:
                            type: boolean
                            example: false
                          price_inclusive_tax_name:
                            type:
                              - string
                              - 'null'
                            example: VAT
                      type:
                        type: string
                        enum:
                          - regular
                          - enrollment
                        example: regular
                      enrollment_pack_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      enrollment_pack:
                        type:
                          - object
                          - 'null'
                        properties:
                          enrollment_pack_id:
                            type: integer
                            example: 1
                          additional_volume:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          slug:
                            type: string
                            example: test-enrollment-pack
                          description:
                            type:
                              - object
                              - 'null'
                              - string
                            properties:
                              id:
                                type: integer
                                example: 111
                              name:
                                type: string
                                example: description
                              body:
                                type: string
                                example: >-
                                  <div>Try the latest and greatest of our sugar
                                  zip packs. Guaranteed to make you skinner and
                                  cure cancer.</div>
                              record_type:
                                type: string
                                example: EnrollmentPack
                              record_id:
                                type: integer
                                example: 1
                              created_at:
                                type: string
                                format: date_time
                                example: '2025-01-16T04:22:43.809Z'
                              updated_at:
                                type: string
                                format: date_time
                                example: '2025-01-22T10:23:52.941Z'
                              locale:
                                type: string
                                example: en
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: 10
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.00
                          images:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2
                                relateable_type:
                                  type: string
                                  example: EnrollmentPack
                                relateable_id:
                                  type: integer
                                  example: 1
                                image_url:
                                  type: string
                                  example: >-
                                    https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                image_path:
                                  type: string
                                  example: jITWaU14QGe0y5AFgY7P_00179.svg
                                position:
                                  type: integer
                                  example: 1
                                shopify_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                                created_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                updated_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                external_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 625
                                allow_subscription:
                                  type: boolean
                                  example: true
                                cv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                cv_in_currency:
                                  type: string
                                  example: $0.00
                                cv_total:
                                  type: integer
                                  example: 0
                                enrollment:
                                  type: boolean
                                  example: true
                                enrollment_pack_id:
                                  type: integer
                                  example: 1
                                price:
                                  type: string
                                  example: '11.13'
                                price_in_currency:
                                  type: string
                                  example: $11.13
                                product_title:
                                  type: string
                                  example: Zip Pack Sample Pack (30)
                                quantity:
                                  type: integer
                                  example: 1
                                qv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                qv_in_currency:
                                  type: string
                                  example: $0.00
                                qv_total:
                                  type: integer
                                  example: 0
                                subscribe_and_save:
                                  type:
                                    - string
                                    - 'null'
                                  example: '-1988.87'
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $-1,988.87
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $-1,988.87
                                subscription:
                                  type: boolean
                                  example: false
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_only:
                                  type: boolean
                                  example: false
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_price:
                                  type: string
                                  example: '2000.0'
                                subscription_price_in_currency:
                                  type: string
                                  example: $2,000.00
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  format: date
                                  example: '2025-02-28'
                                tax:
                                  type: string
                                  example: '0.0'
                                tax_in_currency:
                                  type: string
                                  example: $0.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: null
                                display_to_customer:
                                  type: boolean
                                  example: false
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                          price:
                            type: string
                            example: '11.13'
                          price_in_currency:
                            type: string
                            example: $11.13
                          subscription_price:
                            type:
                              - string
                              - integer
                            example: 2000
                          subscription_price_in_currency:
                            type: string
                            example: $2,000.00
                          title:
                            type: string
                            example: enroll product
                          token:
                            type: string
                            example: NxL22AqLRRisfyF9LqxxWRak
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      recurring:
                        oneOf:
                          - type: array
                            items:
                              type: object
                              properties:
                                subtotal:
                                  type: string
                                  example: '10.0'
                                subtotal_in_currency:
                                  type: string
                                  example: $10.0
                                interval:
                                  type: integer
                                  example: 1
                                interval_unit:
                                  type: string
                                  example: month
                                subtotal_for_display:
                                  type: string
                                  example: $10.00 every 1 month
                                start_date:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-05-27'
                          - type: 'null'
                        default:
                          - subtotal: '10.0'
                            subtotal_in_currency: $10.0
                            interval: 1
                            interval_unit: month
                            subtotal_for_display: $10.00 every 1 month
                            start_date: '2025-05-27'
                      messages:
                        type: object
                        additionalProperties: true
                        example:
                          errors:
                            - Insufficient inventory
                            - Product no longer available
                          warnings:
                            - Low stock warning
                            - Shipping delays expected
                          info:
                            - Free shipping available
                            - Volume discount applied
                      points_enabled:
                        type: boolean
                        example: true
                      points_applied:
                        type: integer
                        example: 500
                        description: Number of points applied to the cart
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Currency value of applied points
                      customer_total_points:
                        type: integer
                        example: 1000
                        description: Customer's total available points balance
                      customer_total_points_in_currency:
                        type: number
                        example: 10
                        description: Currency value of available points
                      remaining_customer_points:
                        type: integer
                        example: 500
                        description: Customer's remaining points after cart redemption
                      remaining_customer_points_amount_in_currency:
                        type: number
                        example: 5
                        description: >-
                          Currency value of remaining points after cart
                          redemption
                      remaining_cart_amount_after_points:
                        type: number
                        example: 95
                        description: Amount to charge to card after points redemption
                      remaining_cart_amount_after_points_in_currency:
                        type:
                          - string
                        example: $95.00
                        description: >-
                          Amount in currency to charge to card after points
                          redemption
                      max_applicable_points:
                        type: integer
                        example: 500
                        description: Maximum points that can be applied to this cart
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      checkout_url:
                        type: string
                        example: https://checkout.fluid.com/checkout?jwt=abc123
                      shop_url:
                        type: string
                        example: https://myco.fluid.app
        '404':
          description: cart not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
                      example:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '410':
          description: Cart is processed and cannot be modified
        '422':
          description: invalid metadata parameter
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid metadata parameters
                  errors:
                    type: object
                    properties:
                      metadata:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                metadata:
                  type: object
                  description: Custom data to merge with existing cart metadata
                  example:
                    custom_field: value
                    shipping_preferences:
                      express: true
              required:
                - metadata
        required: true
  /api/carts/{cart_token}/json_data:
    patch:
      summary: Updates cart json_data (DEPRECATED - use /metadata instead)
      tags:
        - Carts
      deprecated: true
      description: >-
        ⚠️ DEPRECATED: This endpoint is maintained for backward compatibility
        only. Please use PATCH /api/carts/{cart_token}/metadata instead. 


        Updates the metadata field of a cart with custom data. The provided
        json_data object will be merged with existing metadata.
      operationId: updateCartJsonData
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: json_data updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      state:
                        type: string
                        example: start
                      processed:
                        type: boolean
                        example: false
                        description: >-
                          Determines if a cart payment has been processed or
                          not.
                      valid_for_checkout:
                        type: boolean
                        example: true
                      buyer_rep_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      buyer_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: buyer.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                              external_id:
                                type:
                                  - string
                                  - 'null'
                                example: '123241'
                            required:
                              - id
                          - type: 'null'
                      volume_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: volume.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                            required:
                              - id
                          - type: 'null'
                      currency_symbol:
                        type: string
                        example: $
                      currency_code:
                        type: string
                        example: USD
                      shipping_total_for_display:
                        type: string
                        example: Free
                      phone:
                        type:
                          - string
                          - 'null'
                        example: '4035551212'
                      payment_method_auto_assignable:
                        type: boolean
                        example: true
                        description: >-
                          Determines if a payment method can be auto-assigned to
                          the cart.
                      attribution:
                        oneOf:
                          - type: object
                            oneOf:
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  share_guid:
                                    type: string
                                    example: james-bond007
                                required:
                                  - id
                                  - share_guid
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  email:
                                    type: string
                                    example: james.bond@gmail.com
                                required:
                                  - id
                                  - email
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  username:
                                    type: string
                                    example: jaamball234
                                required:
                                  - id
                                  - username
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  fluid_rep_id:
                                    type: integer
                                    example: 23493
                                required:
                                  - id
                                  - fluid_rep_id
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: w3sdf92
                                required:
                                  - id
                          - type: 'null'
                        default:
                          id: 456
                          share_guid: james-bond007
                      agreements:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            required:
                              type: boolean
                              example: true
                            title:
                              type: string
                              example: Terms and Conditions
                            show_path:
                              type: string
                              example: /terms
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                      amount_total:
                        type: string
                        example: '121.65'
                      amount_total_in_currency:
                        type: string
                        example: $121.65 (USD)
                      sub_total:
                        type: string
                        example: '100.00'
                      sub_total_in_currency:
                        type: string
                        example: $100.00 (USD)
                      subtotal_after_discounts:
                        type: string
                        example: '90.00'
                      tax_total:
                        type: string
                        example: '20.00'
                      tax_total_in_currency:
                        type: string
                        example: $20.00 (USD)
                      shipping_total:
                        type:
                          - string
                          - 'null'
                        example: '1.65'
                      shipping_total_in_currency:
                        type: string
                        example: $1.65 (USD)
                      shipping_discount:
                        type: number
                        example: 10.25
                      discount_total:
                        type: string
                        example: '2.99'
                      discount_total_in_currency:
                        type: string
                        example: $2.99 (USD)
                      discount_breakdown:
                        type: object
                        properties:
                          internal_discounts:
                            type: number
                            example: 15
                          external_discounts:
                            type: number
                            example: 10
                          total_discounts:
                            type: number
                            example: 25
                      external_discount:
                        type: object
                        properties:
                          total:
                            type: number
                            example: 10
                          calculated_at:
                            type:
                              - string
                              - 'null'
                            format: date-time
                            example: '2024-01-10T15:30:00Z'
                          sources:
                            type: object
                            additionalProperties:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 6
                                description:
                                  type: string
                                  example: Gold tier discount
                                metadata:
                                  type: object
                              required:
                                - amount
                                - description
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: '1.90'
                      transaction_fee_in_currency:
                        type: string
                        example: $1.90 (USD)
                      cv_total:
                        type: integer
                        example: 10
                      qv_total:
                        type: integer
                        example: 15
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      payment_account:
                        type:
                          - string
                          - 'null'
                        example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                      payment_method:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: CreditCard
                              payment_method_type:
                                type: string
                                example: visa
                              last_four:
                                type: string
                                example: '1234'
                              exp_month:
                                type: string
                                example: '12'
                              exp_year:
                                type: string
                                example: '2025'
                              logo_url:
                                type: string
                                example: https://example.com/image.svg
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Paypal
                              status:
                                type: string
                                example: active
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Affirm
                              affirm_id:
                                type: string
                                example: affirm_123
                              status:
                                type: string
                                example: authorized
                              checkout_id:
                                type: string
                                example: checkout_456
                              created:
                                type: string
                                example: '2025-01-01T00:00:00Z'
                              auth_expiration:
                                type: string
                                example: '2025-01-02T00:00:00Z'
                              currency:
                                type: string
                                example: USD
                              amount:
                                type: string
                                example: '100.00'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Klarna
                              session_id:
                                type: string
                                example: klarna_session_789
                              intent:
                                type: string
                                example: buy
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Droplet
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: SomeCitcon
                      email:
                        type:
                          - string
                          - 'null'
                        example: user@example.com
                      enrollment_fee:
                        type:
                          - number
                          - string
                        example: '10.45'
                      enrollment_fee_in_currency:
                        type: string
                        example: $10.45
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT10
                          - DISCOUNT11
                      language_iso:
                        type:
                          - string
                          - 'null'
                        example: en
                      cart_token:
                        type: string
                        example: abc123
                      immutable_items:
                        type: boolean
                        example: false
                      digital_only:
                        type: boolean
                        example: false
                      requires_3ds:
                        type: boolean
                        example: false
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 101
                            price:
                              type: string
                              example: '43.41'
                            price_in_currency:
                              type: string
                              example: $43.41
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            cv:
                              type: integer
                              example: 5
                            cv_total:
                              type: integer
                              example: 15
                            qv:
                              type: integer
                              example: 7
                            qv_total:
                              type: integer
                              example: 21
                            discount_amount:
                              type: string
                              example: '10'
                            free_item:
                              type: boolean
                              example: false
                            discount_amount_in_currency:
                              type: string
                              example: $10.00
                            total_after_discounts:
                              type: string
                              example: '90.00'
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            product_title:
                              type:
                                - string
                                - 'null'
                              example: Sample Product
                            quantity:
                              type: integer
                              example: 3
                            subscription:
                              type: boolean
                              example: true
                            enrollment:
                              type: boolean
                              example: false
                            allow_subscription:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_plan_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_plans:
                              oneOf:
                                - type: array
                                  items:
                                    title: Commerce::SubscriptionPlan
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        example: Test Subscription Plan
                                        type: string
                                      billing_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      billing_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      billing_frequency_in_words:
                                        example: 2 Months
                                        type: string
                                      shipping_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      shipping_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      volume_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      volume_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      trial_period:
                                        example: 1
                                        type:
                                          - integer
                                          - 'null'
                                        minimum: 1
                                      trial_period_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type:
                                          - string
                                          - 'null'
                                      split_volume:
                                        example: true
                                        type: boolean
                                        default: false
                                      allow_max_billing_cycles:
                                        example: true
                                        type: boolean
                                        default: false
                                      max_billing_cycles:
                                        example: 3
                                        type:
                                          - integer
                                          - 'null'
                                      company_default:
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                        default: false
                                      products_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      subscribers_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      price:
                                        type: string
                                      price_in_currency:
                                        type: string
                                      subscription_start:
                                        type: string
                                      subscribe_and_save:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_in_currency:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_for_display:
                                        type:
                                          - string
                                          - 'null'
                                    required:
                                      - id
                                      - name
                                      - billing_interval
                                      - billing_interval_unit
                                      - billing_frequency_in_words
                                      - shipping_interval
                                      - shipping_interval_unit
                                      - volume_interval
                                      - volume_interval_unit
                                      - split_volume
                                      - allow_max_billing_cycles
                                      - price
                                      - price_in_currency
                                      - subscription_start
                                      - subscribe_and_save
                                      - subscribe_and_save_in_currency
                                      - subscribe_and_save_for_display
                                - type: 'null'
                            subscription_only:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_interval:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_interval_unit:
                              type:
                                - string
                                - 'null'
                              example: month
                            subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 10.5
                            subscription_price_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $10.50
                            subscription_start:
                              type:
                                - string
                                - 'null'
                              example: '2025-02-12'
                            subscribe_and_save:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 2.99
                            subscribe_and_save_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $2.99
                            subscribe_and_save_for_display:
                              type:
                                - string
                                - 'null'
                              example: Subscribe and save $2.99
                            title:
                              type:
                                - string
                                - 'null'
                              example: Surcharge
                            metadata:
                              type: object
                              description: >-
                                A JSON object that can store any custom data
                                structure
                              example: {}
                            product:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type: string
                                      example: Sample Product
                                    introduction:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Product Description
                                    cv:
                                      type: integer
                                      example: 10
                                    external_id:
                                      type:
                                        - string
                                        - 'null'
                                      example: ext-prod-123
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/product.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/product.png
                                    price:
                                      type: string
                                      example: '29.99'
                                    price_in_currency:
                                      type: string
                                      example: $29.99
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    tax:
                                      type: string
                                      example: '2.99'
                                    tax_in_currency:
                                      type: string
                                      example: $2.99
                                    metadata:
                                      type: object
                                      example:
                                        shopify_product_id: 9876054868270
                                    metafields:
                                      type: array
                                      items:
                                        title: LegacyMetafield
                                        type: object
                                        properties:
                                          namespace:
                                            description: >-
                                              A container for related metafields.
                                              Commonly used to group metafields by app
                                              or functionality.
                                            example: custom
                                            type: string
                                            maxLength: 20
                                            pattern: ^[a-zA-Z0-9_]+$
                                          key:
                                            description: >-
                                              The unique identifier for the metafield
                                              within its namespace. Must be unique per
                                              namespace and owner.
                                            example: material
                                            type: string
                                            maxLength: 30
                                            pattern: ^[a-zA-Z0-9_]+$
                                          value:
                                            description: >-
                                              The actual data stored in the metafield.
                                              Type depends on value_type.
                                            example: cotton
                                            type:
                                              - string
                                              - integer
                                              - object
                                              - boolean
                                              - number
                                          value_type:
                                            description: >-
                                              The data type that defines how the value
                                              should be interpreted and validated.
                                            example: single_line_text_field
                                            type: string
                                          description:
                                            description: >-
                                              Optional human-readable description
                                              explaining the purpose of this
                                              metafield.
                                            example: >-
                                              The primary material used in this
                                              product
                                            type:
                                              - string
                                              - 'null'
                                          created_at:
                                            description: >-
                                              Timestamp when the metafield was
                                              created.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          updated_at:
                                            description: >-
                                              Timestamp when the metafield was last
                                              updated.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          locked:
                                            description: >-
                                              Whether this metafield is locked and
                                              cannot be updated or deleted directly.
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                              - 'null'
                                          metafield_definition:
                                            description: >-
                                              The definition that defines validation
                                              rules and structure for this metafield
                                            type:
                                              - 'null'
                                              - object
                                        required:
                                          - namespace
                                          - key
                                          - value
                                          - value_type
                                          - description
                                          - created_at
                                          - updated_at
                                          - metafield_definition
                                - type: 'null'
                            variant:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Variant
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/sample.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/sample.png
                                    primary_image:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/primary.png
                                    price:
                                      type:
                                        - string
                                        - 'null'
                                      example: '34.44'
                                    price_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $34.44
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    options:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          title:
                                            type: string
                                            example: Size
                                          value:
                                            type: string
                                            example: XL
                                    physical:
                                      type:
                                        - boolean
                                        - 'null'
                                      example: true
                                    unit_of_size:
                                      type:
                                        - string
                                        - 'null'
                                      example: cm
                                    height:
                                      type:
                                        - number
                                        - 'null'
                                      example: 13
                                    width:
                                      type:
                                        - number
                                        - 'null'
                                      example: 6
                                    length:
                                      type:
                                        - number
                                        - 'null'
                                      example: 12
                                    unit_of_weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: kg
                                    weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                    hs_code:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                - type: 'null'
                            errors:
                              oneOf:
                                - type: 'null'
                                - type: array
                                  items:
                                    type: object
                                  example:
                                    - country:
                                        - >-
                                          This product is not available for this
                                          country. Please change your country
                            bundled_items:
                              type: array
                              items:
                                type: object
                                description: Bundled items for bundle products
                                properties:
                                  variant_id:
                                    type: integer
                                    example: 1
                                  product_id:
                                    type: integer
                                    example: 1
                                  product_title:
                                    type: string
                                    example: Product Title
                                  variant_title:
                                    type: string
                                    example: Variant Title
                                  option_titles:
                                    type: array
                                    example:
                                      - Option 1
                                      - Option 2
                                  quantity:
                                    type: integer
                                    example: 1
                                  display_to_customer:
                                    type: boolean
                                    example: true
                      ship_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      bill_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      shipping_method:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: string
                            example: standard-shipping
                          name:
                            type: string
                            example: Standard Shipping
                      available_shipping_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: standard-shipping
                            title:
                              type: string
                              example: Standard Shipping
                            price:
                              type:
                                - number
                                - string
                              example: 5.99
                            price_label:
                              type: string
                              example: $5.99
                            delivery_time_estimate:
                              type: string
                              example: 3-5 business days
                      available_payment_methods:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - credit_card
                                name:
                                  type: string
                                  example: Credit Card
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                apple_pay:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method supports
                                    ApplePay or not 
                                bogus_gateway:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is a Bogus
                                    instance or not.
                                tokenize_path:
                                  type:
                                    - string
                                    - 'null'
                                  description: Path to tokenize, if applicable.
                                token_provider:
                                  type: string
                                  enum:
                                    - spreedly
                                    - vgs
                                  description: >-
                                    Determines if payment tokenization is via
                                    spreedly or VGS
                                apple_pay_merchant_identifier:
                                  type:
                                    - string
                                    - 'null'
                                  example: merchant.mycompany.com
                                  description: >-
                                    If ApplePay is supported, returns the
                                    merchant identifier registered with Apple,
                                    else returns nil
                                supported_brands:
                                  type: array
                                  items:
                                    type: string
                                  example:
                                    - visa
                                    - master
                                    - american_express
                                    - discover
                                publishable_key:
                                  type:
                                    - string
                                    - 'null'
                                  example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                  description: >-
                                    If publishable key is set for Hyperswitch,
                                    returns the publishable key, else returns
                                    nil
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                              required:
                                - id
                                - type
                                - name
                                - supported_brands
                                - test
                                - sandbox
                                - apple_pay
                                - apple_pay_merchant_identifier
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - klarna
                                name:
                                  type: string
                                  example: Klarna
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                      country:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          iso:
                            type: string
                            example: US
                          name:
                            type: string
                            example: United States
                          iso_name:
                            type: string
                            example: UNITED STATES
                          iso3:
                            type: string
                            example: USA
                          currency_code:
                            type: string
                            example: USD
                          currency_symbol:
                            type: string
                            example: $
                          province_required:
                            type: boolean
                            example: false
                          tax_enabled:
                            type:
                              - boolean
                              - 'null'
                            example: true
                          price_inclusive_of_tax:
                            type: boolean
                            example: false
                          price_inclusive_tax_name:
                            type:
                              - string
                              - 'null'
                            example: VAT
                      type:
                        type: string
                        enum:
                          - regular
                          - enrollment
                        example: regular
                      enrollment_pack_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      enrollment_pack:
                        type:
                          - object
                          - 'null'
                        properties:
                          enrollment_pack_id:
                            type: integer
                            example: 1
                          additional_volume:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          slug:
                            type: string
                            example: test-enrollment-pack
                          description:
                            type:
                              - object
                              - 'null'
                              - string
                            properties:
                              id:
                                type: integer
                                example: 111
                              name:
                                type: string
                                example: description
                              body:
                                type: string
                                example: >-
                                  <div>Try the latest and greatest of our sugar
                                  zip packs. Guaranteed to make you skinner and
                                  cure cancer.</div>
                              record_type:
                                type: string
                                example: EnrollmentPack
                              record_id:
                                type: integer
                                example: 1
                              created_at:
                                type: string
                                format: date_time
                                example: '2025-01-16T04:22:43.809Z'
                              updated_at:
                                type: string
                                format: date_time
                                example: '2025-01-22T10:23:52.941Z'
                              locale:
                                type: string
                                example: en
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: 10
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.00
                          images:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2
                                relateable_type:
                                  type: string
                                  example: EnrollmentPack
                                relateable_id:
                                  type: integer
                                  example: 1
                                image_url:
                                  type: string
                                  example: >-
                                    https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                image_path:
                                  type: string
                                  example: jITWaU14QGe0y5AFgY7P_00179.svg
                                position:
                                  type: integer
                                  example: 1
                                shopify_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                                created_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                updated_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                external_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 625
                                allow_subscription:
                                  type: boolean
                                  example: true
                                cv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                cv_in_currency:
                                  type: string
                                  example: $0.00
                                cv_total:
                                  type: integer
                                  example: 0
                                enrollment:
                                  type: boolean
                                  example: true
                                enrollment_pack_id:
                                  type: integer
                                  example: 1
                                price:
                                  type: string
                                  example: '11.13'
                                price_in_currency:
                                  type: string
                                  example: $11.13
                                product_title:
                                  type: string
                                  example: Zip Pack Sample Pack (30)
                                quantity:
                                  type: integer
                                  example: 1
                                qv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                qv_in_currency:
                                  type: string
                                  example: $0.00
                                qv_total:
                                  type: integer
                                  example: 0
                                subscribe_and_save:
                                  type:
                                    - string
                                    - 'null'
                                  example: '-1988.87'
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $-1,988.87
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $-1,988.87
                                subscription:
                                  type: boolean
                                  example: false
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_only:
                                  type: boolean
                                  example: false
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_price:
                                  type: string
                                  example: '2000.0'
                                subscription_price_in_currency:
                                  type: string
                                  example: $2,000.00
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  format: date
                                  example: '2025-02-28'
                                tax:
                                  type: string
                                  example: '0.0'
                                tax_in_currency:
                                  type: string
                                  example: $0.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: null
                                display_to_customer:
                                  type: boolean
                                  example: false
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                          price:
                            type: string
                            example: '11.13'
                          price_in_currency:
                            type: string
                            example: $11.13
                          subscription_price:
                            type:
                              - string
                              - integer
                            example: 2000
                          subscription_price_in_currency:
                            type: string
                            example: $2,000.00
                          title:
                            type: string
                            example: enroll product
                          token:
                            type: string
                            example: NxL22AqLRRisfyF9LqxxWRak
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      recurring:
                        oneOf:
                          - type: array
                            items:
                              type: object
                              properties:
                                subtotal:
                                  type: string
                                  example: '10.0'
                                subtotal_in_currency:
                                  type: string
                                  example: $10.0
                                interval:
                                  type: integer
                                  example: 1
                                interval_unit:
                                  type: string
                                  example: month
                                subtotal_for_display:
                                  type: string
                                  example: $10.00 every 1 month
                                start_date:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-05-27'
                          - type: 'null'
                        default:
                          - subtotal: '10.0'
                            subtotal_in_currency: $10.0
                            interval: 1
                            interval_unit: month
                            subtotal_for_display: $10.00 every 1 month
                            start_date: '2025-05-27'
                      messages:
                        type: object
                        additionalProperties: true
                        example:
                          errors:
                            - Insufficient inventory
                            - Product no longer available
                          warnings:
                            - Low stock warning
                            - Shipping delays expected
                          info:
                            - Free shipping available
                            - Volume discount applied
                      points_enabled:
                        type: boolean
                        example: true
                      points_applied:
                        type: integer
                        example: 500
                        description: Number of points applied to the cart
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Currency value of applied points
                      customer_total_points:
                        type: integer
                        example: 1000
                        description: Customer's total available points balance
                      customer_total_points_in_currency:
                        type: number
                        example: 10
                        description: Currency value of available points
                      remaining_customer_points:
                        type: integer
                        example: 500
                        description: Customer's remaining points after cart redemption
                      remaining_customer_points_amount_in_currency:
                        type: number
                        example: 5
                        description: >-
                          Currency value of remaining points after cart
                          redemption
                      remaining_cart_amount_after_points:
                        type: number
                        example: 95
                        description: Amount to charge to card after points redemption
                      remaining_cart_amount_after_points_in_currency:
                        type:
                          - string
                        example: $95.00
                        description: >-
                          Amount in currency to charge to card after points
                          redemption
                      max_applicable_points:
                        type: integer
                        example: 500
                        description: Maximum points that can be applied to this cart
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      checkout_url:
                        type: string
                        example: https://checkout.fluid.com/checkout?jwt=abc123
                      shop_url:
                        type: string
                        example: https://myco.fluid.app
        '404':
          description: cart not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
                      example:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '410':
          description: Cart is processed and cannot be modified
        '422':
          description: invalid json_data parameter
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid json_data parameters
                  errors:
                    type: object
                    properties:
                      json_data:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                json_data:
                  type: object
                  description: Custom data to merge with existing cart metadata
                  example:
                    custom_field: value
                    shipping_preferences:
                      express: true
              required:
                - json_data
        required: true
  /api/carts/{cart_token}/recalculate:
    post:
      summary: Recalculates cart totals and pricing
      tags:
        - Carts
      description: >-
        Recalculates the cart by calling save_cart! on the carts service, which
        updates totals, pricing, taxes, and other calculated fields. Optionally
        filters available payment methods and updates allowed integration
        classes.
      operationId: recalculateCart
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
        - name: payment_methods_includes
          in: query
          required: false
          description: >-
            Comma-separated list of payment method integration classes to
            include (e.g., 'CreditCard,Klarna'). Updates cart's allowed
            integration classes.
          schema:
            type: string
        - name: payment_account
          in: query
          required: false
          description: Payment account UUID to associate with the cart
          schema:
            type: string
      responses:
        '200':
          description: cart recalculated with payment account
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      state:
                        type: string
                        example: start
                      processed:
                        type: boolean
                        example: false
                        description: >-
                          Determines if a cart payment has been processed or
                          not.
                      valid_for_checkout:
                        type: boolean
                        example: true
                      buyer_rep_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      buyer_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: buyer.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                              external_id:
                                type:
                                  - string
                                  - 'null'
                                example: '123241'
                            required:
                              - id
                          - type: 'null'
                      volume_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: volume.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                            required:
                              - id
                          - type: 'null'
                      currency_symbol:
                        type: string
                        example: $
                      currency_code:
                        type: string
                        example: USD
                      shipping_total_for_display:
                        type: string
                        example: Free
                      phone:
                        type:
                          - string
                          - 'null'
                        example: '4035551212'
                      payment_method_auto_assignable:
                        type: boolean
                        example: true
                        description: >-
                          Determines if a payment method can be auto-assigned to
                          the cart.
                      attribution:
                        oneOf:
                          - type: object
                            oneOf:
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  share_guid:
                                    type: string
                                    example: james-bond007
                                required:
                                  - id
                                  - share_guid
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  email:
                                    type: string
                                    example: james.bond@gmail.com
                                required:
                                  - id
                                  - email
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  username:
                                    type: string
                                    example: jaamball234
                                required:
                                  - id
                                  - username
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  fluid_rep_id:
                                    type: integer
                                    example: 23493
                                required:
                                  - id
                                  - fluid_rep_id
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: w3sdf92
                                required:
                                  - id
                          - type: 'null'
                        default:
                          id: 456
                          share_guid: james-bond007
                      agreements:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            required:
                              type: boolean
                              example: true
                            title:
                              type: string
                              example: Terms and Conditions
                            show_path:
                              type: string
                              example: /terms
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                      amount_total:
                        type: string
                        example: '121.65'
                      amount_total_in_currency:
                        type: string
                        example: $121.65 (USD)
                      sub_total:
                        type: string
                        example: '100.00'
                      sub_total_in_currency:
                        type: string
                        example: $100.00 (USD)
                      subtotal_after_discounts:
                        type: string
                        example: '90.00'
                      tax_total:
                        type: string
                        example: '20.00'
                      tax_total_in_currency:
                        type: string
                        example: $20.00 (USD)
                      shipping_total:
                        type:
                          - string
                          - 'null'
                        example: '1.65'
                      shipping_total_in_currency:
                        type: string
                        example: $1.65 (USD)
                      shipping_discount:
                        type: number
                        example: 10.25
                      discount_total:
                        type: string
                        example: '2.99'
                      discount_total_in_currency:
                        type: string
                        example: $2.99 (USD)
                      discount_breakdown:
                        type: object
                        properties:
                          internal_discounts:
                            type: number
                            example: 15
                          external_discounts:
                            type: number
                            example: 10
                          total_discounts:
                            type: number
                            example: 25
                      external_discount:
                        type: object
                        properties:
                          total:
                            type: number
                            example: 10
                          calculated_at:
                            type:
                              - string
                              - 'null'
                            format: date-time
                            example: '2024-01-10T15:30:00Z'
                          sources:
                            type: object
                            additionalProperties:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 6
                                description:
                                  type: string
                                  example: Gold tier discount
                                metadata:
                                  type: object
                              required:
                                - amount
                                - description
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: '1.90'
                      transaction_fee_in_currency:
                        type: string
                        example: $1.90 (USD)
                      cv_total:
                        type: integer
                        example: 10
                      qv_total:
                        type: integer
                        example: 15
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      payment_account:
                        type:
                          - string
                          - 'null'
                        example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                      payment_method:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: CreditCard
                              payment_method_type:
                                type: string
                                example: visa
                              last_four:
                                type: string
                                example: '1234'
                              exp_month:
                                type: string
                                example: '12'
                              exp_year:
                                type: string
                                example: '2025'
                              logo_url:
                                type: string
                                example: https://example.com/image.svg
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Paypal
                              status:
                                type: string
                                example: active
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Affirm
                              affirm_id:
                                type: string
                                example: affirm_123
                              status:
                                type: string
                                example: authorized
                              checkout_id:
                                type: string
                                example: checkout_456
                              created:
                                type: string
                                example: '2025-01-01T00:00:00Z'
                              auth_expiration:
                                type: string
                                example: '2025-01-02T00:00:00Z'
                              currency:
                                type: string
                                example: USD
                              amount:
                                type: string
                                example: '100.00'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Klarna
                              session_id:
                                type: string
                                example: klarna_session_789
                              intent:
                                type: string
                                example: buy
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Droplet
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: SomeCitcon
                      email:
                        type:
                          - string
                          - 'null'
                        example: user@example.com
                      enrollment_fee:
                        type:
                          - number
                          - string
                        example: '10.45'
                      enrollment_fee_in_currency:
                        type: string
                        example: $10.45
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT10
                          - DISCOUNT11
                      language_iso:
                        type:
                          - string
                          - 'null'
                        example: en
                      cart_token:
                        type: string
                        example: abc123
                      immutable_items:
                        type: boolean
                        example: false
                      digital_only:
                        type: boolean
                        example: false
                      requires_3ds:
                        type: boolean
                        example: false
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 101
                            price:
                              type: string
                              example: '43.41'
                            price_in_currency:
                              type: string
                              example: $43.41
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            cv:
                              type: integer
                              example: 5
                            cv_total:
                              type: integer
                              example: 15
                            qv:
                              type: integer
                              example: 7
                            qv_total:
                              type: integer
                              example: 21
                            discount_amount:
                              type: string
                              example: '10'
                            free_item:
                              type: boolean
                              example: false
                            discount_amount_in_currency:
                              type: string
                              example: $10.00
                            total_after_discounts:
                              type: string
                              example: '90.00'
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            product_title:
                              type:
                                - string
                                - 'null'
                              example: Sample Product
                            quantity:
                              type: integer
                              example: 3
                            subscription:
                              type: boolean
                              example: true
                            enrollment:
                              type: boolean
                              example: false
                            allow_subscription:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_plan_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_plans:
                              oneOf:
                                - type: array
                                  items:
                                    title: Commerce::SubscriptionPlan
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        example: Test Subscription Plan
                                        type: string
                                      billing_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      billing_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      billing_frequency_in_words:
                                        example: 2 Months
                                        type: string
                                      shipping_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      shipping_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      volume_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      volume_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      trial_period:
                                        example: 1
                                        type:
                                          - integer
                                          - 'null'
                                        minimum: 1
                                      trial_period_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type:
                                          - string
                                          - 'null'
                                      split_volume:
                                        example: true
                                        type: boolean
                                        default: false
                                      allow_max_billing_cycles:
                                        example: true
                                        type: boolean
                                        default: false
                                      max_billing_cycles:
                                        example: 3
                                        type:
                                          - integer
                                          - 'null'
                                      company_default:
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                        default: false
                                      products_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      subscribers_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      price:
                                        type: string
                                      price_in_currency:
                                        type: string
                                      subscription_start:
                                        type: string
                                      subscribe_and_save:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_in_currency:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_for_display:
                                        type:
                                          - string
                                          - 'null'
                                    required:
                                      - id
                                      - name
                                      - billing_interval
                                      - billing_interval_unit
                                      - billing_frequency_in_words
                                      - shipping_interval
                                      - shipping_interval_unit
                                      - volume_interval
                                      - volume_interval_unit
                                      - split_volume
                                      - allow_max_billing_cycles
                                      - price
                                      - price_in_currency
                                      - subscription_start
                                      - subscribe_and_save
                                      - subscribe_and_save_in_currency
                                      - subscribe_and_save_for_display
                                - type: 'null'
                            subscription_only:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_interval:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_interval_unit:
                              type:
                                - string
                                - 'null'
                              example: month
                            subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 10.5
                            subscription_price_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $10.50
                            subscription_start:
                              type:
                                - string
                                - 'null'
                              example: '2025-02-12'
                            subscribe_and_save:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 2.99
                            subscribe_and_save_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $2.99
                            subscribe_and_save_for_display:
                              type:
                                - string
                                - 'null'
                              example: Subscribe and save $2.99
                            title:
                              type:
                                - string
                                - 'null'
                              example: Surcharge
                            metadata:
                              type: object
                              description: >-
                                A JSON object that can store any custom data
                                structure
                              example: {}
                            product:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type: string
                                      example: Sample Product
                                    introduction:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Product Description
                                    cv:
                                      type: integer
                                      example: 10
                                    external_id:
                                      type:
                                        - string
                                        - 'null'
                                      example: ext-prod-123
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/product.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/product.png
                                    price:
                                      type: string
                                      example: '29.99'
                                    price_in_currency:
                                      type: string
                                      example: $29.99
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    tax:
                                      type: string
                                      example: '2.99'
                                    tax_in_currency:
                                      type: string
                                      example: $2.99
                                    metadata:
                                      type: object
                                      example:
                                        shopify_product_id: 9876054868270
                                    metafields:
                                      type: array
                                      items:
                                        title: LegacyMetafield
                                        type: object
                                        properties:
                                          namespace:
                                            description: >-
                                              A container for related metafields.
                                              Commonly used to group metafields by app
                                              or functionality.
                                            example: custom
                                            type: string
                                            maxLength: 20
                                            pattern: ^[a-zA-Z0-9_]+$
                                          key:
                                            description: >-
                                              The unique identifier for the metafield
                                              within its namespace. Must be unique per
                                              namespace and owner.
                                            example: material
                                            type: string
                                            maxLength: 30
                                            pattern: ^[a-zA-Z0-9_]+$
                                          value:
                                            description: >-
                                              The actual data stored in the metafield.
                                              Type depends on value_type.
                                            example: cotton
                                            type:
                                              - string
                                              - integer
                                              - object
                                              - boolean
                                              - number
                                          value_type:
                                            description: >-
                                              The data type that defines how the value
                                              should be interpreted and validated.
                                            example: single_line_text_field
                                            type: string
                                          description:
                                            description: >-
                                              Optional human-readable description
                                              explaining the purpose of this
                                              metafield.
                                            example: >-
                                              The primary material used in this
                                              product
                                            type:
                                              - string
                                              - 'null'
                                          created_at:
                                            description: >-
                                              Timestamp when the metafield was
                                              created.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          updated_at:
                                            description: >-
                                              Timestamp when the metafield was last
                                              updated.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          locked:
                                            description: >-
                                              Whether this metafield is locked and
                                              cannot be updated or deleted directly.
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                              - 'null'
                                          metafield_definition:
                                            description: >-
                                              The definition that defines validation
                                              rules and structure for this metafield
                                            type:
                                              - 'null'
                                              - object
                                        required:
                                          - namespace
                                          - key
                                          - value
                                          - value_type
                                          - description
                                          - created_at
                                          - updated_at
                                          - metafield_definition
                                - type: 'null'
                            variant:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Variant
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/sample.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/sample.png
                                    primary_image:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/primary.png
                                    price:
                                      type:
                                        - string
                                        - 'null'
                                      example: '34.44'
                                    price_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $34.44
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    options:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          title:
                                            type: string
                                            example: Size
                                          value:
                                            type: string
                                            example: XL
                                    physical:
                                      type:
                                        - boolean
                                        - 'null'
                                      example: true
                                    unit_of_size:
                                      type:
                                        - string
                                        - 'null'
                                      example: cm
                                    height:
                                      type:
                                        - number
                                        - 'null'
                                      example: 13
                                    width:
                                      type:
                                        - number
                                        - 'null'
                                      example: 6
                                    length:
                                      type:
                                        - number
                                        - 'null'
                                      example: 12
                                    unit_of_weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: kg
                                    weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                    hs_code:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                - type: 'null'
                            errors:
                              oneOf:
                                - type: 'null'
                                - type: array
                                  items:
                                    type: object
                                  example:
                                    - country:
                                        - >-
                                          This product is not available for this
                                          country. Please change your country
                            bundled_items:
                              type: array
                              items:
                                type: object
                                description: Bundled items for bundle products
                                properties:
                                  variant_id:
                                    type: integer
                                    example: 1
                                  product_id:
                                    type: integer
                                    example: 1
                                  product_title:
                                    type: string
                                    example: Product Title
                                  variant_title:
                                    type: string
                                    example: Variant Title
                                  option_titles:
                                    type: array
                                    example:
                                      - Option 1
                                      - Option 2
                                  quantity:
                                    type: integer
                                    example: 1
                                  display_to_customer:
                                    type: boolean
                                    example: true
                      ship_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      bill_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      shipping_method:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: string
                            example: standard-shipping
                          name:
                            type: string
                            example: Standard Shipping
                      available_shipping_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: standard-shipping
                            title:
                              type: string
                              example: Standard Shipping
                            price:
                              type:
                                - number
                                - string
                              example: 5.99
                            price_label:
                              type: string
                              example: $5.99
                            delivery_time_estimate:
                              type: string
                              example: 3-5 business days
                      available_payment_methods:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - credit_card
                                name:
                                  type: string
                                  example: Credit Card
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                apple_pay:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method supports
                                    ApplePay or not 
                                bogus_gateway:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is a Bogus
                                    instance or not.
                                tokenize_path:
                                  type:
                                    - string
                                    - 'null'
                                  description: Path to tokenize, if applicable.
                                token_provider:
                                  type: string
                                  enum:
                                    - spreedly
                                    - vgs
                                  description: >-
                                    Determines if payment tokenization is via
                                    spreedly or VGS
                                apple_pay_merchant_identifier:
                                  type:
                                    - string
                                    - 'null'
                                  example: merchant.mycompany.com
                                  description: >-
                                    If ApplePay is supported, returns the
                                    merchant identifier registered with Apple,
                                    else returns nil
                                supported_brands:
                                  type: array
                                  items:
                                    type: string
                                  example:
                                    - visa
                                    - master
                                    - american_express
                                    - discover
                                publishable_key:
                                  type:
                                    - string
                                    - 'null'
                                  example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                  description: >-
                                    If publishable key is set for Hyperswitch,
                                    returns the publishable key, else returns
                                    nil
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                              required:
                                - id
                                - type
                                - name
                                - supported_brands
                                - test
                                - sandbox
                                - apple_pay
                                - apple_pay_merchant_identifier
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - klarna
                                name:
                                  type: string
                                  example: Klarna
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                      country:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          iso:
                            type: string
                            example: US
                          name:
                            type: string
                            example: United States
                          iso_name:
                            type: string
                            example: UNITED STATES
                          iso3:
                            type: string
                            example: USA
                          currency_code:
                            type: string
                            example: USD
                          currency_symbol:
                            type: string
                            example: $
                          province_required:
                            type: boolean
                            example: false
                          tax_enabled:
                            type:
                              - boolean
                              - 'null'
                            example: true
                          price_inclusive_of_tax:
                            type: boolean
                            example: false
                          price_inclusive_tax_name:
                            type:
                              - string
                              - 'null'
                            example: VAT
                      type:
                        type: string
                        enum:
                          - regular
                          - enrollment
                        example: regular
                      enrollment_pack_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      enrollment_pack:
                        type:
                          - object
                          - 'null'
                        properties:
                          enrollment_pack_id:
                            type: integer
                            example: 1
                          additional_volume:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          slug:
                            type: string
                            example: test-enrollment-pack
                          description:
                            type:
                              - object
                              - 'null'
                              - string
                            properties:
                              id:
                                type: integer
                                example: 111
                              name:
                                type: string
                                example: description
                              body:
                                type: string
                                example: >-
                                  <div>Try the latest and greatest of our sugar
                                  zip packs. Guaranteed to make you skinner and
                                  cure cancer.</div>
                              record_type:
                                type: string
                                example: EnrollmentPack
                              record_id:
                                type: integer
                                example: 1
                              created_at:
                                type: string
                                format: date_time
                                example: '2025-01-16T04:22:43.809Z'
                              updated_at:
                                type: string
                                format: date_time
                                example: '2025-01-22T10:23:52.941Z'
                              locale:
                                type: string
                                example: en
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: 10
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.00
                          images:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2
                                relateable_type:
                                  type: string
                                  example: EnrollmentPack
                                relateable_id:
                                  type: integer
                                  example: 1
                                image_url:
                                  type: string
                                  example: >-
                                    https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                image_path:
                                  type: string
                                  example: jITWaU14QGe0y5AFgY7P_00179.svg
                                position:
                                  type: integer
                                  example: 1
                                shopify_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                                created_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                updated_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                external_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 625
                                allow_subscription:
                                  type: boolean
                                  example: true
                                cv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                cv_in_currency:
                                  type: string
                                  example: $0.00
                                cv_total:
                                  type: integer
                                  example: 0
                                enrollment:
                                  type: boolean
                                  example: true
                                enrollment_pack_id:
                                  type: integer
                                  example: 1
                                price:
                                  type: string
                                  example: '11.13'
                                price_in_currency:
                                  type: string
                                  example: $11.13
                                product_title:
                                  type: string
                                  example: Zip Pack Sample Pack (30)
                                quantity:
                                  type: integer
                                  example: 1
                                qv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                qv_in_currency:
                                  type: string
                                  example: $0.00
                                qv_total:
                                  type: integer
                                  example: 0
                                subscribe_and_save:
                                  type:
                                    - string
                                    - 'null'
                                  example: '-1988.87'
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $-1,988.87
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $-1,988.87
                                subscription:
                                  type: boolean
                                  example: false
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_only:
                                  type: boolean
                                  example: false
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_price:
                                  type: string
                                  example: '2000.0'
                                subscription_price_in_currency:
                                  type: string
                                  example: $2,000.00
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  format: date
                                  example: '2025-02-28'
                                tax:
                                  type: string
                                  example: '0.0'
                                tax_in_currency:
                                  type: string
                                  example: $0.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: null
                                display_to_customer:
                                  type: boolean
                                  example: false
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                          price:
                            type: string
                            example: '11.13'
                          price_in_currency:
                            type: string
                            example: $11.13
                          subscription_price:
                            type:
                              - string
                              - integer
                            example: 2000
                          subscription_price_in_currency:
                            type: string
                            example: $2,000.00
                          title:
                            type: string
                            example: enroll product
                          token:
                            type: string
                            example: NxL22AqLRRisfyF9LqxxWRak
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      recurring:
                        oneOf:
                          - type: array
                            items:
                              type: object
                              properties:
                                subtotal:
                                  type: string
                                  example: '10.0'
                                subtotal_in_currency:
                                  type: string
                                  example: $10.0
                                interval:
                                  type: integer
                                  example: 1
                                interval_unit:
                                  type: string
                                  example: month
                                subtotal_for_display:
                                  type: string
                                  example: $10.00 every 1 month
                                start_date:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-05-27'
                          - type: 'null'
                        default:
                          - subtotal: '10.0'
                            subtotal_in_currency: $10.0
                            interval: 1
                            interval_unit: month
                            subtotal_for_display: $10.00 every 1 month
                            start_date: '2025-05-27'
                      messages:
                        type: object
                        additionalProperties: true
                        example:
                          errors:
                            - Insufficient inventory
                            - Product no longer available
                          warnings:
                            - Low stock warning
                            - Shipping delays expected
                          info:
                            - Free shipping available
                            - Volume discount applied
                      points_enabled:
                        type: boolean
                        example: true
                      points_applied:
                        type: integer
                        example: 500
                        description: Number of points applied to the cart
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Currency value of applied points
                      customer_total_points:
                        type: integer
                        example: 1000
                        description: Customer's total available points balance
                      customer_total_points_in_currency:
                        type: number
                        example: 10
                        description: Currency value of available points
                      remaining_customer_points:
                        type: integer
                        example: 500
                        description: Customer's remaining points after cart redemption
                      remaining_customer_points_amount_in_currency:
                        type: number
                        example: 5
                        description: >-
                          Currency value of remaining points after cart
                          redemption
                      remaining_cart_amount_after_points:
                        type: number
                        example: 95
                        description: Amount to charge to card after points redemption
                      remaining_cart_amount_after_points_in_currency:
                        type:
                          - string
                        example: $95.00
                        description: >-
                          Amount in currency to charge to card after points
                          redemption
                      max_applicable_points:
                        type: integer
                        example: 500
                        description: Maximum points that can be applied to this cart
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      checkout_url:
                        type: string
                        example: https://checkout.fluid.com/checkout?jwt=abc123
                      shop_url:
                        type: string
                        example: https://myco.fluid.app
        '404':
          description: cart not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
                      example:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '410':
          description: cart is in authorized enrollment state
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Cart is in authorized state and cannot be modified
                  errors:
                    type: object
                    example:
                      cart:
                        - is in authorized state and cannot be modified
                  meta:
                    type: object
                    properties:
                      shop_url:
                        type: string
                        example: https://example.myshopify.com
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      cart:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 123
                          state:
                            type: string
                            example: start
                          processed:
                            type: boolean
                            example: false
                            description: >-
                              Determines if a cart payment has been processed or
                              not.
                          valid_for_checkout:
                            type: boolean
                            example: true
                          buyer_rep_id:
                            type:
                              - integer
                              - 'null'
                            example: 1
                          buyer_rep:
                            oneOf:
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 2
                                  email:
                                    type:
                                      - string
                                      - 'null'
                                    example: buyer.rep@example.com
                                  full_name:
                                    type:
                                      - string
                                      - 'null'
                                    example: John Doe
                                  image_url:
                                    type:
                                      - string
                                      - 'null'
                                    example: https://example.com/image.png
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: '123241'
                                required:
                                  - id
                              - type: 'null'
                          volume_rep:
                            oneOf:
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 2
                                  email:
                                    type:
                                      - string
                                      - 'null'
                                    example: volume.rep@example.com
                                  full_name:
                                    type:
                                      - string
                                      - 'null'
                                    example: John Doe
                                  image_url:
                                    type:
                                      - string
                                      - 'null'
                                    example: https://example.com/image.png
                                required:
                                  - id
                              - type: 'null'
                          currency_symbol:
                            type: string
                            example: $
                          currency_code:
                            type: string
                            example: USD
                          shipping_total_for_display:
                            type: string
                            example: Free
                          phone:
                            type:
                              - string
                              - 'null'
                            example: '4035551212'
                          payment_method_auto_assignable:
                            type: boolean
                            example: true
                            description: >-
                              Determines if a payment method can be
                              auto-assigned to the cart.
                          attribution:
                            oneOf:
                              - type: object
                                oneOf:
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      share_guid:
                                        type: string
                                        example: james-bond007
                                    required:
                                      - id
                                      - share_guid
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      email:
                                        type: string
                                        example: james.bond@gmail.com
                                    required:
                                      - id
                                      - email
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      username:
                                        type: string
                                        example: jaamball234
                                    required:
                                      - id
                                      - username
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      fluid_rep_id:
                                        type: integer
                                        example: 23493
                                    required:
                                      - id
                                      - fluid_rep_id
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      external_id:
                                        type:
                                          - string
                                          - 'null'
                                        example: w3sdf92
                                    required:
                                      - id
                              - type: 'null'
                            default:
                              id: 456
                              share_guid: james-bond007
                          agreements:
                            type: array
                            items:
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                  example: 1
                                required:
                                  type: boolean
                                  example: true
                                title:
                                  type: string
                                  example: Terms and Conditions
                                show_path:
                                  type: string
                                  example: /terms
                                enrollment_pack_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                          amount_total:
                            type: string
                            example: '121.65'
                          amount_total_in_currency:
                            type: string
                            example: $121.65 (USD)
                          sub_total:
                            type: string
                            example: '100.00'
                          sub_total_in_currency:
                            type: string
                            example: $100.00 (USD)
                          subtotal_after_discounts:
                            type: string
                            example: '90.00'
                          tax_total:
                            type: string
                            example: '20.00'
                          tax_total_in_currency:
                            type: string
                            example: $20.00 (USD)
                          shipping_total:
                            type:
                              - string
                              - 'null'
                            example: '1.65'
                          shipping_total_in_currency:
                            type: string
                            example: $1.65 (USD)
                          shipping_discount:
                            type: number
                            example: 10.25
                          discount_total:
                            type: string
                            example: '2.99'
                          discount_total_in_currency:
                            type: string
                            example: $2.99 (USD)
                          discount_breakdown:
                            type: object
                            properties:
                              internal_discounts:
                                type: number
                                example: 15
                              external_discounts:
                                type: number
                                example: 10
                              total_discounts:
                                type: number
                                example: 25
                          external_discount:
                            type: object
                            properties:
                              total:
                                type: number
                                example: 10
                              calculated_at:
                                type:
                                  - string
                                  - 'null'
                                format: date-time
                                example: '2024-01-10T15:30:00Z'
                              sources:
                                type: object
                                additionalProperties:
                                  type: object
                                  properties:
                                    amount:
                                      type: number
                                      example: 6
                                    description:
                                      type: string
                                      example: Gold tier discount
                                    metadata:
                                      type: object
                                  required:
                                    - amount
                                    - description
                          transaction_fee:
                            type:
                              - number
                              - string
                            example: '1.90'
                          transaction_fee_in_currency:
                            type: string
                            example: $1.90 (USD)
                          cv_total:
                            type: integer
                            example: 10
                          qv_total:
                            type: integer
                            example: 15
                          company:
                            type: object
                            properties:
                              id:
                                type: integer
                              name:
                                type: string
                              primary_domain_hostname:
                                type:
                                  - string
                                  - 'null'
                                example: fluid.com
                              subdomain:
                                type:
                                  - string
                                  - 'null'
                                example: myco
                              logo_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/logo.png
                              fluid_shop:
                                type:
                                  - string
                                  - 'null'
                                example: https://fluid-sample-shop.fluid.com
                              collect_phone:
                                type: boolean
                                example: true
                              require_phone:
                                type: boolean
                                example: false
                              require_billing_zip:
                                type: boolean
                                example: false
                              checkout_primary_button_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#000000'
                              checkout_primary_text_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#FFFFFF'
                              checkout_secondary_button_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#FFFFFF'
                              checkout_secondary_text_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#000000'
                              favicon_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/favicon.ico
                              order_on_behalf:
                                type: boolean
                                example: false
                              use_juspay_gateway:
                                type: boolean
                                example: false
                              reward_points_enabled:
                                type: boolean
                                example: false
                          payment_account:
                            type:
                              - string
                              - 'null'
                            example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                          payment_method:
                            oneOf:
                              - type: 'null'
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: CreditCard
                                  payment_method_type:
                                    type: string
                                    example: visa
                                  last_four:
                                    type: string
                                    example: '1234'
                                  exp_month:
                                    type: string
                                    example: '12'
                                  exp_year:
                                    type: string
                                    example: '2025'
                                  logo_url:
                                    type: string
                                    example: https://example.com/image.svg
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Paypal
                                  status:
                                    type: string
                                    example: active
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Affirm
                                  affirm_id:
                                    type: string
                                    example: affirm_123
                                  status:
                                    type: string
                                    example: authorized
                                  checkout_id:
                                    type: string
                                    example: checkout_456
                                  created:
                                    type: string
                                    example: '2025-01-01T00:00:00Z'
                                  auth_expiration:
                                    type: string
                                    example: '2025-01-02T00:00:00Z'
                                  currency:
                                    type: string
                                    example: USD
                                  amount:
                                    type: string
                                    example: '100.00'
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Klarna
                                  session_id:
                                    type: string
                                    example: klarna_session_789
                                  intent:
                                    type: string
                                    example: buy
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Droplet
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: SomeCitcon
                          email:
                            type:
                              - string
                              - 'null'
                            example: user@example.com
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: '10.45'
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.45
                          discount_codes:
                            type: array
                            items:
                              type: string
                            example:
                              - DISCOUNT10
                              - DISCOUNT11
                          language_iso:
                            type:
                              - string
                              - 'null'
                            example: en
                          cart_token:
                            type: string
                            example: abc123
                          immutable_items:
                            type: boolean
                            example: false
                          digital_only:
                            type: boolean
                            example: false
                          requires_3ds:
                            type: boolean
                            example: false
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 101
                                price:
                                  type: string
                                  example: '43.41'
                                price_in_currency:
                                  type: string
                                  example: $43.41
                                tax:
                                  type: string
                                  example: '2.99'
                                tax_in_currency:
                                  type: string
                                  example: $2.99
                                cv:
                                  type: integer
                                  example: 5
                                cv_total:
                                  type: integer
                                  example: 15
                                qv:
                                  type: integer
                                  example: 7
                                qv_total:
                                  type: integer
                                  example: 21
                                discount_amount:
                                  type: string
                                  example: '10'
                                free_item:
                                  type: boolean
                                  example: false
                                discount_amount_in_currency:
                                  type: string
                                  example: $10.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                enrollment_pack_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                display_to_customer:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                product_title:
                                  type:
                                    - string
                                    - 'null'
                                  example: Sample Product
                                quantity:
                                  type: integer
                                  example: 3
                                subscription:
                                  type: boolean
                                  example: true
                                enrollment:
                                  type: boolean
                                  example: false
                                allow_subscription:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_only:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_price:
                                  type:
                                    - number
                                    - string
                                    - 'null'
                                  example: 10.5
                                subscription_price_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $10.50
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-02-12'
                                subscribe_and_save:
                                  type:
                                    - number
                                    - string
                                    - 'null'
                                  example: 2.99
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $2.99
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $2.99
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: Surcharge
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                product:
                                  oneOf:
                                    - type: object
                                      properties:
                                        id:
                                          type: integer
                                          example: 1
                                        title:
                                          type: string
                                          example: Sample Product
                                        introduction:
                                          type:
                                            - string
                                            - 'null'
                                          example: Sample Product Description
                                        cv:
                                          type: integer
                                          example: 10
                                        external_id:
                                          type:
                                            - string
                                            - 'null'
                                          example: ext-prod-123
                                        image_path:
                                          type:
                                            - string
                                            - 'null'
                                          example: /images/product.png
                                        image_url:
                                          type:
                                            - string
                                            - 'null'
                                          example: https://example.com/images/product.png
                                        price:
                                          type: string
                                          example: '29.99'
                                        price_in_currency:
                                          type: string
                                          example: $29.99
                                        sku:
                                          type:
                                            - string
                                            - 'null'
                                          example: SKU12345
                                        tax:
                                          type: string
                                          example: '2.99'
                                        tax_in_currency:
                                          type: string
                                          example: $2.99
                                        metadata:
                                          type: object
                                          example:
                                            shopify_product_id: 9876054868270
                                        metafields:
                                          type: array
                                          items:
                                            title: LegacyMetafield
                                            type: object
                                            properties:
                                              namespace:
                                                description: >-
                                                  A container for related metafields.
                                                  Commonly used to group metafields by app
                                                  or functionality.
                                                example: custom
                                                type: string
                                                maxLength: 20
                                                pattern: ^[a-zA-Z0-9_]+$
                                              key:
                                                description: >-
                                                  The unique identifier for the metafield
                                                  within its namespace. Must be unique per
                                                  namespace and owner.
                                                example: material
                                                type: string
                                                maxLength: 30
                                                pattern: ^[a-zA-Z0-9_]+$
                                              value:
                                                description: >-
                                                  The actual data stored in the metafield.
                                                  Type depends on value_type.
                                                example: cotton
                                                type:
                                                  - string
                                                  - integer
                                                  - object
                                                  - boolean
                                                  - number
                                              value_type:
                                                description: >-
                                                  The data type that defines how the value
                                                  should be interpreted and validated.
                                                example: single_line_text_field
                                                type: string
                                              description:
                                                description: >-
                                                  Optional human-readable description
                                                  explaining the purpose of this
                                                  metafield.
                                                example: >-
                                                  The primary material used in this
                                                  product
                                                type:
                                                  - string
                                                  - 'null'
                                              created_at:
                                                description: >-
                                                  Timestamp when the metafield was
                                                  created.
                                                example: '2021-01-01T00:00:00Z'
                                                type: string
                                                format: date-time
                                              updated_at:
                                                description: >-
                                                  Timestamp when the metafield was last
                                                  updated.
                                                example: '2021-01-01T00:00:00Z'
                                                type: string
                                                format: date-time
                                              locked:
                                                description: >-
                                                  Whether this metafield is locked and
                                                  cannot be updated or deleted directly.
                                                example: false
                                                type:
                                                  - boolean
                                                  - 'null'
                                                  - 'null'
                                              metafield_definition:
                                                description: >-
                                                  The definition that defines validation
                                                  rules and structure for this metafield
                                                type:
                                                  - 'null'
                                                  - object
                                            required:
                                              - namespace
                                              - key
                                              - value
                                              - value_type
                                              - description
                                              - created_at
                                              - updated_at
                                              - metafield_definition
                                    - type: 'null'
                                variant:
                                  oneOf:
                                    - type: object
                                      properties:
                                        id:
                                          type: integer
                                          example: 1
                                        title:
                                          type:
                                            - string
                                            - 'null'
                                          example: Sample Variant
                                        image_path:
                                          type:
                                            - string
                                            - 'null'
                                          example: /images/sample.png
                                        image_url:
                                          type:
                                            - string
                                            - 'null'
                                          example: https://example.com/images/sample.png
                                        primary_image:
                                          type:
                                            - string
                                            - 'null'
                                          example: https://example.com/images/primary.png
                                        price:
                                          type:
                                            - string
                                            - 'null'
                                          example: '34.44'
                                        price_in_currency:
                                          type:
                                            - string
                                            - 'null'
                                          example: $34.44
                                        sku:
                                          type:
                                            - string
                                            - 'null'
                                          example: SKU12345
                                        options:
                                          type: array
                                          items:
                                            type: object
                                            properties:
                                              title:
                                                type: string
                                                example: Size
                                              value:
                                                type: string
                                                example: XL
                                        physical:
                                          type:
                                            - boolean
                                            - 'null'
                                          example: true
                                        unit_of_size:
                                          type:
                                            - string
                                            - 'null'
                                          example: cm
                                        height:
                                          type:
                                            - number
                                            - 'null'
                                          example: 13
                                        width:
                                          type:
                                            - number
                                            - 'null'
                                          example: 6
                                        length:
                                          type:
                                            - number
                                            - 'null'
                                          example: 12
                                        unit_of_weight:
                                          type:
                                            - string
                                            - 'null'
                                          example: kg
                                        weight:
                                          type:
                                            - string
                                            - 'null'
                                          example: '3.2'
                                        hs_code:
                                          type:
                                            - string
                                            - 'null'
                                          example: '3.2'
                                    - type: 'null'
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                                bundled_items:
                                  type: array
                                  items:
                                    type: object
                                    description: Bundled items for bundle products
                                    properties:
                                      variant_id:
                                        type: integer
                                        example: 1
                                      product_id:
                                        type: integer
                                        example: 1
                                      product_title:
                                        type: string
                                        example: Product Title
                                      variant_title:
                                        type: string
                                        example: Variant Title
                                      option_titles:
                                        type: array
                                        example:
                                          - Option 1
                                          - Option 2
                                      quantity:
                                        type: integer
                                        example: 1
                                      display_to_customer:
                                        type: boolean
                                        example: true
                          ship_to:
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                                example: 1
                              name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              first_name:
                                type:
                                  - string
                                  - 'null'
                                example: John
                              last_name:
                                type:
                                  - string
                                  - 'null'
                                example: Doe
                              address1:
                                type: string
                                example: 123 Main St
                              address2:
                                type:
                                  - string
                                  - 'null'
                                example: Apt 4B
                              address3:
                                type:
                                  - string
                                  - 'null'
                                example: Building 5
                              city:
                                type: string
                                example: New York
                              state:
                                type: string
                                example: NY
                              postal_code:
                                type: string
                                example: '10001'
                              country_code:
                                type: string
                                example: US
                                description: >-
                                  country_id takes precedence if both country_id
                                  and country_code provided.
                              subdivision_code:
                                type:
                                  - string
                                  - 'null'
                                example: NY
                              default:
                                type: boolean
                                example: true
                          bill_to:
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                                example: 1
                              name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              first_name:
                                type:
                                  - string
                                  - 'null'
                                example: John
                              last_name:
                                type:
                                  - string
                                  - 'null'
                                example: Doe
                              address1:
                                type: string
                                example: 123 Main St
                              address2:
                                type:
                                  - string
                                  - 'null'
                                example: Apt 4B
                              address3:
                                type:
                                  - string
                                  - 'null'
                                example: Building 5
                              city:
                                type: string
                                example: New York
                              state:
                                type: string
                                example: NY
                              postal_code:
                                type: string
                                example: '10001'
                              country_code:
                                type: string
                                example: US
                                description: >-
                                  country_id takes precedence if both country_id
                                  and country_code provided.
                              subdivision_code:
                                type:
                                  - string
                                  - 'null'
                                example: NY
                              default:
                                type: boolean
                                example: true
                          shipping_method:
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: string
                                example: standard-shipping
                              name:
                                type: string
                                example: Standard Shipping
                          available_shipping_methods:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                  example: standard-shipping
                                title:
                                  type: string
                                  example: Standard Shipping
                                price:
                                  type:
                                    - number
                                    - string
                                  example: 5.99
                                price_label:
                                  type: string
                                  example: $5.99
                                delivery_time_estimate:
                                  type: string
                                  example: 3-5 business days
                          available_payment_methods:
                            type: array
                            items:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1337
                                    uuid:
                                      type: string
                                      example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                    type:
                                      type: string
                                      enum:
                                        - credit_card
                                    name:
                                      type: string
                                      example: Credit Card
                                    image_url:
                                      type: string
                                      example: https://example.com/image.png
                                    test:
                                      type: boolean
                                      example: true
                                      description: >-
                                        Determines if payment method is test
                                        instance or not. By default, set to
                                        `true`
                                    sandbox:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method is sandbox
                                        instance or not. By default, set to
                                        `false`
                                    apple_pay:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method supports
                                        ApplePay or not 
                                    bogus_gateway:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method is a Bogus
                                        instance or not.
                                    tokenize_path:
                                      type:
                                        - string
                                        - 'null'
                                      description: Path to tokenize, if applicable.
                                    token_provider:
                                      type: string
                                      enum:
                                        - spreedly
                                        - vgs
                                      description: >-
                                        Determines if payment tokenization is
                                        via spreedly or VGS
                                    apple_pay_merchant_identifier:
                                      type:
                                        - string
                                        - 'null'
                                      example: merchant.mycompany.com
                                      description: >-
                                        If ApplePay is supported, returns the
                                        merchant identifier registered with
                                        Apple, else returns nil
                                    supported_brands:
                                      type: array
                                      items:
                                        type: string
                                      example:
                                        - visa
                                        - master
                                        - american_express
                                        - discover
                                    publishable_key:
                                      type:
                                        - string
                                        - 'null'
                                      example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                      description: >-
                                        If publishable key is set for
                                        Hyperswitch, returns the publishable
                                        key, else returns nil
                                    customer_details_schema:
                                      type: object
                                      example: {}
                                      description: >-
                                        Schema defining required customer
                                        details for this payment method
                                  required:
                                    - id
                                    - type
                                    - name
                                    - supported_brands
                                    - test
                                    - sandbox
                                    - apple_pay
                                    - apple_pay_merchant_identifier
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1337
                                    uuid:
                                      type: string
                                      example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                    type:
                                      type: string
                                      enum:
                                        - klarna
                                    name:
                                      type: string
                                      example: Klarna
                                    image_url:
                                      type: string
                                      example: https://example.com/image.png
                                    test:
                                      type: boolean
                                      example: true
                                      description: >-
                                        Determines if payment method is test
                                        instance or not. By default, set to
                                        `true`
                                    sandbox:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method is sandbox
                                        instance or not. By default, set to
                                        `false`
                                    customer_details_schema:
                                      type: object
                                      example: {}
                                      description: >-
                                        Schema defining required customer
                                        details for this payment method
                          country:
                            type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              iso:
                                type: string
                                example: US
                              name:
                                type: string
                                example: United States
                              iso_name:
                                type: string
                                example: UNITED STATES
                              iso3:
                                type: string
                                example: USA
                              currency_code:
                                type: string
                                example: USD
                              currency_symbol:
                                type: string
                                example: $
                              province_required:
                                type: boolean
                                example: false
                              tax_enabled:
                                type:
                                  - boolean
                                  - 'null'
                                example: true
                              price_inclusive_of_tax:
                                type: boolean
                                example: false
                              price_inclusive_tax_name:
                                type:
                                  - string
                                  - 'null'
                                example: VAT
                          type:
                            type: string
                            enum:
                              - regular
                              - enrollment
                            example: regular
                          enrollment_pack_id:
                            type:
                              - integer
                              - 'null'
                            example: 1
                          enrollment_pack:
                            type:
                              - object
                              - 'null'
                            properties:
                              enrollment_pack_id:
                                type: integer
                                example: 1
                              additional_volume:
                                type:
                                  - integer
                                  - 'null'
                                example: 10
                              slug:
                                type: string
                                example: test-enrollment-pack
                              description:
                                type:
                                  - object
                                  - 'null'
                                  - string
                                properties:
                                  id:
                                    type: integer
                                    example: 111
                                  name:
                                    type: string
                                    example: description
                                  body:
                                    type: string
                                    example: >-
                                      <div>Try the latest and greatest of our
                                      sugar zip packs. Guaranteed to make you
                                      skinner and cure cancer.</div>
                                  record_type:
                                    type: string
                                    example: EnrollmentPack
                                  record_id:
                                    type: integer
                                    example: 1
                                  created_at:
                                    type: string
                                    format: date_time
                                    example: '2025-01-16T04:22:43.809Z'
                                  updated_at:
                                    type: string
                                    format: date_time
                                    example: '2025-01-22T10:23:52.941Z'
                                  locale:
                                    type: string
                                    example: en
                              enrollment_fee:
                                type:
                                  - number
                                  - string
                                example: 10
                              enrollment_fee_in_currency:
                                type: string
                                example: $10.00
                              images:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 2
                                    relateable_type:
                                      type: string
                                      example: EnrollmentPack
                                    relateable_id:
                                      type: integer
                                      example: 1
                                    image_url:
                                      type: string
                                      example: >-
                                        https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                    image_path:
                                      type: string
                                      example: jITWaU14QGe0y5AFgY7P_00179.svg
                                    position:
                                      type: integer
                                      example: 1
                                    shopify_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: null
                                    created_at:
                                      type: string
                                      format: date_time
                                      example: '2025-01-16T04:22:44.870Z'
                                    updated_at:
                                      type: string
                                      format: date_time
                                      example: '2025-01-16T04:22:44.870Z'
                                    external_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: null
                              items:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 625
                                    allow_subscription:
                                      type: boolean
                                      example: true
                                    cv:
                                      type:
                                        - number
                                        - string
                                      example: 0
                                    cv_in_currency:
                                      type: string
                                      example: $0.00
                                    cv_total:
                                      type: integer
                                      example: 0
                                    enrollment:
                                      type: boolean
                                      example: true
                                    enrollment_pack_id:
                                      type: integer
                                      example: 1
                                    price:
                                      type: string
                                      example: '11.13'
                                    price_in_currency:
                                      type: string
                                      example: $11.13
                                    product_title:
                                      type: string
                                      example: Zip Pack Sample Pack (30)
                                    quantity:
                                      type: integer
                                      example: 1
                                    qv:
                                      type:
                                        - number
                                        - string
                                      example: 0
                                    qv_in_currency:
                                      type: string
                                      example: $0.00
                                    qv_total:
                                      type: integer
                                      example: 0
                                    subscribe_and_save:
                                      type:
                                        - string
                                        - 'null'
                                      example: '-1988.87'
                                    subscribe_and_save_for_display:
                                      type:
                                        - string
                                        - 'null'
                                      example: Subscribe and save $-1,988.87
                                    subscribe_and_save_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $-1,988.87
                                    subscription:
                                      type: boolean
                                      example: false
                                    subscription_interval:
                                      type:
                                        - integer
                                        - 'null'
                                      example: 1
                                    subscription_interval_unit:
                                      type:
                                        - string
                                        - 'null'
                                      example: month
                                    subscription_only:
                                      type: boolean
                                      example: false
                                    subscription_plan_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: 1
                                    subscription_plans:
                                      oneOf:
                                        - type: array
                                          items:
                                            title: Commerce::SubscriptionPlan
                                            type: object
                                            properties:
                                              id:
                                                type: integer
                                              name:
                                                example: Test Subscription Plan
                                                type: string
                                              billing_interval:
                                                example: 1
                                                type: integer
                                                default: 1
                                                minimum: 1
                                                maximum: 29
                                              billing_interval_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type: string
                                                default: month
                                              billing_frequency_in_words:
                                                example: 2 Months
                                                type: string
                                              shipping_interval:
                                                example: 1
                                                type: integer
                                                default: 1
                                                minimum: 1
                                                maximum: 29
                                              shipping_interval_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type: string
                                                default: month
                                              volume_interval:
                                                example: 1
                                                type: integer
                                                default: 1
                                                minimum: 1
                                                maximum: 29
                                              volume_interval_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type: string
                                                default: month
                                              trial_period:
                                                example: 1
                                                type:
                                                  - integer
                                                  - 'null'
                                                minimum: 1
                                              trial_period_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type:
                                                  - string
                                                  - 'null'
                                              split_volume:
                                                example: true
                                                type: boolean
                                                default: false
                                              allow_max_billing_cycles:
                                                example: true
                                                type: boolean
                                                default: false
                                              max_billing_cycles:
                                                example: 3
                                                type:
                                                  - integer
                                                  - 'null'
                                              company_default:
                                                example: false
                                                type:
                                                  - boolean
                                                  - 'null'
                                                default: false
                                              products_count:
                                                example: 10
                                                type:
                                                  - integer
                                                  - 'null'
                                              subscribers_count:
                                                example: 10
                                                type:
                                                  - integer
                                                  - 'null'
                                              price:
                                                type: string
                                              price_in_currency:
                                                type: string
                                              subscription_start:
                                                type: string
                                              subscribe_and_save:
                                                type:
                                                  - string
                                                  - 'null'
                                              subscribe_and_save_in_currency:
                                                type:
                                                  - string
                                                  - 'null'
                                              subscribe_and_save_for_display:
                                                type:
                                                  - string
                                                  - 'null'
                                            required:
                                              - id
                                              - name
                                              - billing_interval
                                              - billing_interval_unit
                                              - billing_frequency_in_words
                                              - shipping_interval
                                              - shipping_interval_unit
                                              - volume_interval
                                              - volume_interval_unit
                                              - split_volume
                                              - allow_max_billing_cycles
                                              - price
                                              - price_in_currency
                                              - subscription_start
                                              - subscribe_and_save
                                              - subscribe_and_save_in_currency
                                              - subscribe_and_save_for_display
                                        - type: 'null'
                                    subscription_price:
                                      type: string
                                      example: '2000.0'
                                    subscription_price_in_currency:
                                      type: string
                                      example: $2,000.00
                                    subscription_start:
                                      type:
                                        - string
                                        - 'null'
                                      format: date
                                      example: '2025-02-28'
                                    tax:
                                      type: string
                                      example: '0.0'
                                    tax_in_currency:
                                      type: string
                                      example: $0.00
                                    total_after_discounts:
                                      type: string
                                      example: '90.00'
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: null
                                    display_to_customer:
                                      type: boolean
                                      example: false
                                    metadata:
                                      type: object
                                      description: >-
                                        A JSON object that can store any custom
                                        data structure
                                      example: {}
                                    errors:
                                      oneOf:
                                        - type: 'null'
                                        - type: array
                                          items:
                                            type: object
                                          example:
                                            - country:
                                                - >-
                                                  This product is not available for this
                                                  country. Please change your country
                              price:
                                type: string
                                example: '11.13'
                              price_in_currency:
                                type: string
                                example: $11.13
                              subscription_price:
                                type:
                                  - string
                                  - integer
                                example: 2000
                              subscription_price_in_currency:
                                type: string
                                example: $2,000.00
                              title:
                                type: string
                                example: enroll product
                              token:
                                type: string
                                example: NxL22AqLRRisfyF9LqxxWRak
                          metadata:
                            type: object
                            description: >-
                              A JSON object that can store any custom data
                              structure.
                          recurring:
                            oneOf:
                              - type: array
                                items:
                                  type: object
                                  properties:
                                    subtotal:
                                      type: string
                                      example: '10.0'
                                    subtotal_in_currency:
                                      type: string
                                      example: $10.0
                                    interval:
                                      type: integer
                                      example: 1
                                    interval_unit:
                                      type: string
                                      example: month
                                    subtotal_for_display:
                                      type: string
                                      example: $10.00 every 1 month
                                    start_date:
                                      type:
                                        - string
                                        - 'null'
                                      example: '2025-05-27'
                              - type: 'null'
                            default:
                              - subtotal: '10.0'
                                subtotal_in_currency: $10.0
                                interval: 1
                                interval_unit: month
                                subtotal_for_display: $10.00 every 1 month
                                start_date: '2025-05-27'
                          messages:
                            type: object
                            additionalProperties: true
                            example:
                              errors:
                                - Insufficient inventory
                                - Product no longer available
                              warnings:
                                - Low stock warning
                                - Shipping delays expected
                              info:
                                - Free shipping available
                                - Volume discount applied
                          points_enabled:
                            type: boolean
                            example: true
                          points_applied:
                            type: integer
                            example: 500
                            description: Number of points applied to the cart
                          points_applied_amount_in_currency:
                            type: number
                            example: 5
                            description: Currency value of applied points
                          customer_total_points:
                            type: integer
                            example: 1000
                            description: Customer's total available points balance
                          customer_total_points_in_currency:
                            type: number
                            example: 10
                            description: Currency value of available points
                          remaining_customer_points:
                            type: integer
                            example: 500
                            description: Customer's remaining points after cart redemption
                          remaining_customer_points_amount_in_currency:
                            type: number
                            example: 5
                            description: >-
                              Currency value of remaining points after cart
                              redemption
                          remaining_cart_amount_after_points:
                            type: number
                            example: 95
                            description: Amount to charge to card after points redemption
                          remaining_cart_amount_after_points_in_currency:
                            type:
                              - string
                            example: $95.00
                            description: >-
                              Amount in currency to charge to card after points
                              redemption
                          max_applicable_points:
                            type: integer
                            example: 500
                            description: Maximum points that can be applied to this cart
                required:
                  - error_message
                  - errors
                  - meta
  /api/carts/{cart_token}/update_cart_items_prices:
    patch:
      summary: Update cart items prices
      tags:
        - Carts
      operationId: updateCartItemsPrices
      security:
        - bearer_auth: []
      parameters:
        - name: cart_token
          in: path
          required: true
          description: Cart token
          schema:
            type: string
      responses:
        '200':
          description: filters out non-existent cart items and updates only matching ones
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    type: object
                    properties:
                      cart_token:
                        type: string
                      metadata:
                        type: object
                        properties:
                          cart_item_price_updates:
                            type: object
                          cart_item_price_updates_timestamp:
                            type: string
                          cart_item_price_updates_log:
                            type: array
                        additionalProperties: true
                    additionalProperties: true
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
                required:
                  - cart
                  - meta
        '401':
          description: unauthorized - no bearer token
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                required:
                  - message
        '422':
          description: cart is immutable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Cart is immutable and cannot be modified
                  errors:
                    type: array
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                cart_items:
                  type: array
                  description: Array of cart items with their new prices
                  items:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                        description: Cart item ID
                      price:
                        type: number
                        format: decimal
                        example: 29.99
                        description: New price for the cart item
                    required:
                      - id
                      - price
              required:
                - cart_items
  /api/carts/{cart_token}/update_totals:
    patch:
      summary: Updates cart totals manually
      tags:
        - Carts
      description: >-
        Manually updates cart totals such as discount, tax, shipping, amount,
        and transaction fee. This will always skips internal tax and shipping
        calculations to preserve the manual values. This is useful for external
        integrations that need to override calculated totals.
      operationId: updateCartTotals
      security:
        - bearer_auth: []
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: cart totals updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      state:
                        type: string
                        example: start
                      processed:
                        type: boolean
                        example: false
                        description: >-
                          Determines if a cart payment has been processed or
                          not.
                      valid_for_checkout:
                        type: boolean
                        example: true
                      buyer_rep_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      buyer_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: buyer.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                              external_id:
                                type:
                                  - string
                                  - 'null'
                                example: '123241'
                            required:
                              - id
                          - type: 'null'
                      volume_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: volume.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                            required:
                              - id
                          - type: 'null'
                      currency_symbol:
                        type: string
                        example: $
                      currency_code:
                        type: string
                        example: USD
                      shipping_total_for_display:
                        type: string
                        example: Free
                      phone:
                        type:
                          - string
                          - 'null'
                        example: '4035551212'
                      payment_method_auto_assignable:
                        type: boolean
                        example: true
                        description: >-
                          Determines if a payment method can be auto-assigned to
                          the cart.
                      attribution:
                        oneOf:
                          - type: object
                            oneOf:
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  share_guid:
                                    type: string
                                    example: james-bond007
                                required:
                                  - id
                                  - share_guid
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  email:
                                    type: string
                                    example: james.bond@gmail.com
                                required:
                                  - id
                                  - email
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  username:
                                    type: string
                                    example: jaamball234
                                required:
                                  - id
                                  - username
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  fluid_rep_id:
                                    type: integer
                                    example: 23493
                                required:
                                  - id
                                  - fluid_rep_id
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: w3sdf92
                                required:
                                  - id
                          - type: 'null'
                        default:
                          id: 456
                          share_guid: james-bond007
                      agreements:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            required:
                              type: boolean
                              example: true
                            title:
                              type: string
                              example: Terms and Conditions
                            show_path:
                              type: string
                              example: /terms
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                      amount_total:
                        type: string
                        example: '121.65'
                      amount_total_in_currency:
                        type: string
                        example: $121.65 (USD)
                      sub_total:
                        type: string
                        example: '100.00'
                      sub_total_in_currency:
                        type: string
                        example: $100.00 (USD)
                      subtotal_after_discounts:
                        type: string
                        example: '90.00'
                      tax_total:
                        type: string
                        example: '20.00'
                      tax_total_in_currency:
                        type: string
                        example: $20.00 (USD)
                      shipping_total:
                        type:
                          - string
                          - 'null'
                        example: '1.65'
                      shipping_total_in_currency:
                        type: string
                        example: $1.65 (USD)
                      shipping_discount:
                        type: number
                        example: 10.25
                      discount_total:
                        type: string
                        example: '2.99'
                      discount_total_in_currency:
                        type: string
                        example: $2.99 (USD)
                      discount_breakdown:
                        type: object
                        properties:
                          internal_discounts:
                            type: number
                            example: 15
                          external_discounts:
                            type: number
                            example: 10
                          total_discounts:
                            type: number
                            example: 25
                      external_discount:
                        type: object
                        properties:
                          total:
                            type: number
                            example: 10
                          calculated_at:
                            type:
                              - string
                              - 'null'
                            format: date-time
                            example: '2024-01-10T15:30:00Z'
                          sources:
                            type: object
                            additionalProperties:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 6
                                description:
                                  type: string
                                  example: Gold tier discount
                                metadata:
                                  type: object
                              required:
                                - amount
                                - description
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: '1.90'
                      transaction_fee_in_currency:
                        type: string
                        example: $1.90 (USD)
                      cv_total:
                        type: integer
                        example: 10
                      qv_total:
                        type: integer
                        example: 15
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      payment_account:
                        type:
                          - string
                          - 'null'
                        example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                      payment_method:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: CreditCard
                              payment_method_type:
                                type: string
                                example: visa
                              last_four:
                                type: string
                                example: '1234'
                              exp_month:
                                type: string
                                example: '12'
                              exp_year:
                                type: string
                                example: '2025'
                              logo_url:
                                type: string
                                example: https://example.com/image.svg
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Paypal
                              status:
                                type: string
                                example: active
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Affirm
                              affirm_id:
                                type: string
                                example: affirm_123
                              status:
                                type: string
                                example: authorized
                              checkout_id:
                                type: string
                                example: checkout_456
                              created:
                                type: string
                                example: '2025-01-01T00:00:00Z'
                              auth_expiration:
                                type: string
                                example: '2025-01-02T00:00:00Z'
                              currency:
                                type: string
                                example: USD
                              amount:
                                type: string
                                example: '100.00'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Klarna
                              session_id:
                                type: string
                                example: klarna_session_789
                              intent:
                                type: string
                                example: buy
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Droplet
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: SomeCitcon
                      email:
                        type:
                          - string
                          - 'null'
                        example: user@example.com
                      enrollment_fee:
                        type:
                          - number
                          - string
                        example: '10.45'
                      enrollment_fee_in_currency:
                        type: string
                        example: $10.45
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT10
                          - DISCOUNT11
                      language_iso:
                        type:
                          - string
                          - 'null'
                        example: en
                      cart_token:
                        type: string
                        example: abc123
                      immutable_items:
                        type: boolean
                        example: false
                      digital_only:
                        type: boolean
                        example: false
                      requires_3ds:
                        type: boolean
                        example: false
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 101
                            price:
                              type: string
                              example: '43.41'
                            price_in_currency:
                              type: string
                              example: $43.41
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            cv:
                              type: integer
                              example: 5
                            cv_total:
                              type: integer
                              example: 15
                            qv:
                              type: integer
                              example: 7
                            qv_total:
                              type: integer
                              example: 21
                            discount_amount:
                              type: string
                              example: '10'
                            free_item:
                              type: boolean
                              example: false
                            discount_amount_in_currency:
                              type: string
                              example: $10.00
                            total_after_discounts:
                              type: string
                              example: '90.00'
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            product_title:
                              type:
                                - string
                                - 'null'
                              example: Sample Product
                            quantity:
                              type: integer
                              example: 3
                            subscription:
                              type: boolean
                              example: true
                            enrollment:
                              type: boolean
                              example: false
                            allow_subscription:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_plan_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_plans:
                              oneOf:
                                - type: array
                                  items:
                                    title: Commerce::SubscriptionPlan
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        example: Test Subscription Plan
                                        type: string
                                      billing_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      billing_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      billing_frequency_in_words:
                                        example: 2 Months
                                        type: string
                                      shipping_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      shipping_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      volume_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      volume_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      trial_period:
                                        example: 1
                                        type:
                                          - integer
                                          - 'null'
                                        minimum: 1
                                      trial_period_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type:
                                          - string
                                          - 'null'
                                      split_volume:
                                        example: true
                                        type: boolean
                                        default: false
                                      allow_max_billing_cycles:
                                        example: true
                                        type: boolean
                                        default: false
                                      max_billing_cycles:
                                        example: 3
                                        type:
                                          - integer
                                          - 'null'
                                      company_default:
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                        default: false
                                      products_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      subscribers_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      price:
                                        type: string
                                      price_in_currency:
                                        type: string
                                      subscription_start:
                                        type: string
                                      subscribe_and_save:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_in_currency:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_for_display:
                                        type:
                                          - string
                                          - 'null'
                                    required:
                                      - id
                                      - name
                                      - billing_interval
                                      - billing_interval_unit
                                      - billing_frequency_in_words
                                      - shipping_interval
                                      - shipping_interval_unit
                                      - volume_interval
                                      - volume_interval_unit
                                      - split_volume
                                      - allow_max_billing_cycles
                                      - price
                                      - price_in_currency
                                      - subscription_start
                                      - subscribe_and_save
                                      - subscribe_and_save_in_currency
                                      - subscribe_and_save_for_display
                                - type: 'null'
                            subscription_only:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_interval:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_interval_unit:
                              type:
                                - string
                                - 'null'
                              example: month
                            subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 10.5
                            subscription_price_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $10.50
                            subscription_start:
                              type:
                                - string
                                - 'null'
                              example: '2025-02-12'
                            subscribe_and_save:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 2.99
                            subscribe_and_save_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $2.99
                            subscribe_and_save_for_display:
                              type:
                                - string
                                - 'null'
                              example: Subscribe and save $2.99
                            title:
                              type:
                                - string
                                - 'null'
                              example: Surcharge
                            metadata:
                              type: object
                              description: >-
                                A JSON object that can store any custom data
                                structure
                              example: {}
                            product:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type: string
                                      example: Sample Product
                                    introduction:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Product Description
                                    cv:
                                      type: integer
                                      example: 10
                                    external_id:
                                      type:
                                        - string
                                        - 'null'
                                      example: ext-prod-123
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/product.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/product.png
                                    price:
                                      type: string
                                      example: '29.99'
                                    price_in_currency:
                                      type: string
                                      example: $29.99
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    tax:
                                      type: string
                                      example: '2.99'
                                    tax_in_currency:
                                      type: string
                                      example: $2.99
                                    metadata:
                                      type: object
                                      example:
                                        shopify_product_id: 9876054868270
                                    metafields:
                                      type: array
                                      items:
                                        title: LegacyMetafield
                                        type: object
                                        properties:
                                          namespace:
                                            description: >-
                                              A container for related metafields.
                                              Commonly used to group metafields by app
                                              or functionality.
                                            example: custom
                                            type: string
                                            maxLength: 20
                                            pattern: ^[a-zA-Z0-9_]+$
                                          key:
                                            description: >-
                                              The unique identifier for the metafield
                                              within its namespace. Must be unique per
                                              namespace and owner.
                                            example: material
                                            type: string
                                            maxLength: 30
                                            pattern: ^[a-zA-Z0-9_]+$
                                          value:
                                            description: >-
                                              The actual data stored in the metafield.
                                              Type depends on value_type.
                                            example: cotton
                                            type:
                                              - string
                                              - integer
                                              - object
                                              - boolean
                                              - number
                                          value_type:
                                            description: >-
                                              The data type that defines how the value
                                              should be interpreted and validated.
                                            example: single_line_text_field
                                            type: string
                                          description:
                                            description: >-
                                              Optional human-readable description
                                              explaining the purpose of this
                                              metafield.
                                            example: >-
                                              The primary material used in this
                                              product
                                            type:
                                              - string
                                              - 'null'
                                          created_at:
                                            description: >-
                                              Timestamp when the metafield was
                                              created.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          updated_at:
                                            description: >-
                                              Timestamp when the metafield was last
                                              updated.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          locked:
                                            description: >-
                                              Whether this metafield is locked and
                                              cannot be updated or deleted directly.
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                              - 'null'
                                          metafield_definition:
                                            description: >-
                                              The definition that defines validation
                                              rules and structure for this metafield
                                            type:
                                              - 'null'
                                              - object
                                        required:
                                          - namespace
                                          - key
                                          - value
                                          - value_type
                                          - description
                                          - created_at
                                          - updated_at
                                          - metafield_definition
                                - type: 'null'
                            variant:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Variant
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/sample.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/sample.png
                                    primary_image:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/primary.png
                                    price:
                                      type:
                                        - string
                                        - 'null'
                                      example: '34.44'
                                    price_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $34.44
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    options:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          title:
                                            type: string
                                            example: Size
                                          value:
                                            type: string
                                            example: XL
                                    physical:
                                      type:
                                        - boolean
                                        - 'null'
                                      example: true
                                    unit_of_size:
                                      type:
                                        - string
                                        - 'null'
                                      example: cm
                                    height:
                                      type:
                                        - number
                                        - 'null'
                                      example: 13
                                    width:
                                      type:
                                        - number
                                        - 'null'
                                      example: 6
                                    length:
                                      type:
                                        - number
                                        - 'null'
                                      example: 12
                                    unit_of_weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: kg
                                    weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                    hs_code:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                - type: 'null'
                            errors:
                              oneOf:
                                - type: 'null'
                                - type: array
                                  items:
                                    type: object
                                  example:
                                    - country:
                                        - >-
                                          This product is not available for this
                                          country. Please change your country
                            bundled_items:
                              type: array
                              items:
                                type: object
                                description: Bundled items for bundle products
                                properties:
                                  variant_id:
                                    type: integer
                                    example: 1
                                  product_id:
                                    type: integer
                                    example: 1
                                  product_title:
                                    type: string
                                    example: Product Title
                                  variant_title:
                                    type: string
                                    example: Variant Title
                                  option_titles:
                                    type: array
                                    example:
                                      - Option 1
                                      - Option 2
                                  quantity:
                                    type: integer
                                    example: 1
                                  display_to_customer:
                                    type: boolean
                                    example: true
                      ship_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      bill_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      shipping_method:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: string
                            example: standard-shipping
                          name:
                            type: string
                            example: Standard Shipping
                      available_shipping_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: standard-shipping
                            title:
                              type: string
                              example: Standard Shipping
                            price:
                              type:
                                - number
                                - string
                              example: 5.99
                            price_label:
                              type: string
                              example: $5.99
                            delivery_time_estimate:
                              type: string
                              example: 3-5 business days
                      available_payment_methods:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - credit_card
                                name:
                                  type: string
                                  example: Credit Card
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                apple_pay:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method supports
                                    ApplePay or not 
                                bogus_gateway:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is a Bogus
                                    instance or not.
                                tokenize_path:
                                  type:
                                    - string
                                    - 'null'
                                  description: Path to tokenize, if applicable.
                                token_provider:
                                  type: string
                                  enum:
                                    - spreedly
                                    - vgs
                                  description: >-
                                    Determines if payment tokenization is via
                                    spreedly or VGS
                                apple_pay_merchant_identifier:
                                  type:
                                    - string
                                    - 'null'
                                  example: merchant.mycompany.com
                                  description: >-
                                    If ApplePay is supported, returns the
                                    merchant identifier registered with Apple,
                                    else returns nil
                                supported_brands:
                                  type: array
                                  items:
                                    type: string
                                  example:
                                    - visa
                                    - master
                                    - american_express
                                    - discover
                                publishable_key:
                                  type:
                                    - string
                                    - 'null'
                                  example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                  description: >-
                                    If publishable key is set for Hyperswitch,
                                    returns the publishable key, else returns
                                    nil
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                              required:
                                - id
                                - type
                                - name
                                - supported_brands
                                - test
                                - sandbox
                                - apple_pay
                                - apple_pay_merchant_identifier
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - klarna
                                name:
                                  type: string
                                  example: Klarna
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                      country:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          iso:
                            type: string
                            example: US
                          name:
                            type: string
                            example: United States
                          iso_name:
                            type: string
                            example: UNITED STATES
                          iso3:
                            type: string
                            example: USA
                          currency_code:
                            type: string
                            example: USD
                          currency_symbol:
                            type: string
                            example: $
                          province_required:
                            type: boolean
                            example: false
                          tax_enabled:
                            type:
                              - boolean
                              - 'null'
                            example: true
                          price_inclusive_of_tax:
                            type: boolean
                            example: false
                          price_inclusive_tax_name:
                            type:
                              - string
                              - 'null'
                            example: VAT
                      type:
                        type: string
                        enum:
                          - regular
                          - enrollment
                        example: regular
                      enrollment_pack_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      enrollment_pack:
                        type:
                          - object
                          - 'null'
                        properties:
                          enrollment_pack_id:
                            type: integer
                            example: 1
                          additional_volume:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          slug:
                            type: string
                            example: test-enrollment-pack
                          description:
                            type:
                              - object
                              - 'null'
                              - string
                            properties:
                              id:
                                type: integer
                                example: 111
                              name:
                                type: string
                                example: description
                              body:
                                type: string
                                example: >-
                                  <div>Try the latest and greatest of our sugar
                                  zip packs. Guaranteed to make you skinner and
                                  cure cancer.</div>
                              record_type:
                                type: string
                                example: EnrollmentPack
                              record_id:
                                type: integer
                                example: 1
                              created_at:
                                type: string
                                format: date_time
                                example: '2025-01-16T04:22:43.809Z'
                              updated_at:
                                type: string
                                format: date_time
                                example: '2025-01-22T10:23:52.941Z'
                              locale:
                                type: string
                                example: en
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: 10
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.00
                          images:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2
                                relateable_type:
                                  type: string
                                  example: EnrollmentPack
                                relateable_id:
                                  type: integer
                                  example: 1
                                image_url:
                                  type: string
                                  example: >-
                                    https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                image_path:
                                  type: string
                                  example: jITWaU14QGe0y5AFgY7P_00179.svg
                                position:
                                  type: integer
                                  example: 1
                                shopify_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                                created_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                updated_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                external_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 625
                                allow_subscription:
                                  type: boolean
                                  example: true
                                cv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                cv_in_currency:
                                  type: string
                                  example: $0.00
                                cv_total:
                                  type: integer
                                  example: 0
                                enrollment:
                                  type: boolean
                                  example: true
                                enrollment_pack_id:
                                  type: integer
                                  example: 1
                                price:
                                  type: string
                                  example: '11.13'
                                price_in_currency:
                                  type: string
                                  example: $11.13
                                product_title:
                                  type: string
                                  example: Zip Pack Sample Pack (30)
                                quantity:
                                  type: integer
                                  example: 1
                                qv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                qv_in_currency:
                                  type: string
                                  example: $0.00
                                qv_total:
                                  type: integer
                                  example: 0
                                subscribe_and_save:
                                  type:
                                    - string
                                    - 'null'
                                  example: '-1988.87'
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $-1,988.87
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $-1,988.87
                                subscription:
                                  type: boolean
                                  example: false
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_only:
                                  type: boolean
                                  example: false
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_price:
                                  type: string
                                  example: '2000.0'
                                subscription_price_in_currency:
                                  type: string
                                  example: $2,000.00
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  format: date
                                  example: '2025-02-28'
                                tax:
                                  type: string
                                  example: '0.0'
                                tax_in_currency:
                                  type: string
                                  example: $0.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: null
                                display_to_customer:
                                  type: boolean
                                  example: false
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                          price:
                            type: string
                            example: '11.13'
                          price_in_currency:
                            type: string
                            example: $11.13
                          subscription_price:
                            type:
                              - string
                              - integer
                            example: 2000
                          subscription_price_in_currency:
                            type: string
                            example: $2,000.00
                          title:
                            type: string
                            example: enroll product
                          token:
                            type: string
                            example: NxL22AqLRRisfyF9LqxxWRak
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      recurring:
                        oneOf:
                          - type: array
                            items:
                              type: object
                              properties:
                                subtotal:
                                  type: string
                                  example: '10.0'
                                subtotal_in_currency:
                                  type: string
                                  example: $10.0
                                interval:
                                  type: integer
                                  example: 1
                                interval_unit:
                                  type: string
                                  example: month
                                subtotal_for_display:
                                  type: string
                                  example: $10.00 every 1 month
                                start_date:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-05-27'
                          - type: 'null'
                        default:
                          - subtotal: '10.0'
                            subtotal_in_currency: $10.0
                            interval: 1
                            interval_unit: month
                            subtotal_for_display: $10.00 every 1 month
                            start_date: '2025-05-27'
                      messages:
                        type: object
                        additionalProperties: true
                        example:
                          errors:
                            - Insufficient inventory
                            - Product no longer available
                          warnings:
                            - Low stock warning
                            - Shipping delays expected
                          info:
                            - Free shipping available
                            - Volume discount applied
                      points_enabled:
                        type: boolean
                        example: true
                      points_applied:
                        type: integer
                        example: 500
                        description: Number of points applied to the cart
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Currency value of applied points
                      customer_total_points:
                        type: integer
                        example: 1000
                        description: Customer's total available points balance
                      customer_total_points_in_currency:
                        type: number
                        example: 10
                        description: Currency value of available points
                      remaining_customer_points:
                        type: integer
                        example: 500
                        description: Customer's remaining points after cart redemption
                      remaining_customer_points_amount_in_currency:
                        type: number
                        example: 5
                        description: >-
                          Currency value of remaining points after cart
                          redemption
                      remaining_cart_amount_after_points:
                        type: number
                        example: 95
                        description: Amount to charge to card after points redemption
                      remaining_cart_amount_after_points_in_currency:
                        type:
                          - string
                        example: $95.00
                        description: >-
                          Amount in currency to charge to card after points
                          redemption
                      max_applicable_points:
                        type: integer
                        example: 500
                        description: Maximum points that can be applied to this cart
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '400':
          description: no total fields provided
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: No total fields provided for update
                  errors:
                    type: array
                    items:
                      type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
        '401':
          description: unauthorized - no bearer token
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                required:
                  - message
        '404':
          description: cart not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
                      example:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '410':
          description: Cart is processed and cannot be modified
        '422':
          description: cart is immutable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Cart is immutable and cannot be modified
                  errors:
                    type: array
                    items:
                      type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                discount_total:
                  type:
                    - number
                    - 'null'
                  description: Discount total amount
                  example: 15.5
                tax_total:
                  type:
                    - number
                    - 'null'
                  description: Tax total amount.
                  example: 8.75
                shipping_total:
                  type:
                    - number
                    - 'null'
                  description: Shipping total amount.
                  example: 12
                amount_total:
                  type:
                    - number
                    - 'null'
                  description: Total amount including all fees
                  example: 125.25
                transaction_fee:
                  type:
                    - number
                    - 'null'
                  description: Transaction fee amount
                  example: 3.5
              minProperties: 1
        description: Cart totals to update
  /api/carts/{cart_token}/apply_points:
    post:
      summary: Applies points redemption to cart
      tags:
        - Carts
      description: >-
        Apply points redemption to reduce the cart total. Requires the cart to
        have an associated customer and sufficient available points. Points
        redemption is stored in cart metadata and will be processed during
        checkout.
      operationId: applyPointsToCart
      parameters:
        - name: cart_token
          in: path
          required: true
          description: The cart token
          schema:
            type: string
      responses:
        '200':
          description: points applied successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      state:
                        type: string
                        example: start
                      processed:
                        type: boolean
                        example: false
                        description: >-
                          Determines if a cart payment has been processed or
                          not.
                      valid_for_checkout:
                        type: boolean
                        example: true
                      buyer_rep_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      buyer_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: buyer.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                              external_id:
                                type:
                                  - string
                                  - 'null'
                                example: '123241'
                            required:
                              - id
                          - type: 'null'
                      volume_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: volume.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                            required:
                              - id
                          - type: 'null'
                      currency_symbol:
                        type: string
                        example: $
                      currency_code:
                        type: string
                        example: USD
                      shipping_total_for_display:
                        type: string
                        example: Free
                      phone:
                        type:
                          - string
                          - 'null'
                        example: '4035551212'
                      payment_method_auto_assignable:
                        type: boolean
                        example: true
                        description: >-
                          Determines if a payment method can be auto-assigned to
                          the cart.
                      attribution:
                        oneOf:
                          - type: object
                            oneOf:
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  share_guid:
                                    type: string
                                    example: james-bond007
                                required:
                                  - id
                                  - share_guid
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  email:
                                    type: string
                                    example: james.bond@gmail.com
                                required:
                                  - id
                                  - email
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  username:
                                    type: string
                                    example: jaamball234
                                required:
                                  - id
                                  - username
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  fluid_rep_id:
                                    type: integer
                                    example: 23493
                                required:
                                  - id
                                  - fluid_rep_id
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: w3sdf92
                                required:
                                  - id
                          - type: 'null'
                        default:
                          id: 456
                          share_guid: james-bond007
                      agreements:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            required:
                              type: boolean
                              example: true
                            title:
                              type: string
                              example: Terms and Conditions
                            show_path:
                              type: string
                              example: /terms
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                      amount_total:
                        type: string
                        example: '121.65'
                      amount_total_in_currency:
                        type: string
                        example: $121.65 (USD)
                      sub_total:
                        type: string
                        example: '100.00'
                      sub_total_in_currency:
                        type: string
                        example: $100.00 (USD)
                      subtotal_after_discounts:
                        type: string
                        example: '90.00'
                      tax_total:
                        type: string
                        example: '20.00'
                      tax_total_in_currency:
                        type: string
                        example: $20.00 (USD)
                      shipping_total:
                        type:
                          - string
                          - 'null'
                        example: '1.65'
                      shipping_total_in_currency:
                        type: string
                        example: $1.65 (USD)
                      shipping_discount:
                        type: number
                        example: 10.25
                      discount_total:
                        type: string
                        example: '2.99'
                      discount_total_in_currency:
                        type: string
                        example: $2.99 (USD)
                      discount_breakdown:
                        type: object
                        properties:
                          internal_discounts:
                            type: number
                            example: 15
                          external_discounts:
                            type: number
                            example: 10
                          total_discounts:
                            type: number
                            example: 25
                      external_discount:
                        type: object
                        properties:
                          total:
                            type: number
                            example: 10
                          calculated_at:
                            type:
                              - string
                              - 'null'
                            format: date-time
                            example: '2024-01-10T15:30:00Z'
                          sources:
                            type: object
                            additionalProperties:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 6
                                description:
                                  type: string
                                  example: Gold tier discount
                                metadata:
                                  type: object
                              required:
                                - amount
                                - description
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: '1.90'
                      transaction_fee_in_currency:
                        type: string
                        example: $1.90 (USD)
                      cv_total:
                        type: integer
                        example: 10
                      qv_total:
                        type: integer
                        example: 15
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      payment_account:
                        type:
                          - string
                          - 'null'
                        example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                      payment_method:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: CreditCard
                              payment_method_type:
                                type: string
                                example: visa
                              last_four:
                                type: string
                                example: '1234'
                              exp_month:
                                type: string
                                example: '12'
                              exp_year:
                                type: string
                                example: '2025'
                              logo_url:
                                type: string
                                example: https://example.com/image.svg
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Paypal
                              status:
                                type: string
                                example: active
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Affirm
                              affirm_id:
                                type: string
                                example: affirm_123
                              status:
                                type: string
                                example: authorized
                              checkout_id:
                                type: string
                                example: checkout_456
                              created:
                                type: string
                                example: '2025-01-01T00:00:00Z'
                              auth_expiration:
                                type: string
                                example: '2025-01-02T00:00:00Z'
                              currency:
                                type: string
                                example: USD
                              amount:
                                type: string
                                example: '100.00'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Klarna
                              session_id:
                                type: string
                                example: klarna_session_789
                              intent:
                                type: string
                                example: buy
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Droplet
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: SomeCitcon
                      email:
                        type:
                          - string
                          - 'null'
                        example: user@example.com
                      enrollment_fee:
                        type:
                          - number
                          - string
                        example: '10.45'
                      enrollment_fee_in_currency:
                        type: string
                        example: $10.45
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT10
                          - DISCOUNT11
                      language_iso:
                        type:
                          - string
                          - 'null'
                        example: en
                      cart_token:
                        type: string
                        example: abc123
                      immutable_items:
                        type: boolean
                        example: false
                      digital_only:
                        type: boolean
                        example: false
                      requires_3ds:
                        type: boolean
                        example: false
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 101
                            price:
                              type: string
                              example: '43.41'
                            price_in_currency:
                              type: string
                              example: $43.41
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            cv:
                              type: integer
                              example: 5
                            cv_total:
                              type: integer
                              example: 15
                            qv:
                              type: integer
                              example: 7
                            qv_total:
                              type: integer
                              example: 21
                            discount_amount:
                              type: string
                              example: '10'
                            free_item:
                              type: boolean
                              example: false
                            discount_amount_in_currency:
                              type: string
                              example: $10.00
                            total_after_discounts:
                              type: string
                              example: '90.00'
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            product_title:
                              type:
                                - string
                                - 'null'
                              example: Sample Product
                            quantity:
                              type: integer
                              example: 3
                            subscription:
                              type: boolean
                              example: true
                            enrollment:
                              type: boolean
                              example: false
                            allow_subscription:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_plan_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_plans:
                              oneOf:
                                - type: array
                                  items:
                                    title: Commerce::SubscriptionPlan
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        example: Test Subscription Plan
                                        type: string
                                      billing_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      billing_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      billing_frequency_in_words:
                                        example: 2 Months
                                        type: string
                                      shipping_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      shipping_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      volume_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      volume_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      trial_period:
                                        example: 1
                                        type:
                                          - integer
                                          - 'null'
                                        minimum: 1
                                      trial_period_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type:
                                          - string
                                          - 'null'
                                      split_volume:
                                        example: true
                                        type: boolean
                                        default: false
                                      allow_max_billing_cycles:
                                        example: true
                                        type: boolean
                                        default: false
                                      max_billing_cycles:
                                        example: 3
                                        type:
                                          - integer
                                          - 'null'
                                      company_default:
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                        default: false
                                      products_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      subscribers_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      price:
                                        type: string
                                      price_in_currency:
                                        type: string
                                      subscription_start:
                                        type: string
                                      subscribe_and_save:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_in_currency:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_for_display:
                                        type:
                                          - string
                                          - 'null'
                                    required:
                                      - id
                                      - name
                                      - billing_interval
                                      - billing_interval_unit
                                      - billing_frequency_in_words
                                      - shipping_interval
                                      - shipping_interval_unit
                                      - volume_interval
                                      - volume_interval_unit
                                      - split_volume
                                      - allow_max_billing_cycles
                                      - price
                                      - price_in_currency
                                      - subscription_start
                                      - subscribe_and_save
                                      - subscribe_and_save_in_currency
                                      - subscribe_and_save_for_display
                                - type: 'null'
                            subscription_only:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_interval:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_interval_unit:
                              type:
                                - string
                                - 'null'
                              example: month
                            subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 10.5
                            subscription_price_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $10.50
                            subscription_start:
                              type:
                                - string
                                - 'null'
                              example: '2025-02-12'
                            subscribe_and_save:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 2.99
                            subscribe_and_save_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $2.99
                            subscribe_and_save_for_display:
                              type:
                                - string
                                - 'null'
                              example: Subscribe and save $2.99
                            title:
                              type:
                                - string
                                - 'null'
                              example: Surcharge
                            metadata:
                              type: object
                              description: >-
                                A JSON object that can store any custom data
                                structure
                              example: {}
                            product:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type: string
                                      example: Sample Product
                                    introduction:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Product Description
                                    cv:
                                      type: integer
                                      example: 10
                                    external_id:
                                      type:
                                        - string
                                        - 'null'
                                      example: ext-prod-123
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/product.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/product.png
                                    price:
                                      type: string
                                      example: '29.99'
                                    price_in_currency:
                                      type: string
                                      example: $29.99
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    tax:
                                      type: string
                                      example: '2.99'
                                    tax_in_currency:
                                      type: string
                                      example: $2.99
                                    metadata:
                                      type: object
                                      example:
                                        shopify_product_id: 9876054868270
                                    metafields:
                                      type: array
                                      items:
                                        title: LegacyMetafield
                                        type: object
                                        properties:
                                          namespace:
                                            description: >-
                                              A container for related metafields.
                                              Commonly used to group metafields by app
                                              or functionality.
                                            example: custom
                                            type: string
                                            maxLength: 20
                                            pattern: ^[a-zA-Z0-9_]+$
                                          key:
                                            description: >-
                                              The unique identifier for the metafield
                                              within its namespace. Must be unique per
                                              namespace and owner.
                                            example: material
                                            type: string
                                            maxLength: 30
                                            pattern: ^[a-zA-Z0-9_]+$
                                          value:
                                            description: >-
                                              The actual data stored in the metafield.
                                              Type depends on value_type.
                                            example: cotton
                                            type:
                                              - string
                                              - integer
                                              - object
                                              - boolean
                                              - number
                                          value_type:
                                            description: >-
                                              The data type that defines how the value
                                              should be interpreted and validated.
                                            example: single_line_text_field
                                            type: string
                                          description:
                                            description: >-
                                              Optional human-readable description
                                              explaining the purpose of this
                                              metafield.
                                            example: >-
                                              The primary material used in this
                                              product
                                            type:
                                              - string
                                              - 'null'
                                          created_at:
                                            description: >-
                                              Timestamp when the metafield was
                                              created.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          updated_at:
                                            description: >-
                                              Timestamp when the metafield was last
                                              updated.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          locked:
                                            description: >-
                                              Whether this metafield is locked and
                                              cannot be updated or deleted directly.
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                              - 'null'
                                          metafield_definition:
                                            description: >-
                                              The definition that defines validation
                                              rules and structure for this metafield
                                            type:
                                              - 'null'
                                              - object
                                        required:
                                          - namespace
                                          - key
                                          - value
                                          - value_type
                                          - description
                                          - created_at
                                          - updated_at
                                          - metafield_definition
                                - type: 'null'
                            variant:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Variant
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/sample.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/sample.png
                                    primary_image:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/primary.png
                                    price:
                                      type:
                                        - string
                                        - 'null'
                                      example: '34.44'
                                    price_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $34.44
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    options:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          title:
                                            type: string
                                            example: Size
                                          value:
                                            type: string
                                            example: XL
                                    physical:
                                      type:
                                        - boolean
                                        - 'null'
                                      example: true
                                    unit_of_size:
                                      type:
                                        - string
                                        - 'null'
                                      example: cm
                                    height:
                                      type:
                                        - number
                                        - 'null'
                                      example: 13
                                    width:
                                      type:
                                        - number
                                        - 'null'
                                      example: 6
                                    length:
                                      type:
                                        - number
                                        - 'null'
                                      example: 12
                                    unit_of_weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: kg
                                    weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                    hs_code:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                - type: 'null'
                            errors:
                              oneOf:
                                - type: 'null'
                                - type: array
                                  items:
                                    type: object
                                  example:
                                    - country:
                                        - >-
                                          This product is not available for this
                                          country. Please change your country
                            bundled_items:
                              type: array
                              items:
                                type: object
                                description: Bundled items for bundle products
                                properties:
                                  variant_id:
                                    type: integer
                                    example: 1
                                  product_id:
                                    type: integer
                                    example: 1
                                  product_title:
                                    type: string
                                    example: Product Title
                                  variant_title:
                                    type: string
                                    example: Variant Title
                                  option_titles:
                                    type: array
                                    example:
                                      - Option 1
                                      - Option 2
                                  quantity:
                                    type: integer
                                    example: 1
                                  display_to_customer:
                                    type: boolean
                                    example: true
                      ship_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      bill_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      shipping_method:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: string
                            example: standard-shipping
                          name:
                            type: string
                            example: Standard Shipping
                      available_shipping_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: standard-shipping
                            title:
                              type: string
                              example: Standard Shipping
                            price:
                              type:
                                - number
                                - string
                              example: 5.99
                            price_label:
                              type: string
                              example: $5.99
                            delivery_time_estimate:
                              type: string
                              example: 3-5 business days
                      available_payment_methods:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - credit_card
                                name:
                                  type: string
                                  example: Credit Card
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                apple_pay:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method supports
                                    ApplePay or not 
                                bogus_gateway:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is a Bogus
                                    instance or not.
                                tokenize_path:
                                  type:
                                    - string
                                    - 'null'
                                  description: Path to tokenize, if applicable.
                                token_provider:
                                  type: string
                                  enum:
                                    - spreedly
                                    - vgs
                                  description: >-
                                    Determines if payment tokenization is via
                                    spreedly or VGS
                                apple_pay_merchant_identifier:
                                  type:
                                    - string
                                    - 'null'
                                  example: merchant.mycompany.com
                                  description: >-
                                    If ApplePay is supported, returns the
                                    merchant identifier registered with Apple,
                                    else returns nil
                                supported_brands:
                                  type: array
                                  items:
                                    type: string
                                  example:
                                    - visa
                                    - master
                                    - american_express
                                    - discover
                                publishable_key:
                                  type:
                                    - string
                                    - 'null'
                                  example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                  description: >-
                                    If publishable key is set for Hyperswitch,
                                    returns the publishable key, else returns
                                    nil
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                              required:
                                - id
                                - type
                                - name
                                - supported_brands
                                - test
                                - sandbox
                                - apple_pay
                                - apple_pay_merchant_identifier
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - klarna
                                name:
                                  type: string
                                  example: Klarna
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                      country:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          iso:
                            type: string
                            example: US
                          name:
                            type: string
                            example: United States
                          iso_name:
                            type: string
                            example: UNITED STATES
                          iso3:
                            type: string
                            example: USA
                          currency_code:
                            type: string
                            example: USD
                          currency_symbol:
                            type: string
                            example: $
                          province_required:
                            type: boolean
                            example: false
                          tax_enabled:
                            type:
                              - boolean
                              - 'null'
                            example: true
                          price_inclusive_of_tax:
                            type: boolean
                            example: false
                          price_inclusive_tax_name:
                            type:
                              - string
                              - 'null'
                            example: VAT
                      type:
                        type: string
                        enum:
                          - regular
                          - enrollment
                        example: regular
                      enrollment_pack_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      enrollment_pack:
                        type:
                          - object
                          - 'null'
                        properties:
                          enrollment_pack_id:
                            type: integer
                            example: 1
                          additional_volume:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          slug:
                            type: string
                            example: test-enrollment-pack
                          description:
                            type:
                              - object
                              - 'null'
                              - string
                            properties:
                              id:
                                type: integer
                                example: 111
                              name:
                                type: string
                                example: description
                              body:
                                type: string
                                example: >-
                                  <div>Try the latest and greatest of our sugar
                                  zip packs. Guaranteed to make you skinner and
                                  cure cancer.</div>
                              record_type:
                                type: string
                                example: EnrollmentPack
                              record_id:
                                type: integer
                                example: 1
                              created_at:
                                type: string
                                format: date_time
                                example: '2025-01-16T04:22:43.809Z'
                              updated_at:
                                type: string
                                format: date_time
                                example: '2025-01-22T10:23:52.941Z'
                              locale:
                                type: string
                                example: en
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: 10
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.00
                          images:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2
                                relateable_type:
                                  type: string
                                  example: EnrollmentPack
                                relateable_id:
                                  type: integer
                                  example: 1
                                image_url:
                                  type: string
                                  example: >-
                                    https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                image_path:
                                  type: string
                                  example: jITWaU14QGe0y5AFgY7P_00179.svg
                                position:
                                  type: integer
                                  example: 1
                                shopify_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                                created_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                updated_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                external_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 625
                                allow_subscription:
                                  type: boolean
                                  example: true
                                cv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                cv_in_currency:
                                  type: string
                                  example: $0.00
                                cv_total:
                                  type: integer
                                  example: 0
                                enrollment:
                                  type: boolean
                                  example: true
                                enrollment_pack_id:
                                  type: integer
                                  example: 1
                                price:
                                  type: string
                                  example: '11.13'
                                price_in_currency:
                                  type: string
                                  example: $11.13
                                product_title:
                                  type: string
                                  example: Zip Pack Sample Pack (30)
                                quantity:
                                  type: integer
                                  example: 1
                                qv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                qv_in_currency:
                                  type: string
                                  example: $0.00
                                qv_total:
                                  type: integer
                                  example: 0
                                subscribe_and_save:
                                  type:
                                    - string
                                    - 'null'
                                  example: '-1988.87'
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $-1,988.87
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $-1,988.87
                                subscription:
                                  type: boolean
                                  example: false
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_only:
                                  type: boolean
                                  example: false
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_price:
                                  type: string
                                  example: '2000.0'
                                subscription_price_in_currency:
                                  type: string
                                  example: $2,000.00
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  format: date
                                  example: '2025-02-28'
                                tax:
                                  type: string
                                  example: '0.0'
                                tax_in_currency:
                                  type: string
                                  example: $0.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: null
                                display_to_customer:
                                  type: boolean
                                  example: false
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                          price:
                            type: string
                            example: '11.13'
                          price_in_currency:
                            type: string
                            example: $11.13
                          subscription_price:
                            type:
                              - string
                              - integer
                            example: 2000
                          subscription_price_in_currency:
                            type: string
                            example: $2,000.00
                          title:
                            type: string
                            example: enroll product
                          token:
                            type: string
                            example: NxL22AqLRRisfyF9LqxxWRak
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      recurring:
                        oneOf:
                          - type: array
                            items:
                              type: object
                              properties:
                                subtotal:
                                  type: string
                                  example: '10.0'
                                subtotal_in_currency:
                                  type: string
                                  example: $10.0
                                interval:
                                  type: integer
                                  example: 1
                                interval_unit:
                                  type: string
                                  example: month
                                subtotal_for_display:
                                  type: string
                                  example: $10.00 every 1 month
                                start_date:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-05-27'
                          - type: 'null'
                        default:
                          - subtotal: '10.0'
                            subtotal_in_currency: $10.0
                            interval: 1
                            interval_unit: month
                            subtotal_for_display: $10.00 every 1 month
                            start_date: '2025-05-27'
                      messages:
                        type: object
                        additionalProperties: true
                        example:
                          errors:
                            - Insufficient inventory
                            - Product no longer available
                          warnings:
                            - Low stock warning
                            - Shipping delays expected
                          info:
                            - Free shipping available
                            - Volume discount applied
                      points_enabled:
                        type: boolean
                        example: true
                      points_applied:
                        type: integer
                        example: 500
                        description: Number of points applied to the cart
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Currency value of applied points
                      customer_total_points:
                        type: integer
                        example: 1000
                        description: Customer's total available points balance
                      customer_total_points_in_currency:
                        type: number
                        example: 10
                        description: Currency value of available points
                      remaining_customer_points:
                        type: integer
                        example: 500
                        description: Customer's remaining points after cart redemption
                      remaining_customer_points_amount_in_currency:
                        type: number
                        example: 5
                        description: >-
                          Currency value of remaining points after cart
                          redemption
                      remaining_cart_amount_after_points:
                        type: number
                        example: 95
                        description: Amount to charge to card after points redemption
                      remaining_cart_amount_after_points_in_currency:
                        type:
                          - string
                        example: $95.00
                        description: >-
                          Amount in currency to charge to card after points
                          redemption
                      max_applicable_points:
                        type: integer
                        example: 500
                        description: Maximum points that can be applied to this cart
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      checkout_url:
                        type: string
                        example: https://checkout.fluid.com/checkout?jwt=abc123
                      shop_url:
                        type: string
                        example: https://myco.fluid.app
        '403':
          description: feature not enabled
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Feature not enabled
                  errors:
                    type: object
                    properties:
                      points:
                        type: array
                        items:
                          type: string
                        example:
                          - Points redemption is not enabled for this company
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: insufficient points
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Insufficient points
                  errors:
                    type: object
                    properties:
                      cart:
                        type: array
                        items:
                          type: string
                        example:
                          - >-
                            Cart must have an associated customer to redeem
                            points
                      points:
                        type: array
                        items:
                          type: string
                        example:
                          - 'Insufficient points. Available: 0, Requested: 100'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                points_amount:
                  type: integer
                  example: 500
                  description: Amount of points to redeem (must be greater than 0)
              required:
                - points_amount
  /api/carts/{cart_token}/remove_points:
    delete:
      summary: Removes points redemption from cart
      tags:
        - Carts
      description: >-
        Remove previously applied points redemption from the cart. This restores
        the cart total to its original amount.
      operationId: removePointsFromCart
      parameters:
        - name: cart_token
          in: path
          required: true
          description: The cart token
          schema:
            type: string
      responses:
        '200':
          description: points removed successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      state:
                        type: string
                        example: start
                      processed:
                        type: boolean
                        example: false
                        description: >-
                          Determines if a cart payment has been processed or
                          not.
                      valid_for_checkout:
                        type: boolean
                        example: true
                      buyer_rep_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      buyer_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: buyer.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                              external_id:
                                type:
                                  - string
                                  - 'null'
                                example: '123241'
                            required:
                              - id
                          - type: 'null'
                      volume_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: volume.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                            required:
                              - id
                          - type: 'null'
                      currency_symbol:
                        type: string
                        example: $
                      currency_code:
                        type: string
                        example: USD
                      shipping_total_for_display:
                        type: string
                        example: Free
                      phone:
                        type:
                          - string
                          - 'null'
                        example: '4035551212'
                      payment_method_auto_assignable:
                        type: boolean
                        example: true
                        description: >-
                          Determines if a payment method can be auto-assigned to
                          the cart.
                      attribution:
                        oneOf:
                          - type: object
                            oneOf:
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  share_guid:
                                    type: string
                                    example: james-bond007
                                required:
                                  - id
                                  - share_guid
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  email:
                                    type: string
                                    example: james.bond@gmail.com
                                required:
                                  - id
                                  - email
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  username:
                                    type: string
                                    example: jaamball234
                                required:
                                  - id
                                  - username
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  fluid_rep_id:
                                    type: integer
                                    example: 23493
                                required:
                                  - id
                                  - fluid_rep_id
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: w3sdf92
                                required:
                                  - id
                          - type: 'null'
                        default:
                          id: 456
                          share_guid: james-bond007
                      agreements:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            required:
                              type: boolean
                              example: true
                            title:
                              type: string
                              example: Terms and Conditions
                            show_path:
                              type: string
                              example: /terms
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                      amount_total:
                        type: string
                        example: '121.65'
                      amount_total_in_currency:
                        type: string
                        example: $121.65 (USD)
                      sub_total:
                        type: string
                        example: '100.00'
                      sub_total_in_currency:
                        type: string
                        example: $100.00 (USD)
                      subtotal_after_discounts:
                        type: string
                        example: '90.00'
                      tax_total:
                        type: string
                        example: '20.00'
                      tax_total_in_currency:
                        type: string
                        example: $20.00 (USD)
                      shipping_total:
                        type:
                          - string
                          - 'null'
                        example: '1.65'
                      shipping_total_in_currency:
                        type: string
                        example: $1.65 (USD)
                      shipping_discount:
                        type: number
                        example: 10.25
                      discount_total:
                        type: string
                        example: '2.99'
                      discount_total_in_currency:
                        type: string
                        example: $2.99 (USD)
                      discount_breakdown:
                        type: object
                        properties:
                          internal_discounts:
                            type: number
                            example: 15
                          external_discounts:
                            type: number
                            example: 10
                          total_discounts:
                            type: number
                            example: 25
                      external_discount:
                        type: object
                        properties:
                          total:
                            type: number
                            example: 10
                          calculated_at:
                            type:
                              - string
                              - 'null'
                            format: date-time
                            example: '2024-01-10T15:30:00Z'
                          sources:
                            type: object
                            additionalProperties:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 6
                                description:
                                  type: string
                                  example: Gold tier discount
                                metadata:
                                  type: object
                              required:
                                - amount
                                - description
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: '1.90'
                      transaction_fee_in_currency:
                        type: string
                        example: $1.90 (USD)
                      cv_total:
                        type: integer
                        example: 10
                      qv_total:
                        type: integer
                        example: 15
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      payment_account:
                        type:
                          - string
                          - 'null'
                        example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                      payment_method:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: CreditCard
                              payment_method_type:
                                type: string
                                example: visa
                              last_four:
                                type: string
                                example: '1234'
                              exp_month:
                                type: string
                                example: '12'
                              exp_year:
                                type: string
                                example: '2025'
                              logo_url:
                                type: string
                                example: https://example.com/image.svg
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Paypal
                              status:
                                type: string
                                example: active
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Affirm
                              affirm_id:
                                type: string
                                example: affirm_123
                              status:
                                type: string
                                example: authorized
                              checkout_id:
                                type: string
                                example: checkout_456
                              created:
                                type: string
                                example: '2025-01-01T00:00:00Z'
                              auth_expiration:
                                type: string
                                example: '2025-01-02T00:00:00Z'
                              currency:
                                type: string
                                example: USD
                              amount:
                                type: string
                                example: '100.00'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Klarna
                              session_id:
                                type: string
                                example: klarna_session_789
                              intent:
                                type: string
                                example: buy
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Droplet
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: SomeCitcon
                      email:
                        type:
                          - string
                          - 'null'
                        example: user@example.com
                      enrollment_fee:
                        type:
                          - number
                          - string
                        example: '10.45'
                      enrollment_fee_in_currency:
                        type: string
                        example: $10.45
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT10
                          - DISCOUNT11
                      language_iso:
                        type:
                          - string
                          - 'null'
                        example: en
                      cart_token:
                        type: string
                        example: abc123
                      immutable_items:
                        type: boolean
                        example: false
                      digital_only:
                        type: boolean
                        example: false
                      requires_3ds:
                        type: boolean
                        example: false
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 101
                            price:
                              type: string
                              example: '43.41'
                            price_in_currency:
                              type: string
                              example: $43.41
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            cv:
                              type: integer
                              example: 5
                            cv_total:
                              type: integer
                              example: 15
                            qv:
                              type: integer
                              example: 7
                            qv_total:
                              type: integer
                              example: 21
                            discount_amount:
                              type: string
                              example: '10'
                            free_item:
                              type: boolean
                              example: false
                            discount_amount_in_currency:
                              type: string
                              example: $10.00
                            total_after_discounts:
                              type: string
                              example: '90.00'
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            product_title:
                              type:
                                - string
                                - 'null'
                              example: Sample Product
                            quantity:
                              type: integer
                              example: 3
                            subscription:
                              type: boolean
                              example: true
                            enrollment:
                              type: boolean
                              example: false
                            allow_subscription:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_plan_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_plans:
                              oneOf:
                                - type: array
                                  items:
                                    title: Commerce::SubscriptionPlan
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        example: Test Subscription Plan
                                        type: string
                                      billing_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      billing_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      billing_frequency_in_words:
                                        example: 2 Months
                                        type: string
                                      shipping_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      shipping_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      volume_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      volume_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      trial_period:
                                        example: 1
                                        type:
                                          - integer
                                          - 'null'
                                        minimum: 1
                                      trial_period_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type:
                                          - string
                                          - 'null'
                                      split_volume:
                                        example: true
                                        type: boolean
                                        default: false
                                      allow_max_billing_cycles:
                                        example: true
                                        type: boolean
                                        default: false
                                      max_billing_cycles:
                                        example: 3
                                        type:
                                          - integer
                                          - 'null'
                                      company_default:
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                        default: false
                                      products_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      subscribers_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      price:
                                        type: string
                                      price_in_currency:
                                        type: string
                                      subscription_start:
                                        type: string
                                      subscribe_and_save:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_in_currency:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_for_display:
                                        type:
                                          - string
                                          - 'null'
                                    required:
                                      - id
                                      - name
                                      - billing_interval
                                      - billing_interval_unit
                                      - billing_frequency_in_words
                                      - shipping_interval
                                      - shipping_interval_unit
                                      - volume_interval
                                      - volume_interval_unit
                                      - split_volume
                                      - allow_max_billing_cycles
                                      - price
                                      - price_in_currency
                                      - subscription_start
                                      - subscribe_and_save
                                      - subscribe_and_save_in_currency
                                      - subscribe_and_save_for_display
                                - type: 'null'
                            subscription_only:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_interval:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_interval_unit:
                              type:
                                - string
                                - 'null'
                              example: month
                            subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 10.5
                            subscription_price_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $10.50
                            subscription_start:
                              type:
                                - string
                                - 'null'
                              example: '2025-02-12'
                            subscribe_and_save:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 2.99
                            subscribe_and_save_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $2.99
                            subscribe_and_save_for_display:
                              type:
                                - string
                                - 'null'
                              example: Subscribe and save $2.99
                            title:
                              type:
                                - string
                                - 'null'
                              example: Surcharge
                            metadata:
                              type: object
                              description: >-
                                A JSON object that can store any custom data
                                structure
                              example: {}
                            product:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type: string
                                      example: Sample Product
                                    introduction:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Product Description
                                    cv:
                                      type: integer
                                      example: 10
                                    external_id:
                                      type:
                                        - string
                                        - 'null'
                                      example: ext-prod-123
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/product.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/product.png
                                    price:
                                      type: string
                                      example: '29.99'
                                    price_in_currency:
                                      type: string
                                      example: $29.99
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    tax:
                                      type: string
                                      example: '2.99'
                                    tax_in_currency:
                                      type: string
                                      example: $2.99
                                    metadata:
                                      type: object
                                      example:
                                        shopify_product_id: 9876054868270
                                    metafields:
                                      type: array
                                      items:
                                        title: LegacyMetafield
                                        type: object
                                        properties:
                                          namespace:
                                            description: >-
                                              A container for related metafields.
                                              Commonly used to group metafields by app
                                              or functionality.
                                            example: custom
                                            type: string
                                            maxLength: 20
                                            pattern: ^[a-zA-Z0-9_]+$
                                          key:
                                            description: >-
                                              The unique identifier for the metafield
                                              within its namespace. Must be unique per
                                              namespace and owner.
                                            example: material
                                            type: string
                                            maxLength: 30
                                            pattern: ^[a-zA-Z0-9_]+$
                                          value:
                                            description: >-
                                              The actual data stored in the metafield.
                                              Type depends on value_type.
                                            example: cotton
                                            type:
                                              - string
                                              - integer
                                              - object
                                              - boolean
                                              - number
                                          value_type:
                                            description: >-
                                              The data type that defines how the value
                                              should be interpreted and validated.
                                            example: single_line_text_field
                                            type: string
                                          description:
                                            description: >-
                                              Optional human-readable description
                                              explaining the purpose of this
                                              metafield.
                                            example: >-
                                              The primary material used in this
                                              product
                                            type:
                                              - string
                                              - 'null'
                                          created_at:
                                            description: >-
                                              Timestamp when the metafield was
                                              created.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          updated_at:
                                            description: >-
                                              Timestamp when the metafield was last
                                              updated.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          locked:
                                            description: >-
                                              Whether this metafield is locked and
                                              cannot be updated or deleted directly.
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                              - 'null'
                                          metafield_definition:
                                            description: >-
                                              The definition that defines validation
                                              rules and structure for this metafield
                                            type:
                                              - 'null'
                                              - object
                                        required:
                                          - namespace
                                          - key
                                          - value
                                          - value_type
                                          - description
                                          - created_at
                                          - updated_at
                                          - metafield_definition
                                - type: 'null'
                            variant:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Variant
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/sample.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/sample.png
                                    primary_image:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/primary.png
                                    price:
                                      type:
                                        - string
                                        - 'null'
                                      example: '34.44'
                                    price_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $34.44
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    options:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          title:
                                            type: string
                                            example: Size
                                          value:
                                            type: string
                                            example: XL
                                    physical:
                                      type:
                                        - boolean
                                        - 'null'
                                      example: true
                                    unit_of_size:
                                      type:
                                        - string
                                        - 'null'
                                      example: cm
                                    height:
                                      type:
                                        - number
                                        - 'null'
                                      example: 13
                                    width:
                                      type:
                                        - number
                                        - 'null'
                                      example: 6
                                    length:
                                      type:
                                        - number
                                        - 'null'
                                      example: 12
                                    unit_of_weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: kg
                                    weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                    hs_code:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                - type: 'null'
                            errors:
                              oneOf:
                                - type: 'null'
                                - type: array
                                  items:
                                    type: object
                                  example:
                                    - country:
                                        - >-
                                          This product is not available for this
                                          country. Please change your country
                            bundled_items:
                              type: array
                              items:
                                type: object
                                description: Bundled items for bundle products
                                properties:
                                  variant_id:
                                    type: integer
                                    example: 1
                                  product_id:
                                    type: integer
                                    example: 1
                                  product_title:
                                    type: string
                                    example: Product Title
                                  variant_title:
                                    type: string
                                    example: Variant Title
                                  option_titles:
                                    type: array
                                    example:
                                      - Option 1
                                      - Option 2
                                  quantity:
                                    type: integer
                                    example: 1
                                  display_to_customer:
                                    type: boolean
                                    example: true
                      ship_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      bill_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      shipping_method:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: string
                            example: standard-shipping
                          name:
                            type: string
                            example: Standard Shipping
                      available_shipping_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: standard-shipping
                            title:
                              type: string
                              example: Standard Shipping
                            price:
                              type:
                                - number
                                - string
                              example: 5.99
                            price_label:
                              type: string
                              example: $5.99
                            delivery_time_estimate:
                              type: string
                              example: 3-5 business days
                      available_payment_methods:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - credit_card
                                name:
                                  type: string
                                  example: Credit Card
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                apple_pay:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method supports
                                    ApplePay or not 
                                bogus_gateway:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is a Bogus
                                    instance or not.
                                tokenize_path:
                                  type:
                                    - string
                                    - 'null'
                                  description: Path to tokenize, if applicable.
                                token_provider:
                                  type: string
                                  enum:
                                    - spreedly
                                    - vgs
                                  description: >-
                                    Determines if payment tokenization is via
                                    spreedly or VGS
                                apple_pay_merchant_identifier:
                                  type:
                                    - string
                                    - 'null'
                                  example: merchant.mycompany.com
                                  description: >-
                                    If ApplePay is supported, returns the
                                    merchant identifier registered with Apple,
                                    else returns nil
                                supported_brands:
                                  type: array
                                  items:
                                    type: string
                                  example:
                                    - visa
                                    - master
                                    - american_express
                                    - discover
                                publishable_key:
                                  type:
                                    - string
                                    - 'null'
                                  example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                  description: >-
                                    If publishable key is set for Hyperswitch,
                                    returns the publishable key, else returns
                                    nil
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                              required:
                                - id
                                - type
                                - name
                                - supported_brands
                                - test
                                - sandbox
                                - apple_pay
                                - apple_pay_merchant_identifier
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - klarna
                                name:
                                  type: string
                                  example: Klarna
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                      country:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          iso:
                            type: string
                            example: US
                          name:
                            type: string
                            example: United States
                          iso_name:
                            type: string
                            example: UNITED STATES
                          iso3:
                            type: string
                            example: USA
                          currency_code:
                            type: string
                            example: USD
                          currency_symbol:
                            type: string
                            example: $
                          province_required:
                            type: boolean
                            example: false
                          tax_enabled:
                            type:
                              - boolean
                              - 'null'
                            example: true
                          price_inclusive_of_tax:
                            type: boolean
                            example: false
                          price_inclusive_tax_name:
                            type:
                              - string
                              - 'null'
                            example: VAT
                      type:
                        type: string
                        enum:
                          - regular
                          - enrollment
                        example: regular
                      enrollment_pack_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      enrollment_pack:
                        type:
                          - object
                          - 'null'
                        properties:
                          enrollment_pack_id:
                            type: integer
                            example: 1
                          additional_volume:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          slug:
                            type: string
                            example: test-enrollment-pack
                          description:
                            type:
                              - object
                              - 'null'
                              - string
                            properties:
                              id:
                                type: integer
                                example: 111
                              name:
                                type: string
                                example: description
                              body:
                                type: string
                                example: >-
                                  <div>Try the latest and greatest of our sugar
                                  zip packs. Guaranteed to make you skinner and
                                  cure cancer.</div>
                              record_type:
                                type: string
                                example: EnrollmentPack
                              record_id:
                                type: integer
                                example: 1
                              created_at:
                                type: string
                                format: date_time
                                example: '2025-01-16T04:22:43.809Z'
                              updated_at:
                                type: string
                                format: date_time
                                example: '2025-01-22T10:23:52.941Z'
                              locale:
                                type: string
                                example: en
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: 10
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.00
                          images:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2
                                relateable_type:
                                  type: string
                                  example: EnrollmentPack
                                relateable_id:
                                  type: integer
                                  example: 1
                                image_url:
                                  type: string
                                  example: >-
                                    https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                image_path:
                                  type: string
                                  example: jITWaU14QGe0y5AFgY7P_00179.svg
                                position:
                                  type: integer
                                  example: 1
                                shopify_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                                created_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                updated_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                external_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 625
                                allow_subscription:
                                  type: boolean
                                  example: true
                                cv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                cv_in_currency:
                                  type: string
                                  example: $0.00
                                cv_total:
                                  type: integer
                                  example: 0
                                enrollment:
                                  type: boolean
                                  example: true
                                enrollment_pack_id:
                                  type: integer
                                  example: 1
                                price:
                                  type: string
                                  example: '11.13'
                                price_in_currency:
                                  type: string
                                  example: $11.13
                                product_title:
                                  type: string
                                  example: Zip Pack Sample Pack (30)
                                quantity:
                                  type: integer
                                  example: 1
                                qv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                qv_in_currency:
                                  type: string
                                  example: $0.00
                                qv_total:
                                  type: integer
                                  example: 0
                                subscribe_and_save:
                                  type:
                                    - string
                                    - 'null'
                                  example: '-1988.87'
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $-1,988.87
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $-1,988.87
                                subscription:
                                  type: boolean
                                  example: false
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_only:
                                  type: boolean
                                  example: false
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_price:
                                  type: string
                                  example: '2000.0'
                                subscription_price_in_currency:
                                  type: string
                                  example: $2,000.00
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  format: date
                                  example: '2025-02-28'
                                tax:
                                  type: string
                                  example: '0.0'
                                tax_in_currency:
                                  type: string
                                  example: $0.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: null
                                display_to_customer:
                                  type: boolean
                                  example: false
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                          price:
                            type: string
                            example: '11.13'
                          price_in_currency:
                            type: string
                            example: $11.13
                          subscription_price:
                            type:
                              - string
                              - integer
                            example: 2000
                          subscription_price_in_currency:
                            type: string
                            example: $2,000.00
                          title:
                            type: string
                            example: enroll product
                          token:
                            type: string
                            example: NxL22AqLRRisfyF9LqxxWRak
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      recurring:
                        oneOf:
                          - type: array
                            items:
                              type: object
                              properties:
                                subtotal:
                                  type: string
                                  example: '10.0'
                                subtotal_in_currency:
                                  type: string
                                  example: $10.0
                                interval:
                                  type: integer
                                  example: 1
                                interval_unit:
                                  type: string
                                  example: month
                                subtotal_for_display:
                                  type: string
                                  example: $10.00 every 1 month
                                start_date:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-05-27'
                          - type: 'null'
                        default:
                          - subtotal: '10.0'
                            subtotal_in_currency: $10.0
                            interval: 1
                            interval_unit: month
                            subtotal_for_display: $10.00 every 1 month
                            start_date: '2025-05-27'
                      messages:
                        type: object
                        additionalProperties: true
                        example:
                          errors:
                            - Insufficient inventory
                            - Product no longer available
                          warnings:
                            - Low stock warning
                            - Shipping delays expected
                          info:
                            - Free shipping available
                            - Volume discount applied
                      points_enabled:
                        type: boolean
                        example: true
                      points_applied:
                        type: integer
                        example: 500
                        description: Number of points applied to the cart
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Currency value of applied points
                      customer_total_points:
                        type: integer
                        example: 1000
                        description: Customer's total available points balance
                      customer_total_points_in_currency:
                        type: number
                        example: 10
                        description: Currency value of available points
                      remaining_customer_points:
                        type: integer
                        example: 500
                        description: Customer's remaining points after cart redemption
                      remaining_customer_points_amount_in_currency:
                        type: number
                        example: 5
                        description: >-
                          Currency value of remaining points after cart
                          redemption
                      remaining_cart_amount_after_points:
                        type: number
                        example: 95
                        description: Amount to charge to card after points redemption
                      remaining_cart_amount_after_points_in_currency:
                        type:
                          - string
                        example: $95.00
                        description: >-
                          Amount in currency to charge to card after points
                          redemption
                      max_applicable_points:
                        type: integer
                        example: 500
                        description: Maximum points that can be applied to this cart
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      checkout_url:
                        type: string
                        example: https://checkout.fluid.com/checkout?jwt=abc123
                      shop_url:
                        type: string
                        example: https://myco.fluid.app
        '403':
          description: feature not enabled
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Feature not enabled
                  errors:
                    type: object
                    properties:
                      points:
                        type: array
                        items:
                          type: string
                        example:
                          - Points redemption is not enabled for this company
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '410':
          description: cart already processed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Cart is processed and can't be modified
                  errors:
                    type: object
                    properties:
                      cart:
                        type: array
                        items:
                          type: string
                        example:
                          - is processed and can't be modified
                  meta:
                    type: object
                    properties:
                      shop_url:
                        type: string
                        example: https://example.myshopify.com
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      cart:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 123
                          state:
                            type: string
                            example: start
                          processed:
                            type: boolean
                            example: false
                            description: >-
                              Determines if a cart payment has been processed or
                              not.
                          valid_for_checkout:
                            type: boolean
                            example: true
                          buyer_rep_id:
                            type:
                              - integer
                              - 'null'
                            example: 1
                          buyer_rep:
                            oneOf:
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 2
                                  email:
                                    type:
                                      - string
                                      - 'null'
                                    example: buyer.rep@example.com
                                  full_name:
                                    type:
                                      - string
                                      - 'null'
                                    example: John Doe
                                  image_url:
                                    type:
                                      - string
                                      - 'null'
                                    example: https://example.com/image.png
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: '123241'
                                required:
                                  - id
                              - type: 'null'
                          volume_rep:
                            oneOf:
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 2
                                  email:
                                    type:
                                      - string
                                      - 'null'
                                    example: volume.rep@example.com
                                  full_name:
                                    type:
                                      - string
                                      - 'null'
                                    example: John Doe
                                  image_url:
                                    type:
                                      - string
                                      - 'null'
                                    example: https://example.com/image.png
                                required:
                                  - id
                              - type: 'null'
                          currency_symbol:
                            type: string
                            example: $
                          currency_code:
                            type: string
                            example: USD
                          shipping_total_for_display:
                            type: string
                            example: Free
                          phone:
                            type:
                              - string
                              - 'null'
                            example: '4035551212'
                          payment_method_auto_assignable:
                            type: boolean
                            example: true
                            description: >-
                              Determines if a payment method can be
                              auto-assigned to the cart.
                          attribution:
                            oneOf:
                              - type: object
                                oneOf:
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      share_guid:
                                        type: string
                                        example: james-bond007
                                    required:
                                      - id
                                      - share_guid
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      email:
                                        type: string
                                        example: james.bond@gmail.com
                                    required:
                                      - id
                                      - email
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      username:
                                        type: string
                                        example: jaamball234
                                    required:
                                      - id
                                      - username
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      fluid_rep_id:
                                        type: integer
                                        example: 23493
                                    required:
                                      - id
                                      - fluid_rep_id
                                  - properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 456
                                      external_id:
                                        type:
                                          - string
                                          - 'null'
                                        example: w3sdf92
                                    required:
                                      - id
                              - type: 'null'
                            default:
                              id: 456
                              share_guid: james-bond007
                          agreements:
                            type: array
                            items:
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                  example: 1
                                required:
                                  type: boolean
                                  example: true
                                title:
                                  type: string
                                  example: Terms and Conditions
                                show_path:
                                  type: string
                                  example: /terms
                                enrollment_pack_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                          amount_total:
                            type: string
                            example: '121.65'
                          amount_total_in_currency:
                            type: string
                            example: $121.65 (USD)
                          sub_total:
                            type: string
                            example: '100.00'
                          sub_total_in_currency:
                            type: string
                            example: $100.00 (USD)
                          subtotal_after_discounts:
                            type: string
                            example: '90.00'
                          tax_total:
                            type: string
                            example: '20.00'
                          tax_total_in_currency:
                            type: string
                            example: $20.00 (USD)
                          shipping_total:
                            type:
                              - string
                              - 'null'
                            example: '1.65'
                          shipping_total_in_currency:
                            type: string
                            example: $1.65 (USD)
                          shipping_discount:
                            type: number
                            example: 10.25
                          discount_total:
                            type: string
                            example: '2.99'
                          discount_total_in_currency:
                            type: string
                            example: $2.99 (USD)
                          discount_breakdown:
                            type: object
                            properties:
                              internal_discounts:
                                type: number
                                example: 15
                              external_discounts:
                                type: number
                                example: 10
                              total_discounts:
                                type: number
                                example: 25
                          external_discount:
                            type: object
                            properties:
                              total:
                                type: number
                                example: 10
                              calculated_at:
                                type:
                                  - string
                                  - 'null'
                                format: date-time
                                example: '2024-01-10T15:30:00Z'
                              sources:
                                type: object
                                additionalProperties:
                                  type: object
                                  properties:
                                    amount:
                                      type: number
                                      example: 6
                                    description:
                                      type: string
                                      example: Gold tier discount
                                    metadata:
                                      type: object
                                  required:
                                    - amount
                                    - description
                          transaction_fee:
                            type:
                              - number
                              - string
                            example: '1.90'
                          transaction_fee_in_currency:
                            type: string
                            example: $1.90 (USD)
                          cv_total:
                            type: integer
                            example: 10
                          qv_total:
                            type: integer
                            example: 15
                          company:
                            type: object
                            properties:
                              id:
                                type: integer
                              name:
                                type: string
                              primary_domain_hostname:
                                type:
                                  - string
                                  - 'null'
                                example: fluid.com
                              subdomain:
                                type:
                                  - string
                                  - 'null'
                                example: myco
                              logo_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/logo.png
                              fluid_shop:
                                type:
                                  - string
                                  - 'null'
                                example: https://fluid-sample-shop.fluid.com
                              collect_phone:
                                type: boolean
                                example: true
                              require_phone:
                                type: boolean
                                example: false
                              require_billing_zip:
                                type: boolean
                                example: false
                              checkout_primary_button_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#000000'
                              checkout_primary_text_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#FFFFFF'
                              checkout_secondary_button_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#FFFFFF'
                              checkout_secondary_text_color:
                                type:
                                  - string
                                  - 'null'
                                example: '#000000'
                              favicon_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/favicon.ico
                              order_on_behalf:
                                type: boolean
                                example: false
                              use_juspay_gateway:
                                type: boolean
                                example: false
                              reward_points_enabled:
                                type: boolean
                                example: false
                          payment_account:
                            type:
                              - string
                              - 'null'
                            example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                          payment_method:
                            oneOf:
                              - type: 'null'
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: CreditCard
                                  payment_method_type:
                                    type: string
                                    example: visa
                                  last_four:
                                    type: string
                                    example: '1234'
                                  exp_month:
                                    type: string
                                    example: '12'
                                  exp_year:
                                    type: string
                                    example: '2025'
                                  logo_url:
                                    type: string
                                    example: https://example.com/image.svg
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Paypal
                                  status:
                                    type: string
                                    example: active
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Affirm
                                  affirm_id:
                                    type: string
                                    example: affirm_123
                                  status:
                                    type: string
                                    example: authorized
                                  checkout_id:
                                    type: string
                                    example: checkout_456
                                  created:
                                    type: string
                                    example: '2025-01-01T00:00:00Z'
                                  auth_expiration:
                                    type: string
                                    example: '2025-01-02T00:00:00Z'
                                  currency:
                                    type: string
                                    example: USD
                                  amount:
                                    type: string
                                    example: '100.00'
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Klarna
                                  session_id:
                                    type: string
                                    example: klarna_session_789
                                  intent:
                                    type: string
                                    example: buy
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: Droplet
                              - type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  type:
                                    type: string
                                    example: SomeCitcon
                          email:
                            type:
                              - string
                              - 'null'
                            example: user@example.com
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: '10.45'
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.45
                          discount_codes:
                            type: array
                            items:
                              type: string
                            example:
                              - DISCOUNT10
                              - DISCOUNT11
                          language_iso:
                            type:
                              - string
                              - 'null'
                            example: en
                          cart_token:
                            type: string
                            example: abc123
                          immutable_items:
                            type: boolean
                            example: false
                          digital_only:
                            type: boolean
                            example: false
                          requires_3ds:
                            type: boolean
                            example: false
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 101
                                price:
                                  type: string
                                  example: '43.41'
                                price_in_currency:
                                  type: string
                                  example: $43.41
                                tax:
                                  type: string
                                  example: '2.99'
                                tax_in_currency:
                                  type: string
                                  example: $2.99
                                cv:
                                  type: integer
                                  example: 5
                                cv_total:
                                  type: integer
                                  example: 15
                                qv:
                                  type: integer
                                  example: 7
                                qv_total:
                                  type: integer
                                  example: 21
                                discount_amount:
                                  type: string
                                  example: '10'
                                free_item:
                                  type: boolean
                                  example: false
                                discount_amount_in_currency:
                                  type: string
                                  example: $10.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                enrollment_pack_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                display_to_customer:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                product_title:
                                  type:
                                    - string
                                    - 'null'
                                  example: Sample Product
                                quantity:
                                  type: integer
                                  example: 3
                                subscription:
                                  type: boolean
                                  example: true
                                enrollment:
                                  type: boolean
                                  example: false
                                allow_subscription:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_only:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_price:
                                  type:
                                    - number
                                    - string
                                    - 'null'
                                  example: 10.5
                                subscription_price_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $10.50
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-02-12'
                                subscribe_and_save:
                                  type:
                                    - number
                                    - string
                                    - 'null'
                                  example: 2.99
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $2.99
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $2.99
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: Surcharge
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                product:
                                  oneOf:
                                    - type: object
                                      properties:
                                        id:
                                          type: integer
                                          example: 1
                                        title:
                                          type: string
                                          example: Sample Product
                                        introduction:
                                          type:
                                            - string
                                            - 'null'
                                          example: Sample Product Description
                                        cv:
                                          type: integer
                                          example: 10
                                        external_id:
                                          type:
                                            - string
                                            - 'null'
                                          example: ext-prod-123
                                        image_path:
                                          type:
                                            - string
                                            - 'null'
                                          example: /images/product.png
                                        image_url:
                                          type:
                                            - string
                                            - 'null'
                                          example: https://example.com/images/product.png
                                        price:
                                          type: string
                                          example: '29.99'
                                        price_in_currency:
                                          type: string
                                          example: $29.99
                                        sku:
                                          type:
                                            - string
                                            - 'null'
                                          example: SKU12345
                                        tax:
                                          type: string
                                          example: '2.99'
                                        tax_in_currency:
                                          type: string
                                          example: $2.99
                                        metadata:
                                          type: object
                                          example:
                                            shopify_product_id: 9876054868270
                                        metafields:
                                          type: array
                                          items:
                                            title: LegacyMetafield
                                            type: object
                                            properties:
                                              namespace:
                                                description: >-
                                                  A container for related metafields.
                                                  Commonly used to group metafields by app
                                                  or functionality.
                                                example: custom
                                                type: string
                                                maxLength: 20
                                                pattern: ^[a-zA-Z0-9_]+$
                                              key:
                                                description: >-
                                                  The unique identifier for the metafield
                                                  within its namespace. Must be unique per
                                                  namespace and owner.
                                                example: material
                                                type: string
                                                maxLength: 30
                                                pattern: ^[a-zA-Z0-9_]+$
                                              value:
                                                description: >-
                                                  The actual data stored in the metafield.
                                                  Type depends on value_type.
                                                example: cotton
                                                type:
                                                  - string
                                                  - integer
                                                  - object
                                                  - boolean
                                                  - number
                                              value_type:
                                                description: >-
                                                  The data type that defines how the value
                                                  should be interpreted and validated.
                                                example: single_line_text_field
                                                type: string
                                              description:
                                                description: >-
                                                  Optional human-readable description
                                                  explaining the purpose of this
                                                  metafield.
                                                example: >-
                                                  The primary material used in this
                                                  product
                                                type:
                                                  - string
                                                  - 'null'
                                              created_at:
                                                description: >-
                                                  Timestamp when the metafield was
                                                  created.
                                                example: '2021-01-01T00:00:00Z'
                                                type: string
                                                format: date-time
                                              updated_at:
                                                description: >-
                                                  Timestamp when the metafield was last
                                                  updated.
                                                example: '2021-01-01T00:00:00Z'
                                                type: string
                                                format: date-time
                                              locked:
                                                description: >-
                                                  Whether this metafield is locked and
                                                  cannot be updated or deleted directly.
                                                example: false
                                                type:
                                                  - boolean
                                                  - 'null'
                                                  - 'null'
                                              metafield_definition:
                                                description: >-
                                                  The definition that defines validation
                                                  rules and structure for this metafield
                                                type:
                                                  - 'null'
                                                  - object
                                            required:
                                              - namespace
                                              - key
                                              - value
                                              - value_type
                                              - description
                                              - created_at
                                              - updated_at
                                              - metafield_definition
                                    - type: 'null'
                                variant:
                                  oneOf:
                                    - type: object
                                      properties:
                                        id:
                                          type: integer
                                          example: 1
                                        title:
                                          type:
                                            - string
                                            - 'null'
                                          example: Sample Variant
                                        image_path:
                                          type:
                                            - string
                                            - 'null'
                                          example: /images/sample.png
                                        image_url:
                                          type:
                                            - string
                                            - 'null'
                                          example: https://example.com/images/sample.png
                                        primary_image:
                                          type:
                                            - string
                                            - 'null'
                                          example: https://example.com/images/primary.png
                                        price:
                                          type:
                                            - string
                                            - 'null'
                                          example: '34.44'
                                        price_in_currency:
                                          type:
                                            - string
                                            - 'null'
                                          example: $34.44
                                        sku:
                                          type:
                                            - string
                                            - 'null'
                                          example: SKU12345
                                        options:
                                          type: array
                                          items:
                                            type: object
                                            properties:
                                              title:
                                                type: string
                                                example: Size
                                              value:
                                                type: string
                                                example: XL
                                        physical:
                                          type:
                                            - boolean
                                            - 'null'
                                          example: true
                                        unit_of_size:
                                          type:
                                            - string
                                            - 'null'
                                          example: cm
                                        height:
                                          type:
                                            - number
                                            - 'null'
                                          example: 13
                                        width:
                                          type:
                                            - number
                                            - 'null'
                                          example: 6
                                        length:
                                          type:
                                            - number
                                            - 'null'
                                          example: 12
                                        unit_of_weight:
                                          type:
                                            - string
                                            - 'null'
                                          example: kg
                                        weight:
                                          type:
                                            - string
                                            - 'null'
                                          example: '3.2'
                                        hs_code:
                                          type:
                                            - string
                                            - 'null'
                                          example: '3.2'
                                    - type: 'null'
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                                bundled_items:
                                  type: array
                                  items:
                                    type: object
                                    description: Bundled items for bundle products
                                    properties:
                                      variant_id:
                                        type: integer
                                        example: 1
                                      product_id:
                                        type: integer
                                        example: 1
                                      product_title:
                                        type: string
                                        example: Product Title
                                      variant_title:
                                        type: string
                                        example: Variant Title
                                      option_titles:
                                        type: array
                                        example:
                                          - Option 1
                                          - Option 2
                                      quantity:
                                        type: integer
                                        example: 1
                                      display_to_customer:
                                        type: boolean
                                        example: true
                          ship_to:
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                                example: 1
                              name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              first_name:
                                type:
                                  - string
                                  - 'null'
                                example: John
                              last_name:
                                type:
                                  - string
                                  - 'null'
                                example: Doe
                              address1:
                                type: string
                                example: 123 Main St
                              address2:
                                type:
                                  - string
                                  - 'null'
                                example: Apt 4B
                              address3:
                                type:
                                  - string
                                  - 'null'
                                example: Building 5
                              city:
                                type: string
                                example: New York
                              state:
                                type: string
                                example: NY
                              postal_code:
                                type: string
                                example: '10001'
                              country_code:
                                type: string
                                example: US
                                description: >-
                                  country_id takes precedence if both country_id
                                  and country_code provided.
                              subdivision_code:
                                type:
                                  - string
                                  - 'null'
                                example: NY
                              default:
                                type: boolean
                                example: true
                          bill_to:
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                                example: 1
                              name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              first_name:
                                type:
                                  - string
                                  - 'null'
                                example: John
                              last_name:
                                type:
                                  - string
                                  - 'null'
                                example: Doe
                              address1:
                                type: string
                                example: 123 Main St
                              address2:
                                type:
                                  - string
                                  - 'null'
                                example: Apt 4B
                              address3:
                                type:
                                  - string
                                  - 'null'
                                example: Building 5
                              city:
                                type: string
                                example: New York
                              state:
                                type: string
                                example: NY
                              postal_code:
                                type: string
                                example: '10001'
                              country_code:
                                type: string
                                example: US
                                description: >-
                                  country_id takes precedence if both country_id
                                  and country_code provided.
                              subdivision_code:
                                type:
                                  - string
                                  - 'null'
                                example: NY
                              default:
                                type: boolean
                                example: true
                          shipping_method:
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: string
                                example: standard-shipping
                              name:
                                type: string
                                example: Standard Shipping
                          available_shipping_methods:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                  example: standard-shipping
                                title:
                                  type: string
                                  example: Standard Shipping
                                price:
                                  type:
                                    - number
                                    - string
                                  example: 5.99
                                price_label:
                                  type: string
                                  example: $5.99
                                delivery_time_estimate:
                                  type: string
                                  example: 3-5 business days
                          available_payment_methods:
                            type: array
                            items:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1337
                                    uuid:
                                      type: string
                                      example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                    type:
                                      type: string
                                      enum:
                                        - credit_card
                                    name:
                                      type: string
                                      example: Credit Card
                                    image_url:
                                      type: string
                                      example: https://example.com/image.png
                                    test:
                                      type: boolean
                                      example: true
                                      description: >-
                                        Determines if payment method is test
                                        instance or not. By default, set to
                                        `true`
                                    sandbox:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method is sandbox
                                        instance or not. By default, set to
                                        `false`
                                    apple_pay:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method supports
                                        ApplePay or not 
                                    bogus_gateway:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method is a Bogus
                                        instance or not.
                                    tokenize_path:
                                      type:
                                        - string
                                        - 'null'
                                      description: Path to tokenize, if applicable.
                                    token_provider:
                                      type: string
                                      enum:
                                        - spreedly
                                        - vgs
                                      description: >-
                                        Determines if payment tokenization is
                                        via spreedly or VGS
                                    apple_pay_merchant_identifier:
                                      type:
                                        - string
                                        - 'null'
                                      example: merchant.mycompany.com
                                      description: >-
                                        If ApplePay is supported, returns the
                                        merchant identifier registered with
                                        Apple, else returns nil
                                    supported_brands:
                                      type: array
                                      items:
                                        type: string
                                      example:
                                        - visa
                                        - master
                                        - american_express
                                        - discover
                                    publishable_key:
                                      type:
                                        - string
                                        - 'null'
                                      example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                      description: >-
                                        If publishable key is set for
                                        Hyperswitch, returns the publishable
                                        key, else returns nil
                                    customer_details_schema:
                                      type: object
                                      example: {}
                                      description: >-
                                        Schema defining required customer
                                        details for this payment method
                                  required:
                                    - id
                                    - type
                                    - name
                                    - supported_brands
                                    - test
                                    - sandbox
                                    - apple_pay
                                    - apple_pay_merchant_identifier
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1337
                                    uuid:
                                      type: string
                                      example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                    type:
                                      type: string
                                      enum:
                                        - klarna
                                    name:
                                      type: string
                                      example: Klarna
                                    image_url:
                                      type: string
                                      example: https://example.com/image.png
                                    test:
                                      type: boolean
                                      example: true
                                      description: >-
                                        Determines if payment method is test
                                        instance or not. By default, set to
                                        `true`
                                    sandbox:
                                      type: boolean
                                      example: false
                                      description: >-
                                        Determines if payment method is sandbox
                                        instance or not. By default, set to
                                        `false`
                                    customer_details_schema:
                                      type: object
                                      example: {}
                                      description: >-
                                        Schema defining required customer
                                        details for this payment method
                          country:
                            type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              iso:
                                type: string
                                example: US
                              name:
                                type: string
                                example: United States
                              iso_name:
                                type: string
                                example: UNITED STATES
                              iso3:
                                type: string
                                example: USA
                              currency_code:
                                type: string
                                example: USD
                              currency_symbol:
                                type: string
                                example: $
                              province_required:
                                type: boolean
                                example: false
                              tax_enabled:
                                type:
                                  - boolean
                                  - 'null'
                                example: true
                              price_inclusive_of_tax:
                                type: boolean
                                example: false
                              price_inclusive_tax_name:
                                type:
                                  - string
                                  - 'null'
                                example: VAT
                          type:
                            type: string
                            enum:
                              - regular
                              - enrollment
                            example: regular
                          enrollment_pack_id:
                            type:
                              - integer
                              - 'null'
                            example: 1
                          enrollment_pack:
                            type:
                              - object
                              - 'null'
                            properties:
                              enrollment_pack_id:
                                type: integer
                                example: 1
                              additional_volume:
                                type:
                                  - integer
                                  - 'null'
                                example: 10
                              slug:
                                type: string
                                example: test-enrollment-pack
                              description:
                                type:
                                  - object
                                  - 'null'
                                  - string
                                properties:
                                  id:
                                    type: integer
                                    example: 111
                                  name:
                                    type: string
                                    example: description
                                  body:
                                    type: string
                                    example: >-
                                      <div>Try the latest and greatest of our
                                      sugar zip packs. Guaranteed to make you
                                      skinner and cure cancer.</div>
                                  record_type:
                                    type: string
                                    example: EnrollmentPack
                                  record_id:
                                    type: integer
                                    example: 1
                                  created_at:
                                    type: string
                                    format: date_time
                                    example: '2025-01-16T04:22:43.809Z'
                                  updated_at:
                                    type: string
                                    format: date_time
                                    example: '2025-01-22T10:23:52.941Z'
                                  locale:
                                    type: string
                                    example: en
                              enrollment_fee:
                                type:
                                  - number
                                  - string
                                example: 10
                              enrollment_fee_in_currency:
                                type: string
                                example: $10.00
                              images:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 2
                                    relateable_type:
                                      type: string
                                      example: EnrollmentPack
                                    relateable_id:
                                      type: integer
                                      example: 1
                                    image_url:
                                      type: string
                                      example: >-
                                        https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                    image_path:
                                      type: string
                                      example: jITWaU14QGe0y5AFgY7P_00179.svg
                                    position:
                                      type: integer
                                      example: 1
                                    shopify_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: null
                                    created_at:
                                      type: string
                                      format: date_time
                                      example: '2025-01-16T04:22:44.870Z'
                                    updated_at:
                                      type: string
                                      format: date_time
                                      example: '2025-01-16T04:22:44.870Z'
                                    external_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: null
                              items:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 625
                                    allow_subscription:
                                      type: boolean
                                      example: true
                                    cv:
                                      type:
                                        - number
                                        - string
                                      example: 0
                                    cv_in_currency:
                                      type: string
                                      example: $0.00
                                    cv_total:
                                      type: integer
                                      example: 0
                                    enrollment:
                                      type: boolean
                                      example: true
                                    enrollment_pack_id:
                                      type: integer
                                      example: 1
                                    price:
                                      type: string
                                      example: '11.13'
                                    price_in_currency:
                                      type: string
                                      example: $11.13
                                    product_title:
                                      type: string
                                      example: Zip Pack Sample Pack (30)
                                    quantity:
                                      type: integer
                                      example: 1
                                    qv:
                                      type:
                                        - number
                                        - string
                                      example: 0
                                    qv_in_currency:
                                      type: string
                                      example: $0.00
                                    qv_total:
                                      type: integer
                                      example: 0
                                    subscribe_and_save:
                                      type:
                                        - string
                                        - 'null'
                                      example: '-1988.87'
                                    subscribe_and_save_for_display:
                                      type:
                                        - string
                                        - 'null'
                                      example: Subscribe and save $-1,988.87
                                    subscribe_and_save_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $-1,988.87
                                    subscription:
                                      type: boolean
                                      example: false
                                    subscription_interval:
                                      type:
                                        - integer
                                        - 'null'
                                      example: 1
                                    subscription_interval_unit:
                                      type:
                                        - string
                                        - 'null'
                                      example: month
                                    subscription_only:
                                      type: boolean
                                      example: false
                                    subscription_plan_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: 1
                                    subscription_plans:
                                      oneOf:
                                        - type: array
                                          items:
                                            title: Commerce::SubscriptionPlan
                                            type: object
                                            properties:
                                              id:
                                                type: integer
                                              name:
                                                example: Test Subscription Plan
                                                type: string
                                              billing_interval:
                                                example: 1
                                                type: integer
                                                default: 1
                                                minimum: 1
                                                maximum: 29
                                              billing_interval_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type: string
                                                default: month
                                              billing_frequency_in_words:
                                                example: 2 Months
                                                type: string
                                              shipping_interval:
                                                example: 1
                                                type: integer
                                                default: 1
                                                minimum: 1
                                                maximum: 29
                                              shipping_interval_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type: string
                                                default: month
                                              volume_interval:
                                                example: 1
                                                type: integer
                                                default: 1
                                                minimum: 1
                                                maximum: 29
                                              volume_interval_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type: string
                                                default: month
                                              trial_period:
                                                example: 1
                                                type:
                                                  - integer
                                                  - 'null'
                                                minimum: 1
                                              trial_period_unit:
                                                description: >-
                                                  Possible values: `day`, `week`, `month`,
                                                  `year`
                                                example: day
                                                type:
                                                  - string
                                                  - 'null'
                                              split_volume:
                                                example: true
                                                type: boolean
                                                default: false
                                              allow_max_billing_cycles:
                                                example: true
                                                type: boolean
                                                default: false
                                              max_billing_cycles:
                                                example: 3
                                                type:
                                                  - integer
                                                  - 'null'
                                              company_default:
                                                example: false
                                                type:
                                                  - boolean
                                                  - 'null'
                                                default: false
                                              products_count:
                                                example: 10
                                                type:
                                                  - integer
                                                  - 'null'
                                              subscribers_count:
                                                example: 10
                                                type:
                                                  - integer
                                                  - 'null'
                                              price:
                                                type: string
                                              price_in_currency:
                                                type: string
                                              subscription_start:
                                                type: string
                                              subscribe_and_save:
                                                type:
                                                  - string
                                                  - 'null'
                                              subscribe_and_save_in_currency:
                                                type:
                                                  - string
                                                  - 'null'
                                              subscribe_and_save_for_display:
                                                type:
                                                  - string
                                                  - 'null'
                                            required:
                                              - id
                                              - name
                                              - billing_interval
                                              - billing_interval_unit
                                              - billing_frequency_in_words
                                              - shipping_interval
                                              - shipping_interval_unit
                                              - volume_interval
                                              - volume_interval_unit
                                              - split_volume
                                              - allow_max_billing_cycles
                                              - price
                                              - price_in_currency
                                              - subscription_start
                                              - subscribe_and_save
                                              - subscribe_and_save_in_currency
                                              - subscribe_and_save_for_display
                                        - type: 'null'
                                    subscription_price:
                                      type: string
                                      example: '2000.0'
                                    subscription_price_in_currency:
                                      type: string
                                      example: $2,000.00
                                    subscription_start:
                                      type:
                                        - string
                                        - 'null'
                                      format: date
                                      example: '2025-02-28'
                                    tax:
                                      type: string
                                      example: '0.0'
                                    tax_in_currency:
                                      type: string
                                      example: $0.00
                                    total_after_discounts:
                                      type: string
                                      example: '90.00'
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: null
                                    display_to_customer:
                                      type: boolean
                                      example: false
                                    metadata:
                                      type: object
                                      description: >-
                                        A JSON object that can store any custom
                                        data structure
                                      example: {}
                                    errors:
                                      oneOf:
                                        - type: 'null'
                                        - type: array
                                          items:
                                            type: object
                                          example:
                                            - country:
                                                - >-
                                                  This product is not available for this
                                                  country. Please change your country
                              price:
                                type: string
                                example: '11.13'
                              price_in_currency:
                                type: string
                                example: $11.13
                              subscription_price:
                                type:
                                  - string
                                  - integer
                                example: 2000
                              subscription_price_in_currency:
                                type: string
                                example: $2,000.00
                              title:
                                type: string
                                example: enroll product
                              token:
                                type: string
                                example: NxL22AqLRRisfyF9LqxxWRak
                          metadata:
                            type: object
                            description: >-
                              A JSON object that can store any custom data
                              structure.
                          recurring:
                            oneOf:
                              - type: array
                                items:
                                  type: object
                                  properties:
                                    subtotal:
                                      type: string
                                      example: '10.0'
                                    subtotal_in_currency:
                                      type: string
                                      example: $10.0
                                    interval:
                                      type: integer
                                      example: 1
                                    interval_unit:
                                      type: string
                                      example: month
                                    subtotal_for_display:
                                      type: string
                                      example: $10.00 every 1 month
                                    start_date:
                                      type:
                                        - string
                                        - 'null'
                                      example: '2025-05-27'
                              - type: 'null'
                            default:
                              - subtotal: '10.0'
                                subtotal_in_currency: $10.0
                                interval: 1
                                interval_unit: month
                                subtotal_for_display: $10.00 every 1 month
                                start_date: '2025-05-27'
                          messages:
                            type: object
                            additionalProperties: true
                            example:
                              errors:
                                - Insufficient inventory
                                - Product no longer available
                              warnings:
                                - Low stock warning
                                - Shipping delays expected
                              info:
                                - Free shipping available
                                - Volume discount applied
                          points_enabled:
                            type: boolean
                            example: true
                          points_applied:
                            type: integer
                            example: 500
                            description: Number of points applied to the cart
                          points_applied_amount_in_currency:
                            type: number
                            example: 5
                            description: Currency value of applied points
                          customer_total_points:
                            type: integer
                            example: 1000
                            description: Customer's total available points balance
                          customer_total_points_in_currency:
                            type: number
                            example: 10
                            description: Currency value of available points
                          remaining_customer_points:
                            type: integer
                            example: 500
                            description: Customer's remaining points after cart redemption
                          remaining_customer_points_amount_in_currency:
                            type: number
                            example: 5
                            description: >-
                              Currency value of remaining points after cart
                              redemption
                          remaining_cart_amount_after_points:
                            type: number
                            example: 95
                            description: Amount to charge to card after points redemption
                          remaining_cart_amount_after_points_in_currency:
                            type:
                              - string
                            example: $95.00
                            description: >-
                              Amount in currency to charge to card after points
                              redemption
                          max_applicable_points:
                            type: integer
                            example: 500
                            description: Maximum points that can be applied to this cart
  /api/carts/{cart_token}/set_saved_payment_method:
    post:
      summary: Sets a saved payment method for a cart
      tags:
        - Carts
      description: |
        Sets a saved payment method for a cart.
        Requires customer authentication or company admin access.
        The payment method must belong to the customer's fluid pay account.
      operationId: setSavedPaymentMethod
      security:
        - bearer_auth: []
      parameters:
        - name: cart_token
          in: path
          required: true
          description: The cart token
          example: abc123def456
          schema:
            type: string
      responses:
        '200':
          description: Payment method set successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      state:
                        type: string
                        example: start
                      processed:
                        type: boolean
                        example: false
                        description: >-
                          Determines if a cart payment has been processed or
                          not.
                      valid_for_checkout:
                        type: boolean
                        example: true
                      buyer_rep_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      buyer_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: buyer.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                              external_id:
                                type:
                                  - string
                                  - 'null'
                                example: '123241'
                            required:
                              - id
                          - type: 'null'
                      volume_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: volume.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                            required:
                              - id
                          - type: 'null'
                      currency_symbol:
                        type: string
                        example: $
                      currency_code:
                        type: string
                        example: USD
                      shipping_total_for_display:
                        type: string
                        example: Free
                      phone:
                        type:
                          - string
                          - 'null'
                        example: '4035551212'
                      payment_method_auto_assignable:
                        type: boolean
                        example: true
                        description: >-
                          Determines if a payment method can be auto-assigned to
                          the cart.
                      attribution:
                        oneOf:
                          - type: object
                            oneOf:
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  share_guid:
                                    type: string
                                    example: james-bond007
                                required:
                                  - id
                                  - share_guid
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  email:
                                    type: string
                                    example: james.bond@gmail.com
                                required:
                                  - id
                                  - email
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  username:
                                    type: string
                                    example: jaamball234
                                required:
                                  - id
                                  - username
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  fluid_rep_id:
                                    type: integer
                                    example: 23493
                                required:
                                  - id
                                  - fluid_rep_id
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: w3sdf92
                                required:
                                  - id
                          - type: 'null'
                        default:
                          id: 456
                          share_guid: james-bond007
                      agreements:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            required:
                              type: boolean
                              example: true
                            title:
                              type: string
                              example: Terms and Conditions
                            show_path:
                              type: string
                              example: /terms
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                      amount_total:
                        type: string
                        example: '121.65'
                      amount_total_in_currency:
                        type: string
                        example: $121.65 (USD)
                      sub_total:
                        type: string
                        example: '100.00'
                      sub_total_in_currency:
                        type: string
                        example: $100.00 (USD)
                      subtotal_after_discounts:
                        type: string
                        example: '90.00'
                      tax_total:
                        type: string
                        example: '20.00'
                      tax_total_in_currency:
                        type: string
                        example: $20.00 (USD)
                      shipping_total:
                        type:
                          - string
                          - 'null'
                        example: '1.65'
                      shipping_total_in_currency:
                        type: string
                        example: $1.65 (USD)
                      shipping_discount:
                        type: number
                        example: 10.25
                      discount_total:
                        type: string
                        example: '2.99'
                      discount_total_in_currency:
                        type: string
                        example: $2.99 (USD)
                      discount_breakdown:
                        type: object
                        properties:
                          internal_discounts:
                            type: number
                            example: 15
                          external_discounts:
                            type: number
                            example: 10
                          total_discounts:
                            type: number
                            example: 25
                      external_discount:
                        type: object
                        properties:
                          total:
                            type: number
                            example: 10
                          calculated_at:
                            type:
                              - string
                              - 'null'
                            format: date-time
                            example: '2024-01-10T15:30:00Z'
                          sources:
                            type: object
                            additionalProperties:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 6
                                description:
                                  type: string
                                  example: Gold tier discount
                                metadata:
                                  type: object
                              required:
                                - amount
                                - description
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: '1.90'
                      transaction_fee_in_currency:
                        type: string
                        example: $1.90 (USD)
                      cv_total:
                        type: integer
                        example: 10
                      qv_total:
                        type: integer
                        example: 15
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      payment_account:
                        type:
                          - string
                          - 'null'
                        example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                      payment_method:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: CreditCard
                              payment_method_type:
                                type: string
                                example: visa
                              last_four:
                                type: string
                                example: '1234'
                              exp_month:
                                type: string
                                example: '12'
                              exp_year:
                                type: string
                                example: '2025'
                              logo_url:
                                type: string
                                example: https://example.com/image.svg
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Paypal
                              status:
                                type: string
                                example: active
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Affirm
                              affirm_id:
                                type: string
                                example: affirm_123
                              status:
                                type: string
                                example: authorized
                              checkout_id:
                                type: string
                                example: checkout_456
                              created:
                                type: string
                                example: '2025-01-01T00:00:00Z'
                              auth_expiration:
                                type: string
                                example: '2025-01-02T00:00:00Z'
                              currency:
                                type: string
                                example: USD
                              amount:
                                type: string
                                example: '100.00'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Klarna
                              session_id:
                                type: string
                                example: klarna_session_789
                              intent:
                                type: string
                                example: buy
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Droplet
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: SomeCitcon
                      email:
                        type:
                          - string
                          - 'null'
                        example: user@example.com
                      enrollment_fee:
                        type:
                          - number
                          - string
                        example: '10.45'
                      enrollment_fee_in_currency:
                        type: string
                        example: $10.45
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT10
                          - DISCOUNT11
                      language_iso:
                        type:
                          - string
                          - 'null'
                        example: en
                      cart_token:
                        type: string
                        example: abc123
                      immutable_items:
                        type: boolean
                        example: false
                      digital_only:
                        type: boolean
                        example: false
                      requires_3ds:
                        type: boolean
                        example: false
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 101
                            price:
                              type: string
                              example: '43.41'
                            price_in_currency:
                              type: string
                              example: $43.41
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            cv:
                              type: integer
                              example: 5
                            cv_total:
                              type: integer
                              example: 15
                            qv:
                              type: integer
                              example: 7
                            qv_total:
                              type: integer
                              example: 21
                            discount_amount:
                              type: string
                              example: '10'
                            free_item:
                              type: boolean
                              example: false
                            discount_amount_in_currency:
                              type: string
                              example: $10.00
                            total_after_discounts:
                              type: string
                              example: '90.00'
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            product_title:
                              type:
                                - string
                                - 'null'
                              example: Sample Product
                            quantity:
                              type: integer
                              example: 3
                            subscription:
                              type: boolean
                              example: true
                            enrollment:
                              type: boolean
                              example: false
                            allow_subscription:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_plan_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_plans:
                              oneOf:
                                - type: array
                                  items:
                                    title: Commerce::SubscriptionPlan
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        example: Test Subscription Plan
                                        type: string
                                      billing_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      billing_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      billing_frequency_in_words:
                                        example: 2 Months
                                        type: string
                                      shipping_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      shipping_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      volume_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      volume_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      trial_period:
                                        example: 1
                                        type:
                                          - integer
                                          - 'null'
                                        minimum: 1
                                      trial_period_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type:
                                          - string
                                          - 'null'
                                      split_volume:
                                        example: true
                                        type: boolean
                                        default: false
                                      allow_max_billing_cycles:
                                        example: true
                                        type: boolean
                                        default: false
                                      max_billing_cycles:
                                        example: 3
                                        type:
                                          - integer
                                          - 'null'
                                      company_default:
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                        default: false
                                      products_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      subscribers_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      price:
                                        type: string
                                      price_in_currency:
                                        type: string
                                      subscription_start:
                                        type: string
                                      subscribe_and_save:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_in_currency:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_for_display:
                                        type:
                                          - string
                                          - 'null'
                                    required:
                                      - id
                                      - name
                                      - billing_interval
                                      - billing_interval_unit
                                      - billing_frequency_in_words
                                      - shipping_interval
                                      - shipping_interval_unit
                                      - volume_interval
                                      - volume_interval_unit
                                      - split_volume
                                      - allow_max_billing_cycles
                                      - price
                                      - price_in_currency
                                      - subscription_start
                                      - subscribe_and_save
                                      - subscribe_and_save_in_currency
                                      - subscribe_and_save_for_display
                                - type: 'null'
                            subscription_only:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_interval:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_interval_unit:
                              type:
                                - string
                                - 'null'
                              example: month
                            subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 10.5
                            subscription_price_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $10.50
                            subscription_start:
                              type:
                                - string
                                - 'null'
                              example: '2025-02-12'
                            subscribe_and_save:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 2.99
                            subscribe_and_save_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $2.99
                            subscribe_and_save_for_display:
                              type:
                                - string
                                - 'null'
                              example: Subscribe and save $2.99
                            title:
                              type:
                                - string
                                - 'null'
                              example: Surcharge
                            metadata:
                              type: object
                              description: >-
                                A JSON object that can store any custom data
                                structure
                              example: {}
                            product:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type: string
                                      example: Sample Product
                                    introduction:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Product Description
                                    cv:
                                      type: integer
                                      example: 10
                                    external_id:
                                      type:
                                        - string
                                        - 'null'
                                      example: ext-prod-123
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/product.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/product.png
                                    price:
                                      type: string
                                      example: '29.99'
                                    price_in_currency:
                                      type: string
                                      example: $29.99
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    tax:
                                      type: string
                                      example: '2.99'
                                    tax_in_currency:
                                      type: string
                                      example: $2.99
                                    metadata:
                                      type: object
                                      example:
                                        shopify_product_id: 9876054868270
                                    metafields:
                                      type: array
                                      items:
                                        title: LegacyMetafield
                                        type: object
                                        properties:
                                          namespace:
                                            description: >-
                                              A container for related metafields.
                                              Commonly used to group metafields by app
                                              or functionality.
                                            example: custom
                                            type: string
                                            maxLength: 20
                                            pattern: ^[a-zA-Z0-9_]+$
                                          key:
                                            description: >-
                                              The unique identifier for the metafield
                                              within its namespace. Must be unique per
                                              namespace and owner.
                                            example: material
                                            type: string
                                            maxLength: 30
                                            pattern: ^[a-zA-Z0-9_]+$
                                          value:
                                            description: >-
                                              The actual data stored in the metafield.
                                              Type depends on value_type.
                                            example: cotton
                                            type:
                                              - string
                                              - integer
                                              - object
                                              - boolean
                                              - number
                                          value_type:
                                            description: >-
                                              The data type that defines how the value
                                              should be interpreted and validated.
                                            example: single_line_text_field
                                            type: string
                                          description:
                                            description: >-
                                              Optional human-readable description
                                              explaining the purpose of this
                                              metafield.
                                            example: >-
                                              The primary material used in this
                                              product
                                            type:
                                              - string
                                              - 'null'
                                          created_at:
                                            description: >-
                                              Timestamp when the metafield was
                                              created.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          updated_at:
                                            description: >-
                                              Timestamp when the metafield was last
                                              updated.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          locked:
                                            description: >-
                                              Whether this metafield is locked and
                                              cannot be updated or deleted directly.
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                              - 'null'
                                          metafield_definition:
                                            description: >-
                                              The definition that defines validation
                                              rules and structure for this metafield
                                            type:
                                              - 'null'
                                              - object
                                        required:
                                          - namespace
                                          - key
                                          - value
                                          - value_type
                                          - description
                                          - created_at
                                          - updated_at
                                          - metafield_definition
                                - type: 'null'
                            variant:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Variant
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/sample.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/sample.png
                                    primary_image:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/primary.png
                                    price:
                                      type:
                                        - string
                                        - 'null'
                                      example: '34.44'
                                    price_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $34.44
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    options:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          title:
                                            type: string
                                            example: Size
                                          value:
                                            type: string
                                            example: XL
                                    physical:
                                      type:
                                        - boolean
                                        - 'null'
                                      example: true
                                    unit_of_size:
                                      type:
                                        - string
                                        - 'null'
                                      example: cm
                                    height:
                                      type:
                                        - number
                                        - 'null'
                                      example: 13
                                    width:
                                      type:
                                        - number
                                        - 'null'
                                      example: 6
                                    length:
                                      type:
                                        - number
                                        - 'null'
                                      example: 12
                                    unit_of_weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: kg
                                    weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                    hs_code:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                - type: 'null'
                            errors:
                              oneOf:
                                - type: 'null'
                                - type: array
                                  items:
                                    type: object
                                  example:
                                    - country:
                                        - >-
                                          This product is not available for this
                                          country. Please change your country
                            bundled_items:
                              type: array
                              items:
                                type: object
                                description: Bundled items for bundle products
                                properties:
                                  variant_id:
                                    type: integer
                                    example: 1
                                  product_id:
                                    type: integer
                                    example: 1
                                  product_title:
                                    type: string
                                    example: Product Title
                                  variant_title:
                                    type: string
                                    example: Variant Title
                                  option_titles:
                                    type: array
                                    example:
                                      - Option 1
                                      - Option 2
                                  quantity:
                                    type: integer
                                    example: 1
                                  display_to_customer:
                                    type: boolean
                                    example: true
                      ship_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      bill_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      shipping_method:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: string
                            example: standard-shipping
                          name:
                            type: string
                            example: Standard Shipping
                      available_shipping_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: standard-shipping
                            title:
                              type: string
                              example: Standard Shipping
                            price:
                              type:
                                - number
                                - string
                              example: 5.99
                            price_label:
                              type: string
                              example: $5.99
                            delivery_time_estimate:
                              type: string
                              example: 3-5 business days
                      available_payment_methods:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - credit_card
                                name:
                                  type: string
                                  example: Credit Card
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                apple_pay:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method supports
                                    ApplePay or not 
                                bogus_gateway:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is a Bogus
                                    instance or not.
                                tokenize_path:
                                  type:
                                    - string
                                    - 'null'
                                  description: Path to tokenize, if applicable.
                                token_provider:
                                  type: string
                                  enum:
                                    - spreedly
                                    - vgs
                                  description: >-
                                    Determines if payment tokenization is via
                                    spreedly or VGS
                                apple_pay_merchant_identifier:
                                  type:
                                    - string
                                    - 'null'
                                  example: merchant.mycompany.com
                                  description: >-
                                    If ApplePay is supported, returns the
                                    merchant identifier registered with Apple,
                                    else returns nil
                                supported_brands:
                                  type: array
                                  items:
                                    type: string
                                  example:
                                    - visa
                                    - master
                                    - american_express
                                    - discover
                                publishable_key:
                                  type:
                                    - string
                                    - 'null'
                                  example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                  description: >-
                                    If publishable key is set for Hyperswitch,
                                    returns the publishable key, else returns
                                    nil
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                              required:
                                - id
                                - type
                                - name
                                - supported_brands
                                - test
                                - sandbox
                                - apple_pay
                                - apple_pay_merchant_identifier
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - klarna
                                name:
                                  type: string
                                  example: Klarna
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                      country:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          iso:
                            type: string
                            example: US
                          name:
                            type: string
                            example: United States
                          iso_name:
                            type: string
                            example: UNITED STATES
                          iso3:
                            type: string
                            example: USA
                          currency_code:
                            type: string
                            example: USD
                          currency_symbol:
                            type: string
                            example: $
                          province_required:
                            type: boolean
                            example: false
                          tax_enabled:
                            type:
                              - boolean
                              - 'null'
                            example: true
                          price_inclusive_of_tax:
                            type: boolean
                            example: false
                          price_inclusive_tax_name:
                            type:
                              - string
                              - 'null'
                            example: VAT
                      type:
                        type: string
                        enum:
                          - regular
                          - enrollment
                        example: regular
                      enrollment_pack_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      enrollment_pack:
                        type:
                          - object
                          - 'null'
                        properties:
                          enrollment_pack_id:
                            type: integer
                            example: 1
                          additional_volume:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          slug:
                            type: string
                            example: test-enrollment-pack
                          description:
                            type:
                              - object
                              - 'null'
                              - string
                            properties:
                              id:
                                type: integer
                                example: 111
                              name:
                                type: string
                                example: description
                              body:
                                type: string
                                example: >-
                                  <div>Try the latest and greatest of our sugar
                                  zip packs. Guaranteed to make you skinner and
                                  cure cancer.</div>
                              record_type:
                                type: string
                                example: EnrollmentPack
                              record_id:
                                type: integer
                                example: 1
                              created_at:
                                type: string
                                format: date_time
                                example: '2025-01-16T04:22:43.809Z'
                              updated_at:
                                type: string
                                format: date_time
                                example: '2025-01-22T10:23:52.941Z'
                              locale:
                                type: string
                                example: en
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: 10
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.00
                          images:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2
                                relateable_type:
                                  type: string
                                  example: EnrollmentPack
                                relateable_id:
                                  type: integer
                                  example: 1
                                image_url:
                                  type: string
                                  example: >-
                                    https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                image_path:
                                  type: string
                                  example: jITWaU14QGe0y5AFgY7P_00179.svg
                                position:
                                  type: integer
                                  example: 1
                                shopify_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                                created_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                updated_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                external_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 625
                                allow_subscription:
                                  type: boolean
                                  example: true
                                cv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                cv_in_currency:
                                  type: string
                                  example: $0.00
                                cv_total:
                                  type: integer
                                  example: 0
                                enrollment:
                                  type: boolean
                                  example: true
                                enrollment_pack_id:
                                  type: integer
                                  example: 1
                                price:
                                  type: string
                                  example: '11.13'
                                price_in_currency:
                                  type: string
                                  example: $11.13
                                product_title:
                                  type: string
                                  example: Zip Pack Sample Pack (30)
                                quantity:
                                  type: integer
                                  example: 1
                                qv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                qv_in_currency:
                                  type: string
                                  example: $0.00
                                qv_total:
                                  type: integer
                                  example: 0
                                subscribe_and_save:
                                  type:
                                    - string
                                    - 'null'
                                  example: '-1988.87'
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $-1,988.87
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $-1,988.87
                                subscription:
                                  type: boolean
                                  example: false
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_only:
                                  type: boolean
                                  example: false
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_price:
                                  type: string
                                  example: '2000.0'
                                subscription_price_in_currency:
                                  type: string
                                  example: $2,000.00
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  format: date
                                  example: '2025-02-28'
                                tax:
                                  type: string
                                  example: '0.0'
                                tax_in_currency:
                                  type: string
                                  example: $0.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: null
                                display_to_customer:
                                  type: boolean
                                  example: false
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                          price:
                            type: string
                            example: '11.13'
                          price_in_currency:
                            type: string
                            example: $11.13
                          subscription_price:
                            type:
                              - string
                              - integer
                            example: 2000
                          subscription_price_in_currency:
                            type: string
                            example: $2,000.00
                          title:
                            type: string
                            example: enroll product
                          token:
                            type: string
                            example: NxL22AqLRRisfyF9LqxxWRak
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      recurring:
                        oneOf:
                          - type: array
                            items:
                              type: object
                              properties:
                                subtotal:
                                  type: string
                                  example: '10.0'
                                subtotal_in_currency:
                                  type: string
                                  example: $10.0
                                interval:
                                  type: integer
                                  example: 1
                                interval_unit:
                                  type: string
                                  example: month
                                subtotal_for_display:
                                  type: string
                                  example: $10.00 every 1 month
                                start_date:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-05-27'
                          - type: 'null'
                        default:
                          - subtotal: '10.0'
                            subtotal_in_currency: $10.0
                            interval: 1
                            interval_unit: month
                            subtotal_for_display: $10.00 every 1 month
                            start_date: '2025-05-27'
                      messages:
                        type: object
                        additionalProperties: true
                        example:
                          errors:
                            - Insufficient inventory
                            - Product no longer available
                          warnings:
                            - Low stock warning
                            - Shipping delays expected
                          info:
                            - Free shipping available
                            - Volume discount applied
                      points_enabled:
                        type: boolean
                        example: true
                      points_applied:
                        type: integer
                        example: 500
                        description: Number of points applied to the cart
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Currency value of applied points
                      customer_total_points:
                        type: integer
                        example: 1000
                        description: Customer's total available points balance
                      customer_total_points_in_currency:
                        type: number
                        example: 10
                        description: Currency value of available points
                      remaining_customer_points:
                        type: integer
                        example: 500
                        description: Customer's remaining points after cart redemption
                      remaining_customer_points_amount_in_currency:
                        type: number
                        example: 5
                        description: >-
                          Currency value of remaining points after cart
                          redemption
                      remaining_cart_amount_after_points:
                        type: number
                        example: 95
                        description: Amount to charge to card after points redemption
                      remaining_cart_amount_after_points_in_currency:
                        type:
                          - string
                        example: $95.00
                        description: >-
                          Amount in currency to charge to card after points
                          redemption
                      max_applicable_points:
                        type: integer
                        example: 500
                        description: Maximum points that can be applied to this cart
                  meta:
                    type: object
                    properties:
                      shop_url:
                        type: string
                        example: https://myco.fluid.app
                      checkout_url:
                        type: string
                        example: https://checkout.fluid.com/checkout?jwt=abc123
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                    required:
                      - shop_url
                      - checkout_url
                      - request_id
                      - timestamp
                required:
                  - cart
                  - meta
        '401':
          description: Unauthorized - requires admin access
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: unauthorized
                  errors:
                    type: object
                    properties:
                      payment_method:
                        type: array
                        items:
                          type: string
                        example:
                          - requires admin access to set payment method
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
                  - meta
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - payment_method_id
              properties:
                payment_method_id:
                  type: integer
                  description: ID of the saved payment method
                  example: 123
        required: true
        description: The ID of the saved payment method to set
  /api/carts/{cart_token}/items/{item_id}/variant:
    patch:
      summary: Updates a cart item's variant
      tags:
        - Carts
      description: >
        Updates a cart item to use a different variant.

        If the target variant already exists in another cart item, the
        quantities are consolidated.


        **Consolidation behavior:**

        - If cart already has an item with the target variant_id, the source
        item's quantity is added to the existing item

        - The source item is then removed

        - Otherwise, the cart item's variant is updated directly


        **Optional quantity parameter:**

        - If provided, uses this quantity instead of the current cart item
        quantity when updating to a new variant

        - When consolidating, this quantity is added to the existing item's
        quantity (not replacing it)
      operationId: updateCartItemVariant
      parameters:
        - name: cart_token
          in: path
          required: true
          description: The cart token
          example: abc123def456
          schema:
            type: string
        - name: item_id
          in: path
          required: true
          description: The cart item ID
          example: 123
          schema:
            type: integer
      responses:
        '200':
          description: Variant updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      state:
                        type: string
                        example: start
                      processed:
                        type: boolean
                        example: false
                        description: >-
                          Determines if a cart payment has been processed or
                          not.
                      valid_for_checkout:
                        type: boolean
                        example: true
                      buyer_rep_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      buyer_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: buyer.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                              external_id:
                                type:
                                  - string
                                  - 'null'
                                example: '123241'
                            required:
                              - id
                          - type: 'null'
                      volume_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: volume.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                            required:
                              - id
                          - type: 'null'
                      currency_symbol:
                        type: string
                        example: $
                      currency_code:
                        type: string
                        example: USD
                      shipping_total_for_display:
                        type: string
                        example: Free
                      phone:
                        type:
                          - string
                          - 'null'
                        example: '4035551212'
                      payment_method_auto_assignable:
                        type: boolean
                        example: true
                        description: >-
                          Determines if a payment method can be auto-assigned to
                          the cart.
                      attribution:
                        oneOf:
                          - type: object
                            oneOf:
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  share_guid:
                                    type: string
                                    example: james-bond007
                                required:
                                  - id
                                  - share_guid
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  email:
                                    type: string
                                    example: james.bond@gmail.com
                                required:
                                  - id
                                  - email
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  username:
                                    type: string
                                    example: jaamball234
                                required:
                                  - id
                                  - username
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  fluid_rep_id:
                                    type: integer
                                    example: 23493
                                required:
                                  - id
                                  - fluid_rep_id
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: w3sdf92
                                required:
                                  - id
                          - type: 'null'
                        default:
                          id: 456
                          share_guid: james-bond007
                      agreements:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            required:
                              type: boolean
                              example: true
                            title:
                              type: string
                              example: Terms and Conditions
                            show_path:
                              type: string
                              example: /terms
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                      amount_total:
                        type: string
                        example: '121.65'
                      amount_total_in_currency:
                        type: string
                        example: $121.65 (USD)
                      sub_total:
                        type: string
                        example: '100.00'
                      sub_total_in_currency:
                        type: string
                        example: $100.00 (USD)
                      subtotal_after_discounts:
                        type: string
                        example: '90.00'
                      tax_total:
                        type: string
                        example: '20.00'
                      tax_total_in_currency:
                        type: string
                        example: $20.00 (USD)
                      shipping_total:
                        type:
                          - string
                          - 'null'
                        example: '1.65'
                      shipping_total_in_currency:
                        type: string
                        example: $1.65 (USD)
                      shipping_discount:
                        type: number
                        example: 10.25
                      discount_total:
                        type: string
                        example: '2.99'
                      discount_total_in_currency:
                        type: string
                        example: $2.99 (USD)
                      discount_breakdown:
                        type: object
                        properties:
                          internal_discounts:
                            type: number
                            example: 15
                          external_discounts:
                            type: number
                            example: 10
                          total_discounts:
                            type: number
                            example: 25
                      external_discount:
                        type: object
                        properties:
                          total:
                            type: number
                            example: 10
                          calculated_at:
                            type:
                              - string
                              - 'null'
                            format: date-time
                            example: '2024-01-10T15:30:00Z'
                          sources:
                            type: object
                            additionalProperties:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 6
                                description:
                                  type: string
                                  example: Gold tier discount
                                metadata:
                                  type: object
                              required:
                                - amount
                                - description
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: '1.90'
                      transaction_fee_in_currency:
                        type: string
                        example: $1.90 (USD)
                      cv_total:
                        type: integer
                        example: 10
                      qv_total:
                        type: integer
                        example: 15
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      payment_account:
                        type:
                          - string
                          - 'null'
                        example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                      payment_method:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: CreditCard
                              payment_method_type:
                                type: string
                                example: visa
                              last_four:
                                type: string
                                example: '1234'
                              exp_month:
                                type: string
                                example: '12'
                              exp_year:
                                type: string
                                example: '2025'
                              logo_url:
                                type: string
                                example: https://example.com/image.svg
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Paypal
                              status:
                                type: string
                                example: active
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Affirm
                              affirm_id:
                                type: string
                                example: affirm_123
                              status:
                                type: string
                                example: authorized
                              checkout_id:
                                type: string
                                example: checkout_456
                              created:
                                type: string
                                example: '2025-01-01T00:00:00Z'
                              auth_expiration:
                                type: string
                                example: '2025-01-02T00:00:00Z'
                              currency:
                                type: string
                                example: USD
                              amount:
                                type: string
                                example: '100.00'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Klarna
                              session_id:
                                type: string
                                example: klarna_session_789
                              intent:
                                type: string
                                example: buy
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Droplet
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: SomeCitcon
                      email:
                        type:
                          - string
                          - 'null'
                        example: user@example.com
                      enrollment_fee:
                        type:
                          - number
                          - string
                        example: '10.45'
                      enrollment_fee_in_currency:
                        type: string
                        example: $10.45
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT10
                          - DISCOUNT11
                      language_iso:
                        type:
                          - string
                          - 'null'
                        example: en
                      cart_token:
                        type: string
                        example: abc123
                      immutable_items:
                        type: boolean
                        example: false
                      digital_only:
                        type: boolean
                        example: false
                      requires_3ds:
                        type: boolean
                        example: false
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 101
                            price:
                              type: string
                              example: '43.41'
                            price_in_currency:
                              type: string
                              example: $43.41
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            cv:
                              type: integer
                              example: 5
                            cv_total:
                              type: integer
                              example: 15
                            qv:
                              type: integer
                              example: 7
                            qv_total:
                              type: integer
                              example: 21
                            discount_amount:
                              type: string
                              example: '10'
                            free_item:
                              type: boolean
                              example: false
                            discount_amount_in_currency:
                              type: string
                              example: $10.00
                            total_after_discounts:
                              type: string
                              example: '90.00'
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            product_title:
                              type:
                                - string
                                - 'null'
                              example: Sample Product
                            quantity:
                              type: integer
                              example: 3
                            subscription:
                              type: boolean
                              example: true
                            enrollment:
                              type: boolean
                              example: false
                            allow_subscription:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_plan_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_plans:
                              oneOf:
                                - type: array
                                  items:
                                    title: Commerce::SubscriptionPlan
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        example: Test Subscription Plan
                                        type: string
                                      billing_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      billing_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      billing_frequency_in_words:
                                        example: 2 Months
                                        type: string
                                      shipping_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      shipping_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      volume_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      volume_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      trial_period:
                                        example: 1
                                        type:
                                          - integer
                                          - 'null'
                                        minimum: 1
                                      trial_period_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type:
                                          - string
                                          - 'null'
                                      split_volume:
                                        example: true
                                        type: boolean
                                        default: false
                                      allow_max_billing_cycles:
                                        example: true
                                        type: boolean
                                        default: false
                                      max_billing_cycles:
                                        example: 3
                                        type:
                                          - integer
                                          - 'null'
                                      company_default:
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                        default: false
                                      products_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      subscribers_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      price:
                                        type: string
                                      price_in_currency:
                                        type: string
                                      subscription_start:
                                        type: string
                                      subscribe_and_save:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_in_currency:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_for_display:
                                        type:
                                          - string
                                          - 'null'
                                    required:
                                      - id
                                      - name
                                      - billing_interval
                                      - billing_interval_unit
                                      - billing_frequency_in_words
                                      - shipping_interval
                                      - shipping_interval_unit
                                      - volume_interval
                                      - volume_interval_unit
                                      - split_volume
                                      - allow_max_billing_cycles
                                      - price
                                      - price_in_currency
                                      - subscription_start
                                      - subscribe_and_save
                                      - subscribe_and_save_in_currency
                                      - subscribe_and_save_for_display
                                - type: 'null'
                            subscription_only:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_interval:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_interval_unit:
                              type:
                                - string
                                - 'null'
                              example: month
                            subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 10.5
                            subscription_price_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $10.50
                            subscription_start:
                              type:
                                - string
                                - 'null'
                              example: '2025-02-12'
                            subscribe_and_save:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 2.99
                            subscribe_and_save_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $2.99
                            subscribe_and_save_for_display:
                              type:
                                - string
                                - 'null'
                              example: Subscribe and save $2.99
                            title:
                              type:
                                - string
                                - 'null'
                              example: Surcharge
                            metadata:
                              type: object
                              description: >-
                                A JSON object that can store any custom data
                                structure
                              example: {}
                            product:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type: string
                                      example: Sample Product
                                    introduction:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Product Description
                                    cv:
                                      type: integer
                                      example: 10
                                    external_id:
                                      type:
                                        - string
                                        - 'null'
                                      example: ext-prod-123
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/product.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/product.png
                                    price:
                                      type: string
                                      example: '29.99'
                                    price_in_currency:
                                      type: string
                                      example: $29.99
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    tax:
                                      type: string
                                      example: '2.99'
                                    tax_in_currency:
                                      type: string
                                      example: $2.99
                                    metadata:
                                      type: object
                                      example:
                                        shopify_product_id: 9876054868270
                                    metafields:
                                      type: array
                                      items:
                                        title: LegacyMetafield
                                        type: object
                                        properties:
                                          namespace:
                                            description: >-
                                              A container for related metafields.
                                              Commonly used to group metafields by app
                                              or functionality.
                                            example: custom
                                            type: string
                                            maxLength: 20
                                            pattern: ^[a-zA-Z0-9_]+$
                                          key:
                                            description: >-
                                              The unique identifier for the metafield
                                              within its namespace. Must be unique per
                                              namespace and owner.
                                            example: material
                                            type: string
                                            maxLength: 30
                                            pattern: ^[a-zA-Z0-9_]+$
                                          value:
                                            description: >-
                                              The actual data stored in the metafield.
                                              Type depends on value_type.
                                            example: cotton
                                            type:
                                              - string
                                              - integer
                                              - object
                                              - boolean
                                              - number
                                          value_type:
                                            description: >-
                                              The data type that defines how the value
                                              should be interpreted and validated.
                                            example: single_line_text_field
                                            type: string
                                          description:
                                            description: >-
                                              Optional human-readable description
                                              explaining the purpose of this
                                              metafield.
                                            example: >-
                                              The primary material used in this
                                              product
                                            type:
                                              - string
                                              - 'null'
                                          created_at:
                                            description: >-
                                              Timestamp when the metafield was
                                              created.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          updated_at:
                                            description: >-
                                              Timestamp when the metafield was last
                                              updated.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          locked:
                                            description: >-
                                              Whether this metafield is locked and
                                              cannot be updated or deleted directly.
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                              - 'null'
                                          metafield_definition:
                                            description: >-
                                              The definition that defines validation
                                              rules and structure for this metafield
                                            type:
                                              - 'null'
                                              - object
                                        required:
                                          - namespace
                                          - key
                                          - value
                                          - value_type
                                          - description
                                          - created_at
                                          - updated_at
                                          - metafield_definition
                                - type: 'null'
                            variant:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Variant
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/sample.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/sample.png
                                    primary_image:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/primary.png
                                    price:
                                      type:
                                        - string
                                        - 'null'
                                      example: '34.44'
                                    price_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $34.44
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    options:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          title:
                                            type: string
                                            example: Size
                                          value:
                                            type: string
                                            example: XL
                                    physical:
                                      type:
                                        - boolean
                                        - 'null'
                                      example: true
                                    unit_of_size:
                                      type:
                                        - string
                                        - 'null'
                                      example: cm
                                    height:
                                      type:
                                        - number
                                        - 'null'
                                      example: 13
                                    width:
                                      type:
                                        - number
                                        - 'null'
                                      example: 6
                                    length:
                                      type:
                                        - number
                                        - 'null'
                                      example: 12
                                    unit_of_weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: kg
                                    weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                    hs_code:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                - type: 'null'
                            errors:
                              oneOf:
                                - type: 'null'
                                - type: array
                                  items:
                                    type: object
                                  example:
                                    - country:
                                        - >-
                                          This product is not available for this
                                          country. Please change your country
                            bundled_items:
                              type: array
                              items:
                                type: object
                                description: Bundled items for bundle products
                                properties:
                                  variant_id:
                                    type: integer
                                    example: 1
                                  product_id:
                                    type: integer
                                    example: 1
                                  product_title:
                                    type: string
                                    example: Product Title
                                  variant_title:
                                    type: string
                                    example: Variant Title
                                  option_titles:
                                    type: array
                                    example:
                                      - Option 1
                                      - Option 2
                                  quantity:
                                    type: integer
                                    example: 1
                                  display_to_customer:
                                    type: boolean
                                    example: true
                      ship_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      bill_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      shipping_method:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: string
                            example: standard-shipping
                          name:
                            type: string
                            example: Standard Shipping
                      available_shipping_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: standard-shipping
                            title:
                              type: string
                              example: Standard Shipping
                            price:
                              type:
                                - number
                                - string
                              example: 5.99
                            price_label:
                              type: string
                              example: $5.99
                            delivery_time_estimate:
                              type: string
                              example: 3-5 business days
                      available_payment_methods:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - credit_card
                                name:
                                  type: string
                                  example: Credit Card
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                apple_pay:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method supports
                                    ApplePay or not 
                                bogus_gateway:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is a Bogus
                                    instance or not.
                                tokenize_path:
                                  type:
                                    - string
                                    - 'null'
                                  description: Path to tokenize, if applicable.
                                token_provider:
                                  type: string
                                  enum:
                                    - spreedly
                                    - vgs
                                  description: >-
                                    Determines if payment tokenization is via
                                    spreedly or VGS
                                apple_pay_merchant_identifier:
                                  type:
                                    - string
                                    - 'null'
                                  example: merchant.mycompany.com
                                  description: >-
                                    If ApplePay is supported, returns the
                                    merchant identifier registered with Apple,
                                    else returns nil
                                supported_brands:
                                  type: array
                                  items:
                                    type: string
                                  example:
                                    - visa
                                    - master
                                    - american_express
                                    - discover
                                publishable_key:
                                  type:
                                    - string
                                    - 'null'
                                  example: pk_snd_1e021ffa1b974b6c8e2c8fcb3ac14de4
                                  description: >-
                                    If publishable key is set for Hyperswitch,
                                    returns the publishable key, else returns
                                    nil
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                              required:
                                - id
                                - type
                                - name
                                - supported_brands
                                - test
                                - sandbox
                                - apple_pay
                                - apple_pay_merchant_identifier
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - klarna
                                name:
                                  type: string
                                  example: Klarna
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                      country:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          iso:
                            type: string
                            example: US
                          name:
                            type: string
                            example: United States
                          iso_name:
                            type: string
                            example: UNITED STATES
                          iso3:
                            type: string
                            example: USA
                          currency_code:
                            type: string
                            example: USD
                          currency_symbol:
                            type: string
                            example: $
                          province_required:
                            type: boolean
                            example: false
                          tax_enabled:
                            type:
                              - boolean
                              - 'null'
                            example: true
                          price_inclusive_of_tax:
                            type: boolean
                            example: false
                          price_inclusive_tax_name:
                            type:
                              - string
                              - 'null'
                            example: VAT
                      type:
                        type: string
                        enum:
                          - regular
                          - enrollment
                        example: regular
                      enrollment_pack_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      enrollment_pack:
                        type:
                          - object
                          - 'null'
                        properties:
                          enrollment_pack_id:
                            type: integer
                            example: 1
                          additional_volume:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          slug:
                            type: string
                            example: test-enrollment-pack
                          description:
                            type:
                              - object
                              - 'null'
                              - string
                            properties:
                              id:
                                type: integer
                                example: 111
                              name:
                                type: string
                                example: description
                              body:
                                type: string
                                example: >-
                                  <div>Try the latest and greatest of our sugar
                                  zip packs. Guaranteed to make you skinner and
                                  cure cancer.</div>
                              record_type:
                                type: string
                                example: EnrollmentPack
                              record_id:
                                type: integer
                                example: 1
                              created_at:
                                type: string
                                format: date_time
                                example: '2025-01-16T04:22:43.809Z'
                              updated_at:
                                type: string
                                format: date_time
                                example: '2025-01-22T10:23:52.941Z'
                              locale:
                                type: string
                                example: en
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: 10
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.00
                          images:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2
                                relateable_type:
                                  type: string
                                  example: EnrollmentPack
                                relateable_id:
                                  type: integer
                                  example: 1
                                image_url:
                                  type: string
                                  example: >-
                                    https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                image_path:
                                  type: string
                                  example: jITWaU14QGe0y5AFgY7P_00179.svg
                                position:
                                  type: integer
                                  example: 1
                                shopify_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                                created_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                updated_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                external_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 625
                                allow_subscription:
                                  type: boolean
                                  example: true
                                cv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                cv_in_currency:
                                  type: string
                                  example: $0.00
                                cv_total:
                                  type: integer
                                  example: 0
                                enrollment:
                                  type: boolean
                                  example: true
                                enrollment_pack_id:
                                  type: integer
                                  example: 1
                                price:
                                  type: string
                                  example: '11.13'
                                price_in_currency:
                                  type: string
                                  example: $11.13
                                product_title:
                                  type: string
                                  example: Zip Pack Sample Pack (30)
                                quantity:
                                  type: integer
                                  example: 1
                                qv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                qv_in_currency:
                                  type: string
                                  example: $0.00
                                qv_total:
                                  type: integer
                                  example: 0
                                subscribe_and_save:
                                  type:
                                    - string
                                    - 'null'
                                  example: '-1988.87'
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $-1,988.87
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $-1,988.87
                                subscription:
                                  type: boolean
                                  example: false
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_only:
                                  type: boolean
                                  example: false
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_price:
                                  type: string
                                  example: '2000.0'
                                subscription_price_in_currency:
                                  type: string
                                  example: $2,000.00
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  format: date
                                  example: '2025-02-28'
                                tax:
                                  type: string
                                  example: '0.0'
                                tax_in_currency:
                                  type: string
                                  example: $0.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: null
                                display_to_customer:
                                  type: boolean
                                  example: false
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                          price:
                            type: string
                            example: '11.13'
                          price_in_currency:
                            type: string
                            example: $11.13
                          subscription_price:
                            type:
                              - string
                              - integer
                            example: 2000
                          subscription_price_in_currency:
                            type: string
                            example: $2,000.00
                          title:
                            type: string
                            example: enroll product
                          token:
                            type: string
                            example: NxL22AqLRRisfyF9LqxxWRak
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      recurring:
                        oneOf:
                          - type: array
                            items:
                              type: object
                              properties:
                                subtotal:
                                  type: string
                                  example: '10.0'
                                subtotal_in_currency:
                                  type: string
                                  example: $10.0
                                interval:
                                  type: integer
                                  example: 1
                                interval_unit:
                                  type: string
                                  example: month
                                subtotal_for_display:
                                  type: string
                                  example: $10.00 every 1 month
                                start_date:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-05-27'
                          - type: 'null'
                        default:
                          - subtotal: '10.0'
                            subtotal_in_currency: $10.0
                            interval: 1
                            interval_unit: month
                            subtotal_for_display: $10.00 every 1 month
                            start_date: '2025-05-27'
                      messages:
                        type: object
                        additionalProperties: true
                        example:
                          errors:
                            - Insufficient inventory
                            - Product no longer available
                          warnings:
                            - Low stock warning
                            - Shipping delays expected
                          info:
                            - Free shipping available
                            - Volume discount applied
                      points_enabled:
                        type: boolean
                        example: true
                      points_applied:
                        type: integer
                        example: 500
                        description: Number of points applied to the cart
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Currency value of applied points
                      customer_total_points:
                        type: integer
                        example: 1000
                        description: Customer's total available points balance
                      customer_total_points_in_currency:
                        type: number
                        example: 10
                        description: Currency value of available points
                      remaining_customer_points:
                        type: integer
                        example: 500
                        description: Customer's remaining points after cart redemption
                      remaining_customer_points_amount_in_currency:
                        type: number
                        example: 5
                        description: >-
                          Currency value of remaining points after cart
                          redemption
                      remaining_cart_amount_after_points:
                        type: number
                        example: 95
                        description: Amount to charge to card after points redemption
                      remaining_cart_amount_after_points_in_currency:
                        type:
                          - string
                        example: $95.00
                        description: >-
                          Amount in currency to charge to card after points
                          redemption
                      max_applicable_points:
                        type: integer
                        example: 500
                        description: Maximum points that can be applied to this cart
                  meta:
                    type: object
                    properties:
                      shop_url:
                        type: string
                        example: https://myco.fluid.app
                      checkout_url:
                        type: string
                        example: https://checkout.fluid.com/checkout?jwt=abc123
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                    required:
                      - shop_url
                      - checkout_url
                      - request_id
                      - timestamp
                required:
                  - cart
                  - meta
        '404':
          description: Variant or cart item not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Variant not found
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
        '422':
          description: Unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - variant_id
              properties:
                variant_id:
                  type: integer
                  description: The new variant ID to assign to this cart item
                  example: 456
                quantity:
                  type: integer
                  description: 'Optional: Override the quantity (must be >= 1)'
                  example: 2
        required: true
        description: Variant update parameters
  /api/company/carts/{cart_token}.json:
    put:
      tags:
        - Carts
      summary: Update Shopping Cart
      description: >-
        Updates a specific shopping cart with new information including customer
        details, items, totals, shipping options, and other cart-related data.
      operationId: updateCart
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
          description: Unique identifier for the cart to be updated
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/updaterequest4'
                - {}
        required: true
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/update4'
                  - example:
                      cart:
                        date: '2023-12-19T09:01:17.190Z'
                        customer_code: 7319
                        currency_code: USD
                        country_code: USA
                        ip: 139.5.71.59
                        abandoned: null
                        source: web
                        total: '38.23'
                        sub_total: '20.0'
                        tax_total: '10.23'
                        shipping_total: '0.0'
                        enrollment_fee: 0
                        discount_total: 0
                        cv_total: 0
                        fulfillment: fedex-ground
                        payment_token: null
                        payment_total: '28.0'
                        subscription: false
                        customer:
                          email: null
                          external_id: null
                        sponsor: {}
                        addresses:
                          ship_to:
                            name: Customer Name
                            line1: 1145 S 800 E Ste 110
                            line2: line 2
                            city: Orem
                            region: UT
                            postal_code: 84097-7227
                            country: US
                          bill_to:
                            name: Customer Name
                            line1: 1145 S 800 E Ste 110
                            line2: line 2
                            city: Orem
                            region: UT
                            postal_code: 84097-7227
                            country: US
                        lines:
                          - id: 2481
                            images:
                              - >-
                                https://ik.imagekit.io/fluid/s3/NjRJdhqcSR2b9QWyWDIz_Man_T-shirt.jpg
                            item_id: 8305
                            item_code: ''
                            title: Man T-shirt
                            description: >-
                              what is this tshirt all about. Is it good or is it
                              bad
                            quantity: 1
                            amount: 20
                            tax_code: PF050621
                            subscription: false
                            cv: 0
                            qv: 0
                            tax: '0.0'
                            shipping: '0.0'
                            prices:
                              price: '20.0'
                              subscription_price: '10.0'
                              wholesale: '0.0'
                              wholesale_subscription_price: '0.0'
                            stock: 2
                            track_stock: true
                            variant:
                              id: 27265
                              display: L
                              options:
                                - id: 39
                                  type: size
                                  value: l
                                  presentation: L
                        cart_token: HuSmS99wrjLfeehQgYLMjKHG
                        cart_id: 6583
              example:
                cart:
                  date: '2023-12-19T09:01:17.190Z'
                  customer_code: 7319
                  currency_code: USD
                  country_code: USA
                  ip: 139.5.71.59
                  abandoned: null
                  source: web
                  total: '38.23'
                  sub_total: '20.0'
                  tax_total: '10.23'
                  shipping_total: '0.0'
                  enrollment_fee: 0
                  discount_total: 0
                  cv_total: 0
                  fulfillment: fedex-ground
                  payment_token: null
                  payment_total: '28.0'
                  subscription: false
                  customer:
                    email: null
                    external_id: null
                  sponsor: {}
                  addresses:
                    ship_to:
                      name: Customer Name
                      line1: 1145 S 800 E Ste 110
                      line2: line 2
                      city: Orem
                      region: UT
                      postal_code: 84097-7227
                      country: US
                    bill_to:
                      name: Customer Name
                      line1: 1145 S 800 E Ste 110
                      line2: line 2
                      city: Orem
                      region: UT
                      postal_code: 84097-7227
                      country: US
                  lines:
                    - id: 2481
                      images:
                        - >-
                          https://ik.imagekit.io/fluid/s3/NjRJdhqcSR2b9QWyWDIz_Man_T-shirt.jpg
                      item_id: 8305
                      item_code: ''
                      title: Man T-shirt
                      description: what is this tshirt all about. Is it good or is it bad
                      quantity: 1
                      amount: 20
                      tax_code: PF050621
                      subscription: false
                      cv: 0
                      qv: 0
                      tax: '0.0'
                      shipping: '0.0'
                      prices:
                        price: '20.0'
                        subscription_price: '10.0'
                        wholesale: '0.0'
                        wholesale_subscription_price: '0.0'
                      stock: 2
                      track_stock: true
                      variant:
                        id: 27265
                        display: L
                        options:
                          - id: 39
                            type: size
                            value: l
                            presentation: L
                  cart_token: HuSmS99wrjLfeehQgYLMjKHG
                  cart_id: 6583
      deprecated: false
      security:
        - bearer: []
  /api/carts/{cart_token}/vault:
    post:
      summary: Gets VGS vault access token
      tags:
        - Carts
      operationId: createVGSVaultSession
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: VGS vault access token
          content:
            application/json:
              schema:
                type: object
                properties:
                  vault:
                    type: object
                    properties:
                      vault_id:
                        type: string
                        example: tntydlnduqt
                      environment:
                        type: string
                        example: sandbox or live
                      access_token:
                        type: string
                        example: eyJhbGci...
                      route_id:
                        type: string
                        example: e83a1bc9-1212-41e8-9ed2-c04efec22b03
                    required:
                      - vault_id
                      - environment
                      - access_token
                      - route_id
                  requires_3ds:
                    type: boolean
                    example: false
                  payment_account_id:
                    type: integer
                    example: 123
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - vault
                  - requires_3ds
                  - payment_account_id
                  - meta
        '404':
          description: no payment account available for routing
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Payment account not found
                  errors:
                    type: object
                    example:
                      vault:
                        - payment_account not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: Could not get VGS access token
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Could not get VGS access token
                  errors:
                    type: object
                    example:
                      vault:
                        - could not get access_token
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/carts/{cart_token}/sync_customer:
    post:
      summary: Syncs cart with authenticated customer
      tags:
        - Carts
      description: >
        Associates the cart with the authenticated customer from the JWT.

        Called by frontend on cart page load when customer is logged in.


        The cart email and customer association will be set from the verified
        JWT.

        This ensures the cart is properly linked to the logged-in customer's
        account.
      operationId: syncCustomer
      security:
        - bearer_auth: []
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Cart synced with customer successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      state:
                        type: string
                        example: start
                      processed:
                        type: boolean
                        example: false
                        description: >-
                          Determines if a cart payment has been processed or
                          not.
                      valid_for_checkout:
                        type: boolean
                        example: true
                      buyer_rep_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      buyer_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: buyer.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                              external_id:
                                type:
                                  - string
                                  - 'null'
                                example: '123241'
                            required:
                              - id
                          - type: 'null'
                      volume_rep:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 2
                              email:
                                type:
                                  - string
                                  - 'null'
                                example: volume.rep@example.com
                              full_name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                            required:
                              - id
                          - type: 'null'
                      currency_symbol:
                        type: string
                        example: $
                      currency_code:
                        type: string
                        example: USD
                      shipping_total_for_display:
                        type: string
                        example: Free
                      phone:
                        type:
                          - string
                          - 'null'
                        example: '4035551212'
                      payment_method_auto_assignable:
                        type: boolean
                        example: true
                        description: >-
                          Determines if a payment method can be auto-assigned to
                          the cart.
                      attribution:
                        oneOf:
                          - type: object
                            oneOf:
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  share_guid:
                                    type: string
                                    example: james-bond007
                                required:
                                  - id
                                  - share_guid
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  email:
                                    type: string
                                    example: james.bond@gmail.com
                                required:
                                  - id
                                  - email
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  username:
                                    type: string
                                    example: jaamball234
                                required:
                                  - id
                                  - username
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  fluid_rep_id:
                                    type: integer
                                    example: 23493
                                required:
                                  - id
                                  - fluid_rep_id
                              - properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 456
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: w3sdf92
                                required:
                                  - id
                          - type: 'null'
                        default:
                          id: 456
                          share_guid: james-bond007
                      agreements:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            required:
                              type: boolean
                              example: true
                            title:
                              type: string
                              example: Terms and Conditions
                            show_path:
                              type: string
                              example: /terms
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                      amount_total:
                        type: string
                        example: '121.65'
                      amount_total_in_currency:
                        type: string
                        example: $121.65 (USD)
                      sub_total:
                        type: string
                        example: '100.00'
                      sub_total_in_currency:
                        type: string
                        example: $100.00 (USD)
                      subtotal_after_discounts:
                        type: string
                        example: '90.00'
                      subtotal_after_discounts_in_currency:
                        type: string
                        example: $90.00
                      tax_total:
                        type: string
                        example: '20.00'
                      tax_total_in_currency:
                        type: string
                        example: $20.00 (USD)
                      shipping_total:
                        type:
                          - string
                          - 'null'
                        example: '1.65'
                      shipping_total_in_currency:
                        type: string
                        example: $1.65 (USD)
                      shipping_discount:
                        type: number
                        example: 10.25
                      discount_total:
                        type: string
                        example: '2.99'
                      discount_total_in_currency:
                        type: string
                        example: $2.99 (USD)
                      discount_breakdown:
                        type: object
                        properties:
                          internal_discounts:
                            type: number
                            example: 15
                          external_discounts:
                            type: number
                            example: 10
                          total_discounts:
                            type: number
                            example: 25
                      external_discount:
                        type: object
                        properties:
                          total:
                            type: number
                            example: 10
                          calculated_at:
                            type:
                              - string
                              - 'null'
                            format: date-time
                            example: '2024-01-10T15:30:00Z'
                          sources:
                            type: object
                            additionalProperties:
                              type: object
                              properties:
                                amount:
                                  type: number
                                  example: 6
                                description:
                                  type: string
                                  example: Gold tier discount
                                metadata:
                                  type: object
                              required:
                                - amount
                                - description
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: '1.90'
                      transaction_fee_in_currency:
                        type: string
                        example: $1.90 (USD)
                      cv_total:
                        type: integer
                        example: 10
                      qv_total:
                        type: integer
                        example: 15
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      payment_account:
                        type:
                          - string
                          - 'null'
                        example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                      payment_method:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: CreditCard
                              payment_method_type:
                                type: string
                                example: visa
                              last_four:
                                type: string
                                example: '1234'
                              exp_month:
                                type: string
                                example: '12'
                              exp_year:
                                type: string
                                example: '2025'
                              logo_url:
                                type: string
                                example: https://example.com/image.svg
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Paypal
                              status:
                                type: string
                                example: active
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Affirm
                              affirm_id:
                                type: string
                                example: affirm_123
                              status:
                                type: string
                                example: authorized
                              checkout_id:
                                type: string
                                example: checkout_456
                              created:
                                type: string
                                example: '2025-01-01T00:00:00Z'
                              auth_expiration:
                                type: string
                                example: '2025-01-02T00:00:00Z'
                              currency:
                                type: string
                                example: USD
                              amount:
                                type: string
                                example: '100.00'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Klarna
                              session_id:
                                type: string
                                example: klarna_session_789
                              intent:
                                type: string
                                example: buy
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: Droplet
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              type:
                                type: string
                                example: SomeCitcon
                      email:
                        type:
                          - string
                          - 'null'
                        example: user@example.com
                      enrollment_fee:
                        type:
                          - number
                          - string
                        example: '10.45'
                      enrollment_fee_in_currency:
                        type: string
                        example: $10.45
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT10
                          - DISCOUNT11
                      product_discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT10
                          - DISCOUNT11
                      shipping_discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - FREESHIP
                      language_iso:
                        type:
                          - string
                          - 'null'
                        example: en
                      cart_token:
                        type: string
                        example: abc123
                      immutable_items:
                        type: boolean
                        example: false
                      digital_only:
                        type: boolean
                        example: false
                      requires_3ds:
                        type: boolean
                        example: false
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 101
                            price:
                              type: string
                              example: '43.41'
                            price_in_currency:
                              type: string
                              example: $43.41
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            cv:
                              type: integer
                              example: 5
                            cv_total:
                              type: integer
                              example: 15
                            qv:
                              type: integer
                              example: 7
                            qv_total:
                              type: integer
                              example: 21
                            discount_amount:
                              type: string
                              example: '10'
                            free_item:
                              type: boolean
                              example: false
                            discount_amount_in_currency:
                              type: string
                              example: $10.00
                            total_after_discounts:
                              type: string
                              example: '90.00'
                            total_after_discounts_in_currency:
                              type: string
                              example: $90.00
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            product_title:
                              type:
                                - string
                                - 'null'
                              example: Sample Product
                            quantity:
                              type: integer
                              example: 3
                            subscription:
                              type: boolean
                              example: true
                            enrollment:
                              type: boolean
                              example: false
                            allow_subscription:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_plan_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_plans:
                              oneOf:
                                - type: array
                                  items:
                                    title: Commerce::SubscriptionPlan
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        example: Test Subscription Plan
                                        type: string
                                      billing_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      billing_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      billing_frequency_in_words:
                                        example: 2 Months
                                        type: string
                                      shipping_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      shipping_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      volume_interval:
                                        example: 1
                                        type: integer
                                        default: 1
                                        minimum: 1
                                        maximum: 29
                                      volume_interval_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type: string
                                        default: month
                                      trial_period:
                                        example: 1
                                        type:
                                          - integer
                                          - 'null'
                                        minimum: 1
                                      trial_period_unit:
                                        description: >-
                                          Possible values: `day`, `week`, `month`,
                                          `year`
                                        example: day
                                        type:
                                          - string
                                          - 'null'
                                      split_volume:
                                        example: true
                                        type: boolean
                                        default: false
                                      allow_max_billing_cycles:
                                        example: true
                                        type: boolean
                                        default: false
                                      max_billing_cycles:
                                        example: 3
                                        type:
                                          - integer
                                          - 'null'
                                      company_default:
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                        default: false
                                      products_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      subscribers_count:
                                        example: 10
                                        type:
                                          - integer
                                          - 'null'
                                      price:
                                        type: string
                                      price_in_currency:
                                        type: string
                                      subscription_start:
                                        type: string
                                      subscribe_and_save:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_in_currency:
                                        type:
                                          - string
                                          - 'null'
                                      subscribe_and_save_for_display:
                                        type:
                                          - string
                                          - 'null'
                                    required:
                                      - id
                                      - name
                                      - billing_interval
                                      - billing_interval_unit
                                      - billing_frequency_in_words
                                      - shipping_interval
                                      - shipping_interval_unit
                                      - volume_interval
                                      - volume_interval_unit
                                      - split_volume
                                      - allow_max_billing_cycles
                                      - price
                                      - price_in_currency
                                      - subscription_start
                                      - subscribe_and_save
                                      - subscribe_and_save_in_currency
                                      - subscribe_and_save_for_display
                                - type: 'null'
                            subscription_only:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            subscription_interval:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            subscription_interval_unit:
                              type:
                                - string
                                - 'null'
                              example: month
                            subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 10.5
                            subscription_price_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $10.50
                            subscription_start:
                              type:
                                - string
                                - 'null'
                              example: '2025-02-12'
                            subscribe_and_save:
                              type:
                                - number
                                - string
                                - 'null'
                              example: 2.99
                            subscribe_and_save_in_currency:
                              type:
                                - string
                                - 'null'
                              example: $2.99
                            subscribe_and_save_for_display:
                              type:
                                - string
                                - 'null'
                              example: Subscribe and save $2.99
                            title:
                              type:
                                - string
                                - 'null'
                              example: Surcharge
                            metadata:
                              type: object
                              description: >-
                                A JSON object that can store any custom data
                                structure
                              example: {}
                            product:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type: string
                                      example: Sample Product
                                    introduction:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Product Description
                                    cv:
                                      type: integer
                                      example: 10
                                    external_id:
                                      type:
                                        - string
                                        - 'null'
                                      example: ext-prod-123
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/product.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/product.png
                                    price:
                                      type: string
                                      example: '29.99'
                                    price_in_currency:
                                      type: string
                                      example: $29.99
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    tax:
                                      type: string
                                      example: '2.99'
                                    tax_in_currency:
                                      type: string
                                      example: $2.99
                                    canonical_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: >-
                                        https://example.com/home/products/sample-product
                                    metadata:
                                      type: object
                                      example:
                                        shopify_product_id: 9876054868270
                                    metafields:
                                      type: array
                                      items:
                                        title: LegacyMetafield
                                        type: object
                                        properties:
                                          namespace:
                                            description: >-
                                              A container for related metafields.
                                              Commonly used to group metafields by app
                                              or functionality.
                                            example: custom
                                            type: string
                                            maxLength: 20
                                            pattern: ^[a-zA-Z0-9_]+$
                                          key:
                                            description: >-
                                              The unique identifier for the metafield
                                              within its namespace. Must be unique per
                                              namespace and owner.
                                            example: material
                                            type: string
                                            maxLength: 30
                                            pattern: ^[a-zA-Z0-9_]+$
                                          value:
                                            description: >-
                                              The actual data stored in the metafield.
                                              Type depends on value_type.
                                            example: cotton
                                            type:
                                              - string
                                              - integer
                                              - object
                                              - boolean
                                              - number
                                          value_type:
                                            description: >-
                                              The data type that defines how the value
                                              should be interpreted and validated.
                                            example: single_line_text_field
                                            type: string
                                          description:
                                            description: >-
                                              Optional human-readable description
                                              explaining the purpose of this
                                              metafield.
                                            example: >-
                                              The primary material used in this
                                              product
                                            type:
                                              - string
                                              - 'null'
                                          created_at:
                                            description: >-
                                              Timestamp when the metafield was
                                              created.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          updated_at:
                                            description: >-
                                              Timestamp when the metafield was last
                                              updated.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          locked:
                                            description: >-
                                              Whether this metafield is locked and
                                              cannot be updated or deleted directly.
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                              - 'null'
                                          metafield_definition:
                                            description: >-
                                              The definition that defines validation
                                              rules and structure for this metafield
                                            type:
                                              - 'null'
                                              - object
                                        required:
                                          - namespace
                                          - key
                                          - value
                                          - value_type
                                          - description
                                          - created_at
                                          - updated_at
                                          - metafield_definition
                                - type: 'null'
                            variant:
                              oneOf:
                                - type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Variant
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/sample.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/sample.png
                                    primary_image:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/primary.png
                                    price:
                                      type:
                                        - string
                                        - 'null'
                                      example: '34.44'
                                    price_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $34.44
                                    currency_code:
                                      type:
                                        - string
                                        - 'null'
                                      example: USD
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    options:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          title:
                                            type: string
                                            example: Size
                                          value:
                                            type: string
                                            example: XL
                                    physical:
                                      type:
                                        - boolean
                                        - 'null'
                                      example: true
                                    unit_of_size:
                                      type:
                                        - string
                                        - 'null'
                                      example: cm
                                    height:
                                      type:
                                        - number
                                        - 'null'
                                      example: 13
                                    width:
                                      type:
                                        - number
                                        - 'null'
                                      example: 6
                                    length:
                                      type:
                                        - number
                                        - 'null'
                                      example: 12
                                    unit_of_weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: kg
                                    weight:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                    hs_code:
                                      type:
                                        - string
                                        - 'null'
                                      example: '3.2'
                                - type: 'null'
                            errors:
                              oneOf:
                                - type: 'null'
                                - type: array
                                  items:
                                    type: object
                                  example:
                                    - country:
                                        - >-
                                          This product is not available for this
                                          country. Please remove this product from
                                          your cart before proceeding to checkout.
                            bundled_items:
                              type: array
                              items:
                                type: object
                                description: Bundled items for bundle products
                                properties:
                                  variant_id:
                                    type: integer
                                    example: 1
                                  product_id:
                                    type: integer
                                    example: 1
                                  product_title:
                                    type: string
                                    example: Product Title
                                  variant_title:
                                    type: string
                                    example: Variant Title
                                  option_titles:
                                    type: array
                                    example:
                                      - Option 1
                                      - Option 2
                                  quantity:
                                    type: integer
                                    example: 1
                                  display_to_customer:
                                    type: boolean
                                    example: true
                      ship_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      bill_to:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      shipping_address:
                        type:
                          - object
                          - 'null'
                        properties:
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          address1:
                            type:
                              - string
                              - 'null'
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type:
                              - string
                              - 'null'
                            example: New York
                          state:
                            type:
                              - string
                              - 'null'
                            example: NY
                          postal_code:
                            type:
                              - string
                              - 'null'
                            example: '10001'
                          country_code:
                            type:
                              - string
                              - 'null'
                            example: US
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                      billing_address:
                        type:
                          - object
                          - 'null'
                        properties:
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          address1:
                            type:
                              - string
                              - 'null'
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type:
                              - string
                              - 'null'
                            example: New York
                          state:
                            type:
                              - string
                              - 'null'
                            example: NY
                          postal_code:
                            type:
                              - string
                              - 'null'
                            example: '10001'
                          country_code:
                            type:
                              - string
                              - 'null'
                            example: US
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                      shipping_method:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: string
                            example: standard-shipping
                          name:
                            type: string
                            example: Standard Shipping
                      available_shipping_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              example: standard-shipping
                            title:
                              type: string
                              example: Standard Shipping
                            price:
                              type:
                                - number
                                - string
                              example: 5.99
                            price_label:
                              type: string
                              example: $5.99
                            delivery_time_estimate:
                              type:
                                - string
                                - 'null'
                              example: 3-5 business days
                          required:
                            - id
                            - title
                            - price
                            - price_label
                      available_payment_methods:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - credit_card
                                name:
                                  type: string
                                  example: Credit Card
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                apple_pay:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method supports
                                    ApplePay or not 
                                bogus_gateway:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is a Bogus
                                    instance or not.
                                tokenize_path:
                                  type:
                                    - string
                                    - 'null'
                                  description: Path to tokenize, if applicable.
                                token_provider:
                                  type: string
                                  enum:
                                    - spreedly
                                    - vgs
                                  description: >-
                                    Determines if payment tokenization is via
                                    spreedly or VGS
                                apple_pay_merchant_identifier:
                                  type:
                                    - string
                                    - 'null'
                                  example: merchant.mycompany.com
                                  description: >-
                                    If ApplePay is supported, returns the
                                    merchant identifier registered with Apple,
                                    else returns nil
                                supported_brands:
                                  type: array
                                  items:
                                    type: string
                                  example:
                                    - visa
                                    - master
                                    - american_express
                                    - discover
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                                collect_billing_address:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if billing address is required
                                    for this payment method
                              required:
                                - id
                                - type
                                - name
                                - supported_brands
                                - test
                                - sandbox
                                - apple_pay
                                - apple_pay_merchant_identifier
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1337
                                uuid:
                                  type: string
                                  example: pa_Zcx1cDSwVdFoISFiWhwGKKjDLH9dM3An
                                type:
                                  type: string
                                  enum:
                                    - klarna
                                name:
                                  type: string
                                  example: Klarna
                                image_url:
                                  type: string
                                  example: https://example.com/image.png
                                test:
                                  type: boolean
                                  example: true
                                  description: >-
                                    Determines if payment method is test
                                    instance or not. By default, set to `true`
                                sandbox:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if payment method is sandbox
                                    instance or not. By default, set to `false`
                                customer_details_schema:
                                  type: object
                                  example: {}
                                  description: >-
                                    Schema defining required customer details
                                    for this payment method
                                collect_billing_address:
                                  type: boolean
                                  example: false
                                  description: >-
                                    Determines if billing address is required
                                    for this payment method
                      country:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          iso:
                            type: string
                            example: US
                          name:
                            type: string
                            example: United States
                          iso_name:
                            type: string
                            example: UNITED STATES
                          iso3:
                            type: string
                            example: USA
                          currency_code:
                            type: string
                            example: USD
                          currency_symbol:
                            type: string
                            example: $
                          province_required:
                            type: boolean
                            example: false
                          tax_enabled:
                            type:
                              - boolean
                              - 'null'
                            example: true
                          price_inclusive_of_tax:
                            type: boolean
                            example: false
                          price_inclusive_tax_name:
                            type:
                              - string
                              - 'null'
                            example: VAT
                      type:
                        type: string
                        enum:
                          - regular
                          - enrollment
                        example: regular
                      enrollment_pack_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      enrollment_pack:
                        type:
                          - object
                          - 'null'
                        properties:
                          enrollment_pack_id:
                            type: integer
                            example: 1
                          additional_volume:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          slug:
                            type: string
                            example: test-enrollment-pack
                          description:
                            type:
                              - object
                              - 'null'
                              - string
                            properties:
                              id:
                                type: integer
                                example: 111
                              name:
                                type: string
                                example: description
                              body:
                                type: string
                                example: >-
                                  <div>Try the latest and greatest of our sugar
                                  zip packs. Guaranteed to make you skinner and
                                  cure cancer.</div>
                              record_type:
                                type: string
                                example: EnrollmentPack
                              record_id:
                                type: integer
                                example: 1
                              created_at:
                                type: string
                                format: date_time
                                example: '2025-01-16T04:22:43.809Z'
                              updated_at:
                                type: string
                                format: date_time
                                example: '2025-01-22T10:23:52.941Z'
                              locale:
                                type: string
                                example: en
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: 10
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.00
                          images:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2
                                relateable_type:
                                  type: string
                                  example: EnrollmentPack
                                relateable_id:
                                  type: integer
                                  example: 1
                                image_url:
                                  type: string
                                  example: >-
                                    https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                image_path:
                                  type: string
                                  example: jITWaU14QGe0y5AFgY7P_00179.svg
                                position:
                                  type: integer
                                  example: 1
                                shopify_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                                created_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                updated_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                external_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 625
                                allow_subscription:
                                  type: boolean
                                  example: true
                                cv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                cv_in_currency:
                                  type: string
                                  example: $0.00
                                cv_total:
                                  type: integer
                                  example: 0
                                enrollment:
                                  type: boolean
                                  example: true
                                enrollment_pack_id:
                                  type: integer
                                  example: 1
                                price:
                                  type: string
                                  example: '11.13'
                                price_in_currency:
                                  type: string
                                  example: $11.13
                                product_title:
                                  type: string
                                  example: Zip Pack Sample Pack (30)
                                quantity:
                                  type: integer
                                  example: 1
                                qv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                qv_in_currency:
                                  type: string
                                  example: $0.00
                                qv_total:
                                  type: integer
                                  example: 0
                                subscribe_and_save:
                                  type:
                                    - string
                                    - 'null'
                                  example: '-1988.87'
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $-1,988.87
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $-1,988.87
                                subscription:
                                  type: boolean
                                  example: false
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_only:
                                  type: boolean
                                  example: false
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_price:
                                  type: string
                                  example: '2000.0'
                                subscription_price_in_currency:
                                  type: string
                                  example: $2,000.00
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  format: date
                                  example: '2025-02-28'
                                tax:
                                  type: string
                                  example: '0.0'
                                tax_in_currency:
                                  type: string
                                  example: $0.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                total_after_discounts_in_currency:
                                  type: string
                                  example: $90.00
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: null
                                display_to_customer:
                                  type: boolean
                                  example: false
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please remove this product from
                                              your cart before proceeding to checkout.
                          price:
                            type: string
                            example: '11.13'
                          price_in_currency:
                            type: string
                            example: $11.13
                          subscription_price:
                            type:
                              - string
                              - integer
                            example: 2000
                          subscription_price_in_currency:
                            type: string
                            example: $2,000.00
                          title:
                            type: string
                            example: enroll product
                          token:
                            type: string
                            example: NxL22AqLRRisfyF9LqxxWRak
                          canonical_url:
                            type:
                              - string
                              - 'null'
                            example: >-
                              https://example.com/home/enrollment/test-enrollment-pack
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      recurring:
                        oneOf:
                          - type: array
                            items:
                              type: object
                              properties:
                                subtotal:
                                  type: string
                                  example: '10.0'
                                subtotal_in_currency:
                                  type: string
                                  example: $10.0
                                interval:
                                  type: integer
                                  example: 1
                                interval_unit:
                                  type: string
                                  example: month
                                subtotal_for_display:
                                  type: string
                                  example: $10.00 every 1 month
                                start_date:
                                  type:
                                    - string
                                    - 'null'
                                  example: '2025-05-27'
                          - type: 'null'
                        default:
                          - subtotal: '10.0'
                            subtotal_in_currency: $10.0
                            interval: 1
                            interval_unit: month
                            subtotal_for_display: $10.00 every 1 month
                            start_date: '2025-05-27'
                      messages:
                        type: object
                        additionalProperties: true
                        example:
                          errors:
                            - Insufficient inventory
                            - Product no longer available
                          warnings:
                            - Low stock warning
                            - Shipping delays expected
                          info:
                            - Free shipping available
                            - Volume discount applied
                      points_enabled:
                        type: boolean
                        example: true
                      points_applied:
                        type: integer
                        example: 500
                        description: Number of points applied to the cart
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Currency value of applied points
                      customer_total_points:
                        type: integer
                        example: 1000
                        description: Customer's total available points balance
                      customer_total_points_in_currency:
                        type: number
                        example: 10
                        description: Currency value of available points
                      remaining_customer_points:
                        type: integer
                        example: 500
                        description: Customer's remaining points after cart redemption
                      remaining_customer_points_amount_in_currency:
                        type: number
                        example: 5
                        description: >-
                          Currency value of remaining points after cart
                          redemption
                      remaining_cart_amount_after_points:
                        type: number
                        example: 95
                        description: Amount to charge to card after points redemption
                      remaining_cart_amount_after_points_in_currency:
                        type:
                          - string
                        example: $95.00
                        description: >-
                          Amount in currency to charge to card after points
                          redemption
                      max_applicable_points:
                        type: integer
                        example: 500
                        description: Maximum points that can be applied to this cart
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      checkout_url:
                        type: string
                        example: https://checkout.fluid.com/checkout?jwt=abc123
                      shop_url:
                        type: string
                        example: https://myco.fluid.app
        '401':
          description: Unauthorized - customer JWT required
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
  /api/company/custom_catch_ups:
    get:
      summary: List custom catch ups
      tags:
        - Catch Ups
      security:
        - bearer_auth: []
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  catch_ups:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        company_id:
                          type: integer
                        user_company_id:
                          type: integer
                        suggestion_title:
                          type: string
                        suggestion_description:
                          type: string
                        catch_up_class:
                          type: string
                          enum:
                            - CUSTOM_CATCH_UP
                        catch_up_actions:
                          type: array
                        created_at:
                          type: string
                          format: datetime
                        updated_at:
                          type: string
                          format: datetime
                      required:
                        - id
                        - company_id
                        - user_company_id
                        - suggestion_title
                        - catch_up_class
                        - created_at
                        - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: datetime
                    required:
                      - request_id
                      - timestamp
        '401':
          description: unauthorized
    post:
      summary: Create custom catch up
      tags:
        - Catch Ups
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  catch_up:
                    type: object
                    properties:
                      id:
                        type: integer
                      company_id:
                        type: integer
                      user_company_id:
                        type: integer
                      suggestion_title:
                        type: string
                      suggestion_description:
                        type: string
                      catch_up_class:
                        type: string
                      catch_up_actions:
                        type: array
                      created_at:
                        type: string
                        format: datetime
                      updated_at:
                        type: string
                        format: datetime
                    required:
                      - id
                      - company_id
                      - catch_up_class
                      - created_at
                      - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
                    required:
                      - request_id
                      - timestamp
        '401':
          description: unauthorized
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                affiliate_id:
                  type: integer
                  description: >-
                    ID of the UserCompany record for the affiliate creating the
                    catch-up
                title:
                  type: string
                description:
                  type: string
                type:
                  type: string
                  description: Type identifier for the catch-up
                contact_id:
                  type: integer
                actions:
                  type: object
                  description: Structured actions data
                  additionalProperties: true
              required:
                - affiliate_id
                - title
                - type
  /api/company/custom_catch_ups/{id}:
    patch:
      summary: Update custom catch up
      tags:
        - Catch Ups
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  catch_up:
                    type: object
                    properties:
                      id:
                        type: integer
                      company_id:
                        type: integer
                      user_company_id:
                        type: integer
                      suggestion_title:
                        type: string
                      suggestion_description:
                        type: string
                      catch_up_class:
                        type: string
                        enum:
                          - CUSTOM_CATCH_UP
                      catch_up_actions:
                        type: array
                      created_at:
                        type: string
                        format: datetime
                      updated_at:
                        type: string
                        format: datetime
                    required:
                      - id
                      - company_id
                      - user_company_id
                      - suggestion_title
                      - catch_up_class
                      - created_at
                      - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: datetime
                    required:
                      - request_id
                      - timestamp
        '401':
          description: unauthorized
        '404':
          description: not found
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                suggestion_title:
                  type: string
                suggestion_description:
                  type: string
              required: []
    delete:
      summary: Delete custom catch up
      tags:
        - Catch Ups
      security:
        - bearer_auth: []
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  catch_up:
                    type: object
                    properties:
                      id:
                        type: integer
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
        '401':
          description: unauthorized
        '404':
          description: not found
    parameters:
      - name: id
        in: path
        description: CatchUp ID
        required: true
        schema:
          type: string
  /api/company/catch_up/custom_catch_ups:
    post:
      tags:
        - Catch Ups
      summary: generates custom catchup
      operationId: create_custom_catch_up
      parameters: []
      requestBody:
        description: >-
          **Custom Catchups can be created in two main ways:**


          1. **Informative Catchup:** This is the most common type of custom
          catchup. For instance, if the back office needs to share information
          with a user, they can use this API to create a catchup. An optional
          link can be included for further follow-up.


          2. **Action-Based Catchup:** This type of custom catchup allows you to
          add an existing catchup action. For example, you might create a
          catchup for an affiliate to notify them about specific behavior from
          one of their contacts. This behavior might not be covered by our
          existing 26 catchup matrix.


          **Types of CatchUp Action Supported For Custom CatchUp**


          1. **LinkRedirectionCatchUpAction:** Use this action to redirect a
          user from the catchup card to a destination where other actions can be
          executed.

          2. **SendSmsCatchUpAction:** Use this action to allow users to send an
          SMS message to a contact from within a catchup card.

          3. **ToDoCatchUpAction:** Use this action to allow users to add a
          to-do item to their task list from within the catchup card.


          Specific contact assigned to an affiliate should be provided to use
          the SendSmsCatchUpAction and ToDoCatchUpAction.
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/CustomCatchUps'
                - example:
                    type: custom_catch_up
                    title: Update Your Bank Details
                    description: >-
                      Your credit card is going to expire on 24th December.
                      Please update your details.
                    affiliate_id: 1
                    actions:
                      type: LinkRedirectionCatchUpAction
                      data:
                        button_text: View Back Office
                        redirect_to: https://fluid.app/back_office
                - example:
                    type: custom_catch_up
                    title: Talk to your favorite visitor.
                    description: >-
                      This visitor has routing through your mysite and
                      purchasing products constantly. Say Hi.
                    affiliate_id: 1
                    actions:
                      type: SendSmsCatchUpAction
                      action_prompt: >-
                        Craft a short friendly message to a visitor, visiting my
                        site constantly and buying products.
                    contact_id: 22
            example:
              type: custom_catch_up
              title: Update Your Bank Details
              description: >-
                Your credit card is going to expire on 24th December. Please
                update your details.
              affiliate_id: 1
              actions:
                type: LinkRedirectionCatchUpAction
                data:
                  button_text: View Back Office
                  redirect_to: https://fluid.app/back_office
        required: true
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - example:
                      status: success
              example:
                status: success
      deprecated: false
      security:
        - bearer: []
  /api/company/v1/categories:
    get:
      summary: List categories
      tags:
        - Categories
      security:
        - bearer_auth: []
      operationId: listCategories
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            default: 1
          required: false
          description: Page number for pagination
        - name: per_page
          in: query
          schema:
            type: integer
            default: 25
          required: false
          description: Number of records per page
        - name: public
          in: query
          schema:
            type: string
            enum:
              - all
              - 'true'
              - 'false'
            default: 'true'
          required: false
          description: Filter by public status
        - name: status
          in: query
          schema:
            type: string
            enum:
              - all
              - 'true'
              - 'false'
            default: 'true'
          required: false
          description: Filter by status
        - name: sorted_by
          in: query
          schema:
            type: string
            default: created_at_desc
          required: false
          description: >-
            Sorting criteria for categories, e.g., 'created_at_asc',
            'created_at_desc', 'title_asc', 'title_desc'
        - name: search_query
          in: query
          required: false
          description: Search keyword
          example: summer
          schema:
            type: string
        - name: parent_id
          in: query
          schema:
            type: integer
          required: false
          description: Filter by parent category ID
        - name: source_type
          in: query
          schema:
            type: string
            default: product
          required: false
          description: Filter by source type
        - name: include_children
          in: query
          schema:
            type: boolean
            default: false
          required: false
          description: Include child categories in response
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  categories:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 1
                        title:
                          type:
                            - string
                            - 'null'
                          example: Summer Collection
                        description:
                          type:
                            - string
                            - 'null'
                          example: Our latest summer styles
                        image_url:
                          type:
                            - string
                            - 'null'
                          example: https://example.com/image.jpg
                        image_path:
                          type:
                            - string
                            - 'null'
                          example: /images/summer.jpg
                        position:
                          type:
                            - integer
                            - 'null'
                          example: 1
                        public:
                          type: boolean
                          example: true
                        active:
                          type: boolean
                          example: true
                        source_type:
                          type:
                            - string
                            - 'null'
                          example: product
                        parent_id:
                          type:
                            - integer
                            - 'null'
                          example: null
                        has_children:
                          type: boolean
                          example: false
                        slug:
                          type:
                            - string
                            - 'null'
                          example: summer-collection
                        custom_slug:
                          type: boolean
                          example: false
                        created_at:
                          type: string
                          format: date_time
                        updated_at:
                          type: string
                          format: date_time
                        include_children:
                          type:
                            - boolean
                            - 'null'
                          example: false
                        parent_name:
                          type:
                            - string
                            - 'null'
                          example: null
                        sub_categories:
                          type:
                            - array
                            - 'null'
                          items:
                            type: object
                        application_theme_template:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            name:
                              type: string
                              example: Default Template
                            description:
                              type: string
                              example: Default theme template for categories
                            created_at:
                              type: string
                              format: date-time
                              example: '2021-01-01T00:00:00Z'
                            updated_at:
                              type: string
                              format: date-time
                              example: '2021-01-01T00:00:00Z'
                        search_engine_optimizer:
                          type:
                            - object
                            - 'null'
                          properties:
                            title:
                              type: string
                              example: SEO Title
                            description:
                              type: string
                              example: SEO Description
                            image_url:
                              type: string
                              example: https://example.com/seo-image.jpg
                            image_path:
                              type: string
                              example: /images/seo.jpg
                            block_crawler:
                              type: boolean
                              example: false
                            slug:
                              type: string
                              example: summer-collection
                        products:
                          type:
                            - array
                            - 'null'
                          items:
                            type: object
                      required:
                        - id
                        - title
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      pagination:
                        type: object
                        properties:
                          current_page:
                            type: integer
                            example: 1
                          total_pages:
                            type: integer
                            example: 10
                          total_count:
                            type: integer
                            example: 100
                          per_page:
                            type: integer
                            example: 10
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
    post:
      summary: Create category
      tags:
        - Categories
      security:
        - bearer_auth: []
      operationId: createCategory
      parameters: []
      responses:
        '201':
          description: category created
          content:
            application/json:
              schema:
                type: object
                properties:
                  category:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      title:
                        type:
                          - string
                          - 'null'
                        example: Summer Collection
                      description:
                        type:
                          - string
                          - 'null'
                        example: Our latest summer styles
                      image_url:
                        type:
                          - string
                          - 'null'
                        example: https://example.com/image.jpg
                      image_path:
                        type:
                          - string
                          - 'null'
                        example: /images/summer.jpg
                      position:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      public:
                        type: boolean
                        example: true
                      active:
                        type: boolean
                        example: true
                      source_type:
                        type:
                          - string
                          - 'null'
                        example: product
                      parent_id:
                        type:
                          - integer
                          - 'null'
                        example: null
                      has_children:
                        type: boolean
                        example: false
                      slug:
                        type:
                          - string
                          - 'null'
                        example: summer-collection
                      custom_slug:
                        type: boolean
                        example: false
                      created_at:
                        type: string
                        format: date_time
                      updated_at:
                        type: string
                        format: date_time
                      include_children:
                        type:
                          - boolean
                          - 'null'
                        example: false
                      parent_name:
                        type:
                          - string
                          - 'null'
                        example: null
                      sub_categories:
                        type:
                          - array
                          - 'null'
                        items:
                          type: object
                      application_theme_template:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type: string
                            example: Default Template
                          description:
                            type: string
                            example: Default theme template for categories
                          created_at:
                            type: string
                            format: date-time
                            example: '2021-01-01T00:00:00Z'
                          updated_at:
                            type: string
                            format: date-time
                            example: '2021-01-01T00:00:00Z'
                      search_engine_optimizer:
                        type:
                          - object
                          - 'null'
                        properties:
                          title:
                            type: string
                            example: SEO Title
                          description:
                            type: string
                            example: SEO Description
                          image_url:
                            type: string
                            example: https://example.com/seo-image.jpg
                          image_path:
                            type: string
                            example: /images/seo.jpg
                          block_crawler:
                            type: boolean
                            example: false
                          slug:
                            type: string
                            example: summer-collection
                      products:
                        type:
                          - array
                          - 'null'
                        items:
                          type: object
                    required:
                      - id
                      - title
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameter
                  errors:
                    type: object
                    properties:
                      category:
                        type: object
                        example:
                          title:
                            - can't be blank
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                category:
                  type: object
                  properties:
                    title:
                      type: string
                      example: Summer Collection
                    description:
                      type: string
                      example: Our latest summer styles
                    image_url:
                      type: string
                      example: https://example.com/image.jpg
                    image_path:
                      type: string
                      example: /images/summer.jpg
                    position:
                      type: integer
                      example: 1
                    parent_id:
                      type: integer
                      example: null
                    public:
                      type: boolean
                      example: true
                    active:
                      type: boolean
                      example: true
                    source_type:
                      type: string
                      example: product
                    application_theme_template_id:
                      type: integer
                      example: 1
                    slug:
                      type: string
                      example: summer-collection
                    custom_slug:
                      type: boolean
                      example: false
                    feature_attributes:
                      type: object
                      properties:
                        _destroy:
                          type: boolean
                          example: false
                        position:
                          type: integer
                          example: 1
                    product_ids:
                      type: array
                      items:
                        type: integer
                    search_engine_optimizer_attributes:
                      type: object
                      properties:
                        title:
                          type: string
                          example: SEO Title
                        description:
                          type: string
                          example: SEO Description
                        image_url:
                          type: string
                          example: https://example.com/seo-image.jpg
                        image_path:
                          type: string
                          example: /images/seo.jpg
                        block_crawler:
                          type: boolean
                          example: false
                  required:
                    - title
              required:
                - category
  /api/company/v1/categories/{id}:
    get:
      summary: Get category
      tags:
        - Categories
      security:
        - bearer_auth: []
      operationId: getCategory
      parameters:
        - name: id
          in: path
          required: true
          description: Category ID
          schema:
            type: string
        - name: include_children
          in: query
          schema:
            type: boolean
            default: false
          required: false
          description: Include child categories in response
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  category:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      title:
                        type:
                          - string
                          - 'null'
                        example: Summer Collection
                      description:
                        type:
                          - string
                          - 'null'
                        example: Our latest summer styles
                      image_url:
                        type:
                          - string
                          - 'null'
                        example: https://example.com/image.jpg
                      image_path:
                        type:
                          - string
                          - 'null'
                        example: /images/summer.jpg
                      position:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      public:
                        type: boolean
                        example: true
                      active:
                        type: boolean
                        example: true
                      source_type:
                        type:
                          - string
                          - 'null'
                        example: product
                      parent_id:
                        type:
                          - integer
                          - 'null'
                        example: null
                      has_children:
                        type: boolean
                        example: false
                      slug:
                        type:
                          - string
                          - 'null'
                        example: summer-collection
                      custom_slug:
                        type: boolean
                        example: false
                      created_at:
                        type: string
                        format: date_time
                      updated_at:
                        type: string
                        format: date_time
                      include_children:
                        type:
                          - boolean
                          - 'null'
                        example: false
                      parent_name:
                        type:
                          - string
                          - 'null'
                        example: null
                      sub_categories:
                        type:
                          - array
                          - 'null'
                        items:
                          type: object
                      application_theme_template:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type: string
                            example: Default Template
                          description:
                            type: string
                            example: Default theme template for categories
                          created_at:
                            type: string
                            format: date-time
                            example: '2021-01-01T00:00:00Z'
                          updated_at:
                            type: string
                            format: date-time
                            example: '2021-01-01T00:00:00Z'
                      search_engine_optimizer:
                        type:
                          - object
                          - 'null'
                        properties:
                          title:
                            type: string
                            example: SEO Title
                          description:
                            type: string
                            example: SEO Description
                          image_url:
                            type: string
                            example: https://example.com/seo-image.jpg
                          image_path:
                            type: string
                            example: /images/seo.jpg
                          block_crawler:
                            type: boolean
                            example: false
                          slug:
                            type: string
                            example: summer-collection
                      products:
                        type:
                          - array
                          - 'null'
                        items:
                          type: object
                    required:
                      - id
                      - title
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
    patch:
      summary: Update category
      tags:
        - Categories
      security:
        - bearer_auth: []
      operationId: updateCategory
      parameters:
        - name: id
          in: path
          required: true
          description: Category ID
          example: 1
          schema:
            type: integer
      responses:
        '200':
          description: category updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  category:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      title:
                        type:
                          - string
                          - 'null'
                        example: Summer Collection
                      description:
                        type:
                          - string
                          - 'null'
                        example: Our latest summer styles
                      image_url:
                        type:
                          - string
                          - 'null'
                        example: https://example.com/image.jpg
                      image_path:
                        type:
                          - string
                          - 'null'
                        example: /images/summer.jpg
                      position:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      public:
                        type: boolean
                        example: true
                      active:
                        type: boolean
                        example: true
                      source_type:
                        type:
                          - string
                          - 'null'
                        example: product
                      parent_id:
                        type:
                          - integer
                          - 'null'
                        example: null
                      has_children:
                        type: boolean
                        example: false
                      slug:
                        type:
                          - string
                          - 'null'
                        example: summer-collection
                      custom_slug:
                        type: boolean
                        example: false
                      created_at:
                        type: string
                        format: date_time
                      updated_at:
                        type: string
                        format: date_time
                      include_children:
                        type:
                          - boolean
                          - 'null'
                        example: false
                      parent_name:
                        type:
                          - string
                          - 'null'
                        example: null
                      sub_categories:
                        type:
                          - array
                          - 'null'
                        items:
                          type: object
                      application_theme_template:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type: string
                            example: Default Template
                          description:
                            type: string
                            example: Default theme template for categories
                          created_at:
                            type: string
                            format: date-time
                            example: '2021-01-01T00:00:00Z'
                          updated_at:
                            type: string
                            format: date-time
                            example: '2021-01-01T00:00:00Z'
                      search_engine_optimizer:
                        type:
                          - object
                          - 'null'
                        properties:
                          title:
                            type: string
                            example: SEO Title
                          description:
                            type: string
                            example: SEO Description
                          image_url:
                            type: string
                            example: https://example.com/seo-image.jpg
                          image_path:
                            type: string
                            example: /images/seo.jpg
                          block_crawler:
                            type: boolean
                            example: false
                          slug:
                            type: string
                            example: summer-collection
                      products:
                        type:
                          - array
                          - 'null'
                        items:
                          type: object
                    required:
                      - id
                      - title
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameters
                  errors:
                    type: object
                    properties:
                      category:
                        type: object
                        example:
                          title:
                            - must be filled
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                category:
                  type: object
                  properties:
                    title:
                      type: string
                      example: Updated Summer Collection
                    description:
                      type: string
                      example: Our updated summer styles
                    image_url:
                      type: string
                      example: https://example.com/updated-image.jpg
                    image_path:
                      type: string
                      example: /images/updated-summer.jpg
                    position:
                      type: integer
                      example: 2
                    parent_id:
                      type: integer
                      example: null
                    public:
                      type: boolean
                      example: false
                    active:
                      type: boolean
                      example: true
                    source_type:
                      type: string
                      example: product
                    application_theme_template_id:
                      type: integer
                      example: 2
                    slug:
                      type: string
                      example: updated-summer-collection
                    custom_slug:
                      type: boolean
                      example: false
                    feature_attributes:
                      type: object
                      properties:
                        _destroy:
                          type: boolean
                          example: true
                          description: Set to true to remove feature
                        position:
                          type: integer
                          example: 2
                    product_ids:
                      type: array
                      items:
                        type: integer
                    search_engine_optimizer_attributes:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 3
                          description: Auto-populated if SEO record exists
                        title:
                          type: string
                          example: Updated SEO Title
                        description:
                          type: string
                          example: Updated SEO Description
                        image_url:
                          type: string
                          example: https://example.com/updated-seo-image.jpg
                        image_path:
                          type: string
                          example: /images/updated-seo.jpg
                        block_crawler:
                          type: boolean
                          example: true
                  required:
                    - title
              required:
                - category
    delete:
      summary: Delete category
      tags:
        - Categories
      security:
        - bearer_auth: []
      operationId: deleteCategory
      parameters:
        - name: id
          in: path
          required: true
          description: Category ID
          schema:
            type: string
      responses:
        '200':
          description: category deleted
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: category deleted successfully
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/settings/checkout:
    get:
      summary: Show a checkout settings
      tags:
        - Checkout
      security:
        - bearer_auth: []
      operationId: showCheckoutSettings
      description: Show the current checkout settings for the company.
      responses:
        '200':
          description: checkout settings shown
          content:
            application/json:
              schema:
                title: Company
                type: object
                properties:
                  id:
                    type: integer
                  name:
                    type: string
                  favicon_url:
                    type:
                      - string
                      - 'null'
                  primary_domain_hostname:
                    example: acme.com
                    type:
                      - string
                      - 'null'
                  subdomain:
                    example: acme
                    type:
                      - string
                      - 'null'
                  logo_url:
                    example: https://acme.com/logo.png
                    type:
                      - string
                      - 'null'
                  fluid_shop:
                    example: true
                    type:
                      - boolean
                      - 'null'
                  collect_phone:
                    example: true
                    type: boolean
                  require_phone:
                    example: true
                    type: boolean
                  require_billing_zip:
                    example: true
                    type: boolean
                  checkout_primary_button_color:
                    example: '#000000'
                    type:
                      - string
                      - 'null'
                  checkout_primary_text_color:
                    example: '#FFFFFF'
                    type:
                      - string
                      - 'null'
                  checkout_secondary_button_color:
                    example: '#000000'
                    type:
                      - string
                      - 'null'
                  checkout_secondary_text_color:
                    example: '#FFFFFF'
                    type:
                      - string
                      - 'null'
                  order_on_behalf:
                    example: false
                    type: boolean
                  use_juspay_gateway:
                    example: false
                    type: boolean
                  reward_points_enabled:
                    example: false
                    type: boolean
                required:
                  - id
                  - name
                  - collect_phone
                  - require_phone
                  - require_billing_zip
                  - order_on_behalf
                  - use_juspay_gateway
                  - reward_points_enabled
    put:
      summary: Update a checkout settings
      tags:
        - Checkout
      security:
        - bearer_auth: []
      operationId: updateCheckoutSettings
      description: Update the current checkout settings for the company.
      parameters: []
      responses:
        '200':
          description: checkout settings updated
          content:
            application/json:
              schema:
                title: Company
                type: object
                properties:
                  id:
                    type: integer
                  name:
                    type: string
                  favicon_url:
                    type:
                      - string
                      - 'null'
                  primary_domain_hostname:
                    example: acme.com
                    type:
                      - string
                      - 'null'
                  subdomain:
                    example: acme
                    type:
                      - string
                      - 'null'
                  logo_url:
                    example: https://acme.com/logo.png
                    type:
                      - string
                      - 'null'
                  fluid_shop:
                    example: true
                    type:
                      - boolean
                      - 'null'
                  collect_phone:
                    example: true
                    type: boolean
                  require_phone:
                    example: true
                    type: boolean
                  require_billing_zip:
                    example: true
                    type: boolean
                  checkout_primary_button_color:
                    example: '#000000'
                    type:
                      - string
                      - 'null'
                  checkout_primary_text_color:
                    example: '#FFFFFF'
                    type:
                      - string
                      - 'null'
                  checkout_secondary_button_color:
                    example: '#000000'
                    type:
                      - string
                      - 'null'
                  checkout_secondary_text_color:
                    example: '#FFFFFF'
                    type:
                      - string
                      - 'null'
                  order_on_behalf:
                    example: false
                    type: boolean
                  use_juspay_gateway:
                    example: false
                    type: boolean
                  reward_points_enabled:
                    example: false
                    type: boolean
                required:
                  - id
                  - name
                  - collect_phone
                  - require_phone
                  - require_billing_zip
                  - order_on_behalf
                  - use_juspay_gateway
                  - reward_points_enabled
        '422':
          description: checkout settings update failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: string
                required:
                  - errors
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                checkout:
                  type: object
                  properties:
                    collect_phone:
                      type: boolean
                    require_phone:
                      type: boolean
                    require_billing_zip:
                      type: boolean
                    checkout_primary_button_color:
                      type: string
                    checkout_primary_text_color:
                      type: string
                    checkout_secondary_button_color:
                      type: string
                    checkout_secondary_text_color:
                      type: string
                    order_on_behalf:
                      type: boolean
                      example: false
              required:
                - checkout
  /api/company/v1/collections:
    get:
      summary: List collections
      tags:
        - Collections
      security:
        - bearer_auth: []
      operationId: listCollections
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            default: 1
          required: false
          description: Page number for pagination
        - name: per_page
          in: query
          schema:
            type: integer
            default: 10
          required: false
          description: Number of records per page
        - name: public
          in: query
          schema:
            type: string
            enum:
              - all
              - 'true'
              - 'false'
            default: all
          required: false
          description: Filter by public status
        - name: status
          in: query
          schema:
            type: string
            enum:
              - all
              - 'true'
              - 'false'
            default: all
          required: false
          description: Filter by status
        - name: sorted_by
          in: query
          schema:
            type: string
            default: created_at_desc
          required: false
          description: >-
            Sorting criteria for menus, e.g., 'created_at_asc',
            'created_at_desc', 'title_asc', 'title_desc'
        - name: search_query
          in: query
          required: false
          description: Search keyword
          example: john doe
          schema:
            type: string
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  collections:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 1
                        title:
                          type:
                            - string
                            - 'null'
                          example: Summer Collection
                        description:
                          type:
                            - string
                            - 'null'
                          example: Our latest summer styles
                        image_url:
                          type:
                            - string
                            - 'null'
                          example: https://example.com/image.jpg
                        image_path:
                          type:
                            - string
                            - 'null'
                          example: /images/summer.jpg
                        position:
                          type:
                            - integer
                            - 'null'
                          example: 1
                        public:
                          type: boolean
                          example: true
                        active:
                          type: boolean
                          example: true
                        slug:
                          type:
                            - string
                            - 'null'
                          example: summer-collection
                        custom_slug:
                          type: boolean
                          example: false
                        created_at:
                          type: string
                          format: date_time
                        featured_date:
                          type:
                            - string
                            - 'null'
                          format: date_time
                        featured:
                          type: boolean
                          example: true
                        application_theme_template:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            name:
                              type: string
                              example: Default Template
                            description:
                              type: string
                              example: Default theme template for collections
                            created_at:
                              type: string
                              format: date-time
                              example: '2021-01-01T00:00:00Z'
                            updated_at:
                              type: string
                              format: date-time
                              example: '2021-01-01T00:00:00Z'
                        search_engine_optimizer:
                          type:
                            - object
                            - 'null'
                          properties:
                            title:
                              type: string
                              example: SEO Title
                            description:
                              type: string
                              example: SEO Description
                            image_url:
                              type: string
                              example: https://example.com/seo-image.jpg
                            image_path:
                              type: string
                              example: /images/seo.jpg
                            block_crawler:
                              type: boolean
                              example: false
                            slug:
                              type: string
                              example: summer-collection
                        product_collections:
                          type:
                            - array
                            - 'null'
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              product:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  title:
                                    type: string
                                    example: Sample Product
                                  introduction:
                                    type:
                                      - string
                                      - 'null'
                                    example: Sample Short Description
                                  cv:
                                    type: integer
                                    example: 10
                                  cv_in_currency:
                                    type: string
                                    example: $10.00
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: ext-prod-123
                                  image_path:
                                    type:
                                      - string
                                      - 'null'
                                    example: /images/product.png
                                  image_url:
                                    type:
                                      - string
                                      - 'null'
                                    example: https://example.com/images/product.png
                                  price:
                                    type: string
                                    example: '29.99'
                                  price_in_currency:
                                    type: string
                                    example: $29.99
                                  sku:
                                    type:
                                      - string
                                      - 'null'
                                    example: SKU12345
                                  tax:
                                    type: string
                                    example: '2.99'
                                  tax_in_currency:
                                    type: string
                                    example: $2.99
                                  metadata:
                                    type: object
                                    example:
                                      shopify_product_id: 9876054868270
                                  metafields:
                                    type: array
                                    items:
                                      title: LegacyMetafield
                                      type: object
                                      properties:
                                        namespace:
                                          description: >-
                                            A container for related metafields.
                                            Commonly used to group metafields by app
                                            or functionality.
                                          example: custom
                                          type: string
                                          maxLength: 20
                                          pattern: ^[a-zA-Z0-9_]+$
                                        key:
                                          description: >-
                                            The unique identifier for the metafield
                                            within its namespace. Must be unique per
                                            namespace and owner.
                                          example: material
                                          type: string
                                          maxLength: 30
                                          pattern: ^[a-zA-Z0-9_]+$
                                        value:
                                          description: >-
                                            The actual data stored in the metafield.
                                            Type depends on value_type.
                                          example: cotton
                                          type:
                                            - string
                                            - integer
                                            - object
                                            - boolean
                                            - number
                                        value_type:
                                          description: >-
                                            The data type that defines how the value
                                            should be interpreted and validated.
                                          example: single_line_text_field
                                          type: string
                                        description:
                                          description: >-
                                            Optional human-readable description
                                            explaining the purpose of this
                                            metafield.
                                          example: >-
                                            The primary material used in this
                                            product
                                          type:
                                            - string
                                            - 'null'
                                        created_at:
                                          description: >-
                                            Timestamp when the metafield was
                                            created.
                                          example: '2021-01-01T00:00:00Z'
                                          type: string
                                          format: date-time
                                        updated_at:
                                          description: >-
                                            Timestamp when the metafield was last
                                            updated.
                                          example: '2021-01-01T00:00:00Z'
                                          type: string
                                          format: date-time
                                        locked:
                                          description: >-
                                            Whether this metafield is locked and
                                            cannot be updated or deleted directly.
                                          example: false
                                          type:
                                            - boolean
                                            - 'null'
                                            - 'null'
                                        metafield_definition:
                                          description: >-
                                            The definition that defines validation
                                            rules and structure for this metafield
                                          type:
                                            - 'null'
                                            - object
                                      required:
                                        - namespace
                                        - key
                                        - value
                                        - value_type
                                        - description
                                        - created_at
                                        - updated_at
                                        - metafield_definition
                      required:
                        - id
                        - title
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      pagination:
                        type: object
                        properties:
                          current_page:
                            type: integer
                            example: 1
                          total_pages:
                            type: integer
                            example: 10
                          total_count:
                            type: integer
                            example: 100
                          per_page:
                            type: integer
                            example: 10
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
    post:
      summary: Create collection
      tags:
        - Collections
      security:
        - bearer_auth: []
      operationId: createCollection
      parameters: []
      responses:
        '201':
          description: collection created
          content:
            application/json:
              schema:
                type: object
                properties:
                  collection:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      title:
                        type:
                          - string
                          - 'null'
                        example: Summer Collection
                      description:
                        type:
                          - string
                          - 'null'
                        example: Our latest summer styles
                      image_url:
                        type:
                          - string
                          - 'null'
                        example: https://example.com/image.jpg
                      image_path:
                        type:
                          - string
                          - 'null'
                        example: /images/summer.jpg
                      position:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      public:
                        type: boolean
                        example: true
                      active:
                        type: boolean
                        example: true
                      slug:
                        type:
                          - string
                          - 'null'
                        example: summer-collection
                      custom_slug:
                        type: boolean
                        example: false
                      created_at:
                        type: string
                        format: date_time
                      featured_date:
                        type:
                          - string
                          - 'null'
                        format: date_time
                      featured:
                        type: boolean
                        example: true
                      application_theme_template:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type: string
                            example: Default Template
                          description:
                            type: string
                            example: Default theme template for collections
                          created_at:
                            type: string
                            format: date-time
                            example: '2021-01-01T00:00:00Z'
                          updated_at:
                            type: string
                            format: date-time
                            example: '2021-01-01T00:00:00Z'
                      search_engine_optimizer:
                        type:
                          - object
                          - 'null'
                        properties:
                          title:
                            type: string
                            example: SEO Title
                          description:
                            type: string
                            example: SEO Description
                          image_url:
                            type: string
                            example: https://example.com/seo-image.jpg
                          image_path:
                            type: string
                            example: /images/seo.jpg
                          block_crawler:
                            type: boolean
                            example: false
                          slug:
                            type: string
                            example: summer-collection
                      product_collections:
                        type:
                          - array
                          - 'null'
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            product:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1
                                title:
                                  type: string
                                  example: Sample Product
                                introduction:
                                  type:
                                    - string
                                    - 'null'
                                  example: Sample Short Description
                                cv:
                                  type: integer
                                  example: 10
                                cv_in_currency:
                                  type: string
                                  example: $10.00
                                external_id:
                                  type:
                                    - string
                                    - 'null'
                                  example: ext-prod-123
                                image_path:
                                  type:
                                    - string
                                    - 'null'
                                  example: /images/product.png
                                image_url:
                                  type:
                                    - string
                                    - 'null'
                                  example: https://example.com/images/product.png
                                price:
                                  type: string
                                  example: '29.99'
                                price_in_currency:
                                  type: string
                                  example: $29.99
                                sku:
                                  type:
                                    - string
                                    - 'null'
                                  example: SKU12345
                                tax:
                                  type: string
                                  example: '2.99'
                                tax_in_currency:
                                  type: string
                                  example: $2.99
                                metadata:
                                  type: object
                                  example:
                                    shopify_product_id: 9876054868270
                                metafields:
                                  type: array
                                  items:
                                    title: LegacyMetafield
                                    type: object
                                    properties:
                                      namespace:
                                        description: >-
                                          A container for related metafields.
                                          Commonly used to group metafields by app
                                          or functionality.
                                        example: custom
                                        type: string
                                        maxLength: 20
                                        pattern: ^[a-zA-Z0-9_]+$
                                      key:
                                        description: >-
                                          The unique identifier for the metafield
                                          within its namespace. Must be unique per
                                          namespace and owner.
                                        example: material
                                        type: string
                                        maxLength: 30
                                        pattern: ^[a-zA-Z0-9_]+$
                                      value:
                                        description: >-
                                          The actual data stored in the metafield.
                                          Type depends on value_type.
                                        example: cotton
                                        type:
                                          - string
                                          - integer
                                          - object
                                          - boolean
                                          - number
                                      value_type:
                                        description: >-
                                          The data type that defines how the value
                                          should be interpreted and validated.
                                        example: single_line_text_field
                                        type: string
                                      description:
                                        description: >-
                                          Optional human-readable description
                                          explaining the purpose of this
                                          metafield.
                                        example: >-
                                          The primary material used in this
                                          product
                                        type:
                                          - string
                                          - 'null'
                                      created_at:
                                        description: >-
                                          Timestamp when the metafield was
                                          created.
                                        example: '2021-01-01T00:00:00Z'
                                        type: string
                                        format: date-time
                                      updated_at:
                                        description: >-
                                          Timestamp when the metafield was last
                                          updated.
                                        example: '2021-01-01T00:00:00Z'
                                        type: string
                                        format: date-time
                                      locked:
                                        description: >-
                                          Whether this metafield is locked and
                                          cannot be updated or deleted directly.
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                          - 'null'
                                      metafield_definition:
                                        description: >-
                                          The definition that defines validation
                                          rules and structure for this metafield
                                        type:
                                          - 'null'
                                          - object
                                    required:
                                      - namespace
                                      - key
                                      - value
                                      - value_type
                                      - description
                                      - created_at
                                      - updated_at
                                      - metafield_definition
                    required:
                      - id
                      - title
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameter
                  errors:
                    type: object
                    properties:
                      collection:
                        type: object
                        example:
                          title:
                            - can't be blank
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                collection:
                  type: object
                  properties:
                    title:
                      type: string
                      example: Summer Collection
                    description:
                      type: string
                      example: Our latest summer styles
                    image_url:
                      type: string
                      example: https://example.com/image.jpg
                    image_path:
                      type: string
                      example: /images/summer.jpg
                    position:
                      type: integer
                      example: 1
                    public:
                      type: boolean
                      example: true
                    active:
                      type: boolean
                      example: true
                    application_theme_template_id:
                      type: integer
                      example: 1
                    slug:
                      type: string
                      example: my-favourite
                    custom_slug:
                      type: boolean
                      example: false
                    feature_attributes:
                      type: object
                      properties:
                        _destroy:
                          type: boolean
                          example: false
                        position:
                          type: integer
                          example: 1
                    product_collections_attributes:
                      type: array
                      items:
                        type: object
                        properties:
                          product_id:
                            type: integer
                            example: 1
                          _destroy:
                            type: boolean
                            example: false
                    search_engine_optimizer_attributes:
                      type: object
                      properties:
                        title:
                          type: string
                          example: SEO Title
                        description:
                          type: string
                          example: SEO Description
                        image_url:
                          type: string
                          example: https://example.com/seo-image.jpg
                        image_path:
                          type: string
                          example: /images/seo.jpg
                        block_crawler:
                          type: boolean
                          example: false
                  required:
                    - title
              required:
                - collection
  /api/company/v1/collections/{id}:
    get:
      summary: Get collection
      tags:
        - Collections
      security:
        - bearer_auth: []
      operationId: getCollection
      parameters:
        - name: id
          in: path
          required: true
          description: Collection ID
          schema:
            type: string
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  collection:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      title:
                        type:
                          - string
                          - 'null'
                        example: Summer Collection
                      description:
                        type:
                          - string
                          - 'null'
                        example: Our latest summer styles
                      image_url:
                        type:
                          - string
                          - 'null'
                        example: https://example.com/image.jpg
                      image_path:
                        type:
                          - string
                          - 'null'
                        example: /images/summer.jpg
                      position:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      public:
                        type: boolean
                        example: true
                      active:
                        type: boolean
                        example: true
                      slug:
                        type:
                          - string
                          - 'null'
                        example: summer-collection
                      custom_slug:
                        type: boolean
                        example: false
                      created_at:
                        type: string
                        format: date_time
                      featured_date:
                        type:
                          - string
                          - 'null'
                        format: date_time
                      featured:
                        type: boolean
                        example: true
                      application_theme_template:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type: string
                            example: Default Template
                          description:
                            type: string
                            example: Default theme template for collections
                          created_at:
                            type: string
                            format: date-time
                            example: '2021-01-01T00:00:00Z'
                          updated_at:
                            type: string
                            format: date-time
                            example: '2021-01-01T00:00:00Z'
                      search_engine_optimizer:
                        type:
                          - object
                          - 'null'
                        properties:
                          title:
                            type: string
                            example: SEO Title
                          description:
                            type: string
                            example: SEO Description
                          image_url:
                            type: string
                            example: https://example.com/seo-image.jpg
                          image_path:
                            type: string
                            example: /images/seo.jpg
                          block_crawler:
                            type: boolean
                            example: false
                          slug:
                            type: string
                            example: summer-collection
                      product_collections:
                        type:
                          - array
                          - 'null'
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            product:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1
                                title:
                                  type: string
                                  example: Sample Product
                                introduction:
                                  type:
                                    - string
                                    - 'null'
                                  example: Sample Short Description
                                cv:
                                  type: integer
                                  example: 10
                                cv_in_currency:
                                  type: string
                                  example: $10.00
                                external_id:
                                  type:
                                    - string
                                    - 'null'
                                  example: ext-prod-123
                                image_path:
                                  type:
                                    - string
                                    - 'null'
                                  example: /images/product.png
                                image_url:
                                  type:
                                    - string
                                    - 'null'
                                  example: https://example.com/images/product.png
                                price:
                                  type: string
                                  example: '29.99'
                                price_in_currency:
                                  type: string
                                  example: $29.99
                                sku:
                                  type:
                                    - string
                                    - 'null'
                                  example: SKU12345
                                tax:
                                  type: string
                                  example: '2.99'
                                tax_in_currency:
                                  type: string
                                  example: $2.99
                                metadata:
                                  type: object
                                  example:
                                    shopify_product_id: 9876054868270
                                metafields:
                                  type: array
                                  items:
                                    title: LegacyMetafield
                                    type: object
                                    properties:
                                      namespace:
                                        description: >-
                                          A container for related metafields.
                                          Commonly used to group metafields by app
                                          or functionality.
                                        example: custom
                                        type: string
                                        maxLength: 20
                                        pattern: ^[a-zA-Z0-9_]+$
                                      key:
                                        description: >-
                                          The unique identifier for the metafield
                                          within its namespace. Must be unique per
                                          namespace and owner.
                                        example: material
                                        type: string
                                        maxLength: 30
                                        pattern: ^[a-zA-Z0-9_]+$
                                      value:
                                        description: >-
                                          The actual data stored in the metafield.
                                          Type depends on value_type.
                                        example: cotton
                                        type:
                                          - string
                                          - integer
                                          - object
                                          - boolean
                                          - number
                                      value_type:
                                        description: >-
                                          The data type that defines how the value
                                          should be interpreted and validated.
                                        example: single_line_text_field
                                        type: string
                                      description:
                                        description: >-
                                          Optional human-readable description
                                          explaining the purpose of this
                                          metafield.
                                        example: >-
                                          The primary material used in this
                                          product
                                        type:
                                          - string
                                          - 'null'
                                      created_at:
                                        description: >-
                                          Timestamp when the metafield was
                                          created.
                                        example: '2021-01-01T00:00:00Z'
                                        type: string
                                        format: date-time
                                      updated_at:
                                        description: >-
                                          Timestamp when the metafield was last
                                          updated.
                                        example: '2021-01-01T00:00:00Z'
                                        type: string
                                        format: date-time
                                      locked:
                                        description: >-
                                          Whether this metafield is locked and
                                          cannot be updated or deleted directly.
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                          - 'null'
                                      metafield_definition:
                                        description: >-
                                          The definition that defines validation
                                          rules and structure for this metafield
                                        type:
                                          - 'null'
                                          - object
                                    required:
                                      - namespace
                                      - key
                                      - value
                                      - value_type
                                      - description
                                      - created_at
                                      - updated_at
                                      - metafield_definition
                    required:
                      - id
                      - title
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
    patch:
      summary: Update collection
      tags:
        - Collections
      security:
        - bearer_auth: []
      operationId: updateCollection
      parameters:
        - name: id
          in: path
          required: true
          description: Collection ID
          example: 1
          schema:
            type: integer
      responses:
        '200':
          description: collection updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  collection:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      title:
                        type:
                          - string
                          - 'null'
                        example: Summer Collection
                      description:
                        type:
                          - string
                          - 'null'
                        example: Our latest summer styles
                      image_url:
                        type:
                          - string
                          - 'null'
                        example: https://example.com/image.jpg
                      image_path:
                        type:
                          - string
                          - 'null'
                        example: /images/summer.jpg
                      position:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      public:
                        type: boolean
                        example: true
                      active:
                        type: boolean
                        example: true
                      slug:
                        type:
                          - string
                          - 'null'
                        example: summer-collection
                      custom_slug:
                        type: boolean
                        example: false
                      created_at:
                        type: string
                        format: date_time
                      featured_date:
                        type:
                          - string
                          - 'null'
                        format: date_time
                      featured:
                        type: boolean
                        example: true
                      application_theme_template:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type: string
                            example: Default Template
                          description:
                            type: string
                            example: Default theme template for collections
                          created_at:
                            type: string
                            format: date-time
                            example: '2021-01-01T00:00:00Z'
                          updated_at:
                            type: string
                            format: date-time
                            example: '2021-01-01T00:00:00Z'
                      search_engine_optimizer:
                        type:
                          - object
                          - 'null'
                        properties:
                          title:
                            type: string
                            example: SEO Title
                          description:
                            type: string
                            example: SEO Description
                          image_url:
                            type: string
                            example: https://example.com/seo-image.jpg
                          image_path:
                            type: string
                            example: /images/seo.jpg
                          block_crawler:
                            type: boolean
                            example: false
                          slug:
                            type: string
                            example: summer-collection
                      product_collections:
                        type:
                          - array
                          - 'null'
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            product:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1
                                title:
                                  type: string
                                  example: Sample Product
                                introduction:
                                  type:
                                    - string
                                    - 'null'
                                  example: Sample Short Description
                                cv:
                                  type: integer
                                  example: 10
                                cv_in_currency:
                                  type: string
                                  example: $10.00
                                external_id:
                                  type:
                                    - string
                                    - 'null'
                                  example: ext-prod-123
                                image_path:
                                  type:
                                    - string
                                    - 'null'
                                  example: /images/product.png
                                image_url:
                                  type:
                                    - string
                                    - 'null'
                                  example: https://example.com/images/product.png
                                price:
                                  type: string
                                  example: '29.99'
                                price_in_currency:
                                  type: string
                                  example: $29.99
                                sku:
                                  type:
                                    - string
                                    - 'null'
                                  example: SKU12345
                                tax:
                                  type: string
                                  example: '2.99'
                                tax_in_currency:
                                  type: string
                                  example: $2.99
                                metadata:
                                  type: object
                                  example:
                                    shopify_product_id: 9876054868270
                                metafields:
                                  type: array
                                  items:
                                    title: LegacyMetafield
                                    type: object
                                    properties:
                                      namespace:
                                        description: >-
                                          A container for related metafields.
                                          Commonly used to group metafields by app
                                          or functionality.
                                        example: custom
                                        type: string
                                        maxLength: 20
                                        pattern: ^[a-zA-Z0-9_]+$
                                      key:
                                        description: >-
                                          The unique identifier for the metafield
                                          within its namespace. Must be unique per
                                          namespace and owner.
                                        example: material
                                        type: string
                                        maxLength: 30
                                        pattern: ^[a-zA-Z0-9_]+$
                                      value:
                                        description: >-
                                          The actual data stored in the metafield.
                                          Type depends on value_type.
                                        example: cotton
                                        type:
                                          - string
                                          - integer
                                          - object
                                          - boolean
                                          - number
                                      value_type:
                                        description: >-
                                          The data type that defines how the value
                                          should be interpreted and validated.
                                        example: single_line_text_field
                                        type: string
                                      description:
                                        description: >-
                                          Optional human-readable description
                                          explaining the purpose of this
                                          metafield.
                                        example: >-
                                          The primary material used in this
                                          product
                                        type:
                                          - string
                                          - 'null'
                                      created_at:
                                        description: >-
                                          Timestamp when the metafield was
                                          created.
                                        example: '2021-01-01T00:00:00Z'
                                        type: string
                                        format: date-time
                                      updated_at:
                                        description: >-
                                          Timestamp when the metafield was last
                                          updated.
                                        example: '2021-01-01T00:00:00Z'
                                        type: string
                                        format: date-time
                                      locked:
                                        description: >-
                                          Whether this metafield is locked and
                                          cannot be updated or deleted directly.
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                          - 'null'
                                      metafield_definition:
                                        description: >-
                                          The definition that defines validation
                                          rules and structure for this metafield
                                        type:
                                          - 'null'
                                          - object
                                    required:
                                      - namespace
                                      - key
                                      - value
                                      - value_type
                                      - description
                                      - created_at
                                      - updated_at
                                      - metafield_definition
                    required:
                      - id
                      - title
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameters
                  errors:
                    type: object
                    properties:
                      collection:
                        type: object
                        example:
                          title:
                            - must be filled
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                collection:
                  type: object
                  properties:
                    title:
                      type: string
                      example: Updated Summer Collection
                    description:
                      type: string
                      example: Our updated summer styles
                    image_url:
                      type: string
                      example: https://example.com/updated-image.jpg
                    image_path:
                      type: string
                      example: /images/updated-summer.jpg
                    position:
                      type: integer
                      example: 2
                    public:
                      type: boolean
                      example: false
                    active:
                      type: boolean
                      example: true
                    application_theme_template_id:
                      type: integer
                      example: 2
                    slug:
                      type: string
                      example: updated-favourite
                    custom_slug:
                      type: boolean
                      example: false
                    feature_attributes:
                      type: object
                      properties:
                        _destroy:
                          type: boolean
                          example: true
                          description: Set to true to remove feature
                        position:
                          type: integer
                          example: 2
                    product_collections_attributes:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 5
                            description: Required for updating existing product_collection
                          product_id:
                            type: integer
                            example: 4
                          _destroy:
                            type: boolean
                            example: true
                            description: Set to true to remove this product from collection
                      description: >-
                        For fine-grained control over product associations. Use
                        'id' field to update existing associations.
                    search_engine_optimizer_attributes:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 3
                          description: Auto-populated if SEO record exists
                        title:
                          type: string
                          example: Updated SEO Title
                        description:
                          type: string
                          example: Updated SEO Description
                        image_url:
                          type: string
                          example: https://example.com/updated-seo-image.jpg
                        image_path:
                          type: string
                          example: /images/updated-seo.jpg
                        block_crawler:
                          type: boolean
                          example: true
                  required:
                    - title
              required:
                - collection
    delete:
      summary: Delete collection
      tags:
        - Collections
      security:
        - bearer_auth: []
      operationId: deleteCollection
      parameters:
        - name: id
          in: path
          required: true
          description: Collection ID
          schema:
            type: string
      responses:
        '200':
          description: collection deleted
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Collection deleted successfully
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/company/v1/collections/{id_or_slug}:
    get:
      tags:
        - Collections
      summary: Get Collection Details
      description: Retrieves a Collection object by its ID or slug.
      operationId: getCollection
      parameters:
        - name: id_or_slug
          in: path
          required: true
          schema:
            type: string
          description: The unique identifier or slug of the Collection to retrieve
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/show1'
                  - example:
                      status: success
                      data:
                        collection:
                          id: 49
                          title: Test Collection
                          slug: test-collection-3
                          description: 'true'
                          image_path: ''
                          image_url: ''
                          position: null
                          public: false
              example:
                status: success
                data:
                  collection:
                    id: 49
                    title: Test Collection
                    slug: test-collection-3
                    description: 'true'
                    image_path: ''
                    image_url: ''
                    position: null
                    public: false
      deprecated: false
      security:
        - bearer: []
  /api/companies:
    get:
      summary: Get the current company
      tags:
        - Companies
      operationId: getCurrentCompany
      security:
        - bearer_auth: []
      responses:
        '200':
          description: company retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  company:
                    title: Company
                    type: object
                    properties:
                      id:
                        type: integer
                      name:
                        example: Acme, Inc.
                        type: string
                      active:
                        type:
                          - boolean
                          - 'null'
                        default: true
                      shipping:
                        description: >-
                          Company shipping. Possible values: Flat Country,
                          Droplet, Free, Product-based
                        example: fluid-rates
                        type:
                          - string
                          - 'null'
                      allow_free_shipping:
                        example: true
                        type:
                          - boolean
                          - 'null'
                      sandbox:
                        description: Whether the company is in sandbox mode for testing
                        example: false
                        type: boolean
                      is_mlm:
                        description: >-
                          Whether the company is a Multi-Level Marketing (MLM)
                          business
                        example: true
                        type: boolean
                      fluid_shop:
                        example: acme.fluid.app
                        type: string
                      domain:
                        example: acme.com
                        type: string
                      color:
                        example: '#000000'
                        type: string
                      transaction_fee:
                        description: Transaction fee for the company
                        example: 1.9
                        type: number
                      tax_class:
                        description: Tax class for the company
                        example: fluid
                        type: string
                        enum:
                          - fluid
                          - custom
                          - droplet
                          - tax_free
                      appstore_url:
                        description: App Store URL for the company's mobile app
                        example: https://apps.apple.com/us/app/acme-app/id123456789
                        type:
                          - string
                          - 'null'
                      playstore_url:
                        description: Google Play Store URL for the company's mobile app
                        example: >-
                          https://play.google.com/store/apps/details?id=com.acme.app
                        type:
                          - string
                          - 'null'
                      shopify_order_fee:
                        description: Shopify order fee for the company
                        example: 0.1
                        type:
                          - number
                          - string
                          - 'null'
                        default: '1.99'
                      pre_purchase_enrollment_fields:
                        example: true
                        type:
                          - boolean
                          - 'null'
                      allow_signup:
                        description: Whether to allow self-signup
                        example: true
                        type:
                          - boolean
                          - 'null'
                      company_pays:
                        description: Whether the company pays for self-signup
                        example: true
                        type:
                          - boolean
                          - 'null'
                      olumo_token:
                        description: OLUMO token for the company
                        example: '1234567890'
                        type:
                          - string
                          - 'null'
                      apn_bundle:
                        description: APN bundle for the company
                        example: com.acme.app
                        type:
                          - string
                          - 'null'
                      ibi_bundle:
                        description: IBI bundle for the company
                        example: com.acme.app
                        type:
                          - string
                          - 'null'
                      signup_url:
                        description: Signup URL for the company
                        example: https://acme.com/signup
                        type:
                          - string
                          - 'null'
                      vgs_vault_id:
                        description: VGS vault ID for the company
                        example: '1234567890'
                        type:
                          - string
                          - 'null'
                      vgs_client_id:
                        description: VGS client ID for the company
                        example: '1234567890'
                        type:
                          - string
                          - 'null'
                      vgs_client_secret:
                        description: VGS client secret for the company
                        example: '1234567890'
                        type:
                          - string
                          - 'null'
                      payout_collection_enabled:
                        description: Whether payout collection is enabled
                        example: true
                        type:
                          - boolean
                          - 'null'
                      payout_collection_schedule:
                        description: Schedule for payout collection
                        example: daily
                        type:
                          - string
                          - 'null'
                      minimum_payout_amount:
                        description: Minimum payout amount
                        example: 10
                        type:
                          - number
                          - 'null'
                      use_juspay_gateway:
                        description: Whether to use Juspay gateway
                        example: false
                        type:
                          - boolean
                          - 'null'
                      reward_points_enabled:
                        description: Whether the reward points system is enabled
                        example: false
                        type: boolean
                      mobile_app_identifier:
                        example: com.fluid.app
                        type:
                          - string
                          - 'null'
                    required:
                      - id
                      - name
                      - sandbox
                      - is_mlm
                      - fluid_shop
                      - domain
                      - color
                      - transaction_fee
                      - tax_class
                      - reward_points_enabled
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/companies/set_shipping:
    post:
      summary: Set the shipping method for a company
      tags:
        - Companies
      operationId: setShippingMethod
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: shipping method set
          content:
            application/json:
              schema:
                type: object
                properties:
                  company:
                    title: Company
                    type: object
                    properties:
                      id:
                        type: integer
                      name:
                        example: Acme, Inc.
                        type: string
                      active:
                        type:
                          - boolean
                          - 'null'
                        default: true
                      shipping:
                        description: >-
                          Company shipping. Possible values: Flat Country,
                          Droplet, Free, Product-based
                        example: fluid-rates
                        type:
                          - string
                          - 'null'
                      allow_free_shipping:
                        example: true
                        type:
                          - boolean
                          - 'null'
                    required:
                      - id
                      - name
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: invalid shipping value
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: unprocessable_entity
                  errors:
                    type: object
                    example:
                      shipping:
                        - Invalid Shipping value
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                settings:
                  type: object
                  properties:
                    shipping:
                      type: string
                      example: manual
                      description: Shipping calculation mode
                    allow_free_shipping:
                      type: boolean
                      example: true
                      description: Allow free shipping
                  required:
                    - shipping
              required:
                - settings
  /api/companies/set_tax_option:
    patch:
      summary: Set the tax option for a company
      tags:
        - Companies
      operationId: setCompanyTaxOption
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: Tax option set
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Tax option for the company successfully updated.
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - success
                  - message
                  - meta
        '422':
          description: Invalid tax_option value
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Failed to update the company tax option.
                  errors:
                    type: object
                    example:
                      tax_option:
                        - is not included in the list
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                tax_option:
                  type: string
                  example: avalara
                  description: Choose service for taxation.
                  enum:
                    - manual_calculation
                    - avalara
                    - webhook
                    - custom_avalara
                    - tax_table
                    - tax_free
              required:
                - tax_option
  /api/companies/set_tax_class:
    patch:
      summary: Set the tax class for a company
      tags:
        - Companies
      operationId: setCompanyTaxClass
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: Tax class set
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Tax option for the company successfully updated.
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - success
                  - message
                  - meta
        '422':
          description: Invalid tax_class value
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Failed to update the company tax class.
                  errors:
                    type: object
                    example:
                      tax_class:
                        - is not included in the list
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                tax_class:
                  type: string
                  example: droplet
                  description: Choose service class to be used for taxation.
                  enum:
                    - fluid
                    - custom
                    - droplet
                    - tax_free
              required:
                - tax_class
  /api/companies/set_bundle_subscriptions:
    post:
      summary: Set the bundle subscriptions setting for a company
      tags:
        - Companies
      operationId: setCompanyBundleSubscriptions
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: Bundle subscriptions setting updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Bundle subscriptions for the company successfully updated.
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - success
                  - message
                  - meta
        '422':
          description: Invalid bundle_subscriptions value
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameters
                  errors:
                    type: object
                    example:
                      bundle_subscriptions:
                        - must be a boolean
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                bundle_subscriptions:
                  type: boolean
                  example: true
                  description: Enable or disable bundle subscriptions for the company.
              required:
                - bundle_subscriptions
  /api/settings/companies:
    get:
      summary: List all companies
      tags:
        - Companies
      security:
        - bearer_auth: []
      operationId: listAllCompanies
      description: List all companies. Accessible only by root admins.
      parameters:
        - name: Authorization
          in: header
          required: true
          description: Bearer token for authentication
          schema:
            type: string
        - name: page
          in: query
          schema:
            type: integer
            minimum: 1
          required: false
          description: Page number for pagination
        - name: per_page
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
          required: false
          description: 'Number of records per page (default: 25)'
        - name: sorted_by
          in: query
          schema:
            type: string
          required: false
          description: Sort the result by a specific field
        - name: search_query
          in: query
          schema:
            type: string
          required: false
          description: Search query to filter companies
        - name: status
          in: query
          required: false
          description: Filter by status
          schema:
            type: string
      responses:
        '200':
          description: Companies retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  companies:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        active:
                          type: boolean
                        sandbox:
                          type: boolean
                        base_url:
                          type: string
                        created_at:
                          type: string
                          format: date
                        logo_url:
                          type: string
                        name:
                          type: string
                        users_count:
                          type: string
                        user_company:
                          type: object
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date_time
                      current_page:
                        type: integer
                      next_page:
                        type:
                          - integer
                          - 'null'
                      prev_page:
                        type:
                          - integer
                          - 'null'
                      total_pages:
                        type: integer
                      total_count:
                        type: integer
                      count:
                        type: integer
                required:
                  - companies
                  - meta
        '401':
          description: Unauthorized - Invalid credentials
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '403':
          description: Forbidden - User is not authorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not authorized.
                required:
                  - error
    post:
      summary: Add new company
      tags:
        - Companies
      security:
        - bearer_auth: []
      operationId: addCompany
      description: Add new company
      parameters:
        - name: Authorization
          in: header
          required: true
          description: Bearer token for authentication
          schema:
            type: string
      responses:
        '201':
          description: Company created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  company:
                    title: Company
                    type: object
                    properties:
                      id:
                        type: integer
                      name:
                        example: Acme, Inc.
                        type: string
                      active:
                        type:
                          - boolean
                          - 'null'
                        default: true
                      shipping:
                        description: >-
                          Company shipping. Possible values: Flat Country,
                          Droplet, Free, Product-based
                        example: fluid-rates
                        type:
                          - string
                          - 'null'
                      allow_free_shipping:
                        example: true
                        type:
                          - boolean
                          - 'null'
                      sandbox:
                        description: Whether the company is in sandbox mode for testing
                        example: false
                        type: boolean
                      is_mlm:
                        description: >-
                          Whether the company is a Multi-Level Marketing (MLM)
                          business
                        example: true
                        type: boolean
                      fluid_shop:
                        example: acme.fluid.app
                        type: string
                      domain:
                        example: acme.com
                        type: string
                      color:
                        example: '#000000'
                        type: string
                      transaction_fee:
                        description: Transaction fee for the company
                        example: 1.9
                        type: number
                      tax_class:
                        description: Tax class for the company
                        example: fluid
                        type: string
                        enum:
                          - fluid
                          - custom
                          - droplet
                          - tax_free
                      appstore_url:
                        description: App Store URL for the company's mobile app
                        example: https://apps.apple.com/us/app/acme-app/id123456789
                        type:
                          - string
                          - 'null'
                      playstore_url:
                        description: Google Play Store URL for the company's mobile app
                        example: >-
                          https://play.google.com/store/apps/details?id=com.acme.app
                        type:
                          - string
                          - 'null'
                      shopify_order_fee:
                        description: Shopify order fee for the company
                        example: 0.1
                        type:
                          - number
                          - string
                          - 'null'
                        default: '1.99'
                      pre_purchase_enrollment_fields:
                        example: true
                        type:
                          - boolean
                          - 'null'
                      allow_signup:
                        description: Whether to allow self-signup
                        example: true
                        type:
                          - boolean
                          - 'null'
                      company_pays:
                        description: Whether the company pays for self-signup
                        example: true
                        type:
                          - boolean
                          - 'null'
                      olumo_token:
                        description: OLUMO token for the company
                        example: '1234567890'
                        type:
                          - string
                          - 'null'
                      apn_bundle:
                        description: APN bundle for the company
                        example: com.acme.app
                        type:
                          - string
                          - 'null'
                      ibi_bundle:
                        description: IBI bundle for the company
                        example: com.acme.app
                        type:
                          - string
                          - 'null'
                      signup_url:
                        description: Signup URL for the company
                        example: https://acme.com/signup
                        type:
                          - string
                          - 'null'
                      vgs_vault_id:
                        description: VGS vault ID for the company
                        example: '1234567890'
                        type:
                          - string
                          - 'null'
                      vgs_client_id:
                        description: VGS client ID for the company
                        example: '1234567890'
                        type:
                          - string
                          - 'null'
                      vgs_client_secret:
                        description: VGS client secret for the company
                        example: '1234567890'
                        type:
                          - string
                          - 'null'
                      payout_collection_enabled:
                        description: Whether payout collection is enabled
                        example: true
                        type:
                          - boolean
                          - 'null'
                      payout_collection_schedule:
                        description: Schedule for payout collection
                        example: daily
                        type:
                          - string
                          - 'null'
                      minimum_payout_amount:
                        description: Minimum payout amount
                        example: 10
                        type:
                          - number
                          - 'null'
                      use_juspay_gateway:
                        description: Whether to use Juspay gateway
                        example: false
                        type:
                          - boolean
                          - 'null'
                      reward_points_enabled:
                        description: Whether the reward points system is enabled
                        example: false
                        type: boolean
                      mobile_app_identifier:
                        example: com.fluid.app
                        type:
                          - string
                          - 'null'
                    required:
                      - id
                      - name
                      - sandbox
                      - is_mlm
                      - fluid_shop
                      - domain
                      - color
                      - transaction_fee
                      - tax_class
                      - reward_points_enabled
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date_time
                        example: '2021-01-01T00:00:00Z'
                required:
                  - company
                  - meta
        '401':
          description: Unauthorized - Invalid credentials
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '403':
          description: Forbidden - User is not authorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not authorized.
                required:
                  - error
        '422':
          description: Validation errors
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: object
                    properties:
                      company:
                        type: object
                        additionalProperties:
                          type: array
                          items:
                            type: string
                  error_message:
                    type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date_time
                        example: '2021-01-01T00:00:00Z'
                required:
                  - errors
                  - error_message
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  example: Acme Corporation
                subdomain:
                  type: string
                  example: acme
                domain:
                  type: string
                  example: acme.com
                color:
                  type: string
                  example: '#0C7CF6'
                transaction_fee:
                  type: number
                  example: 1.9
                active:
                  type: boolean
                  example: true
                sandbox:
                  type: boolean
                  example: false
                is_mlm:
                  type: boolean
                  example: true
              required:
                - name
                - subdomain
        required: true
        description: Company details for creation
  /api/settings/companies/{id}:
    get:
      summary: Get company details
      tags:
        - Companies
      security:
        - bearer_auth: []
      operationId: getCompanyDetails
      description: >-
        Get detailed information about a specific company. Accessible only by
        root admins.
      parameters:
        - name: Authorization
          in: header
          required: true
          description: Bearer token for authentication
          schema:
            type: string
      responses:
        '200':
          description: Company details retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  name:
                    example: Acme, Inc.
                    type: string
                  active:
                    type:
                      - boolean
                      - 'null'
                    default: true
                  shipping:
                    description: >-
                      Company shipping. Possible values: Flat Country, Droplet,
                      Free, Product-based
                    example: fluid-rates
                    type:
                      - string
                      - 'null'
                  allow_free_shipping:
                    example: true
                    type:
                      - boolean
                      - 'null'
                  sandbox:
                    description: Whether the company is in sandbox mode for testing
                    example: false
                    type: boolean
                  is_mlm:
                    description: >-
                      Whether the company is a Multi-Level Marketing (MLM)
                      business
                    example: true
                    type: boolean
                  fluid_shop:
                    example: acme.fluid.app
                    type: string
                  domain:
                    example: acme.com
                    type: string
                  color:
                    example: '#000000'
                    type: string
                  transaction_fee:
                    description: Transaction fee for the company
                    example: 1.9
                    type: number
                  tax_class:
                    description: Tax class for the company
                    example: fluid
                    type: string
                    enum:
                      - fluid
                      - custom
                      - droplet
                      - tax_free
                  appstore_url:
                    description: App Store URL for the company's mobile app
                    example: https://apps.apple.com/us/app/acme-app/id123456789
                    type:
                      - string
                      - 'null'
                  playstore_url:
                    description: Google Play Store URL for the company's mobile app
                    example: https://play.google.com/store/apps/details?id=com.acme.app
                    type:
                      - string
                      - 'null'
                  shopify_order_fee:
                    description: Shopify order fee for the company
                    example: 0.1
                    type:
                      - number
                      - string
                      - 'null'
                    default: '1.99'
                  pre_purchase_enrollment_fields:
                    example: true
                    type:
                      - boolean
                      - 'null'
                  allow_signup:
                    description: Whether to allow self-signup
                    example: true
                    type:
                      - boolean
                      - 'null'
                  company_pays:
                    description: Whether the company pays for self-signup
                    example: true
                    type:
                      - boolean
                      - 'null'
                  olumo_token:
                    description: OLUMO token for the company
                    example: '1234567890'
                    type:
                      - string
                      - 'null'
                  apn_bundle:
                    description: APN bundle for the company
                    example: com.acme.app
                    type:
                      - string
                      - 'null'
                  ibi_bundle:
                    description: IBI bundle for the company
                    example: com.acme.app
                    type:
                      - string
                      - 'null'
                  signup_url:
                    description: Signup URL for the company
                    example: https://acme.com/signup
                    type:
                      - string
                      - 'null'
                  vgs_vault_id:
                    description: VGS vault ID for the company
                    example: '1234567890'
                    type:
                      - string
                      - 'null'
                  vgs_client_id:
                    description: VGS client ID for the company
                    example: '1234567890'
                    type:
                      - string
                      - 'null'
                  vgs_client_secret:
                    description: VGS client secret for the company
                    example: '1234567890'
                    type:
                      - string
                      - 'null'
                  payout_collection_enabled:
                    description: Whether payout collection is enabled
                    example: true
                    type:
                      - boolean
                      - 'null'
                  payout_collection_schedule:
                    description: Schedule for payout collection
                    example: daily
                    type:
                      - string
                      - 'null'
                  minimum_payout_amount:
                    description: Minimum payout amount
                    example: 10
                    type:
                      - number
                      - 'null'
                  use_juspay_gateway:
                    description: Whether to use Juspay gateway
                    example: false
                    type:
                      - boolean
                      - 'null'
                  reward_points_enabled:
                    description: Whether the reward points system is enabled
                    example: false
                    type: boolean
                  mobile_app_identifier:
                    example: com.fluid.app
                    type:
                      - string
                      - 'null'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - id
                  - name
                  - active
                  - fluid_shop
                  - tax_class
                  - meta
    patch:
      summary: Update company details
      tags:
        - Companies
      security:
        - bearer_auth: []
      operationId: updateCompanyDetails
      description: >-
        Update specific company details. Currently supports updating
        appstore_url and playstore_url. Accessible only by root admins.
      parameters:
        - name: Authorization
          in: header
          required: true
          description: Bearer token for authentication
          schema:
            type: string
      responses:
        '200':
          description: Company updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  name:
                    example: Acme, Inc.
                    type: string
                  active:
                    type:
                      - boolean
                      - 'null'
                    default: true
                  shipping:
                    description: >-
                      Company shipping. Possible values: Flat Country, Droplet,
                      Free, Product-based
                    example: fluid-rates
                    type:
                      - string
                      - 'null'
                  allow_free_shipping:
                    example: true
                    type:
                      - boolean
                      - 'null'
                  sandbox:
                    description: Whether the company is in sandbox mode for testing
                    example: false
                    type: boolean
                  is_mlm:
                    description: >-
                      Whether the company is a Multi-Level Marketing (MLM)
                      business
                    example: true
                    type: boolean
                  fluid_shop:
                    example: acme.fluid.app
                    type: string
                  domain:
                    example: acme.com
                    type: string
                  color:
                    example: '#000000'
                    type: string
                  transaction_fee:
                    description: Transaction fee for the company
                    example: 1.9
                    type: number
                  tax_class:
                    description: Tax class for the company
                    example: fluid
                    type: string
                    enum:
                      - fluid
                      - custom
                      - droplet
                      - tax_free
                  appstore_url:
                    description: App Store URL for the company's mobile app
                    example: https://apps.apple.com/us/app/acme-app/id123456789
                    type:
                      - string
                      - 'null'
                  playstore_url:
                    description: Google Play Store URL for the company's mobile app
                    example: https://play.google.com/store/apps/details?id=com.acme.app
                    type:
                      - string
                      - 'null'
                  shopify_order_fee:
                    description: Shopify order fee for the company
                    example: 0.1
                    type:
                      - number
                      - string
                      - 'null'
                    default: '1.99'
                  pre_purchase_enrollment_fields:
                    example: true
                    type:
                      - boolean
                      - 'null'
                  allow_signup:
                    description: Whether to allow self-signup
                    example: true
                    type:
                      - boolean
                      - 'null'
                  company_pays:
                    description: Whether the company pays for self-signup
                    example: true
                    type:
                      - boolean
                      - 'null'
                  olumo_token:
                    description: OLUMO token for the company
                    example: '1234567890'
                    type:
                      - string
                      - 'null'
                  apn_bundle:
                    description: APN bundle for the company
                    example: com.acme.app
                    type:
                      - string
                      - 'null'
                  ibi_bundle:
                    description: IBI bundle for the company
                    example: com.acme.app
                    type:
                      - string
                      - 'null'
                  signup_url:
                    description: Signup URL for the company
                    example: https://acme.com/signup
                    type:
                      - string
                      - 'null'
                  vgs_vault_id:
                    description: VGS vault ID for the company
                    example: '1234567890'
                    type:
                      - string
                      - 'null'
                  vgs_client_id:
                    description: VGS client ID for the company
                    example: '1234567890'
                    type:
                      - string
                      - 'null'
                  vgs_client_secret:
                    description: VGS client secret for the company
                    example: '1234567890'
                    type:
                      - string
                      - 'null'
                  payout_collection_enabled:
                    description: Whether payout collection is enabled
                    example: true
                    type:
                      - boolean
                      - 'null'
                  payout_collection_schedule:
                    description: Schedule for payout collection
                    example: daily
                    type:
                      - string
                      - 'null'
                  minimum_payout_amount:
                    description: Minimum payout amount
                    example: 10
                    type:
                      - number
                      - 'null'
                  use_juspay_gateway:
                    description: Whether to use Juspay gateway
                    example: false
                    type:
                      - boolean
                      - 'null'
                  reward_points_enabled:
                    description: Whether the reward points system is enabled
                    example: false
                    type: boolean
                  mobile_app_identifier:
                    example: com.fluid.app
                    type:
                      - string
                      - 'null'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date_time
                        example: '2021-01-01T00:00:00Z'
                required:
                  - id
                  - name
                  - active
                  - fluid_shop
                  - tax_class
                  - meta
        '401':
          description: Unauthorized - Invalid credentials
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '403':
          description: Forbidden - User is not authorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not authorized.
                required:
                  - error
        '404':
          description: Company not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    properties:
                      company:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date_time
                        example: '2021-01-01T00:00:00Z'
                required:
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                appstore_url:
                  oneOf:
                    - type: string
                    - type: 'null'
                  example: https://apps.apple.com/us/app/acme-app/id123456789
                playstore_url:
                  oneOf:
                    - type: string
                    - type: 'null'
                  example: https://play.google.com/store/apps/details?id=com.acme.app
                sandbox:
                  type: boolean
                  example: false
                  description: Whether the company is in sandbox mode for testing
                order_on_behalf:
                  type: boolean
                  example: false
                reward_points_enabled:
                  type: boolean
                  example: false
                  description: Whether the reward points system is enabled
              required: []
        required: true
        description: Company details to update
    delete:
      summary: Delete Company
      tags:
        - Companies
      security:
        - bearer_auth: []
      operationId: deleteCompany
      description: >-
        Delete a specific company. This will soft delete the company and
        initiate background job for permanent delete. Accessible only by root
        admins.
      parameters:
        - name: Authorization
          in: header
          required: true
          description: Bearer token for authentication
          schema:
            type: string
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: Company was successfully destroyed
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                    example: 1
                  message:
                    type: string
                    example: Company was successfully destroyed.
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date_time
                        example: '2021-01-01T00:00:00Z'
                required:
                  - id
                  - message
        '401':
          description: Unauthorized - Invalid credentials
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '403':
          description: Forbidden - User is not authorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not authorized.
                required:
                  - error
        '404':
          description: Company not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                        example:
                          - Company not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date_time
                        example: '2021-01-01T00:00:00Z'
                required:
                  - errors
                  - error_message
    parameters:
      - name: id
        in: path
        required: true
        description: Company ID
        schema:
          type: integer
  /api/settings/companies/{id}/reward_points:
    patch:
      summary: Update reward points settings
      tags:
        - Companies
      security:
        - bearer_auth: []
      operationId: updateCompanyRewardPoints
      description: >-
        Update reward points settings. Accessible by root admins or company
        admins for their own company.
      parameters:
        - name: Authorization
          in: header
          required: true
          description: Bearer token for authentication
          schema:
            type: string
      responses:
        '200':
          description: Reward points settings updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  name:
                    example: Acme, Inc.
                    type: string
                  active:
                    type:
                      - boolean
                      - 'null'
                    default: true
                  shipping:
                    description: >-
                      Company shipping. Possible values: Flat Country, Droplet,
                      Free, Product-based
                    example: fluid-rates
                    type:
                      - string
                      - 'null'
                  allow_free_shipping:
                    example: true
                    type:
                      - boolean
                      - 'null'
                  sandbox:
                    description: Whether the company is in sandbox mode for testing
                    example: false
                    type: boolean
                  is_mlm:
                    description: >-
                      Whether the company is a Multi-Level Marketing (MLM)
                      business
                    example: true
                    type: boolean
                  fluid_shop:
                    example: acme.fluid.app
                    type: string
                  domain:
                    example: acme.com
                    type: string
                  color:
                    example: '#000000'
                    type: string
                  transaction_fee:
                    description: Transaction fee for the company
                    example: 1.9
                    type: number
                  tax_class:
                    description: Tax class for the company
                    example: fluid
                    type: string
                    enum:
                      - fluid
                      - custom
                      - droplet
                      - tax_free
                  appstore_url:
                    description: App Store URL for the company's mobile app
                    example: https://apps.apple.com/us/app/acme-app/id123456789
                    type:
                      - string
                      - 'null'
                  playstore_url:
                    description: Google Play Store URL for the company's mobile app
                    example: https://play.google.com/store/apps/details?id=com.acme.app
                    type:
                      - string
                      - 'null'
                  shopify_order_fee:
                    description: Shopify order fee for the company
                    example: 0.1
                    type:
                      - number
                      - string
                      - 'null'
                    default: '1.99'
                  pre_purchase_enrollment_fields:
                    example: true
                    type:
                      - boolean
                      - 'null'
                  allow_signup:
                    description: Whether to allow self-signup
                    example: true
                    type:
                      - boolean
                      - 'null'
                  company_pays:
                    description: Whether the company pays for self-signup
                    example: true
                    type:
                      - boolean
                      - 'null'
                  olumo_token:
                    description: OLUMO token for the company
                    example: '1234567890'
                    type:
                      - string
                      - 'null'
                  apn_bundle:
                    description: APN bundle for the company
                    example: com.acme.app
                    type:
                      - string
                      - 'null'
                  ibi_bundle:
                    description: IBI bundle for the company
                    example: com.acme.app
                    type:
                      - string
                      - 'null'
                  signup_url:
                    description: Signup URL for the company
                    example: https://acme.com/signup
                    type:
                      - string
                      - 'null'
                  vgs_vault_id:
                    description: VGS vault ID for the company
                    example: '1234567890'
                    type:
                      - string
                      - 'null'
                  vgs_client_id:
                    description: VGS client ID for the company
                    example: '1234567890'
                    type:
                      - string
                      - 'null'
                  vgs_client_secret:
                    description: VGS client secret for the company
                    example: '1234567890'
                    type:
                      - string
                      - 'null'
                  payout_collection_enabled:
                    description: Whether payout collection is enabled
                    example: true
                    type:
                      - boolean
                      - 'null'
                  payout_collection_schedule:
                    description: Schedule for payout collection
                    example: daily
                    type:
                      - string
                      - 'null'
                  minimum_payout_amount:
                    description: Minimum payout amount
                    example: 10
                    type:
                      - number
                      - 'null'
                  reward_points_enabled:
                    description: Whether the reward points system is enabled
                    example: false
                    type: boolean
                  mobile_app_identifier:
                    example: com.fluid.app
                    type:
                      - string
                      - 'null'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date_time
                        example: '2021-01-01T00:00:00Z'
                required:
                  - id
                  - name
                  - active
                  - fluid_shop
                  - tax_class
                  - meta
        '401':
          description: Unauthorized - User is not authorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Not authorized.
                required:
                  - message
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                company:
                  type: object
                  properties:
                    reward_points_enabled:
                      type: boolean
                      example: true
                  required:
                    - reward_points_enabled
              required:
                - company
        required: true
        description: Reward points settings to update
    parameters:
      - name: id
        in: path
        required: true
        description: Company ID
        schema:
          type: integer
  /api/companies/{company_id}/company_countries:
    get:
      summary: company countries retrieved
      tags:
        - Company Countries
      description: List all countries configured for the company
      operationId: listCommerceCompanyCountries
      security:
        - bearer_auth: []
      parameters:
        - name: company_id
          in: path
          required: true
          example: 1
          schema:
            type: integer
      responses:
        '200':
          description: company countries retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  company_countries:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 791909808
                        base_shipping:
                          type: string
                          example: '0.0'
                        country:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 446545869
                            currency_code:
                              type: string
                              example: USD
                            currency_symbol:
                              type: string
                              example: $
                            iso:
                              type: string
                              example: US
                            iso3:
                              type: string
                              example: USA
                            iso_name:
                              type: string
                              example: UNITED STATES
                            name:
                              type: string
                              example: United States
                            tax_enabled:
                              type:
                                - boolean
                                - 'null'
                            price_inclusive_of_tax:
                              type: boolean
                              example: false
                            price_inclusive_tax_name:
                              type:
                                - string
                                - 'null'
                              example: VAT
                            province_required:
                              type: boolean
                              example: false
                        currency:
                          type: string
                          example: USD
                        default:
                          type: boolean
                          example: true
                        entity:
                          type:
                            - object
                            - 'null'
                        entity_legally_registered:
                          type:
                            - boolean
                            - 'null'
                        handling_fee:
                          type:
                            - string
                            - 'null'
                        pause_incomplete_enrollment:
                          type:
                            - boolean
                            - 'null'
                        settlement_currency:
                          type:
                            - string
                            - 'null'
                        updated_at:
                          type: string
                          example: '2025-09-01T18:25:43Z'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: fa1d485c-6e72-44a0-9fb9-2a0fa9e7311e
                      timestamp:
                        type: string
                        example: '2025-09-01T18:25:44Z'
                      pagination:
                        type: object
                        properties:
                          current_page:
                            type: integer
                            example: 1
                          total_pages:
                            type: integer
                            example: 1
                          total_count:
                            type: integer
                            example: 2
                          per_page:
                            type: integer
                            example: 25
                required:
                  - company_countries
                  - meta
        '401':
          description: unauthorized - company access denied
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Not authorized
        '404':
          description: company not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    properties:
                      company:
                        type: array
                        items:
                          type: string
                        example:
                          - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: cb22eed6-22c2-4924-bc6c-adf180b0d9b6
                      timestamp:
                        type: string
                        example: '2025-09-01T18:44:22Z'
                required:
                  - error_message
                  - errors
                  - meta
    post:
      summary: Create company country
      tags:
        - Company Countries
      operationId: createCommerceCompanyCountry
      security:
        - bearer_auth: []
      parameters:
        - name: company_id
          in: path
          required: true
          example: 1
          schema:
            type: integer
      responses:
        '201':
          description: company country created
          content:
            application/json:
              schema:
                type: object
                properties:
                  company_country:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 791909808
                      base_shipping:
                        type: string
                        example: '0.0'
                      country:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 446545869
                          currency_code:
                            type: string
                            example: USD
                          currency_symbol:
                            type: string
                            example: $
                          iso:
                            type: string
                            example: US
                          iso3:
                            type: string
                            example: USA
                          iso_name:
                            type: string
                            example: UNITED STATES
                          name:
                            type: string
                            example: United States
                          tax_enabled:
                            type:
                              - boolean
                              - 'null'
                          price_inclusive_of_tax:
                            type: boolean
                            example: false
                          price_inclusive_tax_name:
                            type:
                              - string
                              - 'null'
                            example: VAT
                          province_required:
                            type: boolean
                            example: false
                      currency:
                        type: string
                        example: USD
                      default:
                        type: boolean
                        example: true
                      entity:
                        type:
                          - object
                          - 'null'
                      entity_legally_registered:
                        type:
                          - boolean
                          - 'null'
                      handling_fee:
                        type:
                          - string
                          - 'null'
                      pause_incomplete_enrollment:
                        type:
                          - boolean
                          - 'null'
                      settlement_currency:
                        type:
                          - string
                          - 'null'
                      updated_at:
                        type: string
                        example: '2025-09-01T18:25:43Z'
                  meta:
                    type: object
                required:
                  - company_country
                  - meta
        '401':
          description: unauthorized - company access denied
        '404':
          description: company not found
        '422':
          description: validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Company country could not be created
                  errors:
                    type: object
                    example:
                      company_country:
                        currency:
                          - can't be blank
                  meta:
                    type: object
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                company_country:
                  type: object
                  properties:
                    currency:
                      type: string
                      example: USD
                      description: Currency code
                    entity_id:
                      type:
                        - integer
                        - 'null'
                      example: 1
                      description: Associated entity ID
                    entity_legally_registered:
                      type:
                        - boolean
                        - 'null'
                      example: true
                      description: Whether entity is legally registered
                    settlement_currency:
                      type:
                        - string
                        - 'null'
                      example: USD
                      description: Settlement currency
                  required:
                    - currency
              required:
                - company_country
  /api/companies/{company_id}/company_countries/{id}:
    get:
      summary: Get company country
      tags:
        - Company Countries
      operationId: getCommerceCompanyCountry
      security:
        - bearer_auth: []
      parameters:
        - name: company_id
          in: path
          required: true
          example: 1
          schema:
            type: integer
        - name: id
          in: path
          required: true
          example: 1
          schema:
            type: integer
      responses:
        '200':
          description: company country retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  company_country:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 791909808
                      base_shipping:
                        type: string
                        example: '0.0'
                      country:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 446545869
                          currency_code:
                            type: string
                            example: USD
                          currency_symbol:
                            type: string
                            example: $
                          iso:
                            type: string
                            example: US
                          iso3:
                            type: string
                            example: USA
                          iso_name:
                            type: string
                            example: UNITED STATES
                          name:
                            type: string
                            example: United States
                          tax_enabled:
                            type:
                              - boolean
                              - 'null'
                          price_inclusive_of_tax:
                            type: boolean
                            example: false
                          price_inclusive_tax_name:
                            type:
                              - string
                              - 'null'
                            example: VAT
                          province_required:
                            type: boolean
                            example: false
                      currency:
                        type: string
                        example: USD
                      default:
                        type: boolean
                        example: true
                      entity:
                        type:
                          - object
                          - 'null'
                      entity_legally_registered:
                        type:
                          - boolean
                          - 'null'
                      handling_fee:
                        type:
                          - string
                          - 'null'
                      pause_incomplete_enrollment:
                        type:
                          - boolean
                          - 'null'
                      settlement_currency:
                        type:
                          - string
                          - 'null'
                      updated_at:
                        type: string
                        example: '2025-09-01T18:25:43Z'
                  meta:
                    type: object
                required:
                  - company_country
                  - meta
        '401':
          description: unauthorized - company access denied
        '404':
          description: company country not found
    put:
      summary: Update company country
      tags:
        - Company Countries
      operationId: updateCommerceCompanyCountry
      security:
        - bearer_auth: []
      parameters:
        - name: company_id
          in: path
          required: true
          example: 1
          schema:
            type: integer
        - name: id
          in: path
          required: true
          example: 1
          schema:
            type: integer
      responses:
        '200':
          description: company country updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  company_country:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 791909808
                      base_shipping:
                        type: string
                        example: '0.0'
                      country:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 446545869
                          currency_code:
                            type: string
                            example: USD
                          currency_symbol:
                            type: string
                            example: $
                          iso:
                            type: string
                            example: US
                          iso3:
                            type: string
                            example: USA
                          iso_name:
                            type: string
                            example: UNITED STATES
                          name:
                            type: string
                            example: United States
                          tax_enabled:
                            type:
                              - boolean
                              - 'null'
                          price_inclusive_of_tax:
                            type: boolean
                            example: false
                          price_inclusive_tax_name:
                            type:
                              - string
                              - 'null'
                            example: VAT
                          province_required:
                            type: boolean
                            example: false
                      currency:
                        type: string
                        example: USD
                      default:
                        type: boolean
                        example: true
                      entity:
                        type:
                          - object
                          - 'null'
                      entity_legally_registered:
                        type:
                          - boolean
                          - 'null'
                      handling_fee:
                        type:
                          - string
                          - 'null'
                      pause_incomplete_enrollment:
                        type:
                          - boolean
                          - 'null'
                      settlement_currency:
                        type:
                          - string
                          - 'null'
                      updated_at:
                        type: string
                        example: '2025-09-01T18:25:43Z'
                  meta:
                    type: object
                required:
                  - company_country
                  - meta
        '401':
          description: unauthorized - company access denied
        '404':
          description: company country not found
        '422':
          description: validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Company country could not be created
                  errors:
                    type: object
                    example:
                      company_country:
                        currency:
                          - can't be blank
                  meta:
                    type: object
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                company_country:
                  type: object
                  properties:
                    currency:
                      type:
                        - string
                        - 'null'
                      example: USD
                      description: Currency code
                    entity_id:
                      type:
                        - integer
                        - 'null'
                      example: 1
                      description: Associated entity ID
                    entity_legally_registered:
                      type:
                        - boolean
                        - 'null'
                      example: true
                      description: Whether entity is legally registered
                    settlement_currency:
                      type:
                        - string
                        - 'null'
                      example: USD
                      description: Settlement currency
              required:
                - company_country
    delete:
      summary: Delete company country
      tags:
        - Company Countries
      operationId: deleteCommerceCompanyCountry
      security:
        - bearer_auth: []
      parameters:
        - name: company_id
          in: path
          required: true
          example: 1
          schema:
            type: integer
        - name: id
          in: path
          required: true
          example: 1
          schema:
            type: integer
      responses:
        '204':
          description: company country deleted
        '401':
          description: unauthorized - company access denied
        '404':
          description: company country not found
        '422':
          description: company country cannot be deleted
  /api/v202506/products/{product_id}/compliance:
    get:
      summary: Get latest compliance scan for a product
      tags:
        - Compliance
      operationId: getLatestProductCompliance
      description: Returns the most recent compliance scan for a product
      security:
        - bearer_auth: []
      parameters:
        - name: product_id
          in: path
          required: true
          description: Product ID
          schema:
            type: integer
      responses:
        '200':
          description: latest compliance scan found
          content:
            application/json:
              schema:
                type: object
                properties:
                  item:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      score:
                        type:
                          - string
                          - number
                          - 'null'
                        example: '6.5'
                      status:
                        type: string
                        example: fair
                        enum:
                          - unknown
                          - poor
                          - fair
                          - good
                          - excellent
                      summary:
                        type:
                          - string
                          - 'null'
                        example: >-
                          Your content has some compliance issues that need
                          attention
                      scanned_at:
                        type:
                          - string
                          - 'null'
                        format: date-time
                      service:
                        type: string
                        example: OpenAI Moderation API
                      created_at:
                        type: string
                        format: date-time
                      updated_at:
                        type: string
                        format: date-time
                      compliance_issues:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            issue_text:
                              type: string
                              example: This product cures cancer
                            issue_reference:
                              type:
                                - string
                                - 'null'
                              example: Medical
                            issue_type:
                              type: string
                              example: Medical
                            severity:
                              type:
                                - string
                                - 'null'
                              example: high
                              enum:
                                - low
                                - medium
                                - high
                                - critical
                            recommendation:
                              type:
                                - string
                                - 'null'
                              example: Consider using 'may support' instead of 'cures'
                            created_at:
                              type: string
                              format: date-time
                            updated_at:
                              type: string
                              format: date-time
                          required:
                            - id
                            - issue_text
                            - issue_type
                    required:
                      - id
                      - service
                      - status
                  meta:
                    type: object
                required:
                  - item
        '404':
          description: no compliance scans found
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: object
                  error_message:
                    type:
                      - string
                      - object
                  meta:
                    type: object
  /api/v202506/products/{product_id}/compliances:
    get:
      summary: List all compliance scans for a product
      tags:
        - Compliance
      operationId: listProductCompliances
      description: Returns a paginated list of all compliance scans for a product
      security:
        - bearer_auth: []
      parameters:
        - name: product_id
          in: path
          required: true
          description: Product ID
          schema:
            type: integer
        - name: page
          in: query
          required: false
          description: Page number
          schema:
            type: integer
        - name: per_page
          in: query
          required: false
          description: Items per page
          schema:
            type: integer
      responses:
        '200':
          description: compliance scans retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 1
                        score:
                          type:
                            - string
                            - number
                            - 'null'
                          example: '6.5'
                        status:
                          type: string
                          example: fair
                          enum:
                            - unknown
                            - poor
                            - fair
                            - good
                            - excellent
                        summary:
                          type:
                            - string
                            - 'null'
                          example: >-
                            Your content has some compliance issues that need
                            attention
                        scanned_at:
                          type:
                            - string
                            - 'null'
                          format: date-time
                        service:
                          type: string
                          example: OpenAI Moderation API
                        created_at:
                          type: string
                          format: date-time
                        updated_at:
                          type: string
                          format: date-time
                        compliance_issues:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              issue_text:
                                type: string
                                example: This product cures cancer
                              issue_reference:
                                type:
                                  - string
                                  - 'null'
                                example: Medical
                              issue_type:
                                type: string
                                example: Medical
                              severity:
                                type:
                                  - string
                                  - 'null'
                                example: high
                                enum:
                                  - low
                                  - medium
                                  - high
                                  - critical
                              recommendation:
                                type:
                                  - string
                                  - 'null'
                                example: >-
                                  Consider using 'may support' instead of
                                  'cures'
                              created_at:
                                type: string
                                format: date-time
                              updated_at:
                                type: string
                                format: date-time
                            required:
                              - id
                              - issue_text
                              - issue_type
                      required:
                        - id
                        - service
                        - status
                  pagination:
                    type: object
                    properties:
                      current_page:
                        type: integer
                      total_pages:
                        type: integer
                      total_count:
                        type: integer
                      per_page:
                        type: integer
                  meta:
                    type: object
                required:
                  - items
                  - pagination
    post:
      summary: Create a new compliance scan
      tags:
        - Compliance
      operationId: createProductCompliance
      description: Creates a new compliance scan record for a product
      security:
        - bearer_auth: []
      parameters:
        - name: product_id
          in: path
          required: true
          description: Product ID
          schema:
            type: integer
      responses:
        '201':
          description: compliance scan created
          content:
            application/json:
              schema:
                type: object
                properties:
                  item:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      score:
                        type:
                          - string
                          - number
                          - 'null'
                        example: '6.5'
                      status:
                        type: string
                        example: fair
                        enum:
                          - unknown
                          - poor
                          - fair
                          - good
                          - excellent
                      summary:
                        type:
                          - string
                          - 'null'
                        example: >-
                          Your content has some compliance issues that need
                          attention
                      scanned_at:
                        type:
                          - string
                          - 'null'
                        format: date-time
                      service:
                        type: string
                        example: OpenAI Moderation API
                      created_at:
                        type: string
                        format: date-time
                      updated_at:
                        type: string
                        format: date-time
                      compliance_issues:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            issue_text:
                              type: string
                              example: This product cures cancer
                            issue_reference:
                              type:
                                - string
                                - 'null'
                              example: Medical
                            issue_type:
                              type: string
                              example: Medical
                            severity:
                              type:
                                - string
                                - 'null'
                              example: high
                              enum:
                                - low
                                - medium
                                - high
                                - critical
                            recommendation:
                              type:
                                - string
                                - 'null'
                              example: Consider using 'may support' instead of 'cures'
                            created_at:
                              type: string
                              format: date-time
                            updated_at:
                              type: string
                              format: date-time
                          required:
                            - id
                            - issue_text
                            - issue_type
                    required:
                      - id
                      - service
                      - status
                  meta:
                    type: object
                required:
                  - item
        '422':
          description: invalid parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: object
                  error_message:
                    type:
                      - string
                      - object
                  meta:
                    type: object
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                compliance:
                  type: object
                  properties:
                    service:
                      type: string
                      example: OpenAI Moderation API
                    score:
                      type: number
                      example: 6.5
                      minimum: 0
                      maximum: 10
                    summary:
                      type: string
                      example: Content has some compliance issues
                    scanned_at:
                      type: string
                      format: date-time
                    compliance_issues_attributes:
                      type: array
                      items:
                        type: object
                        properties:
                          issue_text:
                            type: string
                            example: This product cures cancer
                          issue_reference:
                            type: string
                            example: Medical
                          issue_type:
                            type: string
                            example: Medical
                          severity:
                            type: string
                            example: high
                            enum:
                              - low
                              - medium
                              - high
                              - critical
                          recommendation:
                            type: string
                            example: Use 'may support' instead
                        required:
                          - issue_text
                          - issue_type
                  required:
                    - service
              required:
                - compliance
  /api/v202506/products/{product_id}/compliances/{id}:
    get:
      summary: Get a specific compliance scan
      tags:
        - Compliance
      operationId: getProductCompliance
      description: Returns details of a specific compliance scan
      security:
        - bearer_auth: []
      parameters:
        - name: product_id
          in: path
          required: true
          description: Product ID
          schema:
            type: integer
        - name: id
          in: path
          required: true
          description: Compliance ID
          schema:
            type: integer
      responses:
        '200':
          description: compliance scan found
          content:
            application/json:
              schema:
                type: object
                properties:
                  item:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      score:
                        type:
                          - string
                          - number
                          - 'null'
                        example: '6.5'
                      status:
                        type: string
                        example: fair
                        enum:
                          - unknown
                          - poor
                          - fair
                          - good
                          - excellent
                      summary:
                        type:
                          - string
                          - 'null'
                        example: >-
                          Your content has some compliance issues that need
                          attention
                      scanned_at:
                        type:
                          - string
                          - 'null'
                        format: date-time
                      service:
                        type: string
                        example: OpenAI Moderation API
                      created_at:
                        type: string
                        format: date-time
                      updated_at:
                        type: string
                        format: date-time
                      compliance_issues:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            issue_text:
                              type: string
                              example: This product cures cancer
                            issue_reference:
                              type:
                                - string
                                - 'null'
                              example: Medical
                            issue_type:
                              type: string
                              example: Medical
                            severity:
                              type:
                                - string
                                - 'null'
                              example: high
                              enum:
                                - low
                                - medium
                                - high
                                - critical
                            recommendation:
                              type:
                                - string
                                - 'null'
                              example: Consider using 'may support' instead of 'cures'
                            created_at:
                              type: string
                              format: date-time
                            updated_at:
                              type: string
                              format: date-time
                          required:
                            - id
                            - issue_text
                            - issue_type
                    required:
                      - id
                      - service
                      - status
                  meta:
                    type: object
                required:
                  - item
        '404':
          description: compliance scan not found
    patch:
      summary: Update a compliance scan
      tags:
        - Compliance
      operationId: updateProductCompliance
      description: Updates an existing compliance scan
      security:
        - bearer_auth: []
      parameters:
        - name: product_id
          in: path
          required: true
          description: Product ID
          schema:
            type: integer
        - name: id
          in: path
          required: true
          description: Compliance ID
          schema:
            type: integer
      responses:
        '200':
          description: compliance scan updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  item:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      score:
                        type:
                          - string
                          - number
                          - 'null'
                        example: '6.5'
                      status:
                        type: string
                        example: fair
                        enum:
                          - unknown
                          - poor
                          - fair
                          - good
                          - excellent
                      summary:
                        type:
                          - string
                          - 'null'
                        example: >-
                          Your content has some compliance issues that need
                          attention
                      scanned_at:
                        type:
                          - string
                          - 'null'
                        format: date-time
                      service:
                        type: string
                        example: OpenAI Moderation API
                      created_at:
                        type: string
                        format: date-time
                      updated_at:
                        type: string
                        format: date-time
                      compliance_issues:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            issue_text:
                              type: string
                              example: This product cures cancer
                            issue_reference:
                              type:
                                - string
                                - 'null'
                              example: Medical
                            issue_type:
                              type: string
                              example: Medical
                            severity:
                              type:
                                - string
                                - 'null'
                              example: high
                              enum:
                                - low
                                - medium
                                - high
                                - critical
                            recommendation:
                              type:
                                - string
                                - 'null'
                              example: Consider using 'may support' instead of 'cures'
                            created_at:
                              type: string
                              format: date-time
                            updated_at:
                              type: string
                              format: date-time
                          required:
                            - id
                            - issue_text
                            - issue_type
                    required:
                      - id
                      - service
                      - status
                  meta:
                    type: object
                required:
                  - item
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                compliance:
                  type: object
                  properties:
                    score:
                      type: number
                      minimum: 0
                      maximum: 10
                    summary:
                      type: string
                    scanned_at:
                      type: string
                      format: date-time
              required:
                - compliance
    delete:
      summary: Delete a compliance scan
      tags:
        - Compliance
      operationId: deleteProductCompliance
      description: Deletes a compliance scan record
      security:
        - bearer_auth: []
      parameters:
        - name: product_id
          in: path
          required: true
          description: Product ID
          schema:
            type: integer
        - name: id
          in: path
          required: true
          description: Compliance ID
          schema:
            type: integer
      responses:
        '200':
          description: compliance scan deleted
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  meta:
                    type: object
  /api/company/contacts:
    get:
      summary: Get contacts with optional filters
      tags:
        - Contacts
      operationId: indexCompanyContact
      security:
        - bearer_auth: []
      parameters:
        - name: search_query
          in: query
          required: false
          description: >-
            Filter contacts with search query that matches with their first
            name, last name, email, or phone
          schema:
            type: string
        - name: sorted_by
          in: query
          required: false
          example: id_asc
          description: >
            Sort the records by one of the supported attributes:

              - created_at
              - first_name
              - user_name
              - activities

            The sort attribute should be followed by one of the order
            directives: '_asc', '_desc'
          schema:
            type: string
        - name: page
          in: query
          schema:
            type: integer
            default: 1
          required: false
          description: Page number for pagination
        - name: per_page
          in: query
          schema:
            type: integer
            default: 10
          required: false
          description: Number of records per page
        - name: by_metadata
          in: query
          schema:
            type: string
            default: '{}'
            format: json
          required: false
          description: Search JSON meta data
        - name: has_affiliate
          in: query
          schema:
            type: string
            default: assigned
            format: json
          required: false
          description: Filter contacts with or without associated affiliates
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  contacts:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: '13423'
                        token:
                          type:
                            - string
                            - 'null'
                          example: aF1VXFfkjMi9bhCXaE8u5a3B
                        first_name:
                          type:
                            - string
                            - 'null'
                          example: John
                        last_name:
                          type:
                            - string
                            - 'null'
                          example: Nash
                        full_name:
                          type:
                            - string
                            - 'null'
                          example: ''
                        avatar_url:
                          type:
                            - string
                            - 'null'
                          example: https://example.com/images/product.png
                        status:
                          type:
                            - string
                            - 'null'
                          example: new
                        email:
                          type:
                            - string
                            - 'null'
                          example: email@example.com
                        email2:
                          type:
                            - string
                            - 'null'
                          example: email@example.com
                        phone:
                          type:
                            - string
                            - 'null'
                          example: +1-1234567890
                        phone2:
                          type:
                            - string
                            - 'null'
                          example: +1-1234567890
                        phone_id:
                          type:
                            - string
                            - 'null'
                          example: ''
                        address:
                          type:
                            - string
                            - 'null'
                          example: 123 Main St
                        address2:
                          type:
                            - string
                            - 'null'
                          example: Apt 4B
                        city:
                          type:
                            - string
                            - 'null'
                          example: New York
                        state:
                          type:
                            - string
                            - 'null'
                          example: NY
                        postal_code:
                          type:
                            - string
                            - 'null'
                          example: '10001'
                        language_id:
                          type:
                            - integer
                            - 'null'
                          example: 234
                        country_id:
                          type:
                            - integer
                            - 'null'
                          example: 96
                        lead_type:
                          type:
                            - string
                            - 'null'
                          example: Web Chat
                        ip:
                          type:
                            - string
                            - 'null'
                          example: 1.1.1.1
                        requested_at:
                          type:
                            - string
                            - 'null'
                          format: date_time
                          example: '2025-01-16T04:22:43.809Z'
                        best_time:
                          type:
                            - string
                            - 'null'
                          example: Afternoon
                        time_zone:
                          type:
                            - string
                            - 'null'
                          example: America/New_York
                        reason:
                          type:
                            - string
                            - 'null'
                          example: I enjoy working from home
                        income:
                          type:
                            - string
                            - 'null'
                          example: $2500-5000 per Month
                        hours:
                          type:
                            - string
                            - 'null'
                          example: 11-15 hours per week
                        invest:
                          type:
                            - string
                            - 'null'
                          example: $750 - $1000
                        interest:
                          type:
                            - string
                            - 'null'
                          example: Ready to get started!
                        discarded_at:
                          type:
                            - string
                            - 'null'
                          format: date_time
                          example: '2025-01-16T04:22:43.809Z'
                        metadata:
                          type: object
                          description: >-
                            A JSON object that can store any custom data
                            structure.
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                      total_count:
                        type: integer
                        example: 42
                      total_pages:
                        type: integer
                        example: 3
                      current_page:
                        type: integer
                        example: 1
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameters
                  errors:
                    type: object
                    example:
                      by_metadata:
                        - >-
                          The value `{referred_by: {user: 'John},}` in parameter
                          `by_metadata` is not a valid JSON
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
    post:
      summary: Create a contact
      tags:
        - Contacts
      operationId: createCompanyContact
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: created
        '422':
          description: unprocessable entity
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                contact:
                  type: object
                  properties:
                    first_name:
                      type: string
                      minLength: 1
                    last_name:
                      type: string
                      minLength: 1
                    language_code:
                      type:
                        - 'null'
                        - string
                    country_code:
                      type:
                        - 'null'
                        - string
                    status:
                      type:
                        - 'null'
                        - string
                    email:
                      type:
                        - 'null'
                        - string
                    phone:
                      type:
                        - 'null'
                        - string
                    address:
                      type:
                        - 'null'
                        - string
                    city:
                      type:
                        - 'null'
                        - string
                    state:
                      type:
                        - 'null'
                        - string
                    postal_code:
                      type:
                        - 'null'
                        - string
                    affiliate:
                      type:
                        - 'null'
                        - object
                    metadata:
                      type: object
                  required:
                    - first_name
                    - last_name
              required:
                - contact
  /api/company/contacts/{id}:
    get:
      summary: Retrieves a Contact
      tags:
        - Contacts
      operationId: getContact
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: object
            properties:
              id:
                type: integer
                not:
                  type: 'null'
            required:
              - id
      responses:
        '200':
          description: successful
        '404':
          description: not found
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: integer
                  not:
                    type: 'null'
              required:
                - id
    put:
      summary: Updates a contact
      tags:
        - Contacts
      operationId: updateContact
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: object
            properties:
              id:
                type: integer
                not:
                  type: 'null'
              contact:
                type: object
                properties:
                  first_name:
                    type: string
                    minLength: 1
                  last_name:
                    type: string
                    minLength: 1
                  language_code:
                    type:
                      - 'null'
                      - string
                  country_code:
                    type:
                      - 'null'
                      - string
                  status:
                    type:
                      - 'null'
                      - string
                  email:
                    type:
                      - 'null'
                      - string
                  phone:
                    type:
                      - 'null'
                      - string
                  address:
                    type:
                      - 'null'
                      - string
                  city:
                    type:
                      - 'null'
                      - string
                  state:
                    type:
                      - 'null'
                      - string
                  postal_code:
                    type:
                      - 'null'
                      - string
                  affiliate:
                    type:
                      - 'null'
                      - object
                  metadata:
                    type: object
                required:
                  - first_name
                  - last_name
            required:
              - id
              - contact
      responses:
        '200':
          description: successful
        '404':
          description: not found
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: integer
                  not:
                    type: 'null'
                contact:
                  type: object
                  properties:
                    first_name:
                      type: string
                      minLength: 1
                    last_name:
                      type: string
                      minLength: 1
                    language_code:
                      type:
                        - 'null'
                        - string
                    country_code:
                      type:
                        - 'null'
                        - string
                    status:
                      type:
                        - 'null'
                        - string
                    email:
                      type:
                        - 'null'
                        - string
                    phone:
                      type:
                        - 'null'
                        - string
                    address:
                      type:
                        - 'null'
                        - string
                    city:
                      type:
                        - 'null'
                        - string
                    state:
                      type:
                        - 'null'
                        - string
                    postal_code:
                      type:
                        - 'null'
                        - string
                    affiliate:
                      type:
                        - 'null'
                        - object
                    metadata:
                      type: object
                  required:
                    - first_name
                    - last_name
              required:
                - id
                - contact
    delete:
      summary: Deletes a contact
      tags:
        - Contacts
      operationId: deleteCompanyContact
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: object
            properties:
              id:
                type: integer
                not:
                  type: 'null'
            required:
              - id
      responses:
        '200':
          description: successful
        '404':
          description: not found
  /api/company/contacts/find_by_email:
    get:
      summary: Get Company User Details by email
      tags:
        - Contacts
      operationId: findContactByEmail
      security:
        - bearer_auth: []
      parameters:
        - name: email
          in: query
          required: true
          schema:
            type: string
            format: email
      responses:
        '200':
          description: successful
        '404':
          description: not found
  /api/company/contacts/{id}/append_metadata:
    patch:
      summary: Append metadata field
      tags:
        - Contacts
      operationId: contactAppendMetadataField
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Contact's Id
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  contact:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: '13423'
                      token:
                        type:
                          - string
                          - 'null'
                        example: aF1VXFfkjMi9bhCXaE8u5a3B
                      first_name:
                        type:
                          - string
                          - 'null'
                        example: John
                      last_name:
                        type:
                          - string
                          - 'null'
                        example: Nash
                      full_name:
                        type:
                          - string
                          - 'null'
                        example: ''
                      avatar_url:
                        type:
                          - string
                          - 'null'
                        example: https://example.com/images/product.png
                      status:
                        type:
                          - string
                          - 'null'
                        example: new
                      email:
                        type:
                          - string
                          - 'null'
                        example: email@example.com
                      email2:
                        type:
                          - string
                          - 'null'
                        example: email@example.com
                      phone:
                        type:
                          - string
                          - 'null'
                        example: +1-1234567890
                      phone2:
                        type:
                          - string
                          - 'null'
                        example: +1-1234567890
                      phone_id:
                        type:
                          - string
                          - 'null'
                        example: ''
                      address:
                        type:
                          - string
                          - 'null'
                        example: 123 Main St
                      address2:
                        type:
                          - string
                          - 'null'
                        example: Apt 4B
                      city:
                        type:
                          - string
                          - 'null'
                        example: New York
                      state:
                        type:
                          - string
                          - 'null'
                        example: NY
                      postal_code:
                        type:
                          - string
                          - 'null'
                        example: '10001'
                      language_id:
                        type:
                          - integer
                          - 'null'
                        example: 234
                      country_id:
                        type:
                          - integer
                          - 'null'
                        example: 96
                      lead_type:
                        type:
                          - string
                          - 'null'
                        example: Web Chat
                      ip:
                        type:
                          - string
                          - 'null'
                        example: 1.1.1.1
                      requested_at:
                        type:
                          - string
                          - 'null'
                        format: date_time
                        example: '2025-01-16T04:22:43.809Z'
                      best_time:
                        type:
                          - string
                          - 'null'
                        example: Afternoon
                      time_zone:
                        type:
                          - string
                          - 'null'
                        example: America/New_York
                      reason:
                        type:
                          - string
                          - 'null'
                        example: I enjoy working from home
                      income:
                        type:
                          - string
                          - 'null'
                        example: $2500-5000 per Month
                      hours:
                        type:
                          - string
                          - 'null'
                        example: 11-15 hours per week
                      invest:
                        type:
                          - string
                          - 'null'
                        example: $750 - $1000
                      interest:
                        type:
                          - string
                          - 'null'
                        example: Ready to get started!
                      discarded_at:
                        type:
                          - string
                          - 'null'
                        format: date_time
                        example: '2025-01-16T04:22:43.809Z'
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                        example:
                          - Contact not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                metadata:
                  type: object
                  description: >-
                    A JSON object that can store any custom data structure. When
                    provided, merges with existing metadata data.
              required:
                - metadata
  /api/company/contacts/export_csv:
    post:
      summary: Queue a csv export for all company contacts
      tags:
        - Contacts
      operationId: exportCompanyContacts
      security:
        - bearer_auth: []
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: success
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '422':
          description: unprocessable entity
  /api/company/messaging/conversations:
    get:
      tags:
        - Conversations
      summary: List User Conversations
      description: >-
        Get all conversations for the user, with optional filtering by status,
        kind, and pinned state. Supports pagination and various conversation
        templates.
      operationId: listUserConversations
      parameters:
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - open
              - closed
          description: Filter conversations by status
        - name: kind
          in: query
          required: false
          schema:
            type: string
            enum:
              - direct
              - group
          description: Filter conversations by kind
        - name: pinned
          in: query
          required: false
          schema:
            type: boolean
          description: Filter conversations by pinned state
        - name: page
          in: query
          required: false
          schema:
            type: integer
            default: 1
          description: Page number for pagination
        - name: template
          in: query
          required: false
          schema:
            type: string
            enum:
              - new_messages
              - pinned
              - team_groups
              - team_directs
              - teams
              - teams_unread
              - teams_read
              - channels
              - sms
              - sms_read
              - sms_unread
              - email
              - email_read
              - email_unread
              - channels_unread
              - channels_read
              - customers
              - customers_unread
              - customers_read
              - archived_sms
              - archived_email
              - archived_directs
              - archived_groups
              - archived_teams
              - archived_channels
              - archived_customers
              - bots
          description: Conversation template to filter by
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/index11'
                  - example:
                      team_directs:
                        - pagination:
                            current: 1
                            previous: null
                            next: null
                            per_page: 5
                            pages: 1
                            count: 1
                        - items:
                            - id: 3
                              name: Britta Padberg
                              description: null
                              kind: direct
                              type: DirectConversation
                              status: open
                              created_at: '2024-08-19T04:52:05.030Z'
                              pinned: false
                              unread_messages_count: 0
                              sms_enabled?: false
                              draft_message: null
                              email_enabled?: false
                              conversation_type: internal
                              messaging_enabled?: true
                              broadcasting: null
                              total_recipients: 2
                              unread: false
                              image_url: null
                              auto_add_recipients: true
                              muted: false
                              announcing: false
                              scheduled_messages_count: 0
                              avatar_background_color: null
                              avatar_emoji: null
                              avatar_url: null
                              recipients:
                                - id: 34
                                  first_name: Britta
                                  last_name: Padberg
                                  avatar_url: null
                                  image_url: null
                                  receivable_id: 34
                                  receivable_type: UserCompany
                                  discarded_at: null
                                  left_conversation_at: null
                                  blocked: false
                                  status: online
                                  last_online: '2024-08-19T15:02:44.873Z'
                                  country_name: null
                                - id: 1
                                  first_name: John
                                  last_name: Admin
                                  avatar_url: null
                                  image_url: null
                                  receivable_id: 1
                                  receivable_type: UserCompany
                                  discarded_at: null
                                  left_conversation_at: null
                                  blocked: false
                                  status: online
                                  last_online: '2024-08-19T15:02:44.914Z'
                                  country_name: United States
                              creator:
                                id: 1
                                first_name: John
                                last_name: Admin
                                image_url: null
                                discarded_at: null
                                blocked: false
                                blocker: false
                      team_groups:
                        - pagination:
                            current: 1
                            previous: null
                            next: null
                            per_page: 5
                            pages: 1
                            count: 1
                        - items:
                            - id: 5
                              name: Britta & 1 other
                              description: null
                              kind: group
                              type: GroupConversation
                              status: open
                              created_at: '2024-08-19T04:53:19.442Z'
                              pinned: false
                              unread_messages_count: 0
                              sms_enabled?: false
                              draft_message: null
                              email_enabled?: false
                              conversation_type: internal
                              messaging_enabled?: true
                              broadcasting: null
                              total_recipients: 3
                              unread: false
                              image_url: null
                              auto_add_recipients: true
                              muted: false
                              announcing: false
                              scheduled_messages_count: 0
                              avatar_background_color: null
                              avatar_emoji: null
                              avatar_url: null
                              recipients:
                                - id: 34
                                  first_name: Britta
                                  last_name: Padberg
                                  avatar_url: null
                                  image_url: null
                                  receivable_id: 34
                                  receivable_type: UserCompany
                                  discarded_at: null
                                  left_conversation_at: null
                                  blocked: false
                                  status: online
                                  last_online: '2024-08-19T15:02:44.873Z'
                                  country_name: null
                                - id: 56
                                  first_name: Ed
                                  last_name: Rau
                                  avatar_url: null
                                  image_url: null
                                  receivable_id: 56
                                  receivable_type: UserCompany
                                  discarded_at: null
                                  left_conversation_at: null
                                  blocked: false
                                  status: online
                                  last_online: '2024-08-19T15:02:44.903Z'
                                  country_name: null
                                - id: 1
                                  first_name: John
                                  last_name: Admin
                                  avatar_url: null
                                  image_url: null
                                  receivable_id: 1
                                  receivable_type: UserCompany
                                  discarded_at: null
                                  left_conversation_at: null
                                  blocked: false
                                  status: online
                                  last_online: '2024-08-19T15:02:44.914Z'
                                  country_name: United States
                              creator:
                                id: 34
                                first_name: Britta
                                last_name: Padberg
                                image_url: null
                                discarded_at: null
                                blocked: false
                                blocker: false
                      channels:
                        - pagination:
                            current: 1
                            previous: null
                            next: null
                            per_page: 5
                            pages: 1
                            count: 1
                        - items:
                            - id: 6
                              name: all people
                              description: null
                              kind: channel
                              type: ChannelConversation
                              status: open
                              created_at: '2024-08-19T04:59:27.361Z'
                              pinned: false
                              unread_messages_count: 0
                              sms_enabled?: false
                              draft_message: null
                              email_enabled?: false
                              conversation_type: internal
                              messaging_enabled?: true
                              broadcasting: false
                              total_recipients: 61
                              unread: false
                              image_url: null
                              auto_add_recipients: true
                              muted: true
                              announcing: false
                              scheduled_messages_count: 0
                              avatar_background_color: null
                              avatar_emoji: null
                              avatar_url: null
                              recipients:
                                - id: 1
                                  first_name: John
                                  last_name: Admin
                                  avatar_url: null
                                  image_url: null
                                  receivable_id: 1
                                  receivable_type: UserCompany
                                  discarded_at: null
                                  left_conversation_at: null
                                  blocked: false
                                  status: online
                                  last_online: '2024-08-19T15:02:44.914Z'
                                  country_name: United States
                                - id: 3
                                  first_name: Berry
                                  last_name: Schaefer
                                  avatar_url: null
                                  image_url: null
                                  receivable_id: 3
                                  receivable_type: UserCompany
                                  discarded_at: null
                                  left_conversation_at: null
                                  blocked: false
                                  status: offline
                                  last_online: null
                                  country_name: null
                                - id: 4
                                  first_name: Debbra
                                  last_name: Parker
                                  avatar_url: null
                                  image_url: null
                                  receivable_id: 4
                                  receivable_type: UserCompany
                                  discarded_at: null
                                  left_conversation_at: null
                                  blocked: false
                                  status: offline
                                  last_online: null
                                  country_name: null
                                - id: 5
                                  first_name: Marcelino
                                  last_name: Olson
                                  avatar_url: null
                                  image_url: null
                                  receivable_id: 5
                                  receivable_type: UserCompany
                                  discarded_at: null
                                  left_conversation_at: null
                                  blocked: false
                                  status: offline
                                  last_online: null
                                  country_name: null
                                - id: 6
                                  first_name: Doug
                                  last_name: Feeney
                                  avatar_url: null
                                  image_url: null
                                  receivable_id: 6
                                  receivable_type: UserCompany
                                  discarded_at: null
                                  left_conversation_at: null
                                  blocked: false
                                  status: offline
                                  last_online: null
                                  country_name: null
                                - id: 7
                                  first_name: Karlene
                                  last_name: Treutel
                                  avatar_url: null
                                  image_url: null
                                  receivable_id: 7
                                  receivable_type: UserCompany
                                  discarded_at: null
                                  left_conversation_at: null
                                  blocked: false
                                  status: offline
                                  last_online: null
                                  country_name: null
                              creator:
                                id: 1
                                first_name: John
                                last_name: Admin
                                image_url: null
                                discarded_at: null
                                blocked: false
                                blocker: false
                      customers:
                        - pagination:
                            current: 1
                            previous: null
                            next: null
                            per_page: 5
                            pages: 0
                            count: 0
                        - items: []
              example:
                team_directs:
                  - pagination:
                      current: 1
                      previous: null
                      next: null
                      per_page: 5
                      pages: 1
                      count: 1
                  - items:
                      - id: 3
                        name: Britta Padberg
                        description: null
                        kind: direct
                        type: DirectConversation
                        status: open
                        created_at: '2024-08-19T04:52:05.030Z'
                        pinned: false
                        unread_messages_count: 0
                        sms_enabled?: false
                        draft_message: null
                        email_enabled?: false
                        conversation_type: internal
                        messaging_enabled?: true
                        broadcasting: null
                        total_recipients: 2
                        unread: false
                        image_url: null
                        auto_add_recipients: true
                        muted: false
                        announcing: false
                        scheduled_messages_count: 0
                        avatar_background_color: null
                        avatar_emoji: null
                        avatar_url: null
                        recipients:
                          - id: 34
                            first_name: Britta
                            last_name: Padberg
                            avatar_url: null
                            image_url: null
                            receivable_id: 34
                            receivable_type: UserCompany
                            discarded_at: null
                            left_conversation_at: null
                            blocked: false
                            status: online
                            last_online: '2024-08-19T15:02:44.873Z'
                            country_name: null
                          - id: 1
                            first_name: John
                            last_name: Admin
                            avatar_url: null
                            image_url: null
                            receivable_id: 1
                            receivable_type: UserCompany
                            discarded_at: null
                            left_conversation_at: null
                            blocked: false
                            status: online
                            last_online: '2024-08-19T15:02:44.914Z'
                            country_name: United States
                        creator:
                          id: 1
                          first_name: John
                          last_name: Admin
                          image_url: null
                          discarded_at: null
                          blocked: false
                          blocker: false
                team_groups:
                  - pagination:
                      current: 1
                      previous: null
                      next: null
                      per_page: 5
                      pages: 1
                      count: 1
                  - items:
                      - id: 5
                        name: Britta & 1 other
                        description: null
                        kind: group
                        type: GroupConversation
                        status: open
                        created_at: '2024-08-19T04:53:19.442Z'
                        pinned: false
                        unread_messages_count: 0
                        sms_enabled?: false
                        draft_message: null
                        email_enabled?: false
                        conversation_type: internal
                        messaging_enabled?: true
                        broadcasting: null
                        total_recipients: 3
                        unread: false
                        image_url: null
                        auto_add_recipients: true
                        muted: false
                        announcing: false
                        scheduled_messages_count: 0
                        avatar_background_color: null
                        avatar_emoji: null
                        avatar_url: null
                        recipients:
                          - id: 34
                            first_name: Britta
                            last_name: Padberg
                            avatar_url: null
                            image_url: null
                            receivable_id: 34
                            receivable_type: UserCompany
                            discarded_at: null
                            left_conversation_at: null
                            blocked: false
                            status: online
                            last_online: '2024-08-19T15:02:44.873Z'
                            country_name: null
                          - id: 56
                            first_name: Ed
                            last_name: Rau
                            avatar_url: null
                            image_url: null
                            receivable_id: 56
                            receivable_type: UserCompany
                            discarded_at: null
                            left_conversation_at: null
                            blocked: false
                            status: online
                            last_online: '2024-08-19T15:02:44.903Z'
                            country_name: null
                          - id: 1
                            first_name: John
                            last_name: Admin
                            avatar_url: null
                            image_url: null
                            receivable_id: 1
                            receivable_type: UserCompany
                            discarded_at: null
                            left_conversation_at: null
                            blocked: false
                            status: online
                            last_online: '2024-08-19T15:02:44.914Z'
                            country_name: United States
                        creator:
                          id: 34
                          first_name: Britta
                          last_name: Padberg
                          image_url: null
                          discarded_at: null
                          blocked: false
                          blocker: false
                channels:
                  - pagination:
                      current: 1
                      previous: null
                      next: null
                      per_page: 5
                      pages: 1
                      count: 1
                  - items:
                      - id: 6
                        name: all people
                        description: null
                        kind: channel
                        type: ChannelConversation
                        status: open
                        created_at: '2024-08-19T04:59:27.361Z'
                        pinned: false
                        unread_messages_count: 0
                        sms_enabled?: false
                        draft_message: null
                        email_enabled?: false
                        conversation_type: internal
                        messaging_enabled?: true
                        broadcasting: false
                        total_recipients: 61
                        unread: false
                        image_url: null
                        auto_add_recipients: true
                        muted: true
                        announcing: false
                        scheduled_messages_count: 0
                        avatar_background_color: null
                        avatar_emoji: null
                        avatar_url: null
                        recipients:
                          - id: 1
                            first_name: John
                            last_name: Admin
                            avatar_url: null
                            image_url: null
                            receivable_id: 1
                            receivable_type: UserCompany
                            discarded_at: null
                            left_conversation_at: null
                            blocked: false
                            status: online
                            last_online: '2024-08-19T15:02:44.914Z'
                            country_name: United States
                          - id: 3
                            first_name: Berry
                            last_name: Schaefer
                            avatar_url: null
                            image_url: null
                            receivable_id: 3
                            receivable_type: UserCompany
                            discarded_at: null
                            left_conversation_at: null
                            blocked: false
                            status: offline
                            last_online: null
                            country_name: null
                          - id: 4
                            first_name: Debbra
                            last_name: Parker
                            avatar_url: null
                            image_url: null
                            receivable_id: 4
                            receivable_type: UserCompany
                            discarded_at: null
                            left_conversation_at: null
                            blocked: false
                            status: offline
                            last_online: null
                            country_name: null
                          - id: 5
                            first_name: Marcelino
                            last_name: Olson
                            avatar_url: null
                            image_url: null
                            receivable_id: 5
                            receivable_type: UserCompany
                            discarded_at: null
                            left_conversation_at: null
                            blocked: false
                            status: offline
                            last_online: null
                            country_name: null
                          - id: 6
                            first_name: Doug
                            last_name: Feeney
                            avatar_url: null
                            image_url: null
                            receivable_id: 6
                            receivable_type: UserCompany
                            discarded_at: null
                            left_conversation_at: null
                            blocked: false
                            status: offline
                            last_online: null
                            country_name: null
                          - id: 7
                            first_name: Karlene
                            last_name: Treutel
                            avatar_url: null
                            image_url: null
                            receivable_id: 7
                            receivable_type: UserCompany
                            discarded_at: null
                            left_conversation_at: null
                            blocked: false
                            status: offline
                            last_online: null
                            country_name: null
                        creator:
                          id: 1
                          first_name: John
                          last_name: Admin
                          image_url: null
                          discarded_at: null
                          blocked: false
                          blocker: false
                customers:
                  - pagination:
                      current: 1
                      previous: null
                      next: null
                      per_page: 5
                      pages: 0
                      count: 0
                  - items: []
      deprecated: false
  /api/company/messaging/conversations.json:
    post:
      tags:
        - Conversations
      summary: Create Messaging Conversation
      description: >-
        Create a new conversation for a user with specified recipients. The
        conversation can be of different types including direct, group, channel,
        email or SMS conversations.
      operationId: createMessagingConversation
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/CreateRequest16'
                - example:
                    conversation:
                      type: DirectConversation
                    recipients:
                      - uid: 12
                    user:
                      email: admin@fluid.app
            example:
              conversation:
                type: DirectConversation
              recipients:
                - uid: 12
              user:
                email: admin@fluid.app
        required: true
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Create10'
                  - example:
                      id: 8
                      name: Ada Stracke
                      description: null
                      kind: direct
                      type: DirectConversation
                      status: initiated
                      created_at: '2024-08-19T16:58:59.023Z'
                      pinned: false
                      unread_messages_count: 0
                      sms_enabled?: false
                      draft_message: null
                      email_enabled?: false
                      conversation_type: internal
                      messaging_enabled?: true
                      broadcasting: null
                      total_recipients: 2
                      unread: false
                      image_url: null
                      auto_add_recipients: true
                      muted: false
                      announcing: false
                      scheduled_messages_count: 0
                      avatar_background_color: null
                      avatar_emoji: null
                      avatar_url: null
                      recipients:
                        - id: 12
                          first_name: Ada
                          last_name: Stracke
                          avatar_url: null
                          image_url: null
                          receivable_id: 12
                          receivable_type: UserCompany
                          discarded_at: null
                          left_conversation_at: null
                          blocked: false
                          status: offline
                          last_online: null
                          country_name: null
                        - id: 1
                          first_name: John
                          last_name: Admin
                          avatar_url: null
                          image_url: null
                          receivable_id: 1
                          receivable_type: UserCompany
                          discarded_at: null
                          left_conversation_at: null
                          blocked: false
                          status: online
                          last_online: '2024-08-19T15:02:44.914Z'
                          country_name: United States
                      creator:
                        id: 1
                        first_name: John
                        last_name: Admin
                        image_url: null
                        discarded_at: null
                        blocked: false
                        blocker: false
              example:
                id: 8
                name: Ada Stracke
                description: null
                kind: direct
                type: DirectConversation
                status: initiated
                created_at: '2024-08-19T16:58:59.023Z'
                pinned: false
                unread_messages_count: 0
                sms_enabled?: false
                draft_message: null
                email_enabled?: false
                conversation_type: internal
                messaging_enabled?: true
                broadcasting: null
                total_recipients: 2
                unread: false
                image_url: null
                auto_add_recipients: true
                muted: false
                announcing: false
                scheduled_messages_count: 0
                avatar_background_color: null
                avatar_emoji: null
                avatar_url: null
                recipients:
                  - id: 12
                    first_name: Ada
                    last_name: Stracke
                    avatar_url: null
                    image_url: null
                    receivable_id: 12
                    receivable_type: UserCompany
                    discarded_at: null
                    left_conversation_at: null
                    blocked: false
                    status: offline
                    last_online: null
                    country_name: null
                  - id: 1
                    first_name: John
                    last_name: Admin
                    avatar_url: null
                    image_url: null
                    receivable_id: 1
                    receivable_type: UserCompany
                    discarded_at: null
                    left_conversation_at: null
                    blocked: false
                    status: online
                    last_online: '2024-08-19T15:02:44.914Z'
                    country_name: United States
                creator:
                  id: 1
                  first_name: John
                  last_name: Admin
                  image_url: null
                  discarded_at: null
                  blocked: false
                  blocker: false
      deprecated: false
  /api/company/messaging/conversations/{id}.json:
    get:
      tags:
        - Conversations
      summary: Get Conversation Details
      description: Retrieves detailed information about a specific conversation
      operationId: getConversationDetails
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
          description: Unique identifier of the conversation to retrieve
      responses:
        '200':
          description: ''
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
      deprecated: false
  /api/settings/company_countries:
    get:
      summary: List company countries
      tags:
        - Countries
      security:
        - bearer_auth: []
      operationId: listCompanyCountries
      description: List all countries configured for the company
      responses:
        '200':
          description: Company countries retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  company_countries:
                    type: array
                    items:
                      title: CompanyCountry
                      type: object
                      properties:
                        id:
                          type: integer
                        currency:
                          example: USD
                          type: string
                        base_shipping:
                          example: 0
                          type:
                            - number
                            - string
                            - 'null'
                          default: '0.0'
                        default:
                          example: false
                          type: boolean
                        pause_incomplete_enrollment:
                          example: false
                          type:
                            - boolean
                            - 'null'
                        handling_fee:
                          example: 5.99
                          type:
                            - number
                            - 'null'
                        updated_at:
                          example: '2021-01-01T00:00:00Z'
                          type: string
                          format: date-time
                        settlement_currency:
                          example: USD
                          type:
                            - string
                            - 'null'
                        entity_legally_registered:
                          example: false
                          type:
                            - boolean
                            - 'null'
                        country:
                          title: Country
                          type: object
                          properties:
                            id:
                              type: integer
                            name:
                              example: United States
                              type: string
                            iso:
                              description: 2-letter country code (ISO 3166-1 alpha-2)
                              example: US
                              type: string
                            tax_enabled:
                              example: true
                              type:
                                - boolean
                                - 'null'
                            price_inclusive_of_tax:
                              description: >-
                                Whether this country's prices are inclusive of
                                tax
                              example: true
                              type: boolean
                            price_inclusive_tax_name:
                              description: >-
                                The display name of the tax included in the
                                price (e.g., VAT, GST)
                              example: VAT
                              type:
                                - string
                                - 'null'
                            iso_name:
                              example: UNITED STATES
                              type: string
                            iso3:
                              description: 3-letter country code (ISO 3166-1 alpha-3)
                              example: USA
                              type: string
                            currency_code:
                              example: USD
                              type: string
                            currency_symbol:
                              example: $
                              type: string
                            province_required:
                              description: >-
                                Whether this country requires a province/state
                                in addresses
                              example: true
                              type: boolean
                          required:
                            - id
                            - name
                            - iso
                            - price_inclusive_of_tax
                            - iso_name
                            - iso3
                            - currency_code
                            - currency_symbol
                            - province_required
                        entity:
                          title: Company::Entity
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                            legal_name:
                              example: Acme Corporation Inc.
                              type: string
                            classification:
                              example: Corporation
                              type:
                                - string
                                - 'null'
                            trading_name:
                              example: Acme Corp
                              type:
                                - string
                                - 'null'
                            country_iso:
                              example: US
                              type:
                                - string
                                - 'null'
                            address1:
                              example: 123 Business Street
                              type:
                                - string
                                - 'null'
                            address2:
                              example: Suite 100
                              type:
                                - string
                                - 'null'
                            city:
                              example: New York
                              type:
                                - string
                                - 'null'
                            province:
                              example: NY
                              type:
                                - string
                                - 'null'
                            postal_code:
                              example: '10001'
                              type:
                                - string
                                - 'null'
                            registration_number:
                              example: '123456789'
                              type:
                                - string
                                - 'null'
                            date_of_incorporation:
                              example: '2020-01-15'
                              type:
                                - string
                                - 'null'
                            primary_mcc:
                              example: 5411
                              type:
                                - integer
                                - 'null'
                            secondary_mcc:
                              example: 5999
                              type:
                                - integer
                                - 'null'
                            phone_country_code:
                              example: '+1'
                              type:
                                - string
                                - 'null'
                            phone:
                              example: 555-123-4567
                              type:
                                - string
                                - 'null'
                            website:
                              example: https://acme.com
                              type:
                                - string
                                - 'null'
                            tax_id:
                              example: GB123456789
                              type:
                                - string
                                - 'null'
                            principal_same_as_registered_address:
                              example: false
                              type: boolean
                            primary:
                              example: false
                              type: boolean
                            status:
                              example: active
                              type: string
                            business_registration_file_url:
                              example: https://example.com/business-registration.pdf
                              type:
                                - string
                                - 'null'
                            business_registration_file_name:
                              example: business-registration.pdf
                              type:
                                - string
                                - 'null'
                            business_license_file_url:
                              example: https://example.com/business-license.pdf
                              type:
                                - string
                                - 'null'
                            business_license_file_name:
                              example: business-license.pdf
                              type:
                                - string
                                - 'null'
                            articles_of_incorporation_file_url:
                              example: >-
                                https://example.com/articles-of-incorporation.pdf
                              type:
                                - string
                                - 'null'
                            articles_of_incorporation_file_name:
                              example: articles-of-incorporation.pdf
                              type:
                                - string
                                - 'null'
                            last_3_months_processing_statements_file_url:
                              example: https://example.com/processing-statements.pdf
                              type:
                                - string
                                - 'null'
                            last_3_months_processing_statements_file_name:
                              example: processing-statements.pdf
                              type:
                                - string
                                - 'null'
                            business_identification_number:
                              example: '123456789'
                              type:
                                - string
                                - 'null'
                            w_9_file_url:
                              example: https://example.com/w-9.pdf
                              type:
                                - string
                                - 'null'
                            w_9_file_name:
                              example: w-9.pdf
                              type:
                                - string
                                - 'null'
                            business_registration_certificate_file_url:
                              example: >-
                                https://example.com/business-registration-certificate.pdf
                              type:
                                - string
                                - 'null'
                            business_registration_certificate_file_name:
                              example: business-registration-certificate.pdf
                              type:
                                - string
                                - 'null'
                            created_at:
                              example: '2025-01-15T10:30:00Z'
                              type: string
                            updated_at:
                              example: '2025-01-15T10:30:00Z'
                              type: string
                            registered_address:
                              title: Address
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                address1:
                                  example: 123 Main St
                                  type: string
                                address2:
                                  example: Apt 4B
                                  type:
                                    - string
                                    - 'null'
                                address3:
                                  example: Building 5
                                  type:
                                    - string
                                    - 'null'
                                city:
                                  example: New York
                                  type: string
                                state:
                                  example: NY
                                  type: string
                                subdivision_code:
                                  example: NY
                                  type:
                                    - string
                                    - 'null'
                                postal_code:
                                  example: '10001'
                                  type: string
                                country_code:
                                  example: US
                                  type:
                                    - string
                                    - 'null'
                              required:
                                - id
                                - address1
                                - city
                                - state
                                - postal_code
                            principal_address:
                              title: Address
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                address1:
                                  example: 123 Main St
                                  type: string
                                address2:
                                  example: Apt 4B
                                  type:
                                    - string
                                    - 'null'
                                address3:
                                  example: Building 5
                                  type:
                                    - string
                                    - 'null'
                                city:
                                  example: New York
                                  type: string
                                state:
                                  example: NY
                                  type: string
                                subdivision_code:
                                  example: NY
                                  type:
                                    - string
                                    - 'null'
                                postal_code:
                                  example: '10001'
                                  type: string
                                country_code:
                                  example: US
                                  type:
                                    - string
                                    - 'null'
                              required:
                                - id
                                - address1
                                - city
                                - state
                                - postal_code
                          required:
                            - id
                            - legal_name
                            - principal_same_as_registered_address
                            - primary
                            - status
                            - created_at
                            - updated_at
                        tax_apply:
                          example: false
                          type:
                            - boolean
                            - 'null'
                        tax_business_id:
                          example: '123456789'
                          type:
                            - string
                            - 'null'
                        tax_apply_discounted_rates:
                          example: false
                          type:
                            - boolean
                            - 'null'
                        tax_auto_send_invoice:
                          example: false
                          type:
                            - boolean
                            - 'null'
                        apply_shipping_tax:
                          example: false
                          type:
                            - boolean
                            - 'null'
                        avalara_shipping_tax_code:
                          example: FR030000
                          type:
                            - string
                            - 'null'
                        customs:
                          description: >-
                            DDP = Delivery Duty Paid, DAP = Delivered at Place
                            (customer pays VAT/customs on delivery)
                          example: DDP
                          type:
                            - string
                            - 'null'
                        use_company_default_tax_settings:
                          example: true
                          type:
                            - boolean
                            - 'null'
                        use_company_avalara_tax_settings:
                          example: false
                          type:
                            - boolean
                            - 'null'
                        use_company_manual_tax_settings:
                          example: false
                          type:
                            - boolean
                            - 'null'
                        use_company_webhook_tax_settings:
                          example: false
                          type:
                            - boolean
                            - 'null'
                        use_custom_avalara_tax_settings:
                          example: false
                          type:
                            - boolean
                            - 'null'
                        custom_avalara_user_name:
                          example: avalara_user
                          type:
                            - string
                            - 'null'
                        custom_avalara_password:
                          example: password123
                          type:
                            - string
                            - 'null'
                        use_custom_avalara_product_tax_code:
                          example: false
                          type:
                            - boolean
                            - 'null'
                        tax_option:
                          example: avalara
                          type:
                            - string
                            - 'null'
                        require_gaiyo_shomen_in_enrollment:
                          description: >-
                            Gaiyo Shomen is a company overview document required
                            for certain business transactions in Japan. When
                            enabled, this setting mandates that companies
                            provide this document during enrollment flows. Only
                            applicable for Japan country configurations.
                          example: false
                          type:
                            - boolean
                            - 'null'
                        warehouse:
                          title: Warehouse
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                            name:
                              example: Central Distribution Center
                              type: string
                            active:
                              example: true
                              type: boolean
                            external_id:
                              example: WH-12345
                              type:
                                - string
                                - 'null'
                            metadata:
                              example:
                                capacity:
                                  total_square_feet: 50000
                                operations:
                                  staff_count: 15
                                  security_level: high
                              type: object
                            country:
                              title: Country
                              type: object
                              properties:
                                id:
                                  type: integer
                                name:
                                  example: United States
                                  type: string
                                iso:
                                  description: 2-letter country code (ISO 3166-1 alpha-2)
                                  example: US
                                  type: string
                                tax_enabled:
                                  example: true
                                  type:
                                    - boolean
                                    - 'null'
                                price_inclusive_of_tax:
                                  description: >-
                                    Whether this country's prices are inclusive
                                    of tax
                                  example: true
                                  type: boolean
                                price_inclusive_tax_name:
                                  description: >-
                                    The display name of the tax included in the
                                    price (e.g., VAT, GST)
                                  example: VAT
                                  type:
                                    - string
                                    - 'null'
                                iso_name:
                                  example: UNITED STATES
                                  type: string
                                iso3:
                                  description: 3-letter country code (ISO 3166-1 alpha-3)
                                  example: USA
                                  type: string
                                currency_code:
                                  example: USD
                                  type: string
                                currency_symbol:
                                  example: $
                                  type: string
                                province_required:
                                  description: >-
                                    Whether this country requires a
                                    province/state in addresses
                                  example: true
                                  type: boolean
                                currency_details:
                                  example:
                                    currency_name: US Dollar
                                    currency_symbol: $
                                    currency_iso_code: USD
                                  type: object
                              required:
                                - id
                                - name
                                - iso
                                - price_inclusive_of_tax
                                - iso_name
                                - iso3
                                - currency_code
                                - currency_symbol
                                - province_required
                                - currency_details
                            address:
                              title: Address
                              type: object
                              properties:
                                id:
                                  type: integer
                                name:
                                  example: John Doe
                                  type: string
                                address1:
                                  example: 123 Main St
                                  type: string
                                address2:
                                  example: Apt 4B
                                  type:
                                    - string
                                    - 'null'
                                address3:
                                  example: Building 5
                                  type:
                                    - string
                                    - 'null'
                                city:
                                  example: New York
                                  type: string
                                state:
                                  example: NY
                                  type: string
                                subdivision_code:
                                  example: NY
                                  type:
                                    - string
                                    - 'null'
                                postal_code:
                                  example: '10001'
                                  type: string
                                country_code:
                                  example: US
                                  type:
                                    - string
                                    - 'null'
                                default:
                                  description: >-
                                    Use this address by default when there are
                                    multiple addresses
                                  example: true
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                first_name:
                                  example: John
                                  type: string
                                last_name:
                                  example: Doe
                                  type: string
                              required:
                                - id
                                - name
                                - address1
                                - city
                                - state
                                - postal_code
                                - first_name
                                - last_name
                          required:
                            - id
                            - name
                            - active
                            - metadata
                            - country
                            - address
                        company:
                          title: Company
                          type: object
                          properties:
                            id:
                              type: integer
                            name:
                              example: Acme, Inc.
                              type: string
                          required:
                            - id
                            - name
                      required:
                        - id
                        - currency
                        - default
                        - updated_at
                        - country
                        - company
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - company_countries
                  - meta
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
    post:
      summary: Create a company country
      tags:
        - Countries
      security:
        - bearer_auth: []
      operationId: createCompanyCountry
      description: Add a new country to the company configuration
      parameters: []
      responses:
        '200':
          description: No tax settings provided
          content:
            application/json:
              schema:
                type: object
                properties:
                  company_country:
                    title: CompanyCountry
                    type: object
                    properties:
                      id:
                        type: integer
                      currency:
                        example: USD
                        type: string
                      base_shipping:
                        example: 0
                        type:
                          - number
                          - string
                          - 'null'
                        default: '0.0'
                      default:
                        example: false
                        type: boolean
                      pause_incomplete_enrollment:
                        example: false
                        type:
                          - boolean
                          - 'null'
                      handling_fee:
                        example: 5.99
                        type:
                          - number
                          - 'null'
                      updated_at:
                        example: '2021-01-01T00:00:00Z'
                        type: string
                        format: date-time
                      settlement_currency:
                        example: USD
                        type:
                          - string
                          - 'null'
                      entity_legally_registered:
                        example: false
                        type:
                          - boolean
                          - 'null'
                      country:
                        title: Country
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: United States
                            type: string
                          iso:
                            description: 2-letter country code (ISO 3166-1 alpha-2)
                            example: US
                            type: string
                          tax_enabled:
                            example: true
                            type:
                              - boolean
                              - 'null'
                          price_inclusive_of_tax:
                            description: Whether this country's prices are inclusive of tax
                            example: true
                            type: boolean
                          price_inclusive_tax_name:
                            description: >-
                              The display name of the tax included in the price
                              (e.g., VAT, GST)
                            example: VAT
                            type:
                              - string
                              - 'null'
                          iso_name:
                            example: UNITED STATES
                            type: string
                          iso3:
                            description: 3-letter country code (ISO 3166-1 alpha-3)
                            example: USA
                            type: string
                          currency_code:
                            example: USD
                            type: string
                          currency_symbol:
                            example: $
                            type: string
                          province_required:
                            description: >-
                              Whether this country requires a province/state in
                              addresses
                            example: true
                            type: boolean
                        required:
                          - id
                          - name
                          - iso
                          - price_inclusive_of_tax
                          - iso_name
                          - iso3
                          - currency_code
                          - currency_symbol
                          - province_required
                      entity:
                        title: Company::Entity
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                          legal_name:
                            example: Acme Corporation Inc.
                            type: string
                          classification:
                            example: Corporation
                            type:
                              - string
                              - 'null'
                          trading_name:
                            example: Acme Corp
                            type:
                              - string
                              - 'null'
                          country_iso:
                            example: US
                            type:
                              - string
                              - 'null'
                          address1:
                            example: 123 Business Street
                            type:
                              - string
                              - 'null'
                          address2:
                            example: Suite 100
                            type:
                              - string
                              - 'null'
                          city:
                            example: New York
                            type:
                              - string
                              - 'null'
                          province:
                            example: NY
                            type:
                              - string
                              - 'null'
                          postal_code:
                            example: '10001'
                            type:
                              - string
                              - 'null'
                          registration_number:
                            example: '123456789'
                            type:
                              - string
                              - 'null'
                          date_of_incorporation:
                            example: '2020-01-15'
                            type:
                              - string
                              - 'null'
                          primary_mcc:
                            example: 5411
                            type:
                              - integer
                              - 'null'
                          secondary_mcc:
                            example: 5999
                            type:
                              - integer
                              - 'null'
                          phone_country_code:
                            example: '+1'
                            type:
                              - string
                              - 'null'
                          phone:
                            example: 555-123-4567
                            type:
                              - string
                              - 'null'
                          website:
                            example: https://acme.com
                            type:
                              - string
                              - 'null'
                          tax_id:
                            example: GB123456789
                            type:
                              - string
                              - 'null'
                          principal_same_as_registered_address:
                            example: false
                            type: boolean
                          primary:
                            example: false
                            type: boolean
                          status:
                            example: active
                            type: string
                          business_registration_file_url:
                            example: https://example.com/business-registration.pdf
                            type:
                              - string
                              - 'null'
                          business_registration_file_name:
                            example: business-registration.pdf
                            type:
                              - string
                              - 'null'
                          business_license_file_url:
                            example: https://example.com/business-license.pdf
                            type:
                              - string
                              - 'null'
                          business_license_file_name:
                            example: business-license.pdf
                            type:
                              - string
                              - 'null'
                          articles_of_incorporation_file_url:
                            example: https://example.com/articles-of-incorporation.pdf
                            type:
                              - string
                              - 'null'
                          articles_of_incorporation_file_name:
                            example: articles-of-incorporation.pdf
                            type:
                              - string
                              - 'null'
                          last_3_months_processing_statements_file_url:
                            example: https://example.com/processing-statements.pdf
                            type:
                              - string
                              - 'null'
                          last_3_months_processing_statements_file_name:
                            example: processing-statements.pdf
                            type:
                              - string
                              - 'null'
                          business_identification_number:
                            example: '123456789'
                            type:
                              - string
                              - 'null'
                          w_9_file_url:
                            example: https://example.com/w-9.pdf
                            type:
                              - string
                              - 'null'
                          w_9_file_name:
                            example: w-9.pdf
                            type:
                              - string
                              - 'null'
                          business_registration_certificate_file_url:
                            example: >-
                              https://example.com/business-registration-certificate.pdf
                            type:
                              - string
                              - 'null'
                          business_registration_certificate_file_name:
                            example: business-registration-certificate.pdf
                            type:
                              - string
                              - 'null'
                          created_at:
                            example: '2025-01-15T10:30:00Z'
                            type: string
                          updated_at:
                            example: '2025-01-15T10:30:00Z'
                            type: string
                          registered_address:
                            title: Address
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                              address1:
                                example: 123 Main St
                                type: string
                              address2:
                                example: Apt 4B
                                type:
                                  - string
                                  - 'null'
                              address3:
                                example: Building 5
                                type:
                                  - string
                                  - 'null'
                              city:
                                example: New York
                                type: string
                              state:
                                example: NY
                                type: string
                              subdivision_code:
                                example: NY
                                type:
                                  - string
                                  - 'null'
                              postal_code:
                                example: '10001'
                                type: string
                              country_code:
                                example: US
                                type:
                                  - string
                                  - 'null'
                            required:
                              - id
                              - address1
                              - city
                              - state
                              - postal_code
                          principal_address:
                            title: Address
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                              address1:
                                example: 123 Main St
                                type: string
                              address2:
                                example: Apt 4B
                                type:
                                  - string
                                  - 'null'
                              address3:
                                example: Building 5
                                type:
                                  - string
                                  - 'null'
                              city:
                                example: New York
                                type: string
                              state:
                                example: NY
                                type: string
                              subdivision_code:
                                example: NY
                                type:
                                  - string
                                  - 'null'
                              postal_code:
                                example: '10001'
                                type: string
                              country_code:
                                example: US
                                type:
                                  - string
                                  - 'null'
                            required:
                              - id
                              - address1
                              - city
                              - state
                              - postal_code
                        required:
                          - id
                          - legal_name
                          - principal_same_as_registered_address
                          - primary
                          - status
                          - created_at
                          - updated_at
                      tax_apply:
                        example: false
                        type:
                          - boolean
                          - 'null'
                      tax_business_id:
                        example: '123456789'
                        type:
                          - string
                          - 'null'
                      tax_apply_discounted_rates:
                        example: false
                        type:
                          - boolean
                          - 'null'
                      tax_auto_send_invoice:
                        example: false
                        type:
                          - boolean
                          - 'null'
                      apply_shipping_tax:
                        example: false
                        type:
                          - boolean
                          - 'null'
                      avalara_shipping_tax_code:
                        example: FR030000
                        type:
                          - string
                          - 'null'
                      customs:
                        description: >-
                          DDP = Delivery Duty Paid, DAP = Delivered at Place
                          (customer pays VAT/customs on delivery)
                        example: DDP
                        type:
                          - string
                          - 'null'
                      use_company_default_tax_settings:
                        example: true
                        type:
                          - boolean
                          - 'null'
                      use_company_avalara_tax_settings:
                        example: false
                        type:
                          - boolean
                          - 'null'
                      use_company_manual_tax_settings:
                        example: false
                        type:
                          - boolean
                          - 'null'
                      use_company_webhook_tax_settings:
                        example: false
                        type:
                          - boolean
                          - 'null'
                      use_custom_avalara_tax_settings:
                        example: false
                        type:
                          - boolean
                          - 'null'
                      custom_avalara_user_name:
                        example: avalara_user
                        type:
                          - string
                          - 'null'
                      custom_avalara_password:
                        example: password123
                        type:
                          - string
                          - 'null'
                      use_custom_avalara_product_tax_code:
                        example: false
                        type:
                          - boolean
                          - 'null'
                      tax_option:
                        example: avalara
                        type:
                          - string
                          - 'null'
                      require_gaiyo_shomen_in_enrollment:
                        description: >-
                          Gaiyo Shomen is a company overview document required
                          for certain business transactions in Japan. When
                          enabled, this setting mandates that companies provide
                          this document during enrollment flows. Only applicable
                          for Japan country configurations.
                        example: false
                        type:
                          - boolean
                          - 'null'
                      warehouse:
                        title: Warehouse
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                          name:
                            example: Central Distribution Center
                            type: string
                          active:
                            example: true
                            type: boolean
                          external_id:
                            example: WH-12345
                            type:
                              - string
                              - 'null'
                          metadata:
                            example:
                              capacity:
                                total_square_feet: 50000
                              operations:
                                staff_count: 15
                                security_level: high
                            type: object
                          country:
                            title: Country
                            type: object
                            properties:
                              id:
                                type: integer
                              name:
                                example: United States
                                type: string
                              iso:
                                description: 2-letter country code (ISO 3166-1 alpha-2)
                                example: US
                                type: string
                              tax_enabled:
                                example: true
                                type:
                                  - boolean
                                  - 'null'
                              price_inclusive_of_tax:
                                description: >-
                                  Whether this country's prices are inclusive of
                                  tax
                                example: true
                                type: boolean
                              price_inclusive_tax_name:
                                description: >-
                                  The display name of the tax included in the
                                  price (e.g., VAT, GST)
                                example: VAT
                                type:
                                  - string
                                  - 'null'
                              iso_name:
                                example: UNITED STATES
                                type: string
                              iso3:
                                description: 3-letter country code (ISO 3166-1 alpha-3)
                                example: USA
                                type: string
                              currency_code:
                                example: USD
                                type: string
                              currency_symbol:
                                example: $
                                type: string
                              province_required:
                                description: >-
                                  Whether this country requires a province/state
                                  in addresses
                                example: true
                                type: boolean
                              currency_details:
                                example:
                                  currency_name: US Dollar
                                  currency_symbol: $
                                  currency_iso_code: USD
                                type: object
                            required:
                              - id
                              - name
                              - iso
                              - price_inclusive_of_tax
                              - iso_name
                              - iso3
                              - currency_code
                              - currency_symbol
                              - province_required
                              - currency_details
                          address:
                            title: Address
                            type: object
                            properties:
                              id:
                                type: integer
                              name:
                                example: John Doe
                                type: string
                              address1:
                                example: 123 Main St
                                type: string
                              address2:
                                example: Apt 4B
                                type:
                                  - string
                                  - 'null'
                              address3:
                                example: Building 5
                                type:
                                  - string
                                  - 'null'
                              city:
                                example: New York
                                type: string
                              state:
                                example: NY
                                type: string
                              subdivision_code:
                                example: NY
                                type:
                                  - string
                                  - 'null'
                              postal_code:
                                example: '10001'
                                type: string
                              country_code:
                                example: US
                                type:
                                  - string
                                  - 'null'
                              default:
                                description: >-
                                  Use this address by default when there are
                                  multiple addresses
                                example: true
                                type:
                                  - boolean
                                  - 'null'
                                default: false
                              first_name:
                                example: John
                                type: string
                              last_name:
                                example: Doe
                                type: string
                            required:
                              - id
                              - name
                              - address1
                              - city
                              - state
                              - postal_code
                              - first_name
                              - last_name
                        required:
                          - id
                          - name
                          - active
                          - metadata
                          - country
                          - address
                      company:
                        title: Company
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: Acme, Inc.
                            type: string
                        required:
                          - id
                          - name
                    required:
                      - id
                      - currency
                      - default
                      - updated_at
                      - country
                      - company
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - company_country
                  - meta
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '422':
          description: Invalid parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                company_country:
                  type: object
                  properties:
                    country_id:
                      type: integer
                    currency:
                      type: string
                    warehouse_id:
                      type: integer
                    handling_fee:
                      type: number
                    default:
                      type: boolean
                    tax_business_id:
                      type: string
                    use_company_default_tax_settings:
                      type: boolean
                    use_company_avalara_tax_settings:
                      type: boolean
                    use_custom_avalara_tax_settings:
                      type: boolean
                    use_company_webhook_tax_settings:
                      type: boolean
                    use_company_manual_tax_settings:
                      type: boolean
                    custom_avalara_user_name:
                      type: string
                    custom_avalara_password:
                      type: string
                    use_custom_avalara_product_tax_code:
                      type: boolean
                    tax_option:
                      type: string
                    require_gaiyo_shomen_in_enrollment:
                      type: boolean
                    settlement_currency:
                      type: string
                    entity_id:
                      type: integer
                    entity_legally_registered:
                      type: boolean
                  required:
                    - country_id
              required:
                - company_country
  /api/settings/company_countries/{id}:
    put:
      summary: Update a company country
      tags:
        - Countries
      security:
        - bearer_auth: []
      operationId: updateCompanyCountry
      description: Update an existing country configuration for the company
      parameters: []
      responses:
        '200':
          description: Company country updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  company_country:
                    title: CompanyCountry
                    type: object
                    properties:
                      id:
                        type: integer
                      currency:
                        example: USD
                        type: string
                      base_shipping:
                        example: 0
                        type:
                          - number
                          - string
                          - 'null'
                        default: '0.0'
                      default:
                        example: false
                        type: boolean
                      pause_incomplete_enrollment:
                        example: false
                        type:
                          - boolean
                          - 'null'
                      handling_fee:
                        example: 5.99
                        type:
                          - number
                          - 'null'
                      updated_at:
                        example: '2021-01-01T00:00:00Z'
                        type: string
                        format: date-time
                      settlement_currency:
                        example: USD
                        type:
                          - string
                          - 'null'
                      entity_legally_registered:
                        example: false
                        type:
                          - boolean
                          - 'null'
                      country:
                        title: Country
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: United States
                            type: string
                          iso:
                            description: 2-letter country code (ISO 3166-1 alpha-2)
                            example: US
                            type: string
                          tax_enabled:
                            example: true
                            type:
                              - boolean
                              - 'null'
                          price_inclusive_of_tax:
                            description: Whether this country's prices are inclusive of tax
                            example: true
                            type: boolean
                          price_inclusive_tax_name:
                            description: >-
                              The display name of the tax included in the price
                              (e.g., VAT, GST)
                            example: VAT
                            type:
                              - string
                              - 'null'
                          iso_name:
                            example: UNITED STATES
                            type: string
                          iso3:
                            description: 3-letter country code (ISO 3166-1 alpha-3)
                            example: USA
                            type: string
                          currency_code:
                            example: USD
                            type: string
                          currency_symbol:
                            example: $
                            type: string
                          province_required:
                            description: >-
                              Whether this country requires a province/state in
                              addresses
                            example: true
                            type: boolean
                        required:
                          - id
                          - name
                          - iso
                          - price_inclusive_of_tax
                          - iso_name
                          - iso3
                          - currency_code
                          - currency_symbol
                          - province_required
                      entity:
                        title: Company::Entity
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                          legal_name:
                            example: Acme Corporation Inc.
                            type: string
                          classification:
                            example: Corporation
                            type:
                              - string
                              - 'null'
                          trading_name:
                            example: Acme Corp
                            type:
                              - string
                              - 'null'
                          country_iso:
                            example: US
                            type:
                              - string
                              - 'null'
                          address1:
                            example: 123 Business Street
                            type:
                              - string
                              - 'null'
                          address2:
                            example: Suite 100
                            type:
                              - string
                              - 'null'
                          city:
                            example: New York
                            type:
                              - string
                              - 'null'
                          province:
                            example: NY
                            type:
                              - string
                              - 'null'
                          postal_code:
                            example: '10001'
                            type:
                              - string
                              - 'null'
                          registration_number:
                            example: '123456789'
                            type:
                              - string
                              - 'null'
                          date_of_incorporation:
                            example: '2020-01-15'
                            type:
                              - string
                              - 'null'
                          primary_mcc:
                            example: 5411
                            type:
                              - integer
                              - 'null'
                          secondary_mcc:
                            example: 5999
                            type:
                              - integer
                              - 'null'
                          phone_country_code:
                            example: '+1'
                            type:
                              - string
                              - 'null'
                          phone:
                            example: 555-123-4567
                            type:
                              - string
                              - 'null'
                          website:
                            example: https://acme.com
                            type:
                              - string
                              - 'null'
                          tax_id:
                            example: GB123456789
                            type:
                              - string
                              - 'null'
                          principal_same_as_registered_address:
                            example: false
                            type: boolean
                          primary:
                            example: false
                            type: boolean
                          status:
                            example: active
                            type: string
                          business_registration_file_url:
                            example: https://example.com/business-registration.pdf
                            type:
                              - string
                              - 'null'
                          business_registration_file_name:
                            example: business-registration.pdf
                            type:
                              - string
                              - 'null'
                          business_license_file_url:
                            example: https://example.com/business-license.pdf
                            type:
                              - string
                              - 'null'
                          business_license_file_name:
                            example: business-license.pdf
                            type:
                              - string
                              - 'null'
                          articles_of_incorporation_file_url:
                            example: https://example.com/articles-of-incorporation.pdf
                            type:
                              - string
                              - 'null'
                          articles_of_incorporation_file_name:
                            example: articles-of-incorporation.pdf
                            type:
                              - string
                              - 'null'
                          last_3_months_processing_statements_file_url:
                            example: https://example.com/processing-statements.pdf
                            type:
                              - string
                              - 'null'
                          last_3_months_processing_statements_file_name:
                            example: processing-statements.pdf
                            type:
                              - string
                              - 'null'
                          business_identification_number:
                            example: '123456789'
                            type:
                              - string
                              - 'null'
                          w_9_file_url:
                            example: https://example.com/w-9.pdf
                            type:
                              - string
                              - 'null'
                          w_9_file_name:
                            example: w-9.pdf
                            type:
                              - string
                              - 'null'
                          business_registration_certificate_file_url:
                            example: >-
                              https://example.com/business-registration-certificate.pdf
                            type:
                              - string
                              - 'null'
                          business_registration_certificate_file_name:
                            example: business-registration-certificate.pdf
                            type:
                              - string
                              - 'null'
                          created_at:
                            example: '2025-01-15T10:30:00Z'
                            type: string
                          updated_at:
                            example: '2025-01-15T10:30:00Z'
                            type: string
                          registered_address:
                            title: Address
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                              address1:
                                example: 123 Main St
                                type: string
                              address2:
                                example: Apt 4B
                                type:
                                  - string
                                  - 'null'
                              address3:
                                example: Building 5
                                type:
                                  - string
                                  - 'null'
                              city:
                                example: New York
                                type: string
                              state:
                                example: NY
                                type: string
                              subdivision_code:
                                example: NY
                                type:
                                  - string
                                  - 'null'
                              postal_code:
                                example: '10001'
                                type: string
                              country_code:
                                example: US
                                type:
                                  - string
                                  - 'null'
                            required:
                              - id
                              - address1
                              - city
                              - state
                              - postal_code
                          principal_address:
                            title: Address
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                              address1:
                                example: 123 Main St
                                type: string
                              address2:
                                example: Apt 4B
                                type:
                                  - string
                                  - 'null'
                              address3:
                                example: Building 5
                                type:
                                  - string
                                  - 'null'
                              city:
                                example: New York
                                type: string
                              state:
                                example: NY
                                type: string
                              subdivision_code:
                                example: NY
                                type:
                                  - string
                                  - 'null'
                              postal_code:
                                example: '10001'
                                type: string
                              country_code:
                                example: US
                                type:
                                  - string
                                  - 'null'
                            required:
                              - id
                              - address1
                              - city
                              - state
                              - postal_code
                        required:
                          - id
                          - legal_name
                          - principal_same_as_registered_address
                          - primary
                          - status
                          - created_at
                          - updated_at
                      tax_apply:
                        example: false
                        type:
                          - boolean
                          - 'null'
                      tax_business_id:
                        example: '123456789'
                        type:
                          - string
                          - 'null'
                      tax_apply_discounted_rates:
                        example: false
                        type:
                          - boolean
                          - 'null'
                      tax_auto_send_invoice:
                        example: false
                        type:
                          - boolean
                          - 'null'
                      apply_shipping_tax:
                        example: false
                        type:
                          - boolean
                          - 'null'
                      avalara_shipping_tax_code:
                        example: FR030000
                        type:
                          - string
                          - 'null'
                      customs:
                        description: >-
                          DDP = Delivery Duty Paid, DAP = Delivered at Place
                          (customer pays VAT/customs on delivery)
                        example: DDP
                        type:
                          - string
                          - 'null'
                      use_company_default_tax_settings:
                        example: true
                        type:
                          - boolean
                          - 'null'
                      use_company_avalara_tax_settings:
                        example: false
                        type:
                          - boolean
                          - 'null'
                      use_company_manual_tax_settings:
                        example: false
                        type:
                          - boolean
                          - 'null'
                      use_company_webhook_tax_settings:
                        example: false
                        type:
                          - boolean
                          - 'null'
                      use_custom_avalara_tax_settings:
                        example: false
                        type:
                          - boolean
                          - 'null'
                      custom_avalara_user_name:
                        example: avalara_user
                        type:
                          - string
                          - 'null'
                      custom_avalara_password:
                        example: password123
                        type:
                          - string
                          - 'null'
                      use_custom_avalara_product_tax_code:
                        example: false
                        type:
                          - boolean
                          - 'null'
                      tax_option:
                        example: avalara
                        type:
                          - string
                          - 'null'
                      require_gaiyo_shomen_in_enrollment:
                        description: >-
                          Gaiyo Shomen is a company overview document required
                          for certain business transactions in Japan. When
                          enabled, this setting mandates that companies provide
                          this document during enrollment flows. Only applicable
                          for Japan country configurations.
                        example: false
                        type:
                          - boolean
                          - 'null'
                      warehouse:
                        title: Warehouse
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                          name:
                            example: Central Distribution Center
                            type: string
                          active:
                            example: true
                            type: boolean
                          external_id:
                            example: WH-12345
                            type:
                              - string
                              - 'null'
                          metadata:
                            example:
                              capacity:
                                total_square_feet: 50000
                              operations:
                                staff_count: 15
                                security_level: high
                            type: object
                          country:
                            title: Country
                            type: object
                            properties:
                              id:
                                type: integer
                              name:
                                example: United States
                                type: string
                              iso:
                                description: 2-letter country code (ISO 3166-1 alpha-2)
                                example: US
                                type: string
                              tax_enabled:
                                example: true
                                type:
                                  - boolean
                                  - 'null'
                              price_inclusive_of_tax:
                                description: >-
                                  Whether this country's prices are inclusive of
                                  tax
                                example: true
                                type: boolean
                              price_inclusive_tax_name:
                                description: >-
                                  The display name of the tax included in the
                                  price (e.g., VAT, GST)
                                example: VAT
                                type:
                                  - string
                                  - 'null'
                              iso_name:
                                example: UNITED STATES
                                type: string
                              iso3:
                                description: 3-letter country code (ISO 3166-1 alpha-3)
                                example: USA
                                type: string
                              currency_code:
                                example: USD
                                type: string
                              currency_symbol:
                                example: $
                                type: string
                              province_required:
                                description: >-
                                  Whether this country requires a province/state
                                  in addresses
                                example: true
                                type: boolean
                              currency_details:
                                example:
                                  currency_name: US Dollar
                                  currency_symbol: $
                                  currency_iso_code: USD
                                type: object
                            required:
                              - id
                              - name
                              - iso
                              - price_inclusive_of_tax
                              - iso_name
                              - iso3
                              - currency_code
                              - currency_symbol
                              - province_required
                              - currency_details
                          address:
                            title: Address
                            type: object
                            properties:
                              id:
                                type: integer
                              name:
                                example: John Doe
                                type: string
                              address1:
                                example: 123 Main St
                                type: string
                              address2:
                                example: Apt 4B
                                type:
                                  - string
                                  - 'null'
                              address3:
                                example: Building 5
                                type:
                                  - string
                                  - 'null'
                              city:
                                example: New York
                                type: string
                              state:
                                example: NY
                                type: string
                              subdivision_code:
                                example: NY
                                type:
                                  - string
                                  - 'null'
                              postal_code:
                                example: '10001'
                                type: string
                              country_code:
                                example: US
                                type:
                                  - string
                                  - 'null'
                              default:
                                description: >-
                                  Use this address by default when there are
                                  multiple addresses
                                example: true
                                type:
                                  - boolean
                                  - 'null'
                                default: false
                              first_name:
                                example: John
                                type: string
                              last_name:
                                example: Doe
                                type: string
                            required:
                              - id
                              - name
                              - address1
                              - city
                              - state
                              - postal_code
                              - first_name
                              - last_name
                        required:
                          - id
                          - name
                          - active
                          - metadata
                          - country
                          - address
                      company:
                        title: Company
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: Acme, Inc.
                            type: string
                        required:
                          - id
                          - name
                    required:
                      - id
                      - currency
                      - default
                      - updated_at
                      - country
                      - company
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - company_country
                  - meta
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '404':
          description: Company country not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: Invalid parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: integer
                company_country:
                  type: object
                  properties:
                    currency:
                      type: string
                    warehouse_id:
                      type: integer
                    handling_fee:
                      type: number
                    default:
                      type: boolean
                    tax_business_id:
                      type: string
                    use_company_default_tax_settings:
                      type: boolean
                    use_company_avalara_tax_settings:
                      type: boolean
                    use_custom_avalara_tax_settings:
                      type: boolean
                    use_company_webhook_tax_settings:
                      type: boolean
                    use_company_manual_tax_settings:
                      type: boolean
                    custom_avalara_user_name:
                      type: string
                    custom_avalara_password:
                      type: string
                    use_custom_avalara_product_tax_code:
                      type: boolean
                    tax_option:
                      type: string
                    require_gaiyo_shomen_in_enrollment:
                      type: boolean
                    settlement_currency:
                      type: string
                    entity_id:
                      type: integer
                    entity_legally_registered:
                      type: boolean
                  required: []
              required:
                - id
                - company_country
    delete:
      summary: Delete a company country
      tags:
        - Countries
      security:
        - bearer_auth: []
      operationId: deleteCompanyCountry
      description: Remove a country from the company configuration
      responses:
        '200':
          description: Company country deleted successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Company country deleted successfully
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - success
                  - meta
                  - message
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '404':
          description: Company country not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: Unprocessable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
    parameters:
      - name: id
        in: path
        required: true
        description: Company country ID
        schema:
          type: integer
  /api/settings/company_countries/tax_options:
    get:
      summary: Get valid tax options for the company country
      tags:
        - Countries
      security:
        - bearer_auth: []
      operationId: getCompanyCountryTaxOptions
      description: Get valid tax options for the company country
      responses:
        '200':
          description: Company country tax options retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  tax_options:
                    type: array
                    items:
                      type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - tax_options
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '404':
          description: Company country not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - error_message
    parameters:
      - name: country_id
        in: query
        required: true
        description: Company country ID
        schema:
          type: integer
  /api/currencies:
    get:
      summary: List supported currencies
      tags:
        - Currencies
      description: List all supported currencies in the system
      operationId: listCurrencies
      security:
        - bearer_auth: []
      responses:
        '200':
          description: Currencies retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  currencies:
                    type: array
                    items:
                      title: Currency
                      type: object
                      properties:
                        name:
                          example: United States Dollar
                          type:
                            - string
                            - 'null'
                        code:
                          example: USD
                          type: string
                        symbol:
                          example: $
                          type:
                            - string
                            - 'null'
                      required:
                        - code
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - currencies
                  - meta
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
  /api/company/custom_pages:
    get:
      tags:
        - Custom Pages
      summary: List Company Custom Pages
      description: Retrieves a list of custom pages for a company.
      operationId: listCompanyCustomPages
      parameters: []
      responses:
        '200':
          description: ''
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
      deprecated: false
      security:
        - bearer: []
    post:
      tags:
        - Custom Pages
      summary: Create Company Custom Page
      description: >-
        Creates a new custom page for a company with specified content, settings
        and attributes.
      operationId: createCompanyCustomPage
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/createrequest11'
                - example:
                    lang: en
                    custom_page:
                      title: El Condor Pasa
                      html_code: <p>Es un detalles</p>
                      image_url: >-
                        https://wallup.net/wp-content/uploads/2019/09/841798-lamborghini-aventador-super-veloce-cars-supercars-red.jpg
                      active: true
                      use_fluid_menu: true
                      default: true
                      use_for_shop: true
                      use_search_engine: false
                      available_countries:
                        - us
                        - in
                        - fin
            example:
              lang: en
              custom_page:
                title: El Condor Pasa
                html_code: <p>Es un detalles</p>
                image_url: >-
                  https://wallup.net/wp-content/uploads/2019/09/841798-lamborghini-aventador-super-veloce-cars-supercars-red.jpg
                active: true
                use_fluid_menu: true
                default: true
                use_for_shop: true
                use_search_engine: false
                available_countries:
                  - us
                  - in
                  - fin
        required: true
      responses:
        '200':
          description: ''
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
      deprecated: false
      security:
        - bearer: []
  /api/company/custom_pages/{pageId}:
    get:
      tags:
        - Custom Pages
      summary: Get Custom Page Details
      description: Retrieves the details of a specific custom page.
      operationId: getCustomPage
      parameters:
        - name: pageId
          in: path
          required: true
          schema:
            type: integer
          description: The unique identifier of the custom page to retrieve
      responses:
        '200':
          description: ''
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
      deprecated: false
      security:
        - bearer: []
    put:
      tags:
        - Custom Pages
      summary: Update Company Custom Page
      description: >-
        Updates an existing custom page for a company with specified content and
        configuration settings.
      operationId: updateCompanyCustomPage
      parameters:
        - name: pageId
          in: path
          required: true
          schema:
            type: integer
          description: The ID of the custom page to update
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/updaterequest10'
                - example:
                    lang: es
                    custom_page:
                      title: El Pais
                      html_code: <p>Hola, Espanol, que tal?</p>
                      active: true
                      use_fluid_menu: true
                      default: true
                      use_for_shop: true
                      use_search_engine: false
                      available_countries:
                        - ind
                      label_id: 16
            example:
              lang: es
              custom_page:
                title: El Pais
                html_code: <p>Hola, Espanol, que tal?</p>
                active: true
                use_fluid_menu: true
                default: true
                use_for_shop: true
                use_search_engine: false
                available_countries:
                  - ind
                label_id: 16
        required: true
      responses:
        '200':
          description: ''
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
      deprecated: false
      security:
        - bearer: []
    delete:
      tags:
        - Custom Pages
      summary: Delete Company Custom Page
      description: Deletes a specific custom page associated with the company.
      operationId: deleteCompanyCustomPage
      parameters:
        - name: pageId
          in: path
          required: true
          schema:
            type: integer
          description: The unique identifier of the custom page to delete
      responses:
        '200':
          description: ''
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
      deprecated: false
      security:
        - bearer: []
  /api/company/custom_pages/{page_id}/send_to_top:
    get:
      tags:
        - Custom Pages
      summary: Move Custom Page to Top
      description: >-
        Moves a specified custom page to the top position in the company's page
        listing.
      operationId: sendCustomPageToTop
      parameters:
        - name: page_id
          in: path
          required: true
          schema:
            type: integer
          description: The ID of the custom page to move to the top
      responses:
        '200':
          description: ''
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
      deprecated: false
      security:
        - bearer: []
  /api/company/custom_pages/{pageId}/duplicate:
    get:
      tags:
        - Custom Pages
      summary: Duplicate Custom Page
      description: Creates a copy of the specified custom page.
      operationId: duplicateCustomPage
      parameters:
        - name: pageId
          in: path
          required: true
          schema:
            type: integer
          description: ID of the custom page to duplicate
      responses:
        '200':
          description: ''
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
      deprecated: false
      security:
        - bearer: []
  /api/customer_notes:
    get:
      summary: List customer notes
      tags:
        - Customer Notes
      security:
        - bearer_auth: []
      operationId: listCustomerNotes
      parameters:
        - name: customer_id
          in: query
          required: true
          description: Id of customer associated with the customer notes
          schema:
            type: integer
        - name: resource_type
          in: query
          required: false
          description: >-
            Type of Resource the customer note is attached to, for example
            `Product`, `Order`, etc. `SubscriptionOrder`
          schema:
            type: string
        - name: resource_id
          in: query
          required: false
          description: >-
            Id of Resource specified in the `resource_type` field. This can
            however be empty, even when the `resource_type` is specified.
          schema:
            type: integer
        - name: page
          in: query
          schema:
            type: integer
            default: 1
          required: false
          description: Page number for pagination
        - name: per_page
          in: query
          schema:
            type: integer
            default: 10
          required: false
          description: Number of records per page
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: success
                  data:
                    type: object
                    properties:
                      customer_notes:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              description: Id of the customer note
                            user_company_id:
                              type:
                                - integer
                                - 'null'
                              description: Id of UserCompany who created the customer note
                            username:
                              type:
                                - string
                                - 'null'
                              description: >-
                                Username of the User who created the customer
                                note
                            customer_id:
                              type: integer
                              description: Id of Customer associated with the customer note
                            note:
                              type: string
                              description: Note of the customer note
                            resource_type:
                              type:
                                - string
                                - 'null'
                              description: Type of Resource attached with the customer note
                            resource_id:
                              type:
                                - integer
                                - 'null'
                              description: >-
                                Id of Resource specified in the `resource_type`
                                field
                            created_at:
                              type: string
                              description: Time the customer note was created
        '404':
          description: customer not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: fail
                  data:
                    type: object
                    properties:
                      error:
                        type: string
                        example: Couldn't find Customer
    post:
      summary: Create a customer note
      tags:
        - Customer Notes
      security:
        - bearer_auth: []
      operationId: createCustomerNote
      parameters: []
      responses:
        '201':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: success
                  data:
                    type: object
                    properties:
                      customer_note:
                        type: object
                        properties:
                          id:
                            type: integer
                            description: Id of the customer note
                          user_company_id:
                            type:
                              - integer
                              - 'null'
                            description: Id of UserCompany who created the customer note
                          username:
                            type:
                              - string
                              - 'null'
                            description: Username of the User who created the customer note
                          customer_id:
                            type: integer
                            description: Id of Customer associated with the customer note
                          note:
                            type: string
                            description: Note of the customer note
                          resource_type:
                            type:
                              - string
                              - 'null'
                            description: Type of Resource attached with the customer note
                          resource_id:
                            type:
                              - integer
                              - 'null'
                            description: >-
                              Id of Resource specified in the `resource_type`
                              field
                          created_at:
                            type: string
                            description: Time the customer note was created
        '404':
          description: customer not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: fail
                  data:
                    type: object
                    properties:
                      error:
                        type: string
                        example: Couldn't find Customer
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: fail
                  data:
                    type: object
                    properties:
                      customer_note:
                        type: object
                        example:
                          note:
                            - can't be blank
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                user_company_id:
                  type: integer
                  description: UserCompany Id of the creator of the customer note.
                  example: 12
                customer_id:
                  type: integer
                  description: Customer Id for the customer note.
                  example: 1337
                note:
                  type: string
                  description: Note for the customer note.
                  example: >-
                    The customer has requested the delivery to happen before
                    Christmas
                resource_type:
                  type: string
                  example: SubscriptionOrder
                  description: Type of Resource to associate with the customer note.
                resource_id:
                  type: integer
                  example: 2345
                  description: Id of Resource to associate with the customer note.
              required:
                - customer_id
                - note
  /api/customer_orders:
    get:
      summary: List of customer orders
      tags:
        - Customer Orders
      description: >-
        List Customers Orders for a Rep, including orders with no buyer, given
        the Rep token as Authorization header.
      operationId: indexCustomerOrders
      security:
        - bearer_auth: []
      parameters:
        - name: pagination
          in: query
          schema:
            type: object
            properties:
              page:
                type: integer
                exclusiveMinimum: 0
              per_page:
                type: integer
                exclusiveMinimum: 0
                maximum: 100
            required: []
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  orders:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        order_number:
                          type: string
                          example: F1248177316463
                        currency_code:
                          type: string
                          example: USD
                        currency_symbol:
                          type: string
                          example: $
                        created_at:
                          type: string
                          example: '2023-07-24T10:00:00.000Z'
                        customer:
                          anyOf:
                            - type: 'null'
                            - type: object
                              properties:
                                id:
                                  type: integer
                                account_id:
                                  type: string
                                first_name:
                                  type: string
                                last_name:
                                  type: string
                                full_name:
                                  type: string
                                email:
                                  type: string
                                verified_email:
                                  type: boolean
                                phone:
                                  type: string
                                orders_count:
                                  type: integer
                                total_spent:
                                  type:
                                    - number
                                    - string
                                display_total_spent:
                                  type: string
                                last_order_id:
                                  type:
                                    - integer
                                    - 'null'
                                notes:
                                  type:
                                    - string
                                    - 'null'
                                user_company_id:
                                  type:
                                    - integer
                                    - 'null'
                                created_at:
                                  type: string
                                active:
                                  type: boolean
                                is_rep:
                                  type: boolean
                                is_discarded:
                                  type: boolean
                                external_id:
                                  type:
                                    - string
                                    - 'null'
                                role:
                                  type: string
                                  example: customer
                                  enum:
                                    - customer
                                    - preferred_customer
                                    - rep
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure.
                                default_address:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    name:
                                      type:
                                        - string
                                        - 'null'
                                      example: John Doe
                                    first_name:
                                      type:
                                        - string
                                        - 'null'
                                      example: John
                                    last_name:
                                      type:
                                        - string
                                        - 'null'
                                      example: Doe
                                    address1:
                                      type: string
                                      example: 123 Main St
                                    address2:
                                      type:
                                        - string
                                        - 'null'
                                      example: Apt 4B
                                    address3:
                                      type:
                                        - string
                                        - 'null'
                                      example: Building 5
                                    city:
                                      type: string
                                      example: New York
                                    state:
                                      type: string
                                      example: NY
                                    postal_code:
                                      type: string
                                      example: '10001'
                                    country_code:
                                      type: string
                                      example: US
                                      description: >-
                                        country_id takes precedence if both
                                        country_id and country_code provided.
                                    subdivision_code:
                                      type:
                                        - string
                                        - 'null'
                                      example: NY
                                    default:
                                      type: boolean
                                      example: true
                                addresses:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                        example: 1
                                      name:
                                        type:
                                          - string
                                          - 'null'
                                        example: John Doe
                                      first_name:
                                        type:
                                          - string
                                          - 'null'
                                        example: John
                                      last_name:
                                        type:
                                          - string
                                          - 'null'
                                        example: Doe
                                      address1:
                                        type: string
                                        example: 123 Main St
                                      address2:
                                        type:
                                          - string
                                          - 'null'
                                        example: Apt 4B
                                      address3:
                                        type:
                                          - string
                                          - 'null'
                                        example: Building 5
                                      city:
                                        type: string
                                        example: New York
                                      state:
                                        type: string
                                        example: NY
                                      postal_code:
                                        type: string
                                        example: '10001'
                                      country_code:
                                        type: string
                                        example: US
                                        description: >-
                                          country_id takes precedence if both
                                          country_id and country_code provided.
                                      subdivision_code:
                                        type:
                                          - string
                                          - 'null'
                                        example: NY
                                      default:
                                        type: boolean
                                        example: true
                                payment_methods:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                        example: 967023914
                                      company_id:
                                        type: integer
                                        example: 96778814
                                      created_at:
                                        type: string
                                        example: '2025-11-11T04:59:05Z'
                                      logo_url:
                                        type:
                                          - string
                                          - 'null'
                                        example: >-
                                          https://assets.fluid.app/images/payment_icons/visa.svg
                                      payload:
                                        type: object
                                        example:
                                          exp_year: '2030'
                                          card_type: visa
                                          exp_month: '01'
                                          card_last_four: '1234'
                                          token_provider: spreedly
                                      source:
                                        type: string
                                        example: card
                                      updated_at:
                                        type: string
                                        example: '2025-11-11T04:59:05Z'
                                      user_id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: null
                                customer_notes:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      customer_id:
                                        type: integer
                                      user_company_id:
                                        type:
                                          - integer
                                          - 'null'
                                      note:
                                        type: string
                                      resource_type:
                                        type:
                                          - string
                                          - 'null'
                                      resource_id:
                                        type:
                                          - integer
                                          - 'null'
                                      created_at:
                                        type: string
                                active_subscriptions_count:
                                  type: integer
                                inactive_subscriptions_count:
                                  type: integer
                                total_orders:
                                  type: integer
                                  example: 12
                                user_id:
                                  type:
                                    - integer
                                    - 'null'
                        fulfillment_status:
                          type: string
                          example: Fulfilled
                        financial_status:
                          type: string
                          example: Paid
                        order_status:
                          type: string
                          example: Completed
                        payment_status:
                          type: string
                          example: Paid
                        is_cancellable:
                          type: boolean
                          example: true
                        note:
                          type:
                            - string
                            - 'null'
                          example: Order notes
                        notes:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                                description: Id of the customer note
                              user_company_id:
                                type:
                                  - integer
                                  - 'null'
                                description: >-
                                  Id of UserCompany who created the customer
                                  note
                              customer_id:
                                type: integer
                                description: >-
                                  Id of Customer associated with the customer
                                  note
                              note:
                                type: string
                                description: Note of the customer note
                              resource_type:
                                type:
                                  - string
                                  - 'null'
                                description: >-
                                  Type of Resource attached with the customer
                                  note
                              resource_id:
                                type:
                                  - integer
                                  - 'null'
                                description: >-
                                  Id of Resource specified in the
                                  `resource_type` field
                              created_at:
                                type: string
                                description: Time the customer note was created
                        rep:
                          type:
                            - object
                            - 'null'
                          example:
                            email:
                              type: string
                              example: john.doe@example.com
                            name:
                              type: string
                              example: John Doe
                            id:
                              type: integer
                              example: 1
                            image_url:
                              type: string
                              example: https://example.com/image.png
                            external_id:
                              type: string
                              example: '1234567890'
                        company:
                          type: object
                          properties:
                            id:
                              type: integer
                            name:
                              type: string
                            primary_domain_hostname:
                              type:
                                - string
                                - 'null'
                              example: fluid.com
                            subdomain:
                              type:
                                - string
                                - 'null'
                              example: myco
                            logo_url:
                              type:
                                - string
                                - 'null'
                              example: https://example.com/logo.png
                            fluid_shop:
                              type:
                                - string
                                - 'null'
                              example: https://fluid-sample-shop.fluid.com
                            collect_phone:
                              type: boolean
                              example: true
                            require_phone:
                              type: boolean
                              example: false
                            require_billing_zip:
                              type: boolean
                              example: false
                            checkout_primary_button_color:
                              type:
                                - string
                                - 'null'
                              example: '#000000'
                            checkout_primary_text_color:
                              type:
                                - string
                                - 'null'
                              example: '#FFFFFF'
                            checkout_secondary_button_color:
                              type:
                                - string
                                - 'null'
                              example: '#FFFFFF'
                            checkout_secondary_text_color:
                              type:
                                - string
                                - 'null'
                              example: '#000000'
                            favicon_url:
                              type:
                                - string
                                - 'null'
                              example: https://example.com/favicon.ico
                            order_on_behalf:
                              type: boolean
                              example: false
                            use_juspay_gateway:
                              type: boolean
                              example: false
                            reward_points_enabled:
                              type: boolean
                              example: false
                        refunds:
                          type:
                            - array
                            - 'null'
                          items:
                            type:
                              - object
                              - 'null'
                            properties:
                              amount:
                                type: string
                                example: '10.00'
                              reason:
                                type: string
                                example: Refund reason
                              cv:
                                type: integer
                                example: 1
                              qv:
                                type: integer
                                example: 1
                              refund_type:
                                type: string
                                example: Refund type
                        activities:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                              user_id:
                                type: integer
                              relation_type:
                                type: string
                              relation_id:
                                type: integer
                              contact_id:
                                type:
                                  - integer
                                  - 'null'
                              title:
                                type: string
                                example: A new order has been placed
                              description:
                                type: string
                                example: >-
                                  Samantha Joseph placed an order on Vandelay
                                  Shop
                              formatted_description:
                                type: string
                                example: >-
                                  Samantha Joseph placed an order on Vandelay
                                  Shop recently
                              read_at:
                                type:
                                  - string
                                  - 'null'
                              slug:
                                type: string
                              company_id:
                                type: integer
                              created_at:
                                type: string
                        payment_method:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                            spreedly_token:
                              type: string
                            full_name:
                              type: string
                            month:
                              type: integer
                            year:
                              type: integer
                            number:
                              type: string
                            last_four_digits:
                              type:
                                - string
                                - 'null'
                            first_six_digits:
                              type:
                                - string
                                - 'null'
                            card_type:
                              type:
                                - string
                                - 'null'
                            default:
                              type: boolean
                            email:
                              type:
                                - string
                                - 'null'
                            source:
                              type: string
                        total:
                          type: string
                          example: '100.00'
                        total_in_currency:
                          type: string
                          example: $100.00 USD
                        sub_total:
                          type: string
                          example: '90.00'
                        subtotal:
                          type: string
                          example: '90.00'
                        sub_total_in_currency:
                          type: string
                          example: $90.00 USD
                        shipping:
                          type: object
                          properties:
                            amount:
                              type: string
                              example: '5.00'
                            surcharge:
                              type: string
                              example: '2.00'
                            amount_in_currency:
                              type: string
                              example: $5.00 USD
                            surcharge_in_currency:
                              type: string
                              example: $2.00 USD
                        shipping_discount:
                          type: number
                          example: 10.45
                        items_count:
                          type: integer
                          example: 10
                        metadata:
                          type: object
                          example:
                            level: gold
                            tags:
                              - Tag1
                              - Tag2
                            camapaign:
                              id: 1
                              name: Winter 2025
                        metafields_collection:
                          type: array
                          items:
                            type: object
                            properties:
                              key:
                                type: string
                                example: order_source
                              value:
                                type: string
                                example: wholesale_portal
                              namespace:
                                type: string
                                example: global
                              value_type:
                                type: string
                                example: string
                        metafields:
                          type: array
                          items:
                            title: LegacyMetafield
                            type: object
                            properties:
                              id:
                                type: integer
                              namespace:
                                description: >-
                                  A container for related metafields. Commonly
                                  used to group metafields by app or
                                  functionality.
                                example: custom
                                type: string
                                maxLength: 20
                                pattern: ^[a-zA-Z0-9_]+$
                              key:
                                description: >-
                                  The unique identifier for the metafield within
                                  its namespace. Must be unique per namespace
                                  and owner.
                                example: material
                                type: string
                                maxLength: 30
                                pattern: ^[a-zA-Z0-9_]+$
                              value:
                                description: >-
                                  The actual data stored in the metafield. Type
                                  depends on value_type.
                                example: cotton
                                type:
                                  - string
                                  - object
                              value_type:
                                description: >-
                                  The data type that defines how the value
                                  should be interpreted and validated.
                                example: single_line_text_field
                                type: string
                              description:
                                description: >-
                                  Optional human-readable description explaining
                                  the purpose of this metafield.
                                example: The primary material used in this product
                                type:
                                  - string
                                  - 'null'
                              owner_type:
                                description: >-
                                  The type of resource that this metafield
                                  belongs to (polymorphic association).
                                example: Product
                                type: string
                              owner_id:
                                description: >-
                                  The ID of the specific resource that this
                                  metafield belongs to.
                                example: 12345
                                type: integer
                              created_at:
                                description: Timestamp when the metafield was created.
                                example: '2021-01-01T00:00:00Z'
                                type: string
                                format: date-time
                              updated_at:
                                description: Timestamp when the metafield was last updated.
                                example: '2021-01-01T00:00:00Z'
                                type: string
                                format: date-time
                              metafield_definition:
                                title: MetafieldDefinition
                                type:
                                  - object
                                  - 'null'
                                properties:
                                  id:
                                    type: integer
                                  company_id:
                                    description: >-
                                      The ID of the company that owns this
                                      metafield definition.
                                    example: 1
                                    type: integer
                                  namespace:
                                    description: >-
                                      A container for related metafield
                                      definitions. Used to group definitions by
                                      app or functionality. Must be unique
                                      within company and owner_resource.
                                    example: product_details
                                    type: string
                                    maxLength: 20
                                    pattern: ^[a-zA-Z0-9_]+$
                                  key:
                                    description: >-
                                      The unique identifier for the metafield
                                      definition within its namespace and
                                      owner_resource. Combined with namespace
                                      and owner_resource, this must be unique
                                      per company.
                                    example: material_type
                                    type: string
                                    maxLength: 30
                                    pattern: ^[a-zA-Z0-9_]+$
                                  name:
                                    description: >-
                                      Human-readable display name for the
                                      metafield definition, shown in admin
                                      interfaces and forms.
                                    example: Material Type
                                    type: string
                                    maxLength: 100
                                  description:
                                    description: >-
                                      Detailed explanation of what this
                                      metafield definition represents, how it
                                      should be used, and any special
                                      instructions for content creators.
                                    example: >-
                                      Specify the primary material composition
                                      of the product (e.g., cotton, polyester,
                                      silk). This will be displayed on the
                                      product detail page.
                                    type:
                                      - string
                                      - 'null'
                                  value_type:
                                    description: >-
                                      The data type that defines how metafield
                                      values should be validated, stored, and
                                      displayed. Determines which validation
                                      rules are available.
                                    example: single_line_text_field
                                    type: string
                                  validation_rules:
                                    description: >-
                                      JSON object containing validation
                                      constraints that will be applied to
                                      metafield values. Available rules depend
                                      on the value_type.
                                    example:
                                      choices:
                                        - cotton
                                        - polyester
                                        - silk
                                        - wool
                                        - linen
                                        - bamboo
                                      max: 50
                                      min: 2
                                    type:
                                      - object
                                      - 'null'
                                  owner_resource:
                                    description: >-
                                      The type of resource (model class name)
                                      that metafields using this definition can
                                      be attached to. Must match the polymorphic
                                      owner_type.
                                    example: Product
                                    type: string
                                  pinned:
                                    description: >-
                                      Whether this definition should be
                                      prominently displayed or prioritized in
                                      admin interfaces and forms.
                                    example: false
                                    type:
                                      - boolean
                                      - 'null'
                                    default: false
                                  position:
                                    default: 0
                                    description: >-
                                      Sort order for displaying this definition
                                      relative to others in the same category
                                      and owner_resource. Lower numbers appear
                                      first.
                                    example: 1
                                    type:
                                      - integer
                                      - 'null'
                                  locked:
                                    description: >-
                                      Whether this metafield definition is
                                      locked, preventing direct updates or
                                      deletions of metafields using this
                                      definition.
                                    example: false
                                    type:
                                      - boolean
                                      - 'null'
                                    default: false
                                  created_at:
                                    description: >-
                                      Timestamp when the metafield definition
                                      was created.
                                    example: '2024-01-15T10:30:00Z'
                                    type: string
                                    format: date-time
                                  updated_at:
                                    description: >-
                                      Timestamp when the metafield definition
                                      was last updated.
                                    example: '2024-02-20T14:45:00Z'
                                    type: string
                                    format: date-time
                                  list_type:
                                    description: >-
                                      Whether this definition is for list-type
                                      metafields that store arrays of values.
                                    example: false
                                    type: boolean
                                  reference_type:
                                    description: >-
                                      Whether this definition is for
                                      reference-type metafields that store
                                      references to other resources.
                                    example: false
                                    type: boolean
                                  supported_validations:
                                    description: >-
                                      Array of validation rule names that are
                                      supported for this value_type.
                                    example:
                                      - min
                                      - max
                                      - choices
                                      - regex
                                    type: array
                                  validation_description:
                                    description: >-
                                      Human-readable description of what the
                                      value_type represents and its constraints.
                                    example: Single line text up to 5000 characters
                                    type: string
                                  category_ids:
                                    description: >-
                                      Array of category IDs that this metafield
                                      definition is associated with for
                                      organizational purposes.
                                    example:
                                      - 1
                                      - 2
                                      - 3
                                    items:
                                      type: integer
                                    type: array
                                required:
                                  - id
                                  - company_id
                                  - namespace
                                  - key
                                  - name
                                  - value_type
                                  - owner_resource
                                  - created_at
                                  - updated_at
                                  - list_type
                                  - reference_type
                                  - supported_validations
                                  - validation_description
                                  - category_ids
                            required:
                              - id
                              - namespace
                              - key
                              - value
                              - value_type
                              - owner_type
                              - owner_id
                              - created_at
                              - updated_at
                        transaction_fee:
                          type:
                            - number
                            - string
                          example: 3
                        transaction_fee_in_currency:
                          type: string
                          example: $3.00 USD
                        enrollment_fee:
                          type:
                            - number
                            - string
                          example: 3
                        enrollment_fee_in_currency:
                          type: string
                          example: $3.00 USD
                        discount:
                          type: string
                          example: '10.00'
                        tax:
                          type: string
                          example: '8.00'
                        dynamic_charges:
                          type: object
                          example:
                            handling: 2
                        dynamic_charges_in_currency:
                          type: object
                          example:
                            handling: $2.00 USD
                        buyer:
                          type:
                            - object
                            - 'null'
                          example:
                            share_guid: f6b4c9
                        shipping_address:
                          type:
                            - object
                            - 'null'
                          properties:
                            name:
                              type:
                                - string
                                - 'null'
                              example: John Doe
                            address1:
                              type:
                                - string
                                - 'null'
                              example: 123 Main St
                            address2:
                              type:
                                - string
                                - 'null'
                              example: Apt 4B
                            address3:
                              type:
                                - string
                                - 'null'
                              example: Building 5
                            city:
                              type:
                                - string
                                - 'null'
                              example: New York
                            state:
                              type:
                                - string
                                - 'null'
                              example: NY
                            postal_code:
                              type:
                                - string
                                - 'null'
                              example: '10001'
                            country_code:
                              type:
                                - string
                                - 'null'
                              example: US
                            subdivision_code:
                              type:
                                - string
                                - 'null'
                              example: NY
                        billing_address:
                          type:
                            - object
                            - 'null'
                          properties:
                            name:
                              type:
                                - string
                                - 'null'
                              example: John Doe
                            address1:
                              type:
                                - string
                                - 'null'
                              example: 123 Main St
                            address2:
                              type:
                                - string
                                - 'null'
                              example: Apt 4B
                            address3:
                              type:
                                - string
                                - 'null'
                              example: Building 5
                            city:
                              type:
                                - string
                                - 'null'
                              example: New York
                            state:
                              type:
                                - string
                                - 'null'
                              example: NY
                            postal_code:
                              type:
                                - string
                                - 'null'
                              example: '10001'
                            country_code:
                              type:
                                - string
                                - 'null'
                              example: US
                            subdivision_code:
                              type:
                                - string
                                - 'null'
                              example: NY
                        items:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              title:
                                type: string
                                example: Hula Hoop
                              quantity:
                                type: integer
                                example: 3
                              price:
                                type:
                                  - number
                                  - string
                                example: 5.5
                              display_price:
                                type: string
                                example: $5.5 USD
                              total:
                                type:
                                  - number
                                  - string
                                example: 16.5
                              display_total:
                                type: string
                                example: $16.5 USD
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/test_image.jpg
                              sku:
                                type:
                                  - string
                                  - 'null'
                                example: ABC-12345-S-BL
                              cv:
                                type: integer
                                example: 100
                              qv:
                                type: integer
                                example: 100
                              display_to_customer:
                                type:
                                  - boolean
                                  - 'null'
                                example: true
                              ordered_variant:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    option_type:
                                      type: string
                                      example: Size
                                    value:
                                      type: string
                                      example: XXL
                              hs_code:
                                type:
                                  - string
                                  - 'null'
                                example: HS123
                              total_in_currency:
                                type: string
                                example: $11.0 USD
                              price_in_currency:
                                type: string
                                example: $29.99
                              tax:
                                type: string
                                example: '2.99'
                              tax_in_currency:
                                type: string
                                example: $2.99
                              thumbnail:
                                type: string
                                example: https://example.com/test_image.jpg
                              variant:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  title:
                                    type:
                                      - string
                                      - 'null'
                                    example: Sample Variant
                                  image_path:
                                    type:
                                      - string
                                      - 'null'
                                    example: /images/sample.png
                                  image_url:
                                    type:
                                      - string
                                      - 'null'
                                    example: https://example.com/images/sample.png
                                  primary_image:
                                    type:
                                      - string
                                      - 'null'
                                    example: https://example.com/images/primary.png
                                  price:
                                    type:
                                      - string
                                      - 'null'
                                    example: '34.44'
                                  price_in_currency:
                                    type:
                                      - string
                                      - 'null'
                                    example: $34.44
                                  sku:
                                    type:
                                      - string
                                      - 'null'
                                    example: SKU12345
                                  options:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        title:
                                          type: string
                                          example: Size
                                        value:
                                          type: string
                                          example: XL
                        discount_in_currency:
                          type: string
                          example: $10.00 USD
                        tax_in_currency:
                          type: string
                          example: $8.00 USD
                        cv:
                          type: integer
                          example: 100
                        qv:
                          type: integer
                          example: 100
                        status:
                          type: string
                          example: awaiting_payment
                        external_id:
                          type:
                            - string
                            - 'null'
                          example: '1234567890'
                        cart_id:
                          type:
                            - string
                            - 'null'
                          example: 1
                        cart_token:
                          type:
                            - string
                            - 'null'
                          example: CART_TOKEN
                        source:
                          type: string
                          example: web
                          enum:
                            - mobile
                            - web
                            - admin
                            - backoffice
                            - subscription
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      pagination:
                        type: object
                        properties:
                          current_page:
                            type: integer
                            example: 1
                          total_pages:
                            type: integer
                            example: 10
                          total_count:
                            type: integer
                            example: 100
                          per_page:
                            type: integer
                            example: 10
                required:
                  - orders
                  - meta
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: unauthorized
                  errors:
                    type: object
                    example:
                      customer:
                        - Not authorized.
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/customers:
    get:
      summary: List customers
      description: Get all customers with optional filters
      tags:
        - Customers
      operationId: listCustomers
      security:
        - bearer_auth: []
      parameters:
        - name: search_query
          in: query
          required: false
          description: >-
            Filter customers with search query that matches with their email,
            first name, last name or external_id
          schema:
            type: string
        - name: sorted_by
          in: query
          required: false
          example: id_asc
          description: >
            Sort the records by one of the supported attributes:

              - id
              - email
              - created_at
              - updated_at
              - country
              - full_name
              - active_subscriptions_count
              - inactive_subscriptions_count
              - orders_count
              - last_ordered_at

            The sort attribute should be followed by one of the order
            directives: '_asc', '_desc'
          schema:
            type: string
        - name: has_subscription
          in: query
          schema:
            type: boolean
            default: false
          required: false
          description: Filter customers who have subscription
        - name: has_recent_orders
          in: query
          schema:
            type: boolean
            default: false
          required: false
          description: Filter customers who have recent orders made within last 30 days
        - name: has_failed_orders
          in: query
          schema:
            type: boolean
            default: false
          required: false
          description: Filter customers who have failed orders
        - name: purchased_more_than_once
          in: query
          schema:
            type: boolean
            default: false
          required: false
          description: Filter customers who have purchased more than once
        - name: us_customers
          in: query
          schema:
            type: boolean
            default: false
          required: false
          description: Filter customers from US
        - name: non_us_customers
          in: query
          schema:
            type: boolean
            default: false
          required: false
          description: Filter customers outside from US
        - name: abandoned_in_the_last_30_days
          in: query
          schema:
            type: boolean
            default: false
          required: false
          description: Filter customers who have abandoned cart within last 30 days
        - name: reps
          in: query
          schema:
            type: boolean
            default: false
          required: false
          description: Filter customers who are also Reps
        - name: order_status
          in: query
          required: false
          description: Filter customers by their order status
          schema:
            type: string
            enum:
              - fulfilled
              - unfulfilled
        - name: ordered_since
          in: query
          required: false
          description: >-
            Filter customers who have ordered since the specified date. Can be
            used for e.g. last 30 days, 90 days, etc.
          example: '2024-10-27'
          schema:
            type: string
        - name: location
          in: query
          required: false
          description: >-
            Filter customers based upon their default address country iso. `US`,
            `CA`, `UK`, etc.
          example: CA
          schema:
            type: string
        - name: subscription_status
          in: query
          required: false
          description: >-
            Filter customers by their subscription orders status. `active` or
            `inactive`
          schema:
            type: string
            enum:
              - active
              - inactive
        - name: created_between
          in: query
          required: false
          description: >-
            Filter customers by creation date range. Format:
            MM-DD-YYYY-MM-DD-YYYY. Examples: '01-01-2024-12-31-2024' (between
            dates), '01-01-2024-' (after date), '-12-31-2024' (before date).
            Note: URL-encode the entire parameter value.
          example: 01-01-2024-12-31-2024
          schema:
            type: string
        - name: with_total_orders_between
          in: query
          required: false
          description: >-
            Filter customers by total number of orders range. Format: min-max.
            Example: '2-5', '2-', '-5'
          example: 2-5
          schema:
            type: string
        - name: with_total_spent_between
          in: query
          required: false
          description: >-
            Filter customers by total amount spent range. Format: min-max.
            Example: '200-500', '200-', '-500'
          example: 200-500
          schema:
            type: string
        - name: active_subscription_amount_between
          in: query
          required: false
          description: >-
            Filter customers by total amount of active subscription orders (e.g.
            '100-500' or '100-' or '-500')
          example: 100-500
          schema:
            type: string
        - name: inactive_subscription_amount_between
          in: query
          required: false
          description: >-
            Filter customers by total amount of inactive subscription orders
            (e.g. '100-500' or '100-' or '-500')
          example: 100-500
          schema:
            type: string
        - name: for_rep
          in: query
          required: false
          description: Filter customers by their rep id (user_company_id)
          schema:
            type: integer
        - name: page
          in: query
          schema:
            type: integer
            default: 1
          required: false
          description: Page number for pagination
        - name: per_page
          in: query
          schema:
            type: integer
            default: 10
          required: false
          description: Number of records per page
        - name: by_metadata
          in: query
          schema:
            type: string
            default: '{}'
            format: json
          required: false
          description: Search JSON meta data
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  customers:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        account_id:
                          type: string
                        first_name:
                          type: string
                        last_name:
                          type: string
                        full_name:
                          type: string
                        email:
                          type: string
                        verified_email:
                          type: boolean
                        phone:
                          type: string
                        orders_count:
                          type: integer
                        total_spent:
                          type:
                            - number
                            - string
                        display_total_spent:
                          type: string
                        last_order_id:
                          type:
                            - integer
                            - 'null'
                        notes:
                          type:
                            - string
                            - 'null'
                        user_company_id:
                          type:
                            - integer
                            - 'null'
                        created_at:
                          type: string
                        active:
                          type: boolean
                        is_rep:
                          type: boolean
                        is_discarded:
                          type: boolean
                        external_id:
                          type:
                            - string
                            - 'null'
                        role:
                          type: string
                          example: customer
                          enum:
                            - customer
                            - preferred_customer
                            - rep
                        metadata:
                          type: object
                          description: >-
                            A JSON object that can store any custom data
                            structure.
                        default_address:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            name:
                              type:
                                - string
                                - 'null'
                              example: John Doe
                            first_name:
                              type:
                                - string
                                - 'null'
                              example: John
                            last_name:
                              type:
                                - string
                                - 'null'
                              example: Doe
                            address1:
                              type: string
                              example: 123 Main St
                            address2:
                              type:
                                - string
                                - 'null'
                              example: Apt 4B
                            address3:
                              type:
                                - string
                                - 'null'
                              example: Building 5
                            city:
                              type: string
                              example: New York
                            state:
                              type: string
                              example: NY
                            postal_code:
                              type: string
                              example: '10001'
                            country_code:
                              type: string
                              example: US
                              description: >-
                                country_id takes precedence if both country_id
                                and country_code provided.
                            subdivision_code:
                              type:
                                - string
                                - 'null'
                              example: NY
                            default:
                              type: boolean
                              example: true
                        addresses:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              name:
                                type:
                                  - string
                                  - 'null'
                                example: John Doe
                              first_name:
                                type:
                                  - string
                                  - 'null'
                                example: John
                              last_name:
                                type:
                                  - string
                                  - 'null'
                                example: Doe
                              address1:
                                type: string
                                example: 123 Main St
                              address2:
                                type:
                                  - string
                                  - 'null'
                                example: Apt 4B
                              address3:
                                type:
                                  - string
                                  - 'null'
                                example: Building 5
                              city:
                                type: string
                                example: New York
                              state:
                                type: string
                                example: NY
                              postal_code:
                                type: string
                                example: '10001'
                              country_code:
                                type: string
                                example: US
                                description: >-
                                  country_id takes precedence if both country_id
                                  and country_code provided.
                              subdivision_code:
                                type:
                                  - string
                                  - 'null'
                                example: NY
                              default:
                                type: boolean
                                example: true
                        payment_methods:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                                example: 967023914
                              company_id:
                                type: integer
                                example: 96778814
                              created_at:
                                type: string
                                example: '2025-11-11T04:59:05Z'
                              logo_url:
                                type:
                                  - string
                                  - 'null'
                                example: >-
                                  https://assets.fluid.app/images/payment_icons/visa.svg
                              payload:
                                type: object
                                example:
                                  exp_year: '2030'
                                  card_type: visa
                                  exp_month: '01'
                                  card_last_four: '1234'
                                  token_provider: spreedly
                              source:
                                type: string
                                example: card
                              updated_at:
                                type: string
                                example: '2025-11-11T04:59:05Z'
                              user_id:
                                type:
                                  - integer
                                  - 'null'
                                example: null
                        customer_notes:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                              customer_id:
                                type: integer
                              user_company_id:
                                type:
                                  - integer
                                  - 'null'
                              note:
                                type: string
                              resource_type:
                                type:
                                  - string
                                  - 'null'
                              resource_id:
                                type:
                                  - integer
                                  - 'null'
                              created_at:
                                type: string
                        active_subscriptions_count:
                          type: integer
                        inactive_subscriptions_count:
                          type: integer
                        jwt:
                          type: string
                        metafields:
                          type: array
                          items:
                            title: LegacyMetafield
                            type: object
                            properties:
                              id:
                                type: integer
                              namespace:
                                description: >-
                                  A container for related metafields. Commonly
                                  used to group metafields by app or
                                  functionality.
                                example: custom
                                type: string
                                maxLength: 20
                                pattern: ^[a-zA-Z0-9_]+$
                              key:
                                description: >-
                                  The unique identifier for the metafield within
                                  its namespace. Must be unique per namespace
                                  and owner.
                                example: material
                                type: string
                                maxLength: 30
                                pattern: ^[a-zA-Z0-9_]+$
                              value:
                                description: >-
                                  The actual data stored in the metafield. Type
                                  depends on value_type.
                                example: cotton
                                type:
                                  - string
                                  - object
                              value_type:
                                description: >-
                                  The data type that defines how the value
                                  should be interpreted and validated.
                                example: single_line_text_field
                                type: string
                              description:
                                description: >-
                                  Optional human-readable description explaining
                                  the purpose of this metafield.
                                example: The primary material used in this product
                                type:
                                  - string
                                  - 'null'
                              owner_type:
                                description: >-
                                  The type of resource that this metafield
                                  belongs to (polymorphic association).
                                example: Product
                                type: string
                              owner_id:
                                description: >-
                                  The ID of the specific resource that this
                                  metafield belongs to.
                                example: 12345
                                type: integer
                              created_at:
                                description: Timestamp when the metafield was created.
                                example: '2021-01-01T00:00:00Z'
                                type: string
                                format: date-time
                              updated_at:
                                description: Timestamp when the metafield was last updated.
                                example: '2021-01-01T00:00:00Z'
                                type: string
                                format: date-time
                              metafield_definition:
                                title: MetafieldDefinition
                                type:
                                  - object
                                  - 'null'
                                properties:
                                  id:
                                    type: integer
                                  company_id:
                                    description: >-
                                      The ID of the company that owns this
                                      metafield definition.
                                    example: 1
                                    type: integer
                                  namespace:
                                    description: >-
                                      A container for related metafield
                                      definitions. Used to group definitions by
                                      app or functionality. Must be unique
                                      within company and owner_resource.
                                    example: product_details
                                    type: string
                                    maxLength: 20
                                    pattern: ^[a-zA-Z0-9_]+$
                                  key:
                                    description: >-
                                      The unique identifier for the metafield
                                      definition within its namespace and
                                      owner_resource. Combined with namespace
                                      and owner_resource, this must be unique
                                      per company.
                                    example: material_type
                                    type: string
                                    maxLength: 30
                                    pattern: ^[a-zA-Z0-9_]+$
                                  name:
                                    description: >-
                                      Human-readable display name for the
                                      metafield definition, shown in admin
                                      interfaces and forms.
                                    example: Material Type
                                    type: string
                                    maxLength: 100
                                  description:
                                    description: >-
                                      Detailed explanation of what this
                                      metafield definition represents, how it
                                      should be used, and any special
                                      instructions for content creators.
                                    example: >-
                                      Specify the primary material composition
                                      of the product (e.g., cotton, polyester,
                                      silk). This will be displayed on the
                                      product detail page.
                                    type:
                                      - string
                                      - 'null'
                                  value_type:
                                    description: >-
                                      The data type that defines how metafield
                                      values should be validated, stored, and
                                      displayed. Determines which validation
                                      rules are available.
                                    example: single_line_text_field
                                    type: string
                                  validation_rules:
                                    description: >-
                                      JSON object containing validation
                                      constraints that will be applied to
                                      metafield values. Available rules depend
                                      on the value_type.
                                    example:
                                      choices:
                                        - cotton
                                        - polyester
                                        - silk
                                        - wool
                                        - linen
                                        - bamboo
                                      max: 50
                                      min: 2
                                    type:
                                      - object
                                      - 'null'
                                  owner_resource:
                                    description: >-
                                      The type of resource (model class name)
                                      that metafields using this definition can
                                      be attached to. Must match the polymorphic
                                      owner_type.
                                    example: Product
                                    type: string
                                  pinned:
                                    description: >-
                                      Whether this definition should be
                                      prominently displayed or prioritized in
                                      admin interfaces and forms.
                                    example: false
                                    type:
                                      - boolean
                                      - 'null'
                                    default: false
                                  position:
                                    default: 0
                                    description: >-
                                      Sort order for displaying this definition
                                      relative to others in the same category
                                      and owner_resource. Lower numbers appear
                                      first.
                                    example: 1
                                    type:
                                      - integer
                                      - 'null'
                                  locked:
                                    description: >-
                                      Whether this metafield definition is
                                      locked, preventing direct updates or
                                      deletions of metafields using this
                                      definition.
                                    example: false
                                    type:
                                      - boolean
                                      - 'null'
                                    default: false
                                  created_at:
                                    description: >-
                                      Timestamp when the metafield definition
                                      was created.
                                    example: '2024-01-15T10:30:00Z'
                                    type: string
                                    format: date-time
                                  updated_at:
                                    description: >-
                                      Timestamp when the metafield definition
                                      was last updated.
                                    example: '2024-02-20T14:45:00Z'
                                    type: string
                                    format: date-time
                                  list_type:
                                    description: >-
                                      Whether this definition is for list-type
                                      metafields that store arrays of values.
                                    example: false
                                    type: boolean
                                  reference_type:
                                    description: >-
                                      Whether this definition is for
                                      reference-type metafields that store
                                      references to other resources.
                                    example: false
                                    type: boolean
                                  supported_validations:
                                    description: >-
                                      Array of validation rule names that are
                                      supported for this value_type.
                                    example:
                                      - min
                                      - max
                                      - choices
                                      - regex
                                    type: array
                                  validation_description:
                                    description: >-
                                      Human-readable description of what the
                                      value_type represents and its constraints.
                                    example: Single line text up to 5000 characters
                                    type: string
                                  category_ids:
                                    description: >-
                                      Array of category IDs that this metafield
                                      definition is associated with for
                                      organizational purposes.
                                    example:
                                      - 1
                                      - 2
                                      - 3
                                    items:
                                      type: integer
                                    type: array
                                required:
                                  - id
                                  - company_id
                                  - namespace
                                  - key
                                  - name
                                  - value_type
                                  - owner_resource
                                  - created_at
                                  - updated_at
                                  - list_type
                                  - reference_type
                                  - supported_validations
                                  - validation_description
                                  - category_ids
                            required:
                              - id
                              - namespace
                              - key
                              - value
                              - value_type
                              - owner_type
                              - owner_id
                              - created_at
                              - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                      total_count:
                        type: integer
                        example: 42
                      total_pages:
                        type: integer
                        example: 3
                      current_page:
                        type: integer
                        example: 1
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameters
                  errors:
                    type: object
                    example:
                      by_metadata:
                        - >-
                          The value `{referred_by: {user: 'John},}` in parameter
                          `by_metadata` is not a valid JSON
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
    post:
      summary: Create a customer
      tags:
        - Customers
      operationId: createCustomer
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    type: object
                    properties:
                      id:
                        type: integer
                      account_id:
                        type: string
                      first_name:
                        type: string
                      last_name:
                        type: string
                      full_name:
                        type: string
                      email:
                        type: string
                      verified_email:
                        type: boolean
                      phone:
                        type: string
                      orders_count:
                        type: integer
                      total_spent:
                        type:
                          - number
                          - string
                      display_total_spent:
                        type: string
                      last_order_id:
                        type:
                          - integer
                          - 'null'
                      notes:
                        type:
                          - string
                          - 'null'
                      user_company_id:
                        type:
                          - integer
                          - 'null'
                      created_at:
                        type: string
                      active:
                        type: boolean
                      is_rep:
                        type: boolean
                      is_discarded:
                        type: boolean
                      external_id:
                        type:
                          - string
                          - 'null'
                      role:
                        type: string
                        example: customer
                        enum:
                          - customer
                          - preferred_customer
                          - rep
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      default_address:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      addresses:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            name:
                              type:
                                - string
                                - 'null'
                              example: John Doe
                            first_name:
                              type:
                                - string
                                - 'null'
                              example: John
                            last_name:
                              type:
                                - string
                                - 'null'
                              example: Doe
                            address1:
                              type: string
                              example: 123 Main St
                            address2:
                              type:
                                - string
                                - 'null'
                              example: Apt 4B
                            address3:
                              type:
                                - string
                                - 'null'
                              example: Building 5
                            city:
                              type: string
                              example: New York
                            state:
                              type: string
                              example: NY
                            postal_code:
                              type: string
                              example: '10001'
                            country_code:
                              type: string
                              example: US
                              description: >-
                                country_id takes precedence if both country_id
                                and country_code provided.
                            subdivision_code:
                              type:
                                - string
                                - 'null'
                              example: NY
                            default:
                              type: boolean
                              example: true
                      payment_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 967023914
                            company_id:
                              type: integer
                              example: 96778814
                            created_at:
                              type: string
                              example: '2025-11-11T04:59:05Z'
                            logo_url:
                              type:
                                - string
                                - 'null'
                              example: >-
                                https://assets.fluid.app/images/payment_icons/visa.svg
                            payload:
                              type: object
                              example:
                                exp_year: '2030'
                                card_type: visa
                                exp_month: '01'
                                card_last_four: '1234'
                                token_provider: spreedly
                            source:
                              type: string
                              example: card
                            updated_at:
                              type: string
                              example: '2025-11-11T04:59:05Z'
                            user_id:
                              type:
                                - integer
                                - 'null'
                              example: null
                      customer_notes:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            customer_id:
                              type: integer
                            user_company_id:
                              type:
                                - integer
                                - 'null'
                            note:
                              type: string
                            resource_type:
                              type:
                                - string
                                - 'null'
                            resource_id:
                              type:
                                - integer
                                - 'null'
                            created_at:
                              type: string
                      active_subscriptions_count:
                        type: integer
                      inactive_subscriptions_count:
                        type: integer
                      jwt:
                        type: string
                      metafields:
                        type: array
                        items:
                          title: LegacyMetafield
                          type: object
                          properties:
                            id:
                              type: integer
                            namespace:
                              description: >-
                                A container for related metafields. Commonly
                                used to group metafields by app or
                                functionality.
                              example: custom
                              type: string
                              maxLength: 20
                              pattern: ^[a-zA-Z0-9_]+$
                            key:
                              description: >-
                                The unique identifier for the metafield within
                                its namespace. Must be unique per namespace and
                                owner.
                              example: material
                              type: string
                              maxLength: 30
                              pattern: ^[a-zA-Z0-9_]+$
                            value:
                              description: >-
                                The actual data stored in the metafield. Type
                                depends on value_type.
                              example: cotton
                              type:
                                - string
                                - object
                            value_type:
                              description: >-
                                The data type that defines how the value should
                                be interpreted and validated.
                              example: single_line_text_field
                              type: string
                            description:
                              description: >-
                                Optional human-readable description explaining
                                the purpose of this metafield.
                              example: The primary material used in this product
                              type:
                                - string
                                - 'null'
                            owner_type:
                              description: >-
                                The type of resource that this metafield belongs
                                to (polymorphic association).
                              example: Product
                              type: string
                            owner_id:
                              description: >-
                                The ID of the specific resource that this
                                metafield belongs to.
                              example: 12345
                              type: integer
                            created_at:
                              description: Timestamp when the metafield was created.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            updated_at:
                              description: Timestamp when the metafield was last updated.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            metafield_definition:
                              title: MetafieldDefinition
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                company_id:
                                  description: >-
                                    The ID of the company that owns this
                                    metafield definition.
                                  example: 1
                                  type: integer
                                namespace:
                                  description: >-
                                    A container for related metafield
                                    definitions. Used to group definitions by
                                    app or functionality. Must be unique within
                                    company and owner_resource.
                                  example: product_details
                                  type: string
                                  maxLength: 20
                                  pattern: ^[a-zA-Z0-9_]+$
                                key:
                                  description: >-
                                    The unique identifier for the metafield
                                    definition within its namespace and
                                    owner_resource. Combined with namespace and
                                    owner_resource, this must be unique per
                                    company.
                                  example: material_type
                                  type: string
                                  maxLength: 30
                                  pattern: ^[a-zA-Z0-9_]+$
                                name:
                                  description: >-
                                    Human-readable display name for the
                                    metafield definition, shown in admin
                                    interfaces and forms.
                                  example: Material Type
                                  type: string
                                  maxLength: 100
                                description:
                                  description: >-
                                    Detailed explanation of what this metafield
                                    definition represents, how it should be
                                    used, and any special instructions for
                                    content creators.
                                  example: >-
                                    Specify the primary material composition of
                                    the product (e.g., cotton, polyester, silk).
                                    This will be displayed on the product detail
                                    page.
                                  type:
                                    - string
                                    - 'null'
                                value_type:
                                  description: >-
                                    The data type that defines how metafield
                                    values should be validated, stored, and
                                    displayed. Determines which validation rules
                                    are available.
                                  example: single_line_text_field
                                  type: string
                                validation_rules:
                                  description: >-
                                    JSON object containing validation
                                    constraints that will be applied to
                                    metafield values. Available rules depend on
                                    the value_type.
                                  example:
                                    choices:
                                      - cotton
                                      - polyester
                                      - silk
                                      - wool
                                      - linen
                                      - bamboo
                                    max: 50
                                    min: 2
                                  type:
                                    - object
                                    - 'null'
                                owner_resource:
                                  description: >-
                                    The type of resource (model class name) that
                                    metafields using this definition can be
                                    attached to. Must match the polymorphic
                                    owner_type.
                                  example: Product
                                  type: string
                                pinned:
                                  description: >-
                                    Whether this definition should be
                                    prominently displayed or prioritized in
                                    admin interfaces and forms.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                position:
                                  default: 0
                                  description: >-
                                    Sort order for displaying this definition
                                    relative to others in the same category and
                                    owner_resource. Lower numbers appear first.
                                  example: 1
                                  type:
                                    - integer
                                    - 'null'
                                locked:
                                  description: >-
                                    Whether this metafield definition is locked,
                                    preventing direct updates or deletions of
                                    metafields using this definition.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                created_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    created.
                                  example: '2024-01-15T10:30:00Z'
                                  type: string
                                  format: date-time
                                updated_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    last updated.
                                  example: '2024-02-20T14:45:00Z'
                                  type: string
                                  format: date-time
                                list_type:
                                  description: >-
                                    Whether this definition is for list-type
                                    metafields that store arrays of values.
                                  example: false
                                  type: boolean
                                reference_type:
                                  description: >-
                                    Whether this definition is for
                                    reference-type metafields that store
                                    references to other resources.
                                  example: false
                                  type: boolean
                                supported_validations:
                                  description: >-
                                    Array of validation rule names that are
                                    supported for this value_type.
                                  example:
                                    - min
                                    - max
                                    - choices
                                    - regex
                                  type: array
                                validation_description:
                                  description: >-
                                    Human-readable description of what the
                                    value_type represents and its constraints.
                                  example: Single line text up to 5000 characters
                                  type: string
                                category_ids:
                                  description: >-
                                    Array of category IDs that this metafield
                                    definition is associated with for
                                    organizational purposes.
                                  example:
                                    - 1
                                    - 2
                                    - 3
                                  items:
                                    type: integer
                                  type: array
                              required:
                                - id
                                - company_id
                                - namespace
                                - key
                                - name
                                - value_type
                                - owner_resource
                                - created_at
                                - updated_at
                                - list_type
                                - reference_type
                                - supported_validations
                                - validation_description
                                - category_ids
                          required:
                            - id
                            - namespace
                            - key
                            - value
                            - value_type
                            - owner_type
                            - owner_id
                            - created_at
                            - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '422':
          description: duplicate customer error with existing customer data (account_id)
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Customer with this account ID already exists
                  errors:
                    type: object
                    properties:
                      customer:
                        type: object
                        properties:
                          email:
                            type: array
                            items:
                              type: string
                            example:
                              - must be filled
                      email:
                        type: array
                        items:
                          type: string
                        example:
                          - has already been taken
                      existing_customer:
                        type: object
                        properties:
                          customer:
                            title: Customer
                            type: object
                            properties:
                              id:
                                type: integer
                              account_id:
                                type:
                                  - string
                                  - 'null'
                              first_name:
                                type:
                                  - string
                                  - 'null'
                              last_name:
                                type:
                                  - string
                                  - 'null'
                              full_name:
                                type: string
                              email:
                                type: string
                                pattern: >-
                                  ^[a-zA-Z0-9.!\#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$
                              verified_email:
                                type:
                                  - boolean
                                  - 'null'
                                default: false
                              phone:
                                type:
                                  - string
                                  - 'null'
                              orders_count:
                                type:
                                  - integer
                                  - 'null'
                                default: 0
                              created_at:
                                type: string
                                format: date-time
                              display_total_spent:
                                type: string
                              metadata:
                                type: object
                                default: '{}'
                              user_company_id:
                                type:
                                  - integer
                                  - 'null'
                              external_id:
                                type:
                                  - string
                                  - 'null'
                              role:
                                type: string
                                enum:
                                  - customer
                                  - preferred_customer
                                  - rep
                              last_order_id:
                                example: 101
                                type:
                                  - integer
                                  - 'null'
                              notes:
                                example: This is a note
                                type:
                                  - string
                                  - 'null'
                              active:
                                type: boolean
                              total_spent:
                                example: 100
                                type:
                                  - number
                                  - string
                              customer_notes:
                                type: array
                                items:
                                  title: CustomerNote
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                    note:
                                      type: string
                                    user_company_id:
                                      type:
                                        - integer
                                        - 'null'
                                    customer_id:
                                      type: integer
                                    resource_id:
                                      type:
                                        - integer
                                        - 'null'
                                    resource_type:
                                      type:
                                        - string
                                        - 'null'
                                    created_at:
                                      type: string
                                      format: date-time
                                  required:
                                    - id
                                    - note
                                    - customer_id
                                    - created_at
                              default_address:
                                title: Address
                                type:
                                  - object
                                  - 'null'
                                properties:
                                  id:
                                    type: integer
                                  name:
                                    example: John Doe
                                    type: string
                                  address1:
                                    example: 123 Main St
                                    type: string
                                  address2:
                                    example: Apt 4B
                                    type:
                                      - string
                                      - 'null'
                                  address3:
                                    example: Building 5
                                    type:
                                      - string
                                      - 'null'
                                  city:
                                    example: New York
                                    type: string
                                  state:
                                    example: NY
                                    type: string
                                  subdivision_code:
                                    example: NY
                                    type:
                                      - string
                                      - 'null'
                                  postal_code:
                                    example: '10001'
                                    type: string
                                  country_code:
                                    example: US
                                    type:
                                      - string
                                      - 'null'
                                  default:
                                    description: >-
                                      Use this address by default when there are
                                      multiple addresses
                                    example: true
                                    type:
                                      - boolean
                                      - 'null'
                                    default: false
                                  first_name:
                                    example: John
                                    type: string
                                  last_name:
                                    example: Doe
                                    type: string
                                required:
                                  - id
                                  - name
                                  - address1
                                  - city
                                  - state
                                  - postal_code
                                  - first_name
                                  - last_name
                              addresses:
                                type: array
                                items:
                                  title: Address
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                    name:
                                      example: John Doe
                                      type: string
                                    address1:
                                      example: 123 Main St
                                      type: string
                                    address2:
                                      example: Apt 4B
                                      type:
                                        - string
                                        - 'null'
                                    address3:
                                      example: Building 5
                                      type:
                                        - string
                                        - 'null'
                                    city:
                                      example: New York
                                      type: string
                                    state:
                                      example: NY
                                      type: string
                                    subdivision_code:
                                      example: NY
                                      type:
                                        - string
                                        - 'null'
                                    postal_code:
                                      example: '10001'
                                      type: string
                                    country_code:
                                      example: US
                                      type:
                                        - string
                                        - 'null'
                                    default:
                                      description: >-
                                        Use this address by default when there
                                        are multiple addresses
                                      example: true
                                      type:
                                        - boolean
                                        - 'null'
                                      default: false
                                    first_name:
                                      example: John
                                      type: string
                                    last_name:
                                      example: Doe
                                      type: string
                                  required:
                                    - id
                                    - name
                                    - address1
                                    - city
                                    - state
                                    - postal_code
                                    - first_name
                                    - last_name
                              payment_methods:
                                type: array
                                items:
                                  title: Commerce::PaymentMethod
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                    source:
                                      type: string
                                      enum:
                                        - apple_pay
                                        - paypal
                                        - card
                                        - iap
                                        - bread
                                        - affirm
                                        - google_pay
                                        - klarna
                                        - droplet
                                        - citcon
                                        - ppro
                                    payload:
                                      type:
                                        - object
                                        - 'null'
                                    company_id:
                                      type:
                                        - integer
                                        - 'null'
                                    created_at:
                                      type: string
                                      format: date-time
                                    updated_at:
                                      type: string
                                      format: date-time
                                    logo_url:
                                      type: string
                                    user_id:
                                      example: 101
                                      type:
                                        - integer
                                        - 'null'
                                  required:
                                    - id
                                    - source
                                    - created_at
                                    - updated_at
                                    - logo_url
                              is_rep:
                                example: true
                                type: boolean
                              is_discarded:
                                example: false
                                type: boolean
                            required:
                              - id
                              - full_name
                              - email
                              - created_at
                              - display_total_spent
                              - metadata
                              - role
                              - active
                              - total_spent
                              - customer_notes
                              - addresses
                              - payment_methods
                              - is_rep
                              - is_discarded
                      account_id:
                        type: array
                        items:
                          type: string
                        example:
                          - is already taken
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                first_name:
                  type: string
                  example: John
                  description: First name of customer
                last_name:
                  type: string
                  example: Nash
                  description: Last name of customer
                email:
                  type: string
                  example: john.nash@example.com
                  description: Email of customer
                phone:
                  type: string
                  example: 801-000-0000
                  description: Phone number of customer
                account_id:
                  type: string
                  example: VKHJSGHOHSOIZQCK
                  description: >-
                    A unique Account Id for customer. If empty, one is generated
                    by the system
                external_id:
                  type: string
                  example: '1234567890'
                  description: >-
                    A unique External Id for customer that is used to identify
                    them in external systems
                notes:
                  type: string
                  example: Note
                  description: Note for customer
                metadata:
                  type: object
                  description: Can hold JSON object of arbitrary structure
                default_address_attributes:
                  type: object
                  properties:
                    address1:
                      type: string
                      example: 234 Northern Drive
                    address2:
                      type: string
                      example: Apt 5
                    city:
                      type: string
                      example: Provo
                    state:
                      type: string
                      example: UT
                    postal_code:
                      type: string
                      example: '84604'
                    country_id:
                      type: integer
                      example: 1
                      description: Takes precedence over country_code if both are provided.
                    country_code:
                      type: string
                      example: US
                      description: >-
                        country_id takes precedence if both country_id and
                        country_code provided.
                    name:
                      type: string
                    default:
                      type: boolean
                      example: false
                      description: >-
                        Sets the address as the default address for the
                        customer; false by default
                  required:
                    - country_id
                    - city
                    - address1
                    - postal_code
                customer_notes_attributes:
                  type: array
                  items:
                    type: object
                    properties:
                      note:
                        type: string
                        description: Customer Note to be attached to the customer
                        example: Example customer note
                    required:
                      - note
                metafields_attributes:
                  type: array
                  description: Metafields for custom data storage
                  items:
                    type: object
                    properties:
                      namespace:
                        type: string
                        description: Namespace for the metafield
                      key:
                        type: string
                        description: Key for the metafield
                      value:
                        description: Value for the metafield (type depends on value_type)
                      value_type:
                        type: string
                        description: Type of the metafield value
                        enum:
                          - single_line_text_field
                          - multi_line_text_field
                          - rich_text_field
                          - number_integer
                          - number_decimal
                          - date
                          - date_time
                          - boolean
                          - json
                          - color
                          - url
                          - weight
                          - volume
                          - dimension
                          - rating
                          - money
                          - file_reference
                          - page_reference
                          - product_reference
                          - variant_reference
                          - collection_reference
                          - mixed_reference
                          - list.single_line_text_field
                          - list.number_integer
                          - list.number_decimal
                          - list.date
                          - list.date_time
                          - list.color
                          - list.url
                          - list.file_reference
                          - list.page_reference
                          - list.product_reference
                          - list.variant_reference
                          - list.collection_reference
                          - list.mixed_reference
                    required:
                      - namespace
                      - key
                      - value
                      - value_type
              required:
                - email
  /api/customers/stats:
    get:
      summary: Get customers' stats
      tags:
        - Customers
      operationId: statsOfCustomers
      security:
        - bearer_auth: []
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_customers:
                    type: integer
                  total_active_subscriptions:
                    type: integer
                  cart_abandonment_rate:
                    type:
                      - number
                      - string
                  repeat_customers_count:
                    type: integer
                  repeat_customers_rate:
                    type:
                      - number
                      - string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
  /api/customers/{id}/update_addresses:
    patch:
      summary: Add customer addresses
      tags:
        - Customers
      operationId: updateCustomerAddresses
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Customer's Id
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    type: object
                    properties:
                      id:
                        type: integer
                      account_id:
                        type: string
                      first_name:
                        type: string
                      last_name:
                        type: string
                      full_name:
                        type: string
                      email:
                        type: string
                      verified_email:
                        type: boolean
                      phone:
                        type: string
                      orders_count:
                        type: integer
                      total_spent:
                        type:
                          - number
                          - string
                      display_total_spent:
                        type: string
                      last_order_id:
                        type:
                          - integer
                          - 'null'
                      notes:
                        type:
                          - string
                          - 'null'
                      user_company_id:
                        type:
                          - integer
                          - 'null'
                      created_at:
                        type: string
                      active:
                        type: boolean
                      is_rep:
                        type: boolean
                      is_discarded:
                        type: boolean
                      external_id:
                        type:
                          - string
                          - 'null'
                      role:
                        type: string
                        example: customer
                        enum:
                          - customer
                          - preferred_customer
                          - rep
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      default_address:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      addresses:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            name:
                              type:
                                - string
                                - 'null'
                              example: John Doe
                            first_name:
                              type:
                                - string
                                - 'null'
                              example: John
                            last_name:
                              type:
                                - string
                                - 'null'
                              example: Doe
                            address1:
                              type: string
                              example: 123 Main St
                            address2:
                              type:
                                - string
                                - 'null'
                              example: Apt 4B
                            address3:
                              type:
                                - string
                                - 'null'
                              example: Building 5
                            city:
                              type: string
                              example: New York
                            state:
                              type: string
                              example: NY
                            postal_code:
                              type: string
                              example: '10001'
                            country_code:
                              type: string
                              example: US
                              description: >-
                                country_id takes precedence if both country_id
                                and country_code provided.
                            subdivision_code:
                              type:
                                - string
                                - 'null'
                              example: NY
                            default:
                              type: boolean
                              example: true
                      payment_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 967023914
                            company_id:
                              type: integer
                              example: 96778814
                            created_at:
                              type: string
                              example: '2025-11-11T04:59:05Z'
                            logo_url:
                              type:
                                - string
                                - 'null'
                              example: >-
                                https://assets.fluid.app/images/payment_icons/visa.svg
                            payload:
                              type: object
                              example:
                                exp_year: '2030'
                                card_type: visa
                                exp_month: '01'
                                card_last_four: '1234'
                                token_provider: spreedly
                            source:
                              type: string
                              example: card
                            updated_at:
                              type: string
                              example: '2025-11-11T04:59:05Z'
                            user_id:
                              type:
                                - integer
                                - 'null'
                              example: null
                      customer_notes:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            customer_id:
                              type: integer
                            user_company_id:
                              type:
                                - integer
                                - 'null'
                            note:
                              type: string
                            resource_type:
                              type:
                                - string
                                - 'null'
                            resource_id:
                              type:
                                - integer
                                - 'null'
                            created_at:
                              type: string
                      active_subscriptions_count:
                        type: integer
                      inactive_subscriptions_count:
                        type: integer
                      jwt:
                        type: string
                      metafields:
                        type: array
                        items:
                          title: LegacyMetafield
                          type: object
                          properties:
                            id:
                              type: integer
                            namespace:
                              description: >-
                                A container for related metafields. Commonly
                                used to group metafields by app or
                                functionality.
                              example: custom
                              type: string
                              maxLength: 20
                              pattern: ^[a-zA-Z0-9_]+$
                            key:
                              description: >-
                                The unique identifier for the metafield within
                                its namespace. Must be unique per namespace and
                                owner.
                              example: material
                              type: string
                              maxLength: 30
                              pattern: ^[a-zA-Z0-9_]+$
                            value:
                              description: >-
                                The actual data stored in the metafield. Type
                                depends on value_type.
                              example: cotton
                              type:
                                - string
                                - object
                            value_type:
                              description: >-
                                The data type that defines how the value should
                                be interpreted and validated.
                              example: single_line_text_field
                              type: string
                            description:
                              description: >-
                                Optional human-readable description explaining
                                the purpose of this metafield.
                              example: The primary material used in this product
                              type:
                                - string
                                - 'null'
                            owner_type:
                              description: >-
                                The type of resource that this metafield belongs
                                to (polymorphic association).
                              example: Product
                              type: string
                            owner_id:
                              description: >-
                                The ID of the specific resource that this
                                metafield belongs to.
                              example: 12345
                              type: integer
                            created_at:
                              description: Timestamp when the metafield was created.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            updated_at:
                              description: Timestamp when the metafield was last updated.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            metafield_definition:
                              title: MetafieldDefinition
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                company_id:
                                  description: >-
                                    The ID of the company that owns this
                                    metafield definition.
                                  example: 1
                                  type: integer
                                namespace:
                                  description: >-
                                    A container for related metafield
                                    definitions. Used to group definitions by
                                    app or functionality. Must be unique within
                                    company and owner_resource.
                                  example: product_details
                                  type: string
                                  maxLength: 20
                                  pattern: ^[a-zA-Z0-9_]+$
                                key:
                                  description: >-
                                    The unique identifier for the metafield
                                    definition within its namespace and
                                    owner_resource. Combined with namespace and
                                    owner_resource, this must be unique per
                                    company.
                                  example: material_type
                                  type: string
                                  maxLength: 30
                                  pattern: ^[a-zA-Z0-9_]+$
                                name:
                                  description: >-
                                    Human-readable display name for the
                                    metafield definition, shown in admin
                                    interfaces and forms.
                                  example: Material Type
                                  type: string
                                  maxLength: 100
                                description:
                                  description: >-
                                    Detailed explanation of what this metafield
                                    definition represents, how it should be
                                    used, and any special instructions for
                                    content creators.
                                  example: >-
                                    Specify the primary material composition of
                                    the product (e.g., cotton, polyester, silk).
                                    This will be displayed on the product detail
                                    page.
                                  type:
                                    - string
                                    - 'null'
                                value_type:
                                  description: >-
                                    The data type that defines how metafield
                                    values should be validated, stored, and
                                    displayed. Determines which validation rules
                                    are available.
                                  example: single_line_text_field
                                  type: string
                                validation_rules:
                                  description: >-
                                    JSON object containing validation
                                    constraints that will be applied to
                                    metafield values. Available rules depend on
                                    the value_type.
                                  example:
                                    choices:
                                      - cotton
                                      - polyester
                                      - silk
                                      - wool
                                      - linen
                                      - bamboo
                                    max: 50
                                    min: 2
                                  type:
                                    - object
                                    - 'null'
                                owner_resource:
                                  description: >-
                                    The type of resource (model class name) that
                                    metafields using this definition can be
                                    attached to. Must match the polymorphic
                                    owner_type.
                                  example: Product
                                  type: string
                                pinned:
                                  description: >-
                                    Whether this definition should be
                                    prominently displayed or prioritized in
                                    admin interfaces and forms.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                position:
                                  default: 0
                                  description: >-
                                    Sort order for displaying this definition
                                    relative to others in the same category and
                                    owner_resource. Lower numbers appear first.
                                  example: 1
                                  type:
                                    - integer
                                    - 'null'
                                locked:
                                  description: >-
                                    Whether this metafield definition is locked,
                                    preventing direct updates or deletions of
                                    metafields using this definition.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                created_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    created.
                                  example: '2024-01-15T10:30:00Z'
                                  type: string
                                  format: date-time
                                updated_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    last updated.
                                  example: '2024-02-20T14:45:00Z'
                                  type: string
                                  format: date-time
                                list_type:
                                  description: >-
                                    Whether this definition is for list-type
                                    metafields that store arrays of values.
                                  example: false
                                  type: boolean
                                reference_type:
                                  description: >-
                                    Whether this definition is for
                                    reference-type metafields that store
                                    references to other resources.
                                  example: false
                                  type: boolean
                                supported_validations:
                                  description: >-
                                    Array of validation rule names that are
                                    supported for this value_type.
                                  example:
                                    - min
                                    - max
                                    - choices
                                    - regex
                                  type: array
                                validation_description:
                                  description: >-
                                    Human-readable description of what the
                                    value_type represents and its constraints.
                                  example: Single line text up to 5000 characters
                                  type: string
                                category_ids:
                                  description: >-
                                    Array of category IDs that this metafield
                                    definition is associated with for
                                    organizational purposes.
                                  example:
                                    - 1
                                    - 2
                                    - 3
                                  items:
                                    type: integer
                                  type: array
                              required:
                                - id
                                - company_id
                                - namespace
                                - key
                                - name
                                - value_type
                                - owner_resource
                                - created_at
                                - updated_at
                                - list_type
                                - reference_type
                                - supported_validations
                                - validation_description
                                - category_ids
                          required:
                            - id
                            - namespace
                            - key
                            - value
                            - value_type
                            - owner_type
                            - owner_id
                            - created_at
                            - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: unprocessable_entity
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                        example:
                          - Customer not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                required:
                  - error_message
                  - errors
                  - meta
        '422':
          description: duplicate address error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: unprocessable entity
                  errors:
                    type: object
                    properties:
                      addresses:
                        type: array
                        items:
                          type: string
                        example:
                          - Address already exists for customer
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                addresses_attributes:
                  type: object
                  properties:
                    address1:
                      type: string
                      example: 234 Northern Drive
                    address2:
                      type: string
                      example: Apt 5
                    city:
                      type: string
                      example: Provo
                    state:
                      type: string
                      example: UT
                    postal_code:
                      type: string
                      example: '84604'
                    country_id:
                      type: integer
                      example: 1
                      description: Takes precedence over country_code if both are provided.
                    country_code:
                      type: string
                      example: US
                      description: >-
                        country_id takes precedence if both country_id and
                        country_code provided.
                    name:
                      type: string
                    default:
                      type: boolean
                      example: false
                      description: >-
                        Sets the address as the default address for the
                        customer; false by default
                  required:
                    - country_id
                    - city
                    - address1
                    - postal_code
  /api/customers/{id}:
    get:
      summary: Get a customer
      tags:
        - Customers
      operationId: getCustomer
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Customer's Id
          schema:
            type: integer
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    type: object
                    properties:
                      id:
                        type: integer
                      account_id:
                        type: string
                      first_name:
                        type: string
                      last_name:
                        type: string
                      full_name:
                        type: string
                      email:
                        type: string
                      verified_email:
                        type: boolean
                      phone:
                        type: string
                      orders_count:
                        type: integer
                      total_spent:
                        type:
                          - number
                          - string
                      display_total_spent:
                        type: string
                      last_order_id:
                        type:
                          - integer
                          - 'null'
                      notes:
                        type:
                          - string
                          - 'null'
                      user_company_id:
                        type:
                          - integer
                          - 'null'
                      created_at:
                        type: string
                      active:
                        type: boolean
                      is_rep:
                        type: boolean
                      is_discarded:
                        type: boolean
                      external_id:
                        type:
                          - string
                          - 'null'
                      role:
                        type: string
                        example: customer
                        enum:
                          - customer
                          - preferred_customer
                          - rep
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      default_address:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      addresses:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            name:
                              type:
                                - string
                                - 'null'
                              example: John Doe
                            first_name:
                              type:
                                - string
                                - 'null'
                              example: John
                            last_name:
                              type:
                                - string
                                - 'null'
                              example: Doe
                            address1:
                              type: string
                              example: 123 Main St
                            address2:
                              type:
                                - string
                                - 'null'
                              example: Apt 4B
                            address3:
                              type:
                                - string
                                - 'null'
                              example: Building 5
                            city:
                              type: string
                              example: New York
                            state:
                              type: string
                              example: NY
                            postal_code:
                              type: string
                              example: '10001'
                            country_code:
                              type: string
                              example: US
                              description: >-
                                country_id takes precedence if both country_id
                                and country_code provided.
                            subdivision_code:
                              type:
                                - string
                                - 'null'
                              example: NY
                            default:
                              type: boolean
                              example: true
                      payment_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 967023914
                            company_id:
                              type: integer
                              example: 96778814
                            created_at:
                              type: string
                              example: '2025-11-11T04:59:05Z'
                            logo_url:
                              type:
                                - string
                                - 'null'
                              example: >-
                                https://assets.fluid.app/images/payment_icons/visa.svg
                            payload:
                              type: object
                              example:
                                exp_year: '2030'
                                card_type: visa
                                exp_month: '01'
                                card_last_four: '1234'
                                token_provider: spreedly
                            source:
                              type: string
                              example: card
                            updated_at:
                              type: string
                              example: '2025-11-11T04:59:05Z'
                            user_id:
                              type:
                                - integer
                                - 'null'
                              example: null
                      customer_notes:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            customer_id:
                              type: integer
                            user_company_id:
                              type:
                                - integer
                                - 'null'
                            note:
                              type: string
                            resource_type:
                              type:
                                - string
                                - 'null'
                            resource_id:
                              type:
                                - integer
                                - 'null'
                            created_at:
                              type: string
                      attributable_rep:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                          first_name:
                            type: string
                          last_name:
                            type: string
                          image_url:
                            type:
                              - string
                              - 'null'
                      points:
                        type: number
                        example: 100
                      active_subscriptions_count:
                        type: integer
                      inactive_subscriptions_count:
                        type: integer
                      sponsor:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                          first_name:
                            type: string
                          last_name:
                            type: string
                          image_url:
                            type:
                              - string
                              - 'null'
                      jwt:
                        type: string
                      metafields:
                        type: array
                        items:
                          title: LegacyMetafield
                          type: object
                          properties:
                            id:
                              type: integer
                            namespace:
                              description: >-
                                A container for related metafields. Commonly
                                used to group metafields by app or
                                functionality.
                              example: custom
                              type: string
                              maxLength: 20
                              pattern: ^[a-zA-Z0-9_]+$
                            key:
                              description: >-
                                The unique identifier for the metafield within
                                its namespace. Must be unique per namespace and
                                owner.
                              example: material
                              type: string
                              maxLength: 30
                              pattern: ^[a-zA-Z0-9_]+$
                            value:
                              description: >-
                                The actual data stored in the metafield. Type
                                depends on value_type.
                              example: cotton
                              type:
                                - string
                                - object
                            value_type:
                              description: >-
                                The data type that defines how the value should
                                be interpreted and validated.
                              example: single_line_text_field
                              type: string
                            description:
                              description: >-
                                Optional human-readable description explaining
                                the purpose of this metafield.
                              example: The primary material used in this product
                              type:
                                - string
                                - 'null'
                            owner_type:
                              description: >-
                                The type of resource that this metafield belongs
                                to (polymorphic association).
                              example: Product
                              type: string
                            owner_id:
                              description: >-
                                The ID of the specific resource that this
                                metafield belongs to.
                              example: 12345
                              type: integer
                            created_at:
                              description: Timestamp when the metafield was created.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            updated_at:
                              description: Timestamp when the metafield was last updated.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            metafield_definition:
                              title: MetafieldDefinition
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                company_id:
                                  description: >-
                                    The ID of the company that owns this
                                    metafield definition.
                                  example: 1
                                  type: integer
                                namespace:
                                  description: >-
                                    A container for related metafield
                                    definitions. Used to group definitions by
                                    app or functionality. Must be unique within
                                    company and owner_resource.
                                  example: product_details
                                  type: string
                                  maxLength: 20
                                  pattern: ^[a-zA-Z0-9_]+$
                                key:
                                  description: >-
                                    The unique identifier for the metafield
                                    definition within its namespace and
                                    owner_resource. Combined with namespace and
                                    owner_resource, this must be unique per
                                    company.
                                  example: material_type
                                  type: string
                                  maxLength: 30
                                  pattern: ^[a-zA-Z0-9_]+$
                                name:
                                  description: >-
                                    Human-readable display name for the
                                    metafield definition, shown in admin
                                    interfaces and forms.
                                  example: Material Type
                                  type: string
                                  maxLength: 100
                                description:
                                  description: >-
                                    Detailed explanation of what this metafield
                                    definition represents, how it should be
                                    used, and any special instructions for
                                    content creators.
                                  example: >-
                                    Specify the primary material composition of
                                    the product (e.g., cotton, polyester, silk).
                                    This will be displayed on the product detail
                                    page.
                                  type:
                                    - string
                                    - 'null'
                                value_type:
                                  description: >-
                                    The data type that defines how metafield
                                    values should be validated, stored, and
                                    displayed. Determines which validation rules
                                    are available.
                                  example: single_line_text_field
                                  type: string
                                validation_rules:
                                  description: >-
                                    JSON object containing validation
                                    constraints that will be applied to
                                    metafield values. Available rules depend on
                                    the value_type.
                                  example:
                                    choices:
                                      - cotton
                                      - polyester
                                      - silk
                                      - wool
                                      - linen
                                      - bamboo
                                    max: 50
                                    min: 2
                                  type:
                                    - object
                                    - 'null'
                                owner_resource:
                                  description: >-
                                    The type of resource (model class name) that
                                    metafields using this definition can be
                                    attached to. Must match the polymorphic
                                    owner_type.
                                  example: Product
                                  type: string
                                pinned:
                                  description: >-
                                    Whether this definition should be
                                    prominently displayed or prioritized in
                                    admin interfaces and forms.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                position:
                                  default: 0
                                  description: >-
                                    Sort order for displaying this definition
                                    relative to others in the same category and
                                    owner_resource. Lower numbers appear first.
                                  example: 1
                                  type:
                                    - integer
                                    - 'null'
                                locked:
                                  description: >-
                                    Whether this metafield definition is locked,
                                    preventing direct updates or deletions of
                                    metafields using this definition.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                created_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    created.
                                  example: '2024-01-15T10:30:00Z'
                                  type: string
                                  format: date-time
                                updated_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    last updated.
                                  example: '2024-02-20T14:45:00Z'
                                  type: string
                                  format: date-time
                                list_type:
                                  description: >-
                                    Whether this definition is for list-type
                                    metafields that store arrays of values.
                                  example: false
                                  type: boolean
                                reference_type:
                                  description: >-
                                    Whether this definition is for
                                    reference-type metafields that store
                                    references to other resources.
                                  example: false
                                  type: boolean
                                supported_validations:
                                  description: >-
                                    Array of validation rule names that are
                                    supported for this value_type.
                                  example:
                                    - min
                                    - max
                                    - choices
                                    - regex
                                  type: array
                                validation_description:
                                  description: >-
                                    Human-readable description of what the
                                    value_type represents and its constraints.
                                  example: Single line text up to 5000 characters
                                  type: string
                                category_ids:
                                  description: >-
                                    Array of category IDs that this metafield
                                    definition is associated with for
                                    organizational purposes.
                                  example:
                                    - 1
                                    - 2
                                    - 3
                                  items:
                                    type: integer
                                  type: array
                              required:
                                - id
                                - company_id
                                - namespace
                                - key
                                - name
                                - value_type
                                - owner_resource
                                - created_at
                                - updated_at
                                - list_type
                                - reference_type
                                - supported_validations
                                - validation_description
                                - category_ids
                          required:
                            - id
                            - namespace
                            - key
                            - value
                            - value_type
                            - owner_type
                            - owner_id
                            - created_at
                            - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: unprocessable_entity
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                        example:
                          - Customer not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
                  - meta
    patch:
      summary: Update a customer
      tags:
        - Customers
      operationId: updateCustomer
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Customer's Id
          schema:
            type: integer
      responses:
        '200':
          description: success when updating customer role
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    type: object
                    properties:
                      id:
                        type: integer
                      account_id:
                        type: string
                      first_name:
                        type: string
                      last_name:
                        type: string
                      full_name:
                        type: string
                      email:
                        type: string
                      verified_email:
                        type: boolean
                      phone:
                        type: string
                      orders_count:
                        type: integer
                      total_spent:
                        type:
                          - number
                          - string
                      display_total_spent:
                        type: string
                      last_order_id:
                        type:
                          - integer
                          - 'null'
                      notes:
                        type:
                          - string
                          - 'null'
                      user_company_id:
                        type:
                          - integer
                          - 'null'
                      created_at:
                        type: string
                      active:
                        type: boolean
                      is_rep:
                        type: boolean
                      is_discarded:
                        type: boolean
                      external_id:
                        type:
                          - string
                          - 'null'
                      role:
                        type: string
                        example: customer
                        enum:
                          - customer
                          - preferred_customer
                          - rep
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      default_address:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      addresses:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            name:
                              type:
                                - string
                                - 'null'
                              example: John Doe
                            first_name:
                              type:
                                - string
                                - 'null'
                              example: John
                            last_name:
                              type:
                                - string
                                - 'null'
                              example: Doe
                            address1:
                              type: string
                              example: 123 Main St
                            address2:
                              type:
                                - string
                                - 'null'
                              example: Apt 4B
                            address3:
                              type:
                                - string
                                - 'null'
                              example: Building 5
                            city:
                              type: string
                              example: New York
                            state:
                              type: string
                              example: NY
                            postal_code:
                              type: string
                              example: '10001'
                            country_code:
                              type: string
                              example: US
                              description: >-
                                country_id takes precedence if both country_id
                                and country_code provided.
                            subdivision_code:
                              type:
                                - string
                                - 'null'
                              example: NY
                            default:
                              type: boolean
                              example: true
                      payment_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 967023914
                            company_id:
                              type: integer
                              example: 96778814
                            created_at:
                              type: string
                              example: '2025-11-11T04:59:05Z'
                            logo_url:
                              type:
                                - string
                                - 'null'
                              example: >-
                                https://assets.fluid.app/images/payment_icons/visa.svg
                            payload:
                              type: object
                              example:
                                exp_year: '2030'
                                card_type: visa
                                exp_month: '01'
                                card_last_four: '1234'
                                token_provider: spreedly
                            source:
                              type: string
                              example: card
                            updated_at:
                              type: string
                              example: '2025-11-11T04:59:05Z'
                            user_id:
                              type:
                                - integer
                                - 'null'
                              example: null
                      customer_notes:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            customer_id:
                              type: integer
                            user_company_id:
                              type:
                                - integer
                                - 'null'
                            note:
                              type: string
                            resource_type:
                              type:
                                - string
                                - 'null'
                            resource_id:
                              type:
                                - integer
                                - 'null'
                            created_at:
                              type: string
                      active_subscriptions_count:
                        type: integer
                      inactive_subscriptions_count:
                        type: integer
                      attributable_rep:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                          first_name:
                            type: string
                          last_name:
                            type: string
                          image_url:
                            type:
                              - string
                              - 'null'
                      points:
                        type: number
                        example: 100
                      jwt:
                        type:
                          - string
                          - 'null'
                      metafields:
                        type: array
                        items:
                          title: LegacyMetafield
                          type: object
                          properties:
                            id:
                              type: integer
                            namespace:
                              description: >-
                                A container for related metafields. Commonly
                                used to group metafields by app or
                                functionality.
                              example: custom
                              type: string
                              maxLength: 20
                              pattern: ^[a-zA-Z0-9_]+$
                            key:
                              description: >-
                                The unique identifier for the metafield within
                                its namespace. Must be unique per namespace and
                                owner.
                              example: material
                              type: string
                              maxLength: 30
                              pattern: ^[a-zA-Z0-9_]+$
                            value:
                              description: >-
                                The actual data stored in the metafield. Type
                                depends on value_type.
                              example: cotton
                              type:
                                - string
                                - object
                            value_type:
                              description: >-
                                The data type that defines how the value should
                                be interpreted and validated.
                              example: single_line_text_field
                              type: string
                            description:
                              description: >-
                                Optional human-readable description explaining
                                the purpose of this metafield.
                              example: The primary material used in this product
                              type:
                                - string
                                - 'null'
                            owner_type:
                              description: >-
                                The type of resource that this metafield belongs
                                to (polymorphic association).
                              example: Product
                              type: string
                            owner_id:
                              description: >-
                                The ID of the specific resource that this
                                metafield belongs to.
                              example: 12345
                              type: integer
                            created_at:
                              description: Timestamp when the metafield was created.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            updated_at:
                              description: Timestamp when the metafield was last updated.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            metafield_definition:
                              title: MetafieldDefinition
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                company_id:
                                  description: >-
                                    The ID of the company that owns this
                                    metafield definition.
                                  example: 1
                                  type: integer
                                namespace:
                                  description: >-
                                    A container for related metafield
                                    definitions. Used to group definitions by
                                    app or functionality. Must be unique within
                                    company and owner_resource.
                                  example: product_details
                                  type: string
                                  maxLength: 20
                                  pattern: ^[a-zA-Z0-9_]+$
                                key:
                                  description: >-
                                    The unique identifier for the metafield
                                    definition within its namespace and
                                    owner_resource. Combined with namespace and
                                    owner_resource, this must be unique per
                                    company.
                                  example: material_type
                                  type: string
                                  maxLength: 30
                                  pattern: ^[a-zA-Z0-9_]+$
                                name:
                                  description: >-
                                    Human-readable display name for the
                                    metafield definition, shown in admin
                                    interfaces and forms.
                                  example: Material Type
                                  type: string
                                  maxLength: 100
                                description:
                                  description: >-
                                    Detailed explanation of what this metafield
                                    definition represents, how it should be
                                    used, and any special instructions for
                                    content creators.
                                  example: >-
                                    Specify the primary material composition of
                                    the product (e.g., cotton, polyester, silk).
                                    This will be displayed on the product detail
                                    page.
                                  type:
                                    - string
                                    - 'null'
                                value_type:
                                  description: >-
                                    The data type that defines how metafield
                                    values should be validated, stored, and
                                    displayed. Determines which validation rules
                                    are available.
                                  example: single_line_text_field
                                  type: string
                                validation_rules:
                                  description: >-
                                    JSON object containing validation
                                    constraints that will be applied to
                                    metafield values. Available rules depend on
                                    the value_type.
                                  example:
                                    choices:
                                      - cotton
                                      - polyester
                                      - silk
                                      - wool
                                      - linen
                                      - bamboo
                                    max: 50
                                    min: 2
                                  type:
                                    - object
                                    - 'null'
                                owner_resource:
                                  description: >-
                                    The type of resource (model class name) that
                                    metafields using this definition can be
                                    attached to. Must match the polymorphic
                                    owner_type.
                                  example: Product
                                  type: string
                                pinned:
                                  description: >-
                                    Whether this definition should be
                                    prominently displayed or prioritized in
                                    admin interfaces and forms.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                position:
                                  default: 0
                                  description: >-
                                    Sort order for displaying this definition
                                    relative to others in the same category and
                                    owner_resource. Lower numbers appear first.
                                  example: 1
                                  type:
                                    - integer
                                    - 'null'
                                locked:
                                  description: >-
                                    Whether this metafield definition is locked,
                                    preventing direct updates or deletions of
                                    metafields using this definition.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                created_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    created.
                                  example: '2024-01-15T10:30:00Z'
                                  type: string
                                  format: date-time
                                updated_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    last updated.
                                  example: '2024-02-20T14:45:00Z'
                                  type: string
                                  format: date-time
                                list_type:
                                  description: >-
                                    Whether this definition is for list-type
                                    metafields that store arrays of values.
                                  example: false
                                  type: boolean
                                reference_type:
                                  description: >-
                                    Whether this definition is for
                                    reference-type metafields that store
                                    references to other resources.
                                  example: false
                                  type: boolean
                                supported_validations:
                                  description: >-
                                    Array of validation rule names that are
                                    supported for this value_type.
                                  example:
                                    - min
                                    - max
                                    - choices
                                    - regex
                                  type: array
                                validation_description:
                                  description: >-
                                    Human-readable description of what the
                                    value_type represents and its constraints.
                                  example: Single line text up to 5000 characters
                                  type: string
                                category_ids:
                                  description: >-
                                    Array of category IDs that this metafield
                                    definition is associated with for
                                    organizational purposes.
                                  example:
                                    - 1
                                    - 2
                                    - 3
                                  items:
                                    type: integer
                                  type: array
                              required:
                                - id
                                - company_id
                                - namespace
                                - key
                                - name
                                - value_type
                                - owner_resource
                                - created_at
                                - updated_at
                                - list_type
                                - reference_type
                                - supported_validations
                                - validation_description
                                - category_ids
                          required:
                            - id
                            - namespace
                            - key
                            - value
                            - value_type
                            - owner_type
                            - owner_id
                            - created_at
                            - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: unprocessable_entity
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                        example:
                          - Customer not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                first_name:
                  type: string
                  example: John
                  description: First name of customer
                last_name:
                  type: string
                  example: Nash
                  description: Last name of customer
                email:
                  type: string
                  example: john.nash@example.com
                  description: Email of customer
                phone:
                  type: string
                  example: 801-000-0000
                  description: Phone number of customer
                account_id:
                  type: string
                  example: VKHJSGHOHSOIZQCK
                  description: >-
                    A unique Account Id for customer. If empty, one is generated
                    by the system
                external_id:
                  type: string
                  example: '1234567890'
                  description: >-
                    A unique External Id for customer that is used to identify
                    them in external systems
                notes:
                  type: string
                  example: Note
                  description: Note for customer
                metadata:
                  type: object
                  description: >-
                    A JSON object that can store any custom data structure. When
                    provided, replaces all existing metadata data.
                default_address_attributes:
                  type: object
                  properties:
                    address1:
                      type: string
                      example: 234 Northern Drive
                    address2:
                      type: string
                      example: Apt 5
                    city:
                      type: string
                      example: Provo
                    state:
                      type: string
                      example: UT
                    postal_code:
                      type: string
                      example: '84604'
                    country_id:
                      type: integer
                      example: 1
                      description: Takes precedence over country_code if both are provided.
                    country_code:
                      type: string
                      example: US
                      description: >-
                        country_id takes precedence if both country_id and
                        country_code provided.
                    name:
                      type: string
                    default:
                      type: boolean
                      example: false
                      description: >-
                        Sets the address as the default address for the
                        customer; false by default
                  required:
                    - country_id
                    - city
                    - address1
                    - postal_code
                customer_notes_attributes:
                  type: array
                  items:
                    type: object
                    properties:
                      note:
                        type: string
                        description: Customer Note to be attached to the customer
                        example: Example customer note
                    required:
                      - note
                metafields_attributes:
                  type: array
                  description: Metafields for custom data storage
                  items:
                    type: object
                    properties:
                      id:
                        type: integer
                        description: Metafield ID (for updates)
                      namespace:
                        type: string
                        description: Namespace for the metafield
                      key:
                        type: string
                        description: Key for the metafield
                      value:
                        description: Value for the metafield (type depends on value_type)
                      value_type:
                        type: string
                        description: Type of the metafield value
                        enum:
                          - single_line_text_field
                          - multi_line_text_field
                          - rich_text_field
                          - number_integer
                          - number_decimal
                          - date
                          - date_time
                          - boolean
                          - json
                          - color
                          - url
                          - weight
                          - volume
                          - dimension
                          - rating
                          - money
                          - file_reference
                          - page_reference
                          - product_reference
                          - variant_reference
                          - collection_reference
                          - mixed_reference
                          - list.single_line_text_field
                          - list.number_integer
                          - list.number_decimal
                          - list.date
                          - list.date_time
                          - list.color
                          - list.url
                          - list.file_reference
                          - list.page_reference
                          - list.product_reference
                          - list.variant_reference
                          - list.collection_reference
                          - list.mixed_reference
                      _destroy:
                        type: boolean
                        description: Mark for deletion
    delete:
      summary: Delete a customer
      tags:
        - Customers
      operationId: deleteCustomer
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Customer's Id
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: unprocessable_entity
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                        example:
                          - Customer not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
                  - meta
  /api/customers/bulk_delete:
    delete:
      summary: Bulk delete customers
      tags:
        - Customers
      operationId: bulkDeleteCustomers
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer_ids:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                example:
                  customer_ids:
                    - id: 1
                    - id: 2
                    - id: 3
                  meta:
                    request_id: f5473a8c-8a86-4e0e-b3e8-95392003921b
                    timestamp: '2024-12-10T08:04:10Z'
        '422':
          description: invalid customer_ids
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      customer_ids:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                customer_ids:
                  type: array
                  items:
                    type: integer
                  example:
                    - 1
                    - 2
                    - 3
                  description: Array of customer IDs to delete
              required:
                - customer_ids
  /api/customers/presigned_csv_url:
    post:
      summary: Generate a signed URL to upload csv for bulk importing customers
      description: >-
        Generate signed URL to allow users without credentials to perform upload
        (time-limited access to Cloud Storage)
      tags:
        - Customers
      operationId: getPresignedCsvUrlForCustomersImport
      security:
        - bearer_auth: []
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  url:
                    type: string
                    example: https://path/to/file/sth.csv
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - url
        '400':
          description: error
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: fail
                  data:
                    type: object
                    properties:
                      error:
                        type: string
                required:
                  - status
  /api/customers/import_csv:
    post:
      summary: Import customers via csv file in the url
      tags:
        - Customers
      operationId: importCustomersViaCSV
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  created:
                    type: integer
                    example: 10
                  failed:
                    type: integer
                    example: 2
                  invalid_rows:
                    type: integer
                    example: 1
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - created
                  - failed
                  - invalid_rows
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: unprocessable_entity
                  errors:
                    type: object
                    properties:
                      import:
                        type: string
                        example: Bad Request
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  example: https://example.com/path/to/csv
              required:
                - url
  /api/customers/export_csv:
    post:
      summary: Export customers data in a CSV file
      description: Export customers data in a CSV file
      tags:
        - Customers
      operationId: exportCustomersinCSV
      security:
        - bearer_auth: []
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  url:
                    type: string
                    example: https://fake-url.com/file.csv
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - url
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: unprocessable_entity
                  errors:
                    type: object
                    properties:
                      export:
                        type: string
                        example: Bad Request
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
                  - meta
  /api/customers/{id}/append_metadata:
    patch:
      summary: Append metadata field
      tags:
        - Customers
      operationId: customerAppendMetadataField
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Customer's Id
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    type: object
                    properties:
                      id:
                        type: integer
                      account_id:
                        type: string
                      first_name:
                        type: string
                      last_name:
                        type: string
                      full_name:
                        type: string
                      email:
                        type: string
                      verified_email:
                        type: boolean
                      phone:
                        type: string
                      orders_count:
                        type: integer
                      total_spent:
                        type:
                          - number
                          - string
                      display_total_spent:
                        type: string
                      last_order_id:
                        type:
                          - integer
                          - 'null'
                      notes:
                        type:
                          - string
                          - 'null'
                      user_company_id:
                        type:
                          - integer
                          - 'null'
                      created_at:
                        type: string
                      active:
                        type: boolean
                      is_rep:
                        type: boolean
                      is_discarded:
                        type: boolean
                      external_id:
                        type:
                          - string
                          - 'null'
                      role:
                        type: string
                        example: customer
                        enum:
                          - customer
                          - preferred_customer
                          - rep
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      default_address:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      addresses:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            name:
                              type:
                                - string
                                - 'null'
                              example: John Doe
                            first_name:
                              type:
                                - string
                                - 'null'
                              example: John
                            last_name:
                              type:
                                - string
                                - 'null'
                              example: Doe
                            address1:
                              type: string
                              example: 123 Main St
                            address2:
                              type:
                                - string
                                - 'null'
                              example: Apt 4B
                            address3:
                              type:
                                - string
                                - 'null'
                              example: Building 5
                            city:
                              type: string
                              example: New York
                            state:
                              type: string
                              example: NY
                            postal_code:
                              type: string
                              example: '10001'
                            country_code:
                              type: string
                              example: US
                              description: >-
                                country_id takes precedence if both country_id
                                and country_code provided.
                            subdivision_code:
                              type:
                                - string
                                - 'null'
                              example: NY
                            default:
                              type: boolean
                              example: true
                      payment_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 967023914
                            company_id:
                              type: integer
                              example: 96778814
                            created_at:
                              type: string
                              example: '2025-11-11T04:59:05Z'
                            logo_url:
                              type:
                                - string
                                - 'null'
                              example: >-
                                https://assets.fluid.app/images/payment_icons/visa.svg
                            payload:
                              type: object
                              example:
                                exp_year: '2030'
                                card_type: visa
                                exp_month: '01'
                                card_last_four: '1234'
                                token_provider: spreedly
                            source:
                              type: string
                              example: card
                            updated_at:
                              type: string
                              example: '2025-11-11T04:59:05Z'
                            user_id:
                              type:
                                - integer
                                - 'null'
                              example: null
                      customer_notes:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            customer_id:
                              type: integer
                            user_company_id:
                              type:
                                - integer
                                - 'null'
                            note:
                              type: string
                            resource_type:
                              type:
                                - string
                                - 'null'
                            resource_id:
                              type:
                                - integer
                                - 'null'
                            created_at:
                              type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                        example:
                          - Customer not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                metadata:
                  type: object
                  description: >-
                    A JSON object that can store any custom data structure. When
                    provided, merges with existing metadata data.
              required:
                - metadata
  /api/customers/{id}/update_attributable_rep:
    patch:
      summary: Update attributable rep for customer
      tags:
        - Customers
      operationId: updateAttributableRep
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Customer's Id
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    type: object
                    properties:
                      id:
                        type: integer
                      account_id:
                        type: string
                      first_name:
                        type: string
                      last_name:
                        type: string
                      full_name:
                        type: string
                      email:
                        type: string
                      verified_email:
                        type: boolean
                      phone:
                        type: string
                      orders_count:
                        type: integer
                      total_spent:
                        type:
                          - number
                          - string
                      display_total_spent:
                        type: string
                      last_order_id:
                        type:
                          - integer
                          - 'null'
                      notes:
                        type:
                          - string
                          - 'null'
                      user_company_id:
                        type:
                          - integer
                          - 'null'
                      created_at:
                        type: string
                      active:
                        type: boolean
                      is_rep:
                        type: boolean
                      is_discarded:
                        type: boolean
                      external_id:
                        type:
                          - string
                          - 'null'
                      role:
                        type: string
                        example: customer
                        enum:
                          - customer
                          - preferred_customer
                          - rep
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      default_address:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      addresses:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            name:
                              type:
                                - string
                                - 'null'
                              example: John Doe
                            first_name:
                              type:
                                - string
                                - 'null'
                              example: John
                            last_name:
                              type:
                                - string
                                - 'null'
                              example: Doe
                            address1:
                              type: string
                              example: 123 Main St
                            address2:
                              type:
                                - string
                                - 'null'
                              example: Apt 4B
                            address3:
                              type:
                                - string
                                - 'null'
                              example: Building 5
                            city:
                              type: string
                              example: New York
                            state:
                              type: string
                              example: NY
                            postal_code:
                              type: string
                              example: '10001'
                            country_code:
                              type: string
                              example: US
                              description: >-
                                country_id takes precedence if both country_id
                                and country_code provided.
                            subdivision_code:
                              type:
                                - string
                                - 'null'
                              example: NY
                            default:
                              type: boolean
                              example: true
                      payment_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 967023914
                            company_id:
                              type: integer
                              example: 96778814
                            created_at:
                              type: string
                              example: '2025-11-11T04:59:05Z'
                            logo_url:
                              type:
                                - string
                                - 'null'
                              example: >-
                                https://assets.fluid.app/images/payment_icons/visa.svg
                            payload:
                              type: object
                              example:
                                exp_year: '2030'
                                card_type: visa
                                exp_month: '01'
                                card_last_four: '1234'
                                token_provider: spreedly
                            source:
                              type: string
                              example: card
                            updated_at:
                              type: string
                              example: '2025-11-11T04:59:05Z'
                            user_id:
                              type:
                                - integer
                                - 'null'
                              example: null
                      customer_notes:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            customer_id:
                              type: integer
                            user_company_id:
                              type:
                                - integer
                                - 'null'
                            note:
                              type: string
                            resource_type:
                              type:
                                - string
                                - 'null'
                            resource_id:
                              type:
                                - integer
                                - 'null'
                            created_at:
                              type: string
                      attributable_rep:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                          first_name:
                            type: string
                          last_name:
                            type: string
                          image_url:
                            type:
                              - string
                              - 'null'
                      points:
                        type: number
                        example: 100
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: user company not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                        example:
                          - Rep not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                customer:
                  type: object
                  properties:
                    user_company_id:
                      type: integer
                      example: 1
                      description: ID of the user company to be set as attributable rep
                  required:
                    - user_company_id
              required:
                - customer
  /api/customers/{customer_id}/address/{address_id}:
    patch:
      summary: Update specific fields of customer address
      tags:
        - Customers
      operationId: updateCustomerAddress
      security:
        - bearer_auth: []
      parameters:
        - name: customer_id
          in: path
          required: true
          description: Customer's Id
          schema:
            type: integer
        - name: address_id
          in: path
          required: true
          description: Address Id
          schema:
            type: integer
      responses:
        '200':
          description: success when updating address without changing default
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    type: object
                    properties:
                      id:
                        type: integer
                      account_id:
                        type: string
                      first_name:
                        type: string
                      last_name:
                        type: string
                      full_name:
                        type: string
                      email:
                        type: string
                      verified_email:
                        type: boolean
                      phone:
                        type: string
                      orders_count:
                        type: integer
                      total_spent:
                        type:
                          - number
                          - string
                      display_total_spent:
                        type: string
                      last_order_id:
                        type:
                          - integer
                          - 'null'
                      notes:
                        type:
                          - string
                          - 'null'
                      user_company_id:
                        type:
                          - integer
                          - 'null'
                      created_at:
                        type: string
                      active:
                        type: boolean
                      is_rep:
                        type: boolean
                      is_discarded:
                        type: boolean
                      external_id:
                        type:
                          - string
                          - 'null'
                      role:
                        type: string
                        example: customer
                        enum:
                          - customer
                          - preferred_customer
                          - rep
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      default_address:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      addresses:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            name:
                              type:
                                - string
                                - 'null'
                              example: John Doe
                            first_name:
                              type:
                                - string
                                - 'null'
                              example: John
                            last_name:
                              type:
                                - string
                                - 'null'
                              example: Doe
                            address1:
                              type: string
                              example: 123 Main St
                            address2:
                              type:
                                - string
                                - 'null'
                              example: Apt 4B
                            address3:
                              type:
                                - string
                                - 'null'
                              example: Building 5
                            city:
                              type: string
                              example: New York
                            state:
                              type: string
                              example: NY
                            postal_code:
                              type: string
                              example: '10001'
                            country_code:
                              type: string
                              example: US
                              description: >-
                                country_id takes precedence if both country_id
                                and country_code provided.
                            subdivision_code:
                              type:
                                - string
                                - 'null'
                              example: NY
                            default:
                              type: boolean
                              example: true
                      payment_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 967023914
                            company_id:
                              type: integer
                              example: 96778814
                            created_at:
                              type: string
                              example: '2025-11-11T04:59:05Z'
                            logo_url:
                              type:
                                - string
                                - 'null'
                              example: >-
                                https://assets.fluid.app/images/payment_icons/visa.svg
                            payload:
                              type: object
                              example:
                                exp_year: '2030'
                                card_type: visa
                                exp_month: '01'
                                card_last_four: '1234'
                                token_provider: spreedly
                            source:
                              type: string
                              example: card
                            updated_at:
                              type: string
                              example: '2025-11-11T04:59:05Z'
                            user_id:
                              type:
                                - integer
                                - 'null'
                              example: null
                      customer_notes:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            customer_id:
                              type: integer
                            user_company_id:
                              type:
                                - integer
                                - 'null'
                            note:
                              type: string
                            resource_type:
                              type:
                                - string
                                - 'null'
                            resource_id:
                              type:
                                - integer
                                - 'null'
                            created_at:
                              type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: address not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not_found
                  errors:
                    type: object
                    properties:
                      customer:
                        type: array
                        example:
                          - Resource not found.
                      address_id:
                        type: array
                        items:
                          type: string
                        example:
                          - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
                  - meta
        '422':
          description: address update fails due to database error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Something went wrong. Please try again later.
                  errors:
                    type: object
                    properties:
                      address_id:
                        type: array
                        items:
                          type: string
                        example:
                          - Address and Customer doesn't match.
                      base:
                        type: array
                        items:
                          type: string
                        example:
                          - 'Database error: violates foreign key constraint'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                customer:
                  type: object
                  properties:
                    address_details:
                      type: object
                      properties:
                        address1:
                          type: string
                          example: 234 Northern Drive
                        address2:
                          type: string
                          example: Apt 5
                        city:
                          type: string
                          example: Provo
                        state:
                          type: string
                          example: UT
                        postal_code:
                          type: string
                          example: '84604'
                        country_id:
                          type: integer
                          example: 1
                          description: >-
                            Takes precedence over country_code if both are
                            provided.
                        country_code:
                          type: string
                          example: US
                          description: >-
                            country_id takes precedence if both country_id and
                            country_code provided.
                        name:
                          type: string
                        default:
                          type: boolean
                          example: false
                          description: >-
                            Sets the address as the default address for the
                            customer; false by default
                  required:
                    - address_details
              required:
                - customer
    delete:
      summary: Delete customer address
      tags:
        - Customers
      operationId: deleteCustomerAddress
      security:
        - bearer_auth: []
      parameters:
        - name: customer_id
          in: path
          required: true
          description: Customer's Id
          schema:
            type: integer
        - name: address_id
          in: path
          required: true
          description: Address Id to delete
          schema:
            type: integer
      responses:
        '200':
          description: default address successfully deleted
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    type: object
                    properties:
                      id:
                        type: integer
                      account_id:
                        type: string
                      first_name:
                        type: string
                      last_name:
                        type: string
                      full_name:
                        type: string
                      email:
                        type: string
                      verified_email:
                        type: boolean
                      phone:
                        type: string
                      orders_count:
                        type: integer
                      total_spent:
                        type:
                          - number
                          - string
                      display_total_spent:
                        type: string
                      last_order_id:
                        type:
                          - integer
                          - 'null'
                      notes:
                        type:
                          - string
                          - 'null'
                      user_company_id:
                        type:
                          - integer
                          - 'null'
                      created_at:
                        type: string
                      active:
                        type: boolean
                      is_rep:
                        type: boolean
                      is_discarded:
                        type: boolean
                      external_id:
                        type:
                          - string
                          - 'null'
                      role:
                        type: string
                        example: customer
                        enum:
                          - customer
                          - preferred_customer
                          - rep
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      default_address:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      addresses:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            name:
                              type:
                                - string
                                - 'null'
                              example: John Doe
                            first_name:
                              type:
                                - string
                                - 'null'
                              example: John
                            last_name:
                              type:
                                - string
                                - 'null'
                              example: Doe
                            address1:
                              type: string
                              example: 123 Main St
                            address2:
                              type:
                                - string
                                - 'null'
                              example: Apt 4B
                            address3:
                              type:
                                - string
                                - 'null'
                              example: Building 5
                            city:
                              type: string
                              example: New York
                            state:
                              type: string
                              example: NY
                            postal_code:
                              type: string
                              example: '10001'
                            country_code:
                              type: string
                              example: US
                              description: >-
                                country_id takes precedence if both country_id
                                and country_code provided.
                            subdivision_code:
                              type:
                                - string
                                - 'null'
                              example: NY
                            default:
                              type: boolean
                              example: true
                      payment_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 967023914
                            company_id:
                              type: integer
                              example: 96778814
                            created_at:
                              type: string
                              example: '2025-11-11T04:59:05Z'
                            logo_url:
                              type:
                                - string
                                - 'null'
                              example: >-
                                https://assets.fluid.app/images/payment_icons/visa.svg
                            payload:
                              type: object
                              example:
                                exp_year: '2030'
                                card_type: visa
                                exp_month: '01'
                                card_last_four: '1234'
                                token_provider: spreedly
                            source:
                              type: string
                              example: card
                            updated_at:
                              type: string
                              example: '2025-11-11T04:59:05Z'
                            user_id:
                              type:
                                - integer
                                - 'null'
                              example: null
                      customer_notes:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            customer_id:
                              type: integer
                            user_company_id:
                              type:
                                - integer
                                - 'null'
                            note:
                              type: string
                            resource_type:
                              type:
                                - string
                                - 'null'
                            resource_id:
                              type:
                                - integer
                                - 'null'
                            created_at:
                              type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: address not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not_found
                  errors:
                    type: object
                    properties:
                      customer:
                        type: array
                        items:
                          type: string
                        example:
                          - not found
                      address_id:
                        type: array
                        items:
                          type: string
                        example:
                          - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
                  - meta
        '422':
          description: address does not belong to customer
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: unprocessable_entity
                  errors:
                    type: object
                    properties:
                      address_id:
                        type: array
                        items:
                          type: string
                        example:
                          - Address and Customer doesn't match.
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
                  - meta
  /api/customers/{customer_id}/address/{address_id}/default:
    patch:
      summary: Set default address for customer
      tags:
        - Customers
      operationId: setDefaultAddressForCustomer
      security:
        - bearer_auth: []
      parameters:
        - name: customer_id
          in: path
          required: true
          description: Customer's Id
          schema:
            type: integer
        - name: address_id
          in: path
          required: true
          description: Address Id to set as default
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  customer:
                    type: object
                    properties:
                      id:
                        type: integer
                      account_id:
                        type: string
                      first_name:
                        type: string
                      last_name:
                        type: string
                      full_name:
                        type: string
                      email:
                        type: string
                      verified_email:
                        type: boolean
                      phone:
                        type: string
                      orders_count:
                        type: integer
                      total_spent:
                        type:
                          - number
                          - string
                      display_total_spent:
                        type: string
                      last_order_id:
                        type:
                          - integer
                          - 'null'
                      notes:
                        type:
                          - string
                          - 'null'
                      user_company_id:
                        type:
                          - integer
                          - 'null'
                      created_at:
                        type: string
                      active:
                        type: boolean
                      is_rep:
                        type: boolean
                      is_discarded:
                        type: boolean
                      external_id:
                        type:
                          - string
                          - 'null'
                      role:
                        type: string
                        example: customer
                        enum:
                          - customer
                          - preferred_customer
                          - rep
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      default_address:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      addresses:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            name:
                              type:
                                - string
                                - 'null'
                              example: John Doe
                            first_name:
                              type:
                                - string
                                - 'null'
                              example: John
                            last_name:
                              type:
                                - string
                                - 'null'
                              example: Doe
                            address1:
                              type: string
                              example: 123 Main St
                            address2:
                              type:
                                - string
                                - 'null'
                              example: Apt 4B
                            address3:
                              type:
                                - string
                                - 'null'
                              example: Building 5
                            city:
                              type: string
                              example: New York
                            state:
                              type: string
                              example: NY
                            postal_code:
                              type: string
                              example: '10001'
                            country_code:
                              type: string
                              example: US
                              description: >-
                                country_id takes precedence if both country_id
                                and country_code provided.
                            subdivision_code:
                              type:
                                - string
                                - 'null'
                              example: NY
                            default:
                              type: boolean
                              example: true
                      payment_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 967023914
                            company_id:
                              type: integer
                              example: 96778814
                            created_at:
                              type: string
                              example: '2025-11-11T04:59:05Z'
                            logo_url:
                              type:
                                - string
                                - 'null'
                              example: >-
                                https://assets.fluid.app/images/payment_icons/visa.svg
                            payload:
                              type: object
                              example:
                                exp_year: '2030'
                                card_type: visa
                                exp_month: '01'
                                card_last_four: '1234'
                                token_provider: spreedly
                            source:
                              type: string
                              example: card
                            updated_at:
                              type: string
                              example: '2025-11-11T04:59:05Z'
                            user_id:
                              type:
                                - integer
                                - 'null'
                              example: null
                      customer_notes:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            customer_id:
                              type: integer
                            user_company_id:
                              type:
                                - integer
                                - 'null'
                            note:
                              type: string
                            resource_type:
                              type:
                                - string
                                - 'null'
                            resource_id:
                              type:
                                - integer
                                - 'null'
                            created_at:
                              type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: address not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    properties:
                      customer:
                        type: array
                        items:
                          type: string
                        example:
                          - Resource not found.
                      address_id:
                        type: array
                        items:
                          type: string
                        example:
                          - Address not found.
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
                  - meta
        '422':
          description: address not associated with customer
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: unprocessable entity
                  errors:
                    type: object
                    properties:
                      address_id:
                        type: array
                        items:
                          type: string
                        example:
                          - Address and Customer doesn't match.
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
                  - meta
  /api/dam/query:
    post:
      summary: Query DAM assets using tree paths and tags
      tags:
        - DAM
      description: >-
        Searches and retrieves DAM assets using tree path pattern matching,
        tag-based variant filtering, wildcard name matching, and partial search
      operationId: queryDamAssets
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: Empty results for nonexistent path
          content:
            application/json:
              schema:
                type: object
                properties:
                  path:
                    type: string
                    description: The path pattern that was queried
                  tree:
                    type: object
                    description: Nested tree structure of assets organized by path segments
                    additionalProperties: true
                    example:
                      homepage:
                        hero:
                          logo:
                            asset_code: ACMELG
                            name: Logo
                            category: images
                            variants:
                              - id: 2d6a4930-4df3-412d-8ff0-b23e34043e30
                                file_name: acme_logo.png
                                mime_type: image/png
                                default: true
                                tags:
                                  - en-us
                                url: https://test.example.com/acme_logo.png
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - path
                  - tree
                  - meta
        '400':
          description: Too many tags provided
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                path:
                  type: string
                  description: Required tree path pattern for hierarchical filtering
                  example: homepage.*
                tags_string:
                  type: string
                  description: >-
                    Optional comma/semicolon-separated tag string for variant
                    filtering. Comma = OR, Semicolon = AND
                  example: en,en-us;logo
                name:
                  type: string
                  description: Optional asset name with wildcard support
                  example: '*logo*'
                search:
                  type: string
                  description: >-
                    Optional partial search across asset names and descriptions
                    (case-insensitive)
                  example: marketing
              required:
                - path
        required: true
  /api/dam/assets/{code}/asset_paths:
    get:
      summary: Lists asset paths for an existing asset
      tags:
        - DAM
      operationId: getDamAssetPaths
      security:
        - bearer_auth: []
      parameters:
        - name: code
          in: path
          required: true
          description: Asset code
          schema:
            type: string
      responses:
        '200':
          description: asset paths retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  asset_paths:
                    type: array
                    items:
                      title: Dam::AssetPath
                      type: object
                      properties:
                        id:
                          type: integer
                        path:
                          description: The tree path for the asset
                          example: homepage.hero.logo
                          type: string
                        created_at:
                          description: >-
                            The date and time the asset path was created in ISO
                            8601 format
                          type: string
                          format: date-time
                        updated_at:
                          description: >-
                            The date and time the asset path was last updated in
                            ISO 8601 format
                          type: string
                          format: date-time
                        canonical:
                          description: Whether this is the canonical path for the asset
                          type: boolean
                      required:
                        - id
                        - path
                        - created_at
                        - updated_at
                        - canonical
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '404':
          description: asset not found
    post:
      summary: Creates asset paths for an existing asset
      tags:
        - DAM
      operationId: createDamAssetPaths
      security:
        - bearer_auth: []
      parameters:
        - name: code
          in: path
          required: true
          description: Asset code
          schema:
            type: string
      responses:
        '201':
          description: mixed valid and invalid paths
        '404':
          description: asset not found
        '422':
          description: unprocessable entity
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                asset_paths:
                  type: array
                  items:
                    type: string
                  description: Array of tree paths to create
                  example:
                    - homepage.hero.logo
                    - product.gallery.main
              required:
                - asset_paths
  /api/dam/assets/{code}/asset_paths/{id}:
    delete:
      summary: Destroys an asset path
      tags:
        - DAM
      operationId: destroyDamAssetPath
      security:
        - bearer_auth: []
      parameters:
        - name: code
          in: path
          required: true
          description: Asset code
          schema:
            type: string
        - name: id
          in: path
          required: true
          description: Asset path ID
          schema:
            type: integer
      responses:
        '200':
          description: asset path destroyed
        '404':
          description: asset not found
        '422':
          description: canonical asset path cannot be destroyed
  /api/dam/assets/backfill_imagekit:
    post:
      summary: Creates a DAM asset from ImageKit upload metadata
      tags:
        - DAM
      operationId: createDamBackfillImagekit
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: asset backfilled successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  asset:
                    type: object
                    properties:
                      id:
                        type: integer
                      code:
                        description: A unique, human-readable identifier for the asset
                        example: ABC789
                        type: string
                      name:
                        description: The name of the asset
                        type: string
                        pattern: ^[\w\s.-]+$
                      description:
                        description: A description of the asset
                        type:
                          - string
                          - 'null'
                      category:
                        description: The file category of the asset
                        type: string
                        enum:
                          - images
                          - videos
                          - audio
                          - text
                          - documents
                          - other
                      created_at:
                        description: >-
                          The date and time the asset was created in ISO 8601
                          format
                        type: string
                        format: date-time
                      updated_at:
                        description: >-
                          The date and time the asset was last updated in ISO
                          8601 format
                        type: string
                        format: date-time
                      default_variant_id:
                        description: The ID of the default variant
                        type:
                          - string
                          - 'null'
                      canonical_path:
                        type: string
                      company:
                        type: string
                      default_variant_url:
                        type:
                          - string
                          - 'null'
                    title: Dam::Asset
                    required:
                      - id
                      - code
                      - name
                      - category
                      - created_at
                      - updated_at
                      - canonical_path
                      - company
                      - default_variant_url
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '409':
          description: duplicate ImageKit file ID
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      asset:
                        type: object
                        properties:
                          imagekit_file_id:
                            type: array
                            items:
                              type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                asset:
                  type: object
                  properties:
                    imagekit_file_id:
                      type: string
                      description: ImageKit file ID
                      example: ik_file_123456789
                    imagekit_url:
                      type: string
                      description: ImageKit file URL
                      example: https://ik.imagekit.io/company/image.jpg
                    name:
                      type: string
                      description: Asset display name
                      example: Product Hero Image
                    description:
                      type: string
                      description: Optional asset description
                      example: High-resolution product image
                    tags:
                      type: string
                      description: Optional comma-separated tags
                      example: en,en-us,product,featured
                    file_size:
                      type: integer
                      description: File size in bytes
                      example: 1024000
                    mime_type:
                      type: string
                      description: MIME type
                      example: image/jpeg
                    width:
                      type: integer
                      description: Optional image width in pixels
                      example: 1920
                    height:
                      type: integer
                      description: Optional image height in pixels
                      example: 1080
                  required:
                    - imagekit_file_id
                    - imagekit_url
                    - name
                    - file_size
                    - mime_type
        required: true
  /api/dam/assets:
    post:
      summary: Errors when multiple asset types are provided
      tags:
        - DAM
      operationId: createDamAsset
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: placeholder asset created with minimal parameters
        '401':
          description: unauthorized
        '422':
          description: multiple asset types provided
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: string
        description: >-
          Binary file upload for the digital asset. Maximum file size: 100MB.
          Required when using asset parameter group.
  /api/dam/assets/{code}:
    get:
      summary: Retrieves an asset by code
      tags:
        - DAM
      operationId: showDamAsset
      security:
        - bearer_auth: []
      parameters:
        - name: code
          in: path
          required: true
          description: Unique code identifier for the asset
          example: LOGO-001
          schema:
            type: string
      responses:
        '200':
          description: asset found
          content:
            application/json:
              schema:
                type: object
                properties:
                  asset:
                    title: Dam::Asset
                    type: object
                    properties:
                      id:
                        type: integer
                      code:
                        description: A unique, human-readable identifier for the asset
                        example: ABC789
                        type: string
                      name:
                        description: The name of the asset
                        type: string
                        pattern: ^[\w\s.-]+$
                      description:
                        description: A description of the asset
                        type:
                          - string
                          - 'null'
                      category:
                        description: The file category of the asset
                        type: string
                        enum:
                          - images
                          - videos
                          - audio
                          - text
                          - documents
                          - other
                      created_at:
                        description: >-
                          The date and time the asset was created in ISO 8601
                          format
                        type: string
                        format: date-time
                      updated_at:
                        description: >-
                          The date and time the asset was last updated in ISO
                          8601 format
                        type: string
                        format: date-time
                      default_variant_id:
                        description: The ID of the default variant
                        type:
                          - string
                          - 'null'
                      canonical_path:
                        type: string
                      company:
                        type: string
                      default_variant_url:
                        type:
                          - string
                          - 'null'
                    required:
                      - id
                      - code
                      - name
                      - category
                      - created_at
                      - updated_at
                      - canonical_path
                      - company
                      - default_variant_url
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '404':
          description: asset not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
    put:
      summary: Updates an existing asset
      tags:
        - DAM
      operationId: updateDamAsset
      security:
        - bearer_auth: []
      parameters:
        - name: code
          in: path
          required: true
          description: Unique code identifier for the asset
          example: ACMELG
          schema:
            type: string
      responses:
        '200':
          description: asset updated with partial data
          content:
            application/json:
              schema:
                type: object
                properties:
                  asset:
                    title: Dam::Asset
                    type: object
                    properties:
                      id:
                        type: integer
                      code:
                        description: A unique, human-readable identifier for the asset
                        example: ABC789
                        type: string
                      name:
                        description: The name of the asset
                        type: string
                        pattern: ^[\w\s.-]+$
                      description:
                        description: A description of the asset
                        type:
                          - string
                          - 'null'
                      category:
                        description: The file category of the asset
                        type: string
                        enum:
                          - images
                          - videos
                          - audio
                          - text
                          - documents
                          - other
                      created_at:
                        description: >-
                          The date and time the asset was created in ISO 8601
                          format
                        type: string
                        format: date-time
                      updated_at:
                        description: >-
                          The date and time the asset was last updated in ISO
                          8601 format
                        type: string
                        format: date-time
                      default_variant_id:
                        description: The ID of the default variant
                        type:
                          - string
                          - 'null'
                      canonical_path:
                        type: string
                      company:
                        type: string
                      default_variant_url:
                        type:
                          - string
                          - 'null'
                    required:
                      - id
                      - code
                      - name
                      - category
                      - created_at
                      - updated_at
                      - canonical_path
                      - company
                      - default_variant_url
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '404':
          description: asset not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: asset validation failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Updated display name for the asset
                  example: Updated Asset Name
                description:
                  type: string
                  description: Updated description for the asset
                  example: Updated asset description
        required: true
    delete:
      summary: Deletes an asset
      tags:
        - DAM
      operationId: destroyDamAsset
      security:
        - bearer_auth: []
      parameters:
        - name: code
          in: path
          required: true
          description: Unique code identifier for the asset
          example: ACMELG
          schema:
            type: string
      responses:
        '200':
          description: asset deleted successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  asset:
                    title: Dam::Asset
                    type: object
                    properties:
                      id:
                        type: integer
                      code:
                        description: The code of the asset that was destroyed
                        type: string
                    required:
                      - id
                      - code
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '404':
          description: asset not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: asset destruction failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/dam/assets/{code}/discard:
    patch:
      summary: Discard an asset (soft delete)
      tags:
        - DAM
      operationId: discardDamAsset
      security:
        - bearer_auth: []
      parameters:
        - name: code
          in: path
          required: true
          description: Unique code identifier for the asset
          example: ACMELG
          schema:
            type: string
      responses:
        '200':
          description: asset discarded successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  asset:
                    title: Dam::Asset
                    type: object
                    properties:
                      id:
                        type: integer
                      code:
                        description: The code of the asset that was soft deleted
                        type: string
                      discarded_at:
                        description: The date and time the asset was soft deleted
                        type:
                          - string
                          - 'null'
                        format: date-time
                      name:
                        description: The name of the asset
                        type: string
                        pattern: ^[\w\s.-]+$
                    required:
                      - id
                      - code
                      - name
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '404':
          description: asset not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/dam/assets/imagekit_auth:
    post:
      summary: Creates ImageKit authentication credentials for large file uploads
      tags:
        - DAM
      operationId: createImagekitAuth
      security:
        - bearer_auth: []
      responses:
        '201':
          description: authentication credentials created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  token:
                    type: string
                  signature:
                    type: string
                  expire:
                    type: integer
                  folder:
                    type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '500':
          description: ImageKit configuration error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/dam/assets/{code}/variants:
    get:
      summary: Returns all variants for an existing asset
      tags:
        - DAM
      operationId: indexDamVariants
      security:
        - bearer_auth: []
      parameters:
        - name: code
          in: path
          required: true
          description: Asset code
          schema:
            type: string
      responses:
        '200':
          description: variants retrieved
        '404':
          description: asset not found
    post:
      summary: Creates variants for an existing asset
      tags:
        - DAM
      operationId: createDamVariants
      security:
        - bearer_auth: []
      parameters:
        - name: code
          in: path
          required: true
          description: Unique asset code identifier
          schema:
            type: string
      responses:
        '201':
          description: variants created
          content:
            application/json:
              schema:
                type: object
                properties:
                  variants:
                    type: array
                    items:
                      oneOf:
                        - title: Dam::Variant
                          type: object
                          properties:
                            id:
                              type: string
                            file_name:
                              type: string
                            mime_type:
                              type: string
                            metadata:
                              type: object
                            checksum:
                              type:
                                - string
                                - 'null'
                            tags:
                              type: array
                            default:
                              type: boolean
                            url:
                              type:
                                - string
                                - 'null'
                            media_type:
                              type: string
                            is_original:
                              type: boolean
                            is_text:
                              type: boolean
                            content:
                              type:
                                - string
                                - 'null'
                            processing_status:
                              type: string
                              enum:
                                - pending
                                - processing
                                - ready
                                - failed
                            created_at:
                              type: string
                              format: date-time
                          required:
                            - id
                            - file_name
                            - mime_type
                            - metadata
                            - checksum
                            - tags
                            - default
                            - url
                            - media_type
                            - is_original
                            - is_text
                            - content
                            - processing_status
                            - created_at
                        - type: object
                          properties:
                            errors:
                              type: object
                              additionalProperties: true
                          required:
                            - errors
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '404':
          description: asset not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: all variants failed validation
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: array
          application/json:
            schema:
              type: array
  /api/dam/assets/{code}/variants/{id}:
    get:
      summary: Returns a specific variant for an existing asset
      tags:
        - DAM
      operationId: showDamVariant
      security:
        - bearer_auth: []
      parameters:
        - name: code
          in: path
          required: true
          description: Asset code
          schema:
            type: string
        - name: id
          in: path
          required: true
          description: Variant ID
          schema:
            type: string
      responses:
        '200':
          description: non-default variant retrieved
        '404':
          description: asset not found
    put:
      summary: Updates tags for a specific variant
      tags:
        - DAM
      operationId: updateDamVariant
      security:
        - bearer_auth: []
      parameters:
        - name: code
          in: path
          required: true
          description: Asset code
          schema:
            type: string
        - name: id
          in: path
          required: true
          description: Variant ID
          schema:
            type: string
      responses:
        '200':
          description: variant updated without tags parameter
          content:
            application/json:
              schema:
                type: object
                properties:
                  variant:
                    title: Dam::Variant
                    type: object
                    properties:
                      id:
                        type: string
                      file_name:
                        type: string
                      mime_type:
                        type: string
                      metadata:
                        type: object
                      checksum:
                        type:
                          - string
                          - 'null'
                      tags:
                        type: array
                      default:
                        type: boolean
                      url:
                        type:
                          - string
                          - 'null'
                      media_type:
                        type: string
                      is_original:
                        type: boolean
                      is_text:
                        type: boolean
                      content:
                        type:
                          - string
                          - 'null'
                      updated_at:
                        type: string
                        format: date-time
                    required:
                      - id
                      - file_name
                      - mime_type
                      - metadata
                      - checksum
                      - tags
                      - default
                      - url
                      - media_type
                      - is_original
                      - is_text
                      - content
                      - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '404':
          description: asset not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                tags:
                  type: array
                  items:
                    type: string
                  description: >-
                    Array of tag names to assign to the variant (replaces all
                    existing tags)
    delete:
      summary: Destroys a variant for an existing asset
      tags:
        - DAM
      operationId: destroyDamVariant
      security:
        - bearer_auth: []
      parameters:
        - name: code
          in: path
          required: true
          description: Asset code
          schema:
            type: string
        - name: id
          in: path
          required: true
          description: Variant ID
          schema:
            type: string
      responses:
        '200':
          description: variant deleted
        '404':
          description: asset not found
        '422':
          description: cannot delete default variant
  /api/dam/assets/{asset_code}/variants/{id}/discard:
    patch:
      summary: Discards a variant for an existing asset (soft delete)
      tags:
        - DAM
      operationId: discardDamVariant
      security:
        - bearer_auth: []
      parameters:
        - name: asset_code
          in: path
          required: true
          description: Asset code
          schema:
            type: string
        - name: id
          in: path
          required: true
          description: Variant ID
          schema:
            type: string
      responses:
        '200':
          description: variant discarded successfully
        '401':
          description: unauthorized
        '404':
          description: asset not found
        '422':
          description: cannot discard default variant
  /api/default_libraries:
    get:
      summary: List Default Libraries
      tags:
        - Default Libraries
      description: Fetches all default libraries for the current company.
      security:
        - bearer_auth: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  default_libraries:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 1
                        title:
                          type: string
                          example: Default Library
                        active:
                          type: boolean
                          example: true
                        push_to_all:
                          type:
                            - boolean
                            - 'null'
                          example: false
                        default_library_items:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              relateable_type:
                                type: string
                                example: Item
                              relateable_id:
                                type: integer
                                example: 1
                              order:
                                type: integer
                                example: 1
                              title:
                                type: string
                                example: Item Title
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.png
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
    post:
      summary: Create Default Library
      tags:
        - Default Libraries
      description: Creates a new default library for the current company.
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  default_library:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      title:
                        type: string
                        example: Default Library
                      active:
                        type: boolean
                        example: true
                      push_to_all:
                        type:
                          - boolean
                          - 'null'
                        example: false
                      default_library_items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            relateable_type:
                              type: string
                              example: Item
                            relateable_id:
                              type: integer
                              example: 1
                            order:
                              type: integer
                              example: 1
                            title:
                              type: string
                              example: Item Title
                            image_url:
                              type:
                                - string
                                - 'null'
                              example: https://example.com/image.png
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                  description: Title of the default library
                  example: New Default Library
                active:
                  type: boolean
                  description: Is the default library active?
                  example: true
                push_to_all:
                  type: boolean
                  description: Should the library be pushed to all affiliates?
                  example: false
                default_library_items_attributes:
                  type: array
                  items:
                    type: object
                    properties:
                      relateable_type:
                        type: string
                        example: Product
                        description: Type of the related item
                      relateable_id:
                        type: integer
                        example: 1
                        description: ID of the related item
                      order:
                        type: integer
                        example: 1
                        description: Order of the item in the library
                      _destroy:
                        type: boolean
                        example: false
                        description: Flag to mark the item for destruction
              required:
                - title
        required: true
    put:
      summary: Bulk Update Default Libraries
      tags:
        - Default Libraries
      description: Updates multiple default libraries in bulk.
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: Success
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                default_libraries:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                        description: ID of the default library
                      title:
                        type: string
                        example: Updated Library
                        description: Title of the default library
                      active:
                        type: boolean
                        example: true
                        description: Is the default library active?
                      push_to_all:
                        type:
                          - boolean
                          - 'null'
                        example: false
                        description: Should the library be pushed to all affiliates?
                      default_library_items_attributes:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                              description: ID of the library item
                            relateable_type:
                              type: string
                              example: Product
                              description: Type of the related item
                            relateable_id:
                              type: integer
                              example: 1
                              description: ID of the related item
                            order:
                              type: integer
                              example: 1
                              description: Order of the item in the library
                            _destroy:
                              type: boolean
                              example: false
                              description: Flag to mark the item for destruction
        required: true
  /api/default_my_sites:
    get:
      summary: Retrieves the default my site
      description: Fetches the default my site for the current company.
      tags:
        - Default My Sites
      security:
        - bearer_auth: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  default_my_site:
                    type: object
                    properties:
                      id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      forwarding:
                        type:
                          - string
                          - 'null'
                        example: custom
                      forwarding_url:
                        type:
                          - string
                          - 'null'
                        example: https://example.com
                      active:
                        type: boolean
                        example: true
                      theme_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      preview_url:
                        type:
                          - string
                          - 'null'
                        example: https://example.com/preview
                      default_favorites:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            title:
                              type: string
                              example: Favorite Site
                            favoriteable_type:
                              type: string
                              example: Site
                            favoriteable_id:
                              type: integer
                              example: 1
                            order:
                              type: integer
                              example: 1
                            image_url:
                              type:
                                - string
                                - 'null'
                              example: https://example.com/image.png
                      default_links:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            url:
                              type: string
                              example: https://example.com
                            text:
                              type: string
                              example: Example Link
                            order:
                              type: integer
                              example: 1
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
    post:
      summary: Creates or updates the default my site
      description: Creates or updates the default my site for the current company.
      tags:
        - Default My Sites
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  default_my_site:
                    type: object
                    properties:
                      id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      forwarding:
                        type:
                          - string
                          - 'null'
                        example: custom
                      forwarding_url:
                        type:
                          - string
                          - 'null'
                        example: https://example.com
                      active:
                        type: boolean
                        example: true
                      theme_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      preview_url:
                        type:
                          - string
                          - 'null'
                        example: https://example.com/preview
                      default_favorites:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            title:
                              type: string
                              example: Favorite Site
                            favoriteable_type:
                              type: string
                              example: Site
                            favoriteable_id:
                              type: integer
                              example: 1
                            order:
                              type: integer
                              example: 1
                            image_url:
                              type:
                                - string
                                - 'null'
                              example: https://example.com/image.png
                      default_links:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            url:
                              type: string
                              example: https://example.com
                            text:
                              type: string
                              example: Example Link
                            order:
                              type: integer
                              example: 1
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                    required:
                      - request_id
                      - timestamp
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                forwarding:
                  type: string
                  enum:
                    - none
                    - custom
                  example: custom
                  description: >-
                    Type of forwarding for the site. 'none' means no forwarding,
                    'custom' means a custom URL is provided.
                forwarding_url:
                  type: string
                  example: https://example.com
                  description: >-
                    The URL to which the site will forward if forwarding is set
                    to 'custom'.
                active:
                  type: boolean
                  example: true
                  description: Indicates whether the default my site is active.
                theme_id:
                  type: integer
                  example: 1
                  description: ID of the theme to be used for the default my site.
                default_favorites_attributes:
                  type: array
                  items:
                    type: object
                    properties:
                      favoriteable_type:
                        type: string
                        example: Site
                        description: >-
                          Type of the favoriteable item (e.g., 'Site',
                          'Product').
                      favoriteable_id:
                        type: integer
                        example: 1
                        description: ID of the favoriteable item.
                      order:
                        type: integer
                        example: 1
                        description: Order of the favoriteable item.
                      _destroy:
                        type: boolean
                        example: false
                        description: >-
                          Indicates whether the favoriteable item should be
                          removed.
                default_links_attributes:
                  type: array
                  items:
                    type: object
                    properties:
                      url:
                        type:
                          - string
                          - 'null'
                        example: https://example.com
                        description: URL of the link.
                      text:
                        type:
                          - string
                          - 'null'
                        example: Example Link
                        description: Text of the link.
                      order:
                        type:
                          - integer
                          - 'null'
                        example: 1
                        description: Order of the link.
                      _destroy:
                        type:
                          - boolean
                          - 'null'
                        example: false
                        description: Indicates whether the link should be removed.
        required: true
  /api/devices:
    get:
      summary: List all expo devices (Root Admin Only)
      tags:
        - Devices
      description: >-
        Get all expo devices across all companies. This endpoint is restricted
        to root administrators only.
      operationId: listDevices
      security:
        - bearer_auth: []
      parameters:
        - name: page
          in: query
          required: false
          description: 'Page number for pagination (default: 1)'
          schema:
            type: integer
        - name: per_page
          in: query
          required: false
          description: 'Number of items per page (default: 20, max: 100)'
          schema:
            type: integer
        - name: user_id
          in: query
          required: false
          description: Filter devices by user ID
          schema:
            type: integer
        - name: device_type
          in: query
          required: false
          description: Filter devices by type (ios, android, etc.)
          schema:
            type: string
        - name: active_only
          in: query
          required: false
          description: Only return devices that have been refreshed recently
          schema:
            type: boolean
        - name: sorted_by
          in: query
          required: false
          description: >-
            Sort order. Options: created_at_asc, created_at_desc,
            refreshed_at_asc, refreshed_at_desc (default: created_at_desc)
          schema:
            type: string
        - name: search_query
          in: query
          required: false
          description: Search across device_uid, token, and bundle_id fields
          schema:
            type: string
      responses:
        '200':
          description: Devices retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  devices:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 1
                          description: Unique identifier for the device
                        user_id:
                          type: integer
                          example: 123
                          description: ID of the user who owns this device
                        device_type:
                          type:
                            - string
                            - 'null'
                          example: ios
                          description: Type of device (ios, android, etc.)
                        token:
                          type:
                            - string
                            - 'null'
                          example: ExponentPushToken[abc123]
                          description: Device push token
                        device_uid:
                          type:
                            - string
                            - 'null'
                          example: device-uid-123
                          description: Unique device identifier
                        project_id:
                          type:
                            - string
                            - 'null'
                          example: project-123
                          description: Project ID for the device
                        bundle_id:
                          type:
                            - string
                            - 'null'
                          example: com.example.app
                          description: Bundle identifier
                        refreshed_at:
                          type:
                            - string
                            - 'null'
                          format: date-time
                          example: '2025-01-28T12:00:00Z'
                          description: Last time device was refreshed
                        created_at:
                          type: string
                          format: date-time
                          example: '2025-01-28T12:00:00Z'
                          description: When device was created
                        updated_at:
                          type: string
                          format: date-time
                          example: '2025-01-28T12:00:00Z'
                          description: When device was last updated
                        user:
                          type: object
                          description: Full user object with all fields
                          additionalProperties: true
                      required:
                        - id
                        - user_id
                        - created_at
                        - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-01-28T12:00:00Z'
                      pagination:
                        type: object
                        properties:
                          current_page:
                            type: integer
                            example: 1
                          total_pages:
                            type: integer
                            example: 5
                          total_count:
                            type: integer
                            example: 50
                          per_page:
                            type: integer
                            example: 10
                required:
                  - devices
                  - meta
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '403':
          description: Forbidden - Root Admin Required
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Insufficient permissions.
                additionalProperties: false
    delete:
      summary: Delete device by push token
      tags:
        - Devices
      description: >-
        Delete a device by push token. Available to all authenticated users.
        Users can only delete their own devices, except root admins who can
        delete any device.
      operationId: deleteDeviceByToken
      security:
        - bearer_auth: []
      parameters:
        - name: push_token
          in: query
          required: true
          description: Push token of the device to delete
          schema:
            type: string
      responses:
        '200':
          description: Device deleted successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Device deleted successfully
                  deleted_count:
                    type: integer
                    example: 1
                    description: Number of devices deleted
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-01-28T12:00:00Z'
                required:
                  - message
                  - deleted_count
                  - meta
        '400':
          description: Bad Request - Missing parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Device not found
                  errors:
                    type: object
                    example:
                      device:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-01-28T12:00:00Z'
                required:
                  - error_message
                  - errors
                additionalProperties: false
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '403':
          description: Forbidden - Cannot delete other user's device
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Device not found
                  errors:
                    type: object
                    example:
                      device:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-01-28T12:00:00Z'
                required:
                  - error_message
                  - errors
                additionalProperties: false
        '404':
          description: Device not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Device not found
                  errors:
                    type: object
                    example:
                      device:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-01-28T12:00:00Z'
                required:
                  - error_message
                  - errors
                additionalProperties: false
  /api/devices/create_or_refresh:
    post:
      summary: Create or refresh a device
      tags:
        - Devices
      description: >-
        Create a new device or refresh an existing one if the push token already
        exists for the current user. Available to all authenticated users. Users
        can only manage their own devices.
      operationId: createOrRefreshDevice
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: Device refreshed successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  device:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                        description: Unique identifier for the device
                      user_id:
                        type: integer
                        example: 123
                        description: ID of the user who owns this device
                      device_type:
                        type:
                          - string
                          - 'null'
                        example: ios
                        description: Type of device (ios, android, etc.)
                      token:
                        type:
                          - string
                          - 'null'
                        example: ExponentPushToken[abc123]
                        description: Device push token
                      device_uid:
                        type:
                          - string
                          - 'null'
                        example: device-uid-123
                        description: Unique device identifier
                      project_id:
                        type:
                          - string
                          - 'null'
                        example: project-123
                        description: Project ID for the device
                      bundle_id:
                        type:
                          - string
                          - 'null'
                        example: com.example.app
                        description: Bundle identifier
                      refreshed_at:
                        type:
                          - string
                          - 'null'
                        format: date-time
                        example: '2025-01-28T12:00:00Z'
                        description: Last time device was refreshed
                      created_at:
                        type: string
                        format: date-time
                        example: '2025-01-28T12:00:00Z'
                        description: When device was created
                      updated_at:
                        type: string
                        format: date-time
                        example: '2025-01-28T12:00:00Z'
                        description: When device was last updated
                      user:
                        type: object
                        description: Full user object with all fields
                        additionalProperties: true
                    required:
                      - id
                      - user_id
                      - created_at
                      - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-01-28T12:00:00Z'
                required:
                  - device
                  - meta
        '201':
          description: Device created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  device:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                        description: Unique identifier for the device
                      user_id:
                        type: integer
                        example: 123
                        description: ID of the user who owns this device
                      device_type:
                        type:
                          - string
                          - 'null'
                        example: ios
                        description: Type of device (ios, android, etc.)
                      token:
                        type:
                          - string
                          - 'null'
                        example: ExponentPushToken[abc123]
                        description: Device push token
                      device_uid:
                        type:
                          - string
                          - 'null'
                        example: device-uid-123
                        description: Unique device identifier
                      project_id:
                        type:
                          - string
                          - 'null'
                        example: project-123
                        description: Project ID for the device
                      bundle_id:
                        type:
                          - string
                          - 'null'
                        example: com.example.app
                        description: Bundle identifier
                      refreshed_at:
                        type:
                          - string
                          - 'null'
                        format: date-time
                        example: '2025-01-28T12:00:00Z'
                        description: Last time device was refreshed
                      created_at:
                        type: string
                        format: date-time
                        example: '2025-01-28T12:00:00Z'
                        description: When device was created
                      updated_at:
                        type: string
                        format: date-time
                        example: '2025-01-28T12:00:00Z'
                        description: When device was last updated
                      user:
                        type: object
                        description: Full user object with all fields
                        additionalProperties: true
                    required:
                      - id
                      - user_id
                      - created_at
                      - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-01-28T12:00:00Z'
                required:
                  - device
                  - meta
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Device not found
                  errors:
                    type: object
                    example:
                      device:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-01-28T12:00:00Z'
                required:
                  - error_message
                  - errors
                additionalProperties: false
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                push_token:
                  type: string
                  example: ExponentPushToken[abc123]
                  description: Device push token (required)
                device_type:
                  type: string
                  example: ios
                  description: Type of device (ios, android, etc.)
                device_uid:
                  type: string
                  example: device-uid-123
                  description: Unique device identifier
                project_id:
                  type: string
                  example: project-123
                  description: Project ID for the device
                bundle_id:
                  type: string
                  example: com.example.app
                  description: Bundle identifier
              required:
                - push_token
  /api/devices/{id}:
    get:
      summary: Get a specific expo device (Root Admin Only)
      tags:
        - Devices
      description: >-
        Get details of a specific expo device by ID. This endpoint is restricted
        to root administrators only.
      operationId: getDevice
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Device ID
          schema:
            type: integer
      responses:
        '200':
          description: Device retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  device:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                        description: Unique identifier for the device
                      user_id:
                        type: integer
                        example: 123
                        description: ID of the user who owns this device
                      device_type:
                        type:
                          - string
                          - 'null'
                        example: ios
                        description: Type of device (ios, android, etc.)
                      token:
                        type:
                          - string
                          - 'null'
                        example: ExponentPushToken[abc123]
                        description: Device push token
                      device_uid:
                        type:
                          - string
                          - 'null'
                        example: device-uid-123
                        description: Unique device identifier
                      project_id:
                        type:
                          - string
                          - 'null'
                        example: project-123
                        description: Project ID for the device
                      bundle_id:
                        type:
                          - string
                          - 'null'
                        example: com.example.app
                        description: Bundle identifier
                      refreshed_at:
                        type:
                          - string
                          - 'null'
                        format: date-time
                        example: '2025-01-28T12:00:00Z'
                        description: Last time device was refreshed
                      created_at:
                        type: string
                        format: date-time
                        example: '2025-01-28T12:00:00Z'
                        description: When device was created
                      updated_at:
                        type: string
                        format: date-time
                        example: '2025-01-28T12:00:00Z'
                        description: When device was last updated
                      user:
                        type: object
                        description: Full user object with all fields
                        additionalProperties: true
                    required:
                      - id
                      - user_id
                      - created_at
                      - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-01-28T12:00:00Z'
                required:
                  - device
                  - meta
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '403':
          description: Forbidden - Root Admin Required
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Insufficient permissions.
                additionalProperties: false
        '404':
          description: Device not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Device not found
                  errors:
                    type: object
                    example:
                      device:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-01-28T12:00:00Z'
                required:
                  - error_message
                  - errors
                additionalProperties: false
    delete:
      summary: Delete device by ID
      tags:
        - Devices
      description: >-
        Delete a device by ID. Available to all authenticated users. Users can
        only delete their own devices, except root admins who can delete any
        device.
      operationId: deleteDeviceById
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Device ID
          schema:
            type: integer
      responses:
        '200':
          description: Device deleted successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Device deleted successfully
                  deleted_count:
                    type: integer
                    example: 1
                    description: Number of devices deleted
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-01-28T12:00:00Z'
                required:
                  - message
                  - deleted_count
                  - meta
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '403':
          description: Forbidden - Cannot delete other user's device
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Device not found
                  errors:
                    type: object
                    example:
                      device:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-01-28T12:00:00Z'
                required:
                  - error_message
                  - errors
                additionalProperties: false
        '404':
          description: Device not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Device not found
                  errors:
                    type: object
                    example:
                      device:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-01-28T12:00:00Z'
                required:
                  - error_message
                  - errors
                additionalProperties: false
  /api/devices/{id}/send_push:
    post:
      summary: Send push notification to device (Root Admin Only)
      tags:
        - Devices
      description: >-
        Send a push notification to a specific device. This endpoint is
        restricted to root administrators only.
      operationId: sendPushNotification
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Device ID
          schema:
            type: integer
      responses:
        '200':
          description: Push notification sent successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Push notification sent successfully
                  device:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                        description: Unique identifier for the device
                      user_id:
                        type: integer
                        example: 123
                        description: ID of the user who owns this device
                      device_type:
                        type:
                          - string
                          - 'null'
                        example: ios
                        description: Type of device (ios, android, etc.)
                      token:
                        type:
                          - string
                          - 'null'
                        example: ExponentPushToken[abc123]
                        description: Device push token
                      device_uid:
                        type:
                          - string
                          - 'null'
                        example: device-uid-123
                        description: Unique device identifier
                      project_id:
                        type:
                          - string
                          - 'null'
                        example: project-123
                        description: Project ID for the device
                      bundle_id:
                        type:
                          - string
                          - 'null'
                        example: com.example.app
                        description: Bundle identifier
                      refreshed_at:
                        type:
                          - string
                          - 'null'
                        format: date-time
                        example: '2025-01-28T12:00:00Z'
                        description: Last time device was refreshed
                      created_at:
                        type: string
                        format: date-time
                        example: '2025-01-28T12:00:00Z'
                        description: When device was created
                      updated_at:
                        type: string
                        format: date-time
                        example: '2025-01-28T12:00:00Z'
                        description: When device was last updated
                      user:
                        type: object
                        description: Full user object with all fields
                        additionalProperties: true
                    required:
                      - id
                      - user_id
                      - created_at
                      - updated_at
                  notification:
                    type: object
                    properties:
                      body:
                        type: string
                        example: Hello from the admin!
                      title:
                        type:
                          - string
                          - 'null'
                        example: Admin Message
                      data:
                        type:
                          - object
                          - 'null'
                        example:
                          action: open_page
                      company_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-01-28T12:00:00Z'
                required:
                  - message
                  - device
                  - notification
                  - meta
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '403':
          description: Forbidden - Root Admin Required
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Insufficient permissions.
                additionalProperties: false
        '404':
          description: Device not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Device not found
                  errors:
                    type: object
                    example:
                      device:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-01-28T12:00:00Z'
                required:
                  - error_message
                  - errors
                additionalProperties: false
        '422':
          description: Push notification failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Device not found
                  errors:
                    type: object
                    example:
                      device:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-01-28T12:00:00Z'
                required:
                  - error_message
                  - errors
                additionalProperties: false
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                body:
                  type: string
                  example: Hello from the admin!
                  description: Notification body text (required)
                title:
                  type: string
                  example: Admin Message
                  description: Notification title (optional)
                data:
                  type: object
                  example:
                    action: open_page
                    page_id: 123
                  description: Custom data payload (optional)
                company_id:
                  type: integer
                  example: 1
                  description: Company ID for notification context (optional)
              required:
                - body
  /api/devices/user/{user_id}:
    get:
      summary: Get all expo devices for a specific user (Root Admin Only)
      tags:
        - Devices
      description: >-
        Get all expo devices for a specific user. This endpoint is restricted to
        root administrators only.
      operationId: getUserDevices
      security:
        - bearer_auth: []
      parameters:
        - name: user_id
          in: path
          required: true
          description: User ID
          schema:
            type: integer
        - name: page
          in: query
          required: false
          description: 'Page number for pagination (default: 1)'
          schema:
            type: integer
        - name: per_page
          in: query
          required: false
          description: 'Number of items per page (default: 20, max: 100)'
          schema:
            type: integer
        - name: device_type
          in: query
          required: false
          description: Filter devices by type (ios, android, etc.)
          schema:
            type: string
        - name: active_only
          in: query
          required: false
          description: Only return devices that have been refreshed recently
          schema:
            type: boolean
        - name: sorted_by
          in: query
          required: false
          description: >-
            Sort order. Options: created_at_asc, created_at_desc,
            refreshed_at_asc, refreshed_at_desc (default: created_at_desc)
          schema:
            type: string
        - name: search_query
          in: query
          required: false
          description: Search across device_uid, token, and bundle_id fields
          schema:
            type: string
      responses:
        '200':
          description: User devices retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  devices:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 1
                          description: Unique identifier for the device
                        user_id:
                          type: integer
                          example: 123
                          description: ID of the user who owns this device
                        device_type:
                          type:
                            - string
                            - 'null'
                          example: ios
                          description: Type of device (ios, android, etc.)
                        token:
                          type:
                            - string
                            - 'null'
                          example: ExponentPushToken[abc123]
                          description: Device push token
                        device_uid:
                          type:
                            - string
                            - 'null'
                          example: device-uid-123
                          description: Unique device identifier
                        project_id:
                          type:
                            - string
                            - 'null'
                          example: project-123
                          description: Project ID for the device
                        bundle_id:
                          type:
                            - string
                            - 'null'
                          example: com.example.app
                          description: Bundle identifier
                        refreshed_at:
                          type:
                            - string
                            - 'null'
                          format: date-time
                          example: '2025-01-28T12:00:00Z'
                          description: Last time device was refreshed
                        created_at:
                          type: string
                          format: date-time
                          example: '2025-01-28T12:00:00Z'
                          description: When device was created
                        updated_at:
                          type: string
                          format: date-time
                          example: '2025-01-28T12:00:00Z'
                          description: When device was last updated
                        user:
                          type: object
                          description: Full user object with all fields
                          additionalProperties: true
                      required:
                        - id
                        - user_id
                        - created_at
                        - updated_at
                  user_id:
                    type: integer
                    example: 123
                    description: ID of the user
                  user_name:
                    type: string
                    example: John Doe
                    description: Full name of the user
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-01-28T12:00:00Z'
                      pagination:
                        type: object
                        properties:
                          current_page:
                            type: integer
                            example: 1
                          total_pages:
                            type: integer
                            example: 5
                          total_count:
                            type: integer
                            example: 50
                          per_page:
                            type: integer
                            example: 10
                required:
                  - devices
                  - user_id
                  - user_name
                  - meta
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '403':
          description: Forbidden - Root Admin Required
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Insufficient permissions.
                additionalProperties: false
        '404':
          description: User not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Device not found
                  errors:
                    type: object
                    example:
                      device:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-01-28T12:00:00Z'
                required:
                  - error_message
                  - errors
                additionalProperties: false
  /api/devices/user/{user_id}/send_push:
    post:
      summary: Send push notification to all user devices (Root Admin Only)
      tags:
        - Devices
      description: >-
        Send a push notification to all devices belonging to a specific user.
        This endpoint is restricted to root administrators only.
      operationId: sendPushToAllUserDevices
      security:
        - bearer_auth: []
      parameters:
        - name: user_id
          in: path
          required: true
          description: User ID
          schema:
            type: integer
      responses:
        '200':
          description: No devices found for user
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: No devices found for user
                  user_id:
                    type: integer
                    example: 123
                    description: ID of the target user
                  user_name:
                    type: string
                    example: John Doe
                    description: Full name of the target user
                  devices_count:
                    type: integer
                    example: 0
                    description: Total number of devices for the user
                  notifications_sent:
                    type: integer
                    example: 0
                    description: Number of successful notifications
                  notifications_failed:
                    type: integer
                    example: 0
                    description: Number of failed notifications
                  notification:
                    type: object
                    properties:
                      body:
                        type: string
                        example: Important announcement for all your devices!
                      title:
                        type:
                          - string
                          - 'null'
                        example: System Alert
                      data:
                        type:
                          - object
                          - 'null'
                        example:
                          action: sync_data
                      company_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-01-28T12:00:00Z'
                required:
                  - message
                  - user_id
                  - user_name
                  - devices_count
                  - notifications_sent
                  - meta
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '403':
          description: Forbidden - Root Admin Required
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Insufficient permissions.
                additionalProperties: false
        '404':
          description: User not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Device not found
                  errors:
                    type: object
                    example:
                      device:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-01-28T12:00:00Z'
                required:
                  - error_message
                  - errors
                additionalProperties: false
        '422':
          description: All push notifications failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Device not found
                  errors:
                    type: object
                    example:
                      device:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-01-28T12:00:00Z'
                required:
                  - error_message
                  - errors
                additionalProperties: false
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                body:
                  type: string
                  example: Important announcement for all your devices!
                  description: Notification body text (required)
                title:
                  type: string
                  example: System Alert
                  description: Notification title (optional)
                data:
                  type: object
                  example:
                    action: sync_data
                    priority: high
                  description: Custom data payload (optional)
                company_id:
                  type: integer
                  example: 1
                  description: Company ID for notification context (optional)
              required:
                - body
  /api/v2025-06/discounts:
    get:
      summary: Retrieve a list of company discounts
      description: Get all company discounts for the current company.
      tags:
        - Discounts
      operationId: listDiscounts
      security:
        - bearer_auth: []
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            default: 1
          required: false
          description: Page number for pagination
        - name: per_page
          in: query
          schema:
            type: integer
            default: 10
          required: false
          description: Number of records per page
        - name: search_query
          in: query
          schema:
            type: string
          required: false
          description: Search term to filter discounts
        - name: active
          in: query
          schema:
            type: boolean
          required: false
          description: Filter by active status
        - name: sorted_by
          in: query
          schema:
            type: string
          required: false
          description: >
            Sort the records by one of the supported attributes:
              - created_at
              - used
              - code
              - active
              - price_discount_type
              - automatic
            The sort attribute should be followed by one of the order
            directives: '_asc', '_desc'
      responses:
        '200':
          description: discounts retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  discounts:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 1
                        name:
                          type: string
                          example: Summer Sale
                        code:
                          type: string
                          example: SUMMER20
                        price_discount_type:
                          type: string
                          example: percentage
                        price_discount_amount:
                          type: integer
                          example: 0
                        price_discount_percent:
                          type: number
                          example: 20
                        start_date_time:
                          type:
                            - string
                            - 'null'
                          format: date_time
                          example: '2023-06-01T00:00:00Z'
                        start_date:
                          type:
                            - string
                            - 'null'
                          format: date
                          example: '2023-06-01'
                        start_time:
                          type:
                            - string
                            - 'null'
                          format: time
                          example: '16:00'
                        end_date_time:
                          type:
                            - string
                            - 'null'
                          format: date_time
                          example: '2023-08-31T23:59:59Z'
                        end_date:
                          type:
                            - string
                            - 'null'
                          format: date
                          example: '2023-06-01'
                        end_time:
                          type:
                            - string
                            - 'null'
                          format: time
                          example: '03:00'
                        customer_usage_limit:
                          type: integer
                          example: 1
                        minimum_amount_cents:
                          type: integer
                          example: 1000
                        collection_ids:
                          type: array
                          items:
                            type: integer
                          example:
                            - 1
                            - 2
                            - 3
                        product_ids:
                          type: array
                          items:
                            type: integer
                          example:
                            - 4
                            - 5
                            - 6
                        active:
                          type: boolean
                          example: true
                        customer_ids:
                          type: array
                          items:
                            type: integer
                          example:
                            - 7
                            - 8
                            - 9
                        country_codes:
                          type: array
                          items:
                            type: string
                          example:
                            - US
                            - CA
                        created_at:
                          type: string
                          format: date_time
                          example: '2023-06-01T00:00:00Z'
                        updated_at:
                          type: string
                          format: date_time
                          example: '2023-06-01T00:00:00Z'
                        discount_type:
                          type: string
                          example: product_discount
                        description:
                          type:
                            - string
                            - 'null'
                          example: 20% off your entire order
                        total_usage:
                          type: integer
                          example: 42
                        automatic:
                          type: boolean
                          example: true
                        percentage_value:
                          type:
                            - string
                            - 'null'
                          example: '10.21'
                        applicable_for:
                          type: string
                          example: everything
                        apply_only_once:
                          type:
                            - boolean
                            - 'null'
                          example: true
                        apply_to_subscriptions:
                          type: boolean
                          example: true
                        apply_to_volume:
                          type: boolean
                          example: true
                        country_filter:
                          type: string
                          example: apply_all
                        purchase_requirement:
                          type: string
                          example: no_minimum_required
                        purchase_requirement_applies_to_whole_cart:
                          type: boolean
                          example: true
                        customer_filter:
                          type: string
                          example: all_customer
                        has_end_date:
                          type:
                            - boolean
                            - 'null'
                          example: true
                        time_zone:
                          type:
                            - string
                            - 'null'
                          example: UK
                        free_variant_ids:
                          type: array
                          items:
                            type: integer
                          example:
                            - 3
                            - 5
                            - 12
                        applicable_product_ids:
                          type: array
                          items:
                            type: integer
                          example:
                            - 4
                            - 5
                            - 6
                        inapplicable_product_ids:
                          type: array
                          items:
                            type: integer
                          example:
                            - 4
                            - 5
                            - 6
                        applicable_collection_ids:
                          type: array
                          items:
                            type: integer
                          example:
                            - 4
                            - 5
                            - 6
                        add_free_products_automatically:
                          type: boolean
                          example: true
                        eligible_customer_ids:
                          type: array
                          items:
                            type: integer
                          example:
                            - 4
                            - 5
                            - 6
                        eligible_country_ids:
                          type: array
                          items:
                            type: integer
                          example:
                            - 4
                            - 5
                            - 6
                        ineligible_country_ids:
                          type: array
                          items:
                            type: integer
                          example:
                            - 4
                            - 5
                            - 6
                        minimum_purchase_requirement_amount:
                          type: number
                          format: float
                          example: 10.15
                        minimum_purchase_requirement_quantity:
                          type: integer
                          items:
                            type: integer
                          example: 2
                        eligible_customer_segments:
                          type: array
                          items:
                            type: string
                          example:
                            - user
                        limit_usage_of_code:
                          type: boolean
                          example: true
                        limit_usage_per_customer:
                          type: boolean
                          example: true
                        other_shipping_discounts:
                          type: boolean
                          example: true
                        other_product_discounts:
                          type: boolean
                          example: true
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                      pagination:
                        type: object
                        properties:
                          total_count:
                            type: integer
                            example: 42
                          total_pages:
                            type: integer
                            example: 3
                          per_page:
                            type: integer
                            example: 3
                          current_page:
                            type: integer
                            example: 1
    post:
      summary: Create a new company discount
      description: Create a new company discount
      tags:
        - Discounts
      operationId: createDiscount
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: discount created
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                    example: 1
                  name:
                    type: string
                    example: Summer Sale
                  code:
                    type: string
                    example: SUMMER20
                  price_discount_type:
                    type: string
                    example: percentage
                  price_discount_amount:
                    type: integer
                    example: 0
                  price_discount_percent:
                    type: number
                    example: 20
                  start_date_time:
                    type:
                      - string
                      - 'null'
                    format: date_time
                    example: '2023-06-01T00:00:00Z'
                  start_date:
                    type:
                      - string
                      - 'null'
                    format: date
                    example: '2023-06-01'
                  start_time:
                    type:
                      - string
                      - 'null'
                    format: time
                    example: '16:00'
                  end_date_time:
                    type:
                      - string
                      - 'null'
                    format: date_time
                    example: '2023-08-31T23:59:59Z'
                  end_date:
                    type:
                      - string
                      - 'null'
                    format: date
                    example: '2023-06-01'
                  end_time:
                    type:
                      - string
                      - 'null'
                    format: time
                    example: '03:00'
                  customer_usage_limit:
                    type: integer
                    example: 1
                  minimum_amount_cents:
                    type: integer
                    example: 1000
                  collection_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 1
                      - 2
                      - 3
                  product_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 4
                      - 5
                      - 6
                  active:
                    type: boolean
                    example: true
                  customer_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 7
                      - 8
                      - 9
                  country_codes:
                    type: array
                    items:
                      type: string
                    example:
                      - US
                      - CA
                  created_at:
                    type: string
                    format: date_time
                    example: '2023-06-01T00:00:00Z'
                  updated_at:
                    type: string
                    format: date_time
                    example: '2023-06-01T00:00:00Z'
                  discount_type:
                    type: string
                    example: product_discount
                  description:
                    type:
                      - string
                      - 'null'
                    example: 20% off your entire order
                  total_usage:
                    type: integer
                    example: 42
                  automatic:
                    type: boolean
                    example: true
                  percentage_value:
                    type:
                      - string
                      - 'null'
                    example: '10.21'
                  applicable_for:
                    type: string
                    example: everything
                  apply_only_once:
                    type:
                      - boolean
                      - 'null'
                    example: true
                  apply_to_subscriptions:
                    type: boolean
                    example: true
                  apply_to_volume:
                    type: boolean
                    example: true
                  country_filter:
                    type: string
                    example: apply_all
                  purchase_requirement:
                    type: string
                    example: no_minimum_required
                  purchase_requirement_applies_to_whole_cart:
                    type: boolean
                    example: true
                  customer_filter:
                    type: string
                    example: all_customer
                  has_end_date:
                    type:
                      - boolean
                      - 'null'
                    example: true
                  time_zone:
                    type:
                      - string
                      - 'null'
                    example: UK
                  free_variant_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 3
                      - 5
                      - 12
                  applicable_product_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 4
                      - 5
                      - 6
                  inapplicable_product_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 4
                      - 5
                      - 6
                  applicable_collection_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 4
                      - 5
                      - 6
                  add_free_products_automatically:
                    type: boolean
                    example: true
                  eligible_customer_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 4
                      - 5
                      - 6
                  eligible_country_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 4
                      - 5
                      - 6
                  ineligible_country_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 4
                      - 5
                      - 6
                  minimum_purchase_requirement_amount:
                    type: number
                    format: float
                    example: 10.15
                  minimum_purchase_requirement_quantity:
                    type: integer
                    items:
                      type: integer
                    example: 2
                  eligible_customer_segments:
                    type: array
                    items:
                      type: string
                    example:
                      - user
                  limit_usage_of_code:
                    type: boolean
                    example: true
                  limit_usage_per_customer:
                    type: boolean
                    example: true
                  other_shipping_discounts:
                    type: boolean
                    example: true
                  other_product_discounts:
                    type: boolean
                    example: true
                  meta:
                    type: object
                  csv_uploaded_customer_emails:
                    type: array
                    items:
                      type: string
                    example:
                      - b@ex.com
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                  meta:
                    type: object
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                discount:
                  type: object
                  properties:
                    code:
                      type: string
                      example: SUMMER20
                    apply_type:
                      type: string
                      example: product_discount
                    price_discount_type:
                      type: string
                      example: free_product
                      enum:
                        - flat
                        - percentage
                        - free_product
                        - free_shipping
                    percentage_value:
                      type: number
                      format: float
                      example: 10.15
                      description: When price_discount_type is percentage
                    flat_value:
                      type: number
                      format: float
                      example: 10.15
                      description: When price_discount_type is flat
                    free_variant_ids:
                      type: array
                      example:
                        - 1
                        - 2
                      description: When price_discount_type is free_product
                    automatic:
                      type: boolean
                      example: true
                    applicable_for:
                      type: string
                      example: everything
                      enum:
                        - everything
                        - specific_products
                        - specific_collections
                        - except_specific_products
                    product_ids:
                      type: array
                      example:
                        - 1
                        - 2
                      description: >-
                        When applicable_for is specific_products or
                        except_specific_products
                    applicable_collection_ids:
                      type: array
                      example:
                        - 1
                        - 2
                      description: When applicable_for is specific_collections
                    apply_only_once:
                      type: boolean
                      example: true
                      description: Only apply discount once per order
                    apply_to_subscriptions:
                      type: boolean
                      example: true
                      description: Apply discount to subscription orders
                    add_free_products_automatically:
                      type: boolean
                      example: true
                      description: >-
                        Automatically/Manually add the free product to carts
                        when applied
                    country_filter:
                      type: string
                      example: apply_all
                      enum:
                        - apply_all
                        - apply_some
                        - exclude_some
                    country_ids:
                      type: array
                      example:
                        - 1
                        - 2
                      description: When country_filter is apply_some or exclude_some
                    purchase_requirement:
                      type: string
                      example: no_minimum_required
                      enum:
                        - no_minimum_required
                        - minimum_purchase_amount
                        - minimum_purchase_quantity
                    minimum_purchase_requirement_amount:
                      type: number
                      format: float
                      example: 10.15
                      description: When purchase_requirement is minimum_purchase_amount
                    minimum_purchase_requirement_quantity:
                      type: integer
                      example: 2
                      description: When purchase_requirement is minimum_purchase_quantity
                    purchase_requirement_applies_to_whole_cart:
                      type: boolean
                      example: true
                      description: Apply to Whole Cart
                    customer_filter:
                      type: string
                      example: all_customers
                      enum:
                        - all_customers
                        - specific_customer_segment
                        - specific_customers
                        - first_time_customers
                        - csv_uploaded_customers
                    customer_emails:
                      type: array
                      items:
                        type: string
                      example:
                        - bob@gmail.com
                        - rp@gmail.com
                      description: When the customer filter is csv_uploaded_customers
                    eligible_customer_ids:
                      type: array
                      example:
                        - 1
                        - 2
                      description: When customer_filter is specific_customers
                    eligible_customer_segments:
                      type: array
                      items:
                        type: string
                      example:
                        - user
                        - customer
                        - guest
                      description: When customer_filter is specific_customer_segment
                    limit_usage_of_code:
                      type: boolean
                      example: true
                      description: Limit number of times this discount can be used in total
                    use_limit:
                      type: integer
                      example: 3
                      description: Number of times this discount can be used in total
                    limit_usage_per_customer:
                      type: boolean
                      example: true
                      description: Limit to one use per customer
                    other_shipping_discounts:
                      type: boolean
                      example: true
                    other_product_discounts:
                      type: boolean
                      example: true
                    active:
                      type: boolean
                      example: true
                    start_date:
                      type: string
                      format: date
                      example: '2025-07-02'
                    start_time:
                      type: string
                      format: time
                      example: 14:30 PM
                    has_end_date:
                      type: boolean
                      example: true
                    end_date:
                      type: string
                      format: date
                      example: '2025-07-03'
                    end_time:
                      type: string
                      format: time
                      example: 14:30 AM
                    time_zone:
                      type: string
                      example: Europe/London
                  required:
                    - code
  /api/v2025-06/discounts/{id}:
    get:
      summary: Retrieve a single company discount
      description: Fetch a specific discount by its ID for the current company.
      tags:
        - Discounts
      operationId: showDiscount
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          description: Discount's Id
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: discount retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                    example: 1
                  name:
                    type: string
                    example: Summer Sale
                  code:
                    type: string
                    example: SUMMER20
                  price_discount_type:
                    type: string
                    example: percentage
                  price_discount_amount:
                    type: integer
                    example: 0
                  price_discount_percent:
                    type: number
                    example: 20
                  start_date_time:
                    type:
                      - string
                      - 'null'
                    format: date_time
                    example: '2023-06-01T00:00:00Z'
                  start_date:
                    type:
                      - string
                      - 'null'
                    format: date
                    example: '2023-06-01'
                  start_time:
                    type:
                      - string
                      - 'null'
                    format: time
                    example: '16:00'
                  end_date_time:
                    type:
                      - string
                      - 'null'
                    format: date_time
                    example: '2023-08-31T23:59:59Z'
                  end_date:
                    type:
                      - string
                      - 'null'
                    format: date
                    example: '2023-06-01'
                  end_time:
                    type:
                      - string
                      - 'null'
                    format: time
                    example: '03:00'
                  customer_usage_limit:
                    type: integer
                    example: 1
                  minimum_amount_cents:
                    type: integer
                    example: 1000
                  collection_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 1
                      - 2
                      - 3
                  product_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 4
                      - 5
                      - 6
                  active:
                    type: boolean
                    example: true
                  customer_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 7
                      - 8
                      - 9
                  country_codes:
                    type: array
                    items:
                      type: string
                    example:
                      - US
                      - CA
                  created_at:
                    type: string
                    format: date_time
                    example: '2023-06-01T00:00:00Z'
                  updated_at:
                    type: string
                    format: date_time
                    example: '2023-06-01T00:00:00Z'
                  discount_type:
                    type: string
                    example: product_discount
                  description:
                    type:
                      - string
                      - 'null'
                    example: 20% off your entire order
                  total_usage:
                    type: integer
                    example: 42
                  automatic:
                    type: boolean
                    example: true
                  percentage_value:
                    type:
                      - string
                      - 'null'
                    example: '10.21'
                  applicable_for:
                    type: string
                    example: everything
                  apply_only_once:
                    type:
                      - boolean
                      - 'null'
                    example: true
                  apply_to_subscriptions:
                    type: boolean
                    example: true
                  apply_to_volume:
                    type: boolean
                    example: true
                  country_filter:
                    type: string
                    example: apply_all
                  purchase_requirement:
                    type: string
                    example: no_minimum_required
                  purchase_requirement_applies_to_whole_cart:
                    type: boolean
                    example: true
                  customer_filter:
                    type: string
                    example: all_customer
                  has_end_date:
                    type:
                      - boolean
                      - 'null'
                    example: true
                  time_zone:
                    type:
                      - string
                      - 'null'
                    example: UK
                  free_variant_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 3
                      - 5
                      - 12
                  applicable_product_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 4
                      - 5
                      - 6
                  inapplicable_product_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 4
                      - 5
                      - 6
                  applicable_collection_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 4
                      - 5
                      - 6
                  add_free_products_automatically:
                    type: boolean
                    example: true
                  eligible_customer_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 4
                      - 5
                      - 6
                  eligible_country_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 4
                      - 5
                      - 6
                  ineligible_country_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 4
                      - 5
                      - 6
                  minimum_purchase_requirement_amount:
                    type: number
                    format: float
                    example: 10.15
                  minimum_purchase_requirement_quantity:
                    type: integer
                    items:
                      type: integer
                    example: 2
                  eligible_customer_segments:
                    type: array
                    items:
                      type: string
                    example:
                      - user
                  limit_usage_of_code:
                    type: boolean
                    example: true
                  limit_usage_per_customer:
                    type: boolean
                    example: true
                  other_shipping_discounts:
                    type: boolean
                    example: true
                  other_product_discounts:
                    type: boolean
                    example: true
                  meta:
                    type: object
                  csv_uploaded_customer_emails:
                    type: array
                    items:
                      type: string
                    example:
                      - b@ex.com
        '404':
          description: discount not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: array
                    items:
                      type: string
                  meta:
                    type: object
    put:
      summary: Update a company discount
      description: Update the details of a specific company discount.
      tags:
        - Discounts
      operationId: updateDiscount
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          description: Discount's Id
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: discount updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                    example: 1
                  name:
                    type: string
                    example: Summer Sale
                  code:
                    type: string
                    example: SUMMER20
                  price_discount_type:
                    type: string
                    example: percentage
                  price_discount_amount:
                    type: integer
                    example: 0
                  price_discount_percent:
                    type: number
                    example: 20
                  start_date_time:
                    type:
                      - string
                      - 'null'
                    format: date_time
                    example: '2023-06-01T00:00:00Z'
                  start_date:
                    type:
                      - string
                      - 'null'
                    format: date
                    example: '2023-06-01'
                  start_time:
                    type:
                      - string
                      - 'null'
                    format: time
                    example: '16:00'
                  end_date_time:
                    type:
                      - string
                      - 'null'
                    format: date_time
                    example: '2023-08-31T23:59:59Z'
                  end_date:
                    type:
                      - string
                      - 'null'
                    format: date
                    example: '2023-06-01'
                  end_time:
                    type:
                      - string
                      - 'null'
                    format: time
                    example: '03:00'
                  customer_usage_limit:
                    type: integer
                    example: 1
                  minimum_amount_cents:
                    type: integer
                    example: 1000
                  collection_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 1
                      - 2
                      - 3
                  product_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 4
                      - 5
                      - 6
                  active:
                    type: boolean
                    example: true
                  customer_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 7
                      - 8
                      - 9
                  country_codes:
                    type: array
                    items:
                      type: string
                    example:
                      - US
                      - CA
                  created_at:
                    type: string
                    format: date_time
                    example: '2023-06-01T00:00:00Z'
                  updated_at:
                    type: string
                    format: date_time
                    example: '2023-06-01T00:00:00Z'
                  discount_type:
                    type: string
                    example: product_discount
                  description:
                    type:
                      - string
                      - 'null'
                    example: 20% off your entire order
                  total_usage:
                    type: integer
                    example: 42
                  automatic:
                    type: boolean
                    example: true
                  percentage_value:
                    type:
                      - string
                      - 'null'
                    example: '10.21'
                  applicable_for:
                    type: string
                    example: everything
                  apply_only_once:
                    type:
                      - boolean
                      - 'null'
                    example: true
                  apply_to_subscriptions:
                    type: boolean
                    example: true
                  apply_to_volume:
                    type: boolean
                    example: true
                  country_filter:
                    type: string
                    example: apply_all
                  purchase_requirement:
                    type: string
                    example: no_minimum_required
                  purchase_requirement_applies_to_whole_cart:
                    type: boolean
                    example: true
                  customer_filter:
                    type: string
                    example: all_customer
                  has_end_date:
                    type:
                      - boolean
                      - 'null'
                    example: true
                  time_zone:
                    type:
                      - string
                      - 'null'
                    example: UK
                  free_variant_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 3
                      - 5
                      - 12
                  applicable_product_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 4
                      - 5
                      - 6
                  inapplicable_product_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 4
                      - 5
                      - 6
                  applicable_collection_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 4
                      - 5
                      - 6
                  add_free_products_automatically:
                    type: boolean
                    example: true
                  eligible_customer_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 4
                      - 5
                      - 6
                  eligible_country_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 4
                      - 5
                      - 6
                  ineligible_country_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 4
                      - 5
                      - 6
                  minimum_purchase_requirement_amount:
                    type: number
                    format: float
                    example: 10.15
                  minimum_purchase_requirement_quantity:
                    type: integer
                    items:
                      type: integer
                    example: 2
                  eligible_customer_segments:
                    type: array
                    items:
                      type: string
                    example:
                      - user
                  limit_usage_of_code:
                    type: boolean
                    example: true
                  limit_usage_per_customer:
                    type: boolean
                    example: true
                  other_shipping_discounts:
                    type: boolean
                    example: true
                  other_product_discounts:
                    type: boolean
                    example: true
                  meta:
                    type: object
                  csv_uploaded_customer_emails:
                    type: array
                    items:
                      type: string
                    example:
                      - b@ex.com
        '404':
          description: discount not found
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: integer
                  example: 123
                discount:
                  type: object
                  properties:
                    code:
                      type: string
                      example: SUMMER20
                    price_discount_type:
                      type: string
                      example: free_product
                      enum:
                        - flat
                        - percentage
                        - free_product
                        - free_shipping
                    percentage_value:
                      type: number
                      format: float
                      example: 10.15
                      description: When price_discount_type is percentage
                    flat_value:
                      type: number
                      format: float
                      example: 10.15
                      description: When price_discount_type is flat
                    free_variant_ids:
                      type: array
                      example:
                        - 1
                        - 2
                      description: When price_discount_type is free_product
                    automatic:
                      type: boolean
                      example: true
                    applicable_for:
                      type: string
                      example: everything
                      enum:
                        - everything
                        - specific_products
                        - specific_collections
                        - except_specific_products
                    product_ids:
                      type: array
                      example:
                        - 1
                        - 2
                      description: >-
                        When applicable_for is specific_products or
                        except_specific_products
                    applicable_collection_ids:
                      type: array
                      example:
                        - 1
                        - 2
                      description: When applicable_for is specific_collections
                    apply_only_once:
                      type: boolean
                      example: true
                      description: Only apply discount once per order
                    apply_to_subscriptions:
                      type: boolean
                      example: true
                      description: Apply discount to subscription orders
                    add_free_products_automatically:
                      type: boolean
                      example: true
                      description: >-
                        Automatically/Manually add the free product to carts
                        when applied
                    country_filter:
                      type: string
                      example: apply_all
                      enum:
                        - apply_all
                        - apply_some
                        - exclude_some
                    country_ids:
                      type: array
                      example:
                        - 1
                        - 2
                      description: When country_filter is apply_some or exclude_some
                    purchase_requirement:
                      type: string
                      example: no_minimum_required
                      enum:
                        - no_minimum_required
                        - minimum_purchase_amount
                        - minimum_purchase_quantity
                    minimum_purchase_requirement_amount:
                      type: number
                      format: float
                      example: 10.15
                      description: When purchase_requirement is minimum_purchase_amount
                    minimum_purchase_requirement_quantity:
                      type: integer
                      example: 2
                      description: When purchase_requirement is minimum_purchase_quantity
                    purchase_requirement_applies_to_whole_cart:
                      type: boolean
                      example: true
                      description: Apply to Whole Cart
                    customer_filter:
                      type: string
                      example: all_customers
                      enum:
                        - all_customers
                        - specific_customer_segment
                        - specific_customers
                        - first_time_customers
                        - csv_uploaded_customers
                    customer_emails:
                      type: array
                      items:
                        type: string
                      example:
                        - bob@gmail.com
                        - rp@gmail.com
                      description: When the customer filter is csv_uploaded_customers
                    eligible_customer_ids:
                      type: array
                      example:
                        - 1
                        - 2
                      description: When customer_filter is specific_customers
                    eligible_customer_segments:
                      type: array
                      items:
                        type: string
                      example:
                        - user
                        - customer
                        - guest
                      description: When customer_filter is specific_customer_segment
                    limit_usage_of_code:
                      type: boolean
                      example: true
                      description: Limit number of times this discount can be used in total
                    use_limit:
                      type: integer
                      example: 3
                      description: Number of times this discount can be used in total
                    limit_usage_per_customer:
                      type: boolean
                      example: true
                      description: Limit to one use per customer
                    other_shipping_discounts:
                      type: boolean
                      example: true
                    other_product_discounts:
                      type: boolean
                      example: true
                    active:
                      type: boolean
                      example: true
                    start_date:
                      type: string
                      format: date
                      example: '2025-07-02'
                    start_time:
                      type: string
                      format: time
                      example: 14:30 PM
                    has_end_date:
                      type: boolean
                      example: true
                    end_date:
                      type: string
                      format: date
                      example: '2025-07-03'
                    end_time:
                      type: string
                      format: time
                      example: 14:30 AM
                    time_zone:
                      type: string
                      example: Europe/London
                  required:
                    - id
    delete:
      summary: Delete a company discount
      description: Delete a specific discount for the current company.
      tags:
        - Discounts
      operationId: deleteDiscount
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          description: Discount's Id
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: discount deleted
        '404':
          description: discount not found
  /api/v2025-06/discounts/{id}/clone:
    post:
      summary: Clones a discount
      tags:
        - Discounts
      operationId: cloneDiscount
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          description: Discount Id
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: discount cloned
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                    example: 1
                  name:
                    type: string
                    example: Summer Sale
                  code:
                    type: string
                    example: SUMMER20
                  price_discount_type:
                    type: string
                    example: percentage
                  price_discount_amount:
                    type: integer
                    example: 0
                  price_discount_percent:
                    type: number
                    example: 20
                  start_date_time:
                    type:
                      - string
                      - 'null'
                    format: date_time
                    example: '2023-06-01T00:00:00Z'
                  start_date:
                    type:
                      - string
                      - 'null'
                    format: date
                    example: '2023-06-01'
                  start_time:
                    type:
                      - string
                      - 'null'
                    format: time
                    example: '16:00'
                  end_date_time:
                    type:
                      - string
                      - 'null'
                    format: date_time
                    example: '2023-08-31T23:59:59Z'
                  end_date:
                    type:
                      - string
                      - 'null'
                    format: date
                    example: '2023-06-01'
                  end_time:
                    type:
                      - string
                      - 'null'
                    format: time
                    example: '03:00'
                  customer_usage_limit:
                    type: integer
                    example: 1
                  minimum_amount_cents:
                    type: integer
                    example: 1000
                  collection_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 1
                      - 2
                      - 3
                  product_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 4
                      - 5
                      - 6
                  active:
                    type: boolean
                    example: true
                  customer_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 7
                      - 8
                      - 9
                  country_codes:
                    type: array
                    items:
                      type: string
                    example:
                      - US
                      - CA
                  created_at:
                    type: string
                    format: date_time
                    example: '2023-06-01T00:00:00Z'
                  updated_at:
                    type: string
                    format: date_time
                    example: '2023-06-01T00:00:00Z'
                  discount_type:
                    type: string
                    example: product_discount
                  description:
                    type:
                      - string
                      - 'null'
                    example: 20% off your entire order
                  total_usage:
                    type: integer
                    example: 42
                  automatic:
                    type: boolean
                    example: true
                  percentage_value:
                    type:
                      - string
                      - 'null'
                    example: '10.21'
                  applicable_for:
                    type: string
                    example: everything
                  apply_only_once:
                    type:
                      - boolean
                      - 'null'
                    example: true
                  apply_to_subscriptions:
                    type: boolean
                    example: true
                  apply_to_volume:
                    type: boolean
                    example: true
                  country_filter:
                    type: string
                    example: apply_all
                  purchase_requirement:
                    type: string
                    example: no_minimum_required
                  purchase_requirement_applies_to_whole_cart:
                    type: boolean
                    example: true
                  customer_filter:
                    type: string
                    example: all_customer
                  has_end_date:
                    type:
                      - boolean
                      - 'null'
                    example: true
                  time_zone:
                    type:
                      - string
                      - 'null'
                    example: UK
                  free_variant_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 3
                      - 5
                      - 12
                  applicable_product_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 4
                      - 5
                      - 6
                  inapplicable_product_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 4
                      - 5
                      - 6
                  applicable_collection_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 4
                      - 5
                      - 6
                  add_free_products_automatically:
                    type: boolean
                    example: true
                  eligible_customer_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 4
                      - 5
                      - 6
                  eligible_country_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 4
                      - 5
                      - 6
                  ineligible_country_ids:
                    type: array
                    items:
                      type: integer
                    example:
                      - 4
                      - 5
                      - 6
                  minimum_purchase_requirement_amount:
                    type: number
                    format: float
                    example: 10.15
                  minimum_purchase_requirement_quantity:
                    type: integer
                    items:
                      type: integer
                    example: 2
                  eligible_customer_segments:
                    type: array
                    items:
                      type: string
                    example:
                      - user
                  limit_usage_of_code:
                    type: boolean
                    example: true
                  limit_usage_per_customer:
                    type: boolean
                    example: true
                  other_shipping_discounts:
                    type: boolean
                    example: true
                  other_product_discounts:
                    type: boolean
                    example: true
                  meta:
                    type: object
                  csv_uploaded_customer_emails:
                    type: array
                    items:
                      type: string
                    example:
                      - b@ex.com
  /api/v2025-06/discounts/bulk_delete:
    delete:
      summary: Bulk deletes discounts
      tags:
        - Discounts
      operationId: bulkDeleteDiscounts
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  discount_ids:
                    type: array
                    items:
                      type: integer
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                example:
                  discount_ids:
                    - 1
                    - 2
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                discount_ids:
                  type: array
                  items:
                    type: integer
              example:
                discount_ids:
                  - 1
                  - 2
              required:
                - discount_ids
        required: true
  /api/settings/displays:
    get:
      summary: Get display settings
      tags:
        - Display Settings
      security:
        - bearer_auth: []
      operationId: getDisplaySettings
      description: >-
        Get current display settings for the company. Accessible only by root
        admins.
      parameters:
        - name: Authorization
          in: header
          required: true
          description: Bearer token for authentication
          schema:
            type: string
      responses:
        '200':
          description: Display settings retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  display_settings:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        oneOf:
                          - type: object
                            properties:
                              name:
                                type: string
                              value:
                                type: boolean
                              default:
                                type: boolean
                              setting_name:
                                type: string
                            required:
                              - name
                              - value
                              - default
                              - setting_name
                          - type: object
                            properties:
                              name:
                                type: string
                              children:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    name:
                                      type: string
                                    value:
                                      type: boolean
                                    default:
                                      type: boolean
                                    setting_name:
                                      type: string
                                  required:
                                    - name
                                    - value
                                    - default
                                    - setting_name
                            required:
                              - name
                              - children
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - display_settings
                  - meta
        '401':
          description: Unauthorized - Invalid credentials
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '403':
          description: Forbidden - User is not authorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not authorized.
                required:
                  - error
    patch:
      summary: Update display settings
      tags:
        - Display Settings
      security:
        - bearer_auth: []
      operationId: updateDisplaySettings
      description: Update display settings for the company. Accessible only by root admins.
      parameters:
        - name: Authorization
          in: header
          required: true
          description: Bearer token for authentication
          schema:
            type: string
      responses:
        '200':
          description: Display settings updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  display_settings:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        setting_name:
                          type: string
                        value:
                          type: boolean
                      required:
                        - id
                        - setting_name
                        - value
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - display_settings
                  - meta
        '401':
          description: Unauthorized - Invalid credentials
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '403':
          description: Forbidden - User is not authorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not authorized.
                required:
                  - error
        '422':
          description: Unprocessable Entity - Invalid setting values
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Validation failed
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                    properties:
                      display_settings:
                        type: object
                        properties:
                          '0':
                            type: object
                            properties:
                              value:
                                type: array
                                items:
                                  type: string
                                example:
                                  - is missing
                          '1':
                            type: object
                            properties:
                              setting_name:
                                type: array
                                items:
                                  type: string
                                example:
                                  - is missing
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                display_settings:
                  type: array
                  items:
                    type: object
                    properties:
                      setting_name:
                        type: string
                      value:
                        type: boolean
                    required:
                      - setting_name
                      - value
              required:
                - display_settings
  /api/domains:
    get:
      summary: Lists domains
      tags:
        - Domains
      operationId: listDomains
      security:
        - bearer_auth: []
      parameters:
        - name: search_query
          in: query
          required: false
          description: Search by domain name or target
          schema:
            type: string
        - name: page
          in: query
          schema:
            type: integer
            default: 1
          required: false
          description: Page number for pagination
        - name: per_page
          in: query
          schema:
            type: integer
            default: 10
          required: false
          description: Number of records per page
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  domains:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 101
                        hostname:
                          type: string
                          example: example.com
                        created_at:
                          type: string
                          example: '2024-04-20T12:34:56.000Z'
                        updated_at:
                          type: string
                          example: '2024-08-20T12:34:56.000Z'
                        apex_domain:
                          type: string
                          example: example1.com
                        certificate_domain_id:
                          type:
                            - integer
                            - 'null'
                          example: 101
                        company_id:
                          type: integer
                          example: 101
                        dns_config:
                          type:
                            - object
                            - 'null'
                          example: {}
                        primary:
                          type: boolean
                          example: false
                        redirection_domain_id:
                          type:
                            - integer
                            - 'null'
                          example: 101
                        redirection_domain_hostname:
                          type:
                            - string
                            - 'null'
                          example: example2.com
                        verification_status:
                          type: string
                          example: pending_cname
                        wildcard_subdomain:
                          type: boolean
                          example: false
                        dns_fluid_verified:
                          type: string
                          example: 'no'
                        cert_created:
                          type: boolean
                          example: true
                        connected:
                          type: boolean
                          example: false
                        verifying_cname:
                          type:
                            - boolean
                            - 'null'
                          example: false
                        payment_account:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            active:
                              type: boolean
                              example: true
                            integration_class:
                              type: string
                              example: Paypal
                            adapter_class:
                              type:
                                - string
                                - 'null'
                              example: ActiveMerchant::Billing::SpreedlyCoreGateway
                            adapter_class_label:
                              type:
                                - string
                                - 'null'
                              example: SpreedlyCoreGateway
                            name:
                              type: string
                              example: Test Payment
                            settings:
                              type: object
                              example: {}
                            test:
                              type: boolean
                              example: false
                            auto_assign_to_cart:
                              type: boolean
                              example: false
                            mid:
                              type:
                                - string
                                - 'null'
                              example: '123456789012345'
                            paypal_seller_verified:
                              type:
                                - 'null'
                                - boolean
                              example: false
                            countries:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  name:
                                    type: string
                                    example: United States
                                  iso:
                                    type: string
                                    example: US
                                  iso_name:
                                    type: string
                                    example: UNITED STATES
                                  iso3:
                                    type: string
                                    example: USA
                                  currency_code:
                                    type: string
                                    example: USD
                                  currency_symbol:
                                    type: string
                                    example: $
                                  province_required:
                                    type: boolean
                                    example: false
                                  tax_enabled:
                                    type:
                                      - boolean
                                      - 'null'
                                    example: true
                                  price_inclusive_of_tax:
                                    type: boolean
                                    example: false
                                  price_inclusive_tax_name:
                                    type:
                                      - string
                                      - 'null'
                                    example: VAT
                                required:
                                  - id
                                  - name
                                  - iso
                            icon:
                              type:
                                - string
                                - 'null'
                              example: https://example.com/icon.png
                            recurring_only:
                              type: boolean
                              example: false
                  meta:
                    type: object
                    properties:
                      total_count:
                        type: integer
                        example: 20
                      total_pages:
                        type: integer
                        example: 2
                      current_page:
                        type: integer
                        example: 1
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-11T08:04:10Z'
    post:
      summary: Create domain
      description: Create a new domain
      tags:
        - Domains
      operationId: createDomain
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: created
          content:
            application/json:
              schema:
                type: object
                properties:
                  domain:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 101
                      hostname:
                        type: string
                        example: example.com
                      created_at:
                        type: string
                        example: '2024-04-20T12:34:56.000Z'
                      updated_at:
                        type: string
                        example: '2024-08-20T12:34:56.000Z'
                      apex_domain:
                        type: string
                        example: example1.com
                      certificate_domain_id:
                        type:
                          - integer
                          - 'null'
                        example: 101
                      company_id:
                        type: integer
                        example: 101
                      dns_config:
                        type:
                          - object
                          - 'null'
                        example: {}
                      primary:
                        type: boolean
                        example: false
                      redirection_domain_id:
                        type:
                          - integer
                          - 'null'
                        example: 101
                      redirection_domain_hostname:
                        type:
                          - string
                          - 'null'
                        example: example2.com
                      verification_status:
                        type: string
                        example: pending_cname
                      wildcard_subdomain:
                        type: boolean
                        example: false
                      dns_fluid_verified:
                        type: string
                        example: 'no'
                      cert_created:
                        type: boolean
                        example: true
                      connected:
                        type: boolean
                        example: false
                      verifying_cname:
                        type:
                          - boolean
                          - 'null'
                        example: false
                      payment_account:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          active:
                            type: boolean
                            example: true
                          integration_class:
                            type: string
                            example: Paypal
                          adapter_class:
                            type:
                              - string
                              - 'null'
                            example: ActiveMerchant::Billing::SpreedlyCoreGateway
                          adapter_class_label:
                            type:
                              - string
                              - 'null'
                            example: SpreedlyCoreGateway
                          name:
                            type: string
                            example: Test Payment
                          settings:
                            type: object
                            example: {}
                          test:
                            type: boolean
                            example: false
                          auto_assign_to_cart:
                            type: boolean
                            example: false
                          mid:
                            type:
                              - string
                              - 'null'
                            example: '123456789012345'
                          paypal_seller_verified:
                            type:
                              - 'null'
                              - boolean
                            example: false
                          countries:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1
                                name:
                                  type: string
                                  example: United States
                                iso:
                                  type: string
                                  example: US
                                iso_name:
                                  type: string
                                  example: UNITED STATES
                                iso3:
                                  type: string
                                  example: USA
                                currency_code:
                                  type: string
                                  example: USD
                                currency_symbol:
                                  type: string
                                  example: $
                                province_required:
                                  type: boolean
                                  example: false
                                tax_enabled:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                price_inclusive_of_tax:
                                  type: boolean
                                  example: false
                                price_inclusive_tax_name:
                                  type:
                                    - string
                                    - 'null'
                                  example: VAT
                              required:
                                - id
                                - name
                                - iso
                          icon:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/icon.png
                          recurring_only:
                            type: boolean
                            example: false
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: unprocessable entity
                  errors:
                    type: object
                    example:
                      hostname:
                        - 'param is missing or the value is empty: hostname'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                hostname:
                  type: string
                  example: newdomain.com
                redirection_domain_id:
                  type: integer
                  example: 101
                primary:
                  type: boolean
                  example: false
                wildcard_subdomain:
                  type: boolean
                  example: false
              required:
                - hostname
  /api/domains/{id}:
    get:
      summary: Retrieves a domain
      tags:
        - Domains
      operationId: getDomain
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  domain:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 101
                      hostname:
                        type: string
                        example: example.com
                      created_at:
                        type: string
                        example: '2024-04-20T12:34:56.000Z'
                      updated_at:
                        type: string
                        example: '2024-08-20T12:34:56.000Z'
                      apex_domain:
                        type: string
                        example: example1.com
                      certificate_domain_id:
                        type:
                          - integer
                          - 'null'
                        example: 101
                      company_id:
                        type: integer
                        example: 101
                      dns_config:
                        type:
                          - object
                          - 'null'
                        example: {}
                      primary:
                        type: boolean
                        example: false
                      redirection_domain_id:
                        type:
                          - integer
                          - 'null'
                        example: 101
                      redirection_domain_hostname:
                        type:
                          - string
                          - 'null'
                        example: example2.com
                      verification_status:
                        type: string
                        example: pending_cname
                      wildcard_subdomain:
                        type: boolean
                        example: false
                      dns_fluid_verified:
                        type: string
                        example: 'no'
                      cert_created:
                        type: boolean
                        example: true
                      connected:
                        type: boolean
                        example: false
                      verifying_cname:
                        type:
                          - boolean
                          - 'null'
                        example: false
                      payment_account:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          active:
                            type: boolean
                            example: true
                          integration_class:
                            type: string
                            example: Paypal
                          adapter_class:
                            type:
                              - string
                              - 'null'
                            example: ActiveMerchant::Billing::SpreedlyCoreGateway
                          adapter_class_label:
                            type:
                              - string
                              - 'null'
                            example: SpreedlyCoreGateway
                          name:
                            type: string
                            example: Test Payment
                          settings:
                            type: object
                            example: {}
                          test:
                            type: boolean
                            example: false
                          auto_assign_to_cart:
                            type: boolean
                            example: false
                          mid:
                            type:
                              - string
                              - 'null'
                            example: '123456789012345'
                          paypal_seller_verified:
                            type:
                              - 'null'
                              - boolean
                            example: false
                          countries:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1
                                name:
                                  type: string
                                  example: United States
                                iso:
                                  type: string
                                  example: US
                                iso_name:
                                  type: string
                                  example: UNITED STATES
                                iso3:
                                  type: string
                                  example: USA
                                currency_code:
                                  type: string
                                  example: USD
                                currency_symbol:
                                  type: string
                                  example: $
                                province_required:
                                  type: boolean
                                  example: false
                                tax_enabled:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                price_inclusive_of_tax:
                                  type: boolean
                                  example: false
                                price_inclusive_tax_name:
                                  type:
                                    - string
                                    - 'null'
                                  example: VAT
                              required:
                                - id
                                - name
                                - iso
                          icon:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/icon.png
                          recurring_only:
                            type: boolean
                            example: false
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    example:
                      id:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
    put:
      summary: Updates a domain
      tags:
        - Domains
      operationId: updateDomain
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  domain:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 101
                      hostname:
                        type: string
                        example: example.com
                      created_at:
                        type: string
                        example: '2024-04-20T12:34:56.000Z'
                      updated_at:
                        type: string
                        example: '2024-08-20T12:34:56.000Z'
                      apex_domain:
                        type: string
                        example: example1.com
                      certificate_domain_id:
                        type:
                          - integer
                          - 'null'
                        example: 101
                      company_id:
                        type: integer
                        example: 101
                      dns_config:
                        type:
                          - object
                          - 'null'
                        example: {}
                      primary:
                        type: boolean
                        example: false
                      redirection_domain_id:
                        type:
                          - integer
                          - 'null'
                        example: 101
                      redirection_domain_hostname:
                        type:
                          - string
                          - 'null'
                        example: example2.com
                      verification_status:
                        type: string
                        example: pending_cname
                      wildcard_subdomain:
                        type: boolean
                        example: false
                      dns_fluid_verified:
                        type: string
                        example: 'no'
                      cert_created:
                        type: boolean
                        example: true
                      connected:
                        type: boolean
                        example: false
                      verifying_cname:
                        type:
                          - boolean
                          - 'null'
                        example: false
                      payment_account:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          active:
                            type: boolean
                            example: true
                          integration_class:
                            type: string
                            example: Paypal
                          adapter_class:
                            type:
                              - string
                              - 'null'
                            example: ActiveMerchant::Billing::SpreedlyCoreGateway
                          adapter_class_label:
                            type:
                              - string
                              - 'null'
                            example: SpreedlyCoreGateway
                          name:
                            type: string
                            example: Test Payment
                          settings:
                            type: object
                            example: {}
                          test:
                            type: boolean
                            example: false
                          auto_assign_to_cart:
                            type: boolean
                            example: false
                          mid:
                            type:
                              - string
                              - 'null'
                            example: '123456789012345'
                          paypal_seller_verified:
                            type:
                              - 'null'
                              - boolean
                            example: false
                          countries:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1
                                name:
                                  type: string
                                  example: United States
                                iso:
                                  type: string
                                  example: US
                                iso_name:
                                  type: string
                                  example: UNITED STATES
                                iso3:
                                  type: string
                                  example: USA
                                currency_code:
                                  type: string
                                  example: USD
                                currency_symbol:
                                  type: string
                                  example: $
                                province_required:
                                  type: boolean
                                  example: false
                                tax_enabled:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                price_inclusive_of_tax:
                                  type: boolean
                                  example: false
                                price_inclusive_tax_name:
                                  type:
                                    - string
                                    - 'null'
                                  example: VAT
                              required:
                                - id
                                - name
                                - iso
                          icon:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/icon.png
                          recurring_only:
                            type: boolean
                            example: false
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    example:
                      domain:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                hostname:
                  type: string
                  example: updateddomain.com
    delete:
      summary: Deletes a domain
      tags:
        - Domains
      operationId: deleteDomain
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  domain:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 101
                      hostname:
                        type: string
                        example: example.com
                      created_at:
                        type: string
                        example: '2024-04-20T12:34:56.000Z'
                      updated_at:
                        type: string
                        example: '2024-08-20T12:34:56.000Z'
                      apex_domain:
                        type: string
                        example: example1.com
                      certificate_domain_id:
                        type:
                          - integer
                          - 'null'
                        example: 101
                      company_id:
                        type: integer
                        example: 101
                      dns_config:
                        type:
                          - object
                          - 'null'
                        example: {}
                      primary:
                        type: boolean
                        example: false
                      redirection_domain_id:
                        type:
                          - integer
                          - 'null'
                        example: 101
                      redirection_domain_hostname:
                        type:
                          - string
                          - 'null'
                        example: example2.com
                      verification_status:
                        type: string
                        example: pending_cname
                      wildcard_subdomain:
                        type: boolean
                        example: false
                      dns_fluid_verified:
                        type: string
                        example: 'no'
                      cert_created:
                        type: boolean
                        example: true
                      connected:
                        type: boolean
                        example: false
                      verifying_cname:
                        type:
                          - boolean
                          - 'null'
                        example: false
                      payment_account:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          active:
                            type: boolean
                            example: true
                          integration_class:
                            type: string
                            example: Paypal
                          adapter_class:
                            type:
                              - string
                              - 'null'
                            example: ActiveMerchant::Billing::SpreedlyCoreGateway
                          adapter_class_label:
                            type:
                              - string
                              - 'null'
                            example: SpreedlyCoreGateway
                          name:
                            type: string
                            example: Test Payment
                          settings:
                            type: object
                            example: {}
                          test:
                            type: boolean
                            example: false
                          auto_assign_to_cart:
                            type: boolean
                            example: false
                          mid:
                            type:
                              - string
                              - 'null'
                            example: '123456789012345'
                          paypal_seller_verified:
                            type:
                              - 'null'
                              - boolean
                            example: false
                          countries:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1
                                name:
                                  type: string
                                  example: United States
                                iso:
                                  type: string
                                  example: US
                                iso_name:
                                  type: string
                                  example: UNITED STATES
                                iso3:
                                  type: string
                                  example: USA
                                currency_code:
                                  type: string
                                  example: USD
                                currency_symbol:
                                  type: string
                                  example: $
                                province_required:
                                  type: boolean
                                  example: false
                                tax_enabled:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                price_inclusive_of_tax:
                                  type: boolean
                                  example: false
                                price_inclusive_tax_name:
                                  type:
                                    - string
                                    - 'null'
                                  example: VAT
                              required:
                                - id
                                - name
                                - iso
                          icon:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/icon.png
                          recurring_only:
                            type: boolean
                            example: false
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                        example:
                          - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: unprocessable entity
                  errors:
                    type: object
                    example:
                      hostname:
                        - >-
                          is a Primary Domain and cannot be deleted. Please
                          change the Primary Domain before attempting to delete.
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
  /api/domains/{id}/check_cname_propagation:
    get:
      summary: Check CNAME propagation
      tags:
        - Domains
      operationId: checkCNAMEPropagation
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Domain ID
          schema:
            type: integer
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  propagated:
                    type: boolean
                    example: true
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Domain not found
                  errors:
                    type: object
                    example:
                      id:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: unprocessable entity
                  errors:
                    type: string
                    example: Unexpected error
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
  /api/domains/{id}/verify_domain:
    patch:
      summary: Verify domain
      tags:
        - Domains
      operationId: verifyDomain
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Domain ID
          schema:
            type: integer
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  domain:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 101
                      hostname:
                        type: string
                        example: example.com
                      created_at:
                        type: string
                        example: '2024-04-20T12:34:56.000Z'
                      updated_at:
                        type: string
                        example: '2024-08-20T12:34:56.000Z'
                      apex_domain:
                        type: string
                        example: example1.com
                      certificate_domain_id:
                        type:
                          - integer
                          - 'null'
                        example: 101
                      company_id:
                        type: integer
                        example: 101
                      dns_config:
                        type:
                          - object
                          - 'null'
                        example: {}
                      primary:
                        type: boolean
                        example: false
                      redirection_domain_id:
                        type:
                          - integer
                          - 'null'
                        example: 101
                      redirection_domain_hostname:
                        type:
                          - string
                          - 'null'
                        example: example2.com
                      verification_status:
                        type: string
                        example: pending_cname
                      wildcard_subdomain:
                        type: boolean
                        example: false
                      dns_fluid_verified:
                        type: string
                        example: 'no'
                      cert_created:
                        type: boolean
                        example: true
                      connected:
                        type: boolean
                        example: false
                      verifying_cname:
                        type:
                          - boolean
                          - 'null'
                        example: false
                      payment_account:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          active:
                            type: boolean
                            example: true
                          integration_class:
                            type: string
                            example: Paypal
                          adapter_class:
                            type:
                              - string
                              - 'null'
                            example: ActiveMerchant::Billing::SpreedlyCoreGateway
                          adapter_class_label:
                            type:
                              - string
                              - 'null'
                            example: SpreedlyCoreGateway
                          name:
                            type: string
                            example: Test Payment
                          settings:
                            type: object
                            example: {}
                          test:
                            type: boolean
                            example: false
                          auto_assign_to_cart:
                            type: boolean
                            example: false
                          mid:
                            type:
                              - string
                              - 'null'
                            example: '123456789012345'
                          paypal_seller_verified:
                            type:
                              - 'null'
                              - boolean
                            example: false
                          countries:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1
                                name:
                                  type: string
                                  example: United States
                                iso:
                                  type: string
                                  example: US
                                iso_name:
                                  type: string
                                  example: UNITED STATES
                                iso3:
                                  type: string
                                  example: USA
                                currency_code:
                                  type: string
                                  example: USD
                                currency_symbol:
                                  type: string
                                  example: $
                                province_required:
                                  type: boolean
                                  example: false
                                tax_enabled:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                price_inclusive_of_tax:
                                  type: boolean
                                  example: false
                                price_inclusive_tax_name:
                                  type:
                                    - string
                                    - 'null'
                                  example: VAT
                              required:
                                - id
                                - name
                                - iso
                          icon:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/icon.png
                          recurring_only:
                            type: boolean
                            example: false
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    example:
                      domain:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: string
                    example: Domain not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
  /api/domains/{id}/confirm_cname_for_domain:
    patch:
      summary: Confirm CNAME for domain
      tags:
        - Domains
      operationId: confirmCNAMEForDomain
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Domain ID
          schema:
            type: integer
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  domain:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 101
                      hostname:
                        type: string
                        example: example.com
                      created_at:
                        type: string
                        example: '2024-04-20T12:34:56.000Z'
                      updated_at:
                        type: string
                        example: '2024-08-20T12:34:56.000Z'
                      apex_domain:
                        type: string
                        example: example1.com
                      certificate_domain_id:
                        type:
                          - integer
                          - 'null'
                        example: 101
                      company_id:
                        type: integer
                        example: 101
                      dns_config:
                        type:
                          - object
                          - 'null'
                        example: {}
                      primary:
                        type: boolean
                        example: false
                      redirection_domain_id:
                        type:
                          - integer
                          - 'null'
                        example: 101
                      redirection_domain_hostname:
                        type:
                          - string
                          - 'null'
                        example: example2.com
                      verification_status:
                        type: string
                        example: pending_cname
                      wildcard_subdomain:
                        type: boolean
                        example: false
                      dns_fluid_verified:
                        type: string
                        example: 'no'
                      cert_created:
                        type: boolean
                        example: true
                      connected:
                        type: boolean
                        example: false
                      verifying_cname:
                        type:
                          - boolean
                          - 'null'
                        example: false
                      payment_account:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                            example: 1
                          active:
                            type: boolean
                            example: true
                          integration_class:
                            type: string
                            example: Paypal
                          adapter_class:
                            type:
                              - string
                              - 'null'
                            example: ActiveMerchant::Billing::SpreedlyCoreGateway
                          adapter_class_label:
                            type:
                              - string
                              - 'null'
                            example: SpreedlyCoreGateway
                          name:
                            type: string
                            example: Test Payment
                          settings:
                            type: object
                            example: {}
                          test:
                            type: boolean
                            example: false
                          auto_assign_to_cart:
                            type: boolean
                            example: false
                          mid:
                            type:
                              - string
                              - 'null'
                            example: '123456789012345'
                          paypal_seller_verified:
                            type:
                              - 'null'
                              - boolean
                            example: false
                          countries:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1
                                name:
                                  type: string
                                  example: United States
                                iso:
                                  type: string
                                  example: US
                                iso_name:
                                  type: string
                                  example: UNITED STATES
                                iso3:
                                  type: string
                                  example: USA
                                currency_code:
                                  type: string
                                  example: USD
                                currency_symbol:
                                  type: string
                                  example: $
                                province_required:
                                  type: boolean
                                  example: false
                                tax_enabled:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                price_inclusive_of_tax:
                                  type: boolean
                                  example: false
                                price_inclusive_tax_name:
                                  type:
                                    - string
                                    - 'null'
                                  example: VAT
                              required:
                                - id
                                - name
                                - iso
                          icon:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/icon.png
                          recurring_only:
                            type: boolean
                            example: false
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    example:
                      domain:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: unprocessable entity
                  errors:
                    type: string
                    example: CNAME validation failed
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
  /api/drop_zones:
    get:
      summary: An array of available drop zones
      tags:
        - Drop Zones
      operationId: indexDropZones
      security:
        - bearer_auth: []
      parameters:
        - name: pagination
          in: query
          schema:
            type: object
            properties:
              page:
                type: integer
                exclusiveMinimum: 0
              per_page:
                type: integer
                exclusiveMinimum: 0
                maximum: 100
              active:
                type: boolean
              public:
                type: boolean
              page_type:
                type: string
            required: []
      responses:
        '200':
          description: returns a list of order confirmation drop zones
          content:
            application/json:
              schema:
                type: object
                properties:
                  drop_zones:
                    type: array
                    items:
                      title: DropZone
                      type: object
                      properties:
                        uuid:
                          type: string
                        name:
                          type: string
                        active:
                          type:
                            - boolean
                            - 'null'
                          default: false
                        settings:
                          type:
                            - object
                            - 'null'
                          default: '{}'
                        embed_url:
                          type: string
                      required:
                        - uuid
                        - name
                        - embed_url
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      pagination:
                        type: object
                        properties:
                          current_page:
                            type: integer
                            example: 1
                          total_pages:
                            type: integer
                            example: 10
                          total_count:
                            type: integer
                            example: 100
                          per_page:
                            type: integer
                            example: 10
                required:
                  - drop_zones
                  - meta
    post:
      summary: creates a drop zone
      tags:
        - Drop Zones
      operationId: createDropZone
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: admin detail drop zone created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  drop_zone:
                    title: DropZone
                    type: object
                    properties:
                      uuid:
                        type: string
                      name:
                        type: string
                      active:
                        type:
                          - boolean
                          - 'null'
                        default: false
                      settings:
                        type:
                          - object
                          - 'null'
                        default: '{}'
                      embed_url:
                        type: string
                      created_at:
                        type: string
                        format: date-time
                    required:
                      - uuid
                      - name
                      - embed_url
                      - created_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - drop_zone
                  - meta
        '422':
          description: invalid order confirmation zone
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                drop_zone:
                  type: object
                  properties:
                    name:
                      type: string
                      minLength: 1
                    embed_url:
                      type: string
                      minLength: 1
                    active:
                      type: boolean
                    settings:
                      type: object
                  required:
                    - name
                    - embed_url
              required:
                - drop_zone
  /api/drop_zones/{uuid}:
    get:
      summary: shows a drop zone
      tags:
        - Drop Zones
      operationId: showDropZone
      security:
        - bearer_auth: []
      parameters:
        - name: uuid
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: returns a single drop zone
          content:
            application/json:
              schema:
                type: object
                properties:
                  drop_zone:
                    title: DropZone
                    type: object
                    properties:
                      uuid:
                        type: string
                      name:
                        type: string
                      active:
                        type:
                          - boolean
                          - 'null'
                        default: false
                      settings:
                        type:
                          - object
                          - 'null'
                        default: '{}'
                      embed_url:
                        type: string
                    required:
                      - uuid
                      - name
                      - embed_url
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - drop_zone
                  - meta
        '404':
          description: drop zone not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
    put:
      summary: updates a drop zone
      tags:
        - Drop Zones
      operationId: updateDropZone
      security:
        - bearer_auth: []
      parameters:
        - name: uuid
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: drop zone updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  drop_zone:
                    title: DropZone
                    type: object
                    properties:
                      uuid:
                        type: string
                      name:
                        type: string
                      active:
                        type:
                          - boolean
                          - 'null'
                        default: false
                      settings:
                        type:
                          - object
                          - 'null'
                        default: '{}'
                      embed_url:
                        type: string
                      updated_at:
                        type: string
                        format: date-time
                    required:
                      - uuid
                      - name
                      - embed_url
                      - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - drop_zone
                  - meta
        '404':
          description: drop zone not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: invalid drop zone parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                uuid:
                  type: string
                drop_zone:
                  type: object
                  properties:
                    name:
                      type: string
                      minLength: 1
                    active:
                      type: boolean
                      not:
                        type: 'null'
                    settings:
                      type: object
                      not:
                        type: 'null'
                    embed_url:
                      type: string
                      minLength: 1
                  required: []
              required:
                - uuid
                - drop_zone
    delete:
      summary: deletes a drop zone
      tags:
        - Drop Zones
      operationId: destroyDropZone
      security:
        - bearer_auth: []
      parameters:
        - name: uuid
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: drop zone deleted successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  uuid:
                    type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - uuid
                  - meta
        '404':
          description: drop zone not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                uuid:
                  type: string
              required:
                - uuid
  /api/drop_zones/constants:
    get:
      summary: returns drop zone constants
      tags:
        - Drop Zones
      operationId: getDropZoneConstants
      security:
        - bearer_auth: []
      responses:
        '200':
          description: returns drop zone constants
          content:
            application/json:
              schema:
                type: object
                properties:
                  constants:
                    type: object
                    properties:
                      page_types:
                        type: array
                        items:
                          type: string
                      checkout_zones:
                        type: array
                        items:
                          type: string
                      order_confirmation_zones:
                        type: array
                        items:
                          type: string
                      subscription_zones:
                        type: array
                        items:
                          type: string
                      form_zones:
                        type: array
                        items:
                          type: string
                      admin_detail_zones:
                        type: array
                        items:
                          type: string
                      home_zones:
                        type: array
                        items:
                          type: string
                      product_zones:
                        type: array
                        items:
                          type: string
                      page_zones:
                        type: object
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - constants
                  - meta
  /api/droplet_categories:
    get:
      summary: Returns a list of all droplet categories
      tags:
        - Droplet Categories
      operationId: indexDropletCategories
      security:
        - bearer_auth: []
      responses:
        '200':
          description: returns a list of droplet categories
          content:
            application/json:
              schema:
                type: object
                properties:
                  droplet_categories:
                    type: array
                    items:
                      title: DropletCategory
                      type: object
                      properties:
                        name:
                          type: string
                        slug:
                          type:
                            - string
                            - 'null'
                        description:
                          type:
                            - string
                            - 'null'
                      required:
                        - name
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/droplet_installations:
    get:
      summary: List droplet installations
      tags:
        - Droplet Installations
      operationId: indexDropletInstallations
      security:
        - bearer_auth: []
      parameters:
        - name: page
          in: query
          required: false
          description: Page number for pagination
          schema:
            type: integer
        - name: per_page
          in: query
          required: false
          description: 'Number of records per page (max: 100)'
          schema:
            type: integer
        - name: category
          in: query
          required: false
          description: Filter by droplet category
          schema:
            type: string
      responses:
        '200':
          description: returns a list of droplet installations
          content:
            application/json:
              schema:
                type: object
                properties:
                  droplet_installations:
                    type: array
                    items:
                      title: DropletInstallation
                      type: object
                      properties:
                        uuid:
                          type: string
                        id:
                          type: integer
                        droplet_uuid:
                          example: drp_p4r9jsl305iduqrsl0ujdth35jhuy2al
                          type: string
                        droplet_name:
                          type: string
                        active:
                          type: boolean
                          default: true
                      required:
                        - uuid
                        - id
                        - droplet_uuid
                        - droplet_name
                        - active
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      pagination:
                        type: object
                        properties:
                          current_page:
                            type: integer
                            example: 1
                          total_pages:
                            type: integer
                            example: 10
                          total_count:
                            type: integer
                            example: 100
                          per_page:
                            type: integer
                            example: 10
                required:
                  - droplet_installations
                  - meta
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
    post:
      summary: Create a droplet installation
      tags:
        - Droplet Installations
      operationId: createDropletInstallation
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: droplet installation created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  droplet_installation:
                    title: DropletInstallation
                    type: object
                    properties:
                      uuid:
                        type: string
                      id:
                        type: integer
                      droplet_uuid:
                        example: drp_p4r9jsl305iduqrsl0ujdth35jhuy2al
                        type: string
                      droplet_name:
                        type: string
                      active:
                        type: boolean
                        default: true
                      created_at:
                        type: string
                        format: date-time
                    required:
                      - uuid
                      - id
                      - droplet_uuid
                      - droplet_name
                      - active
                      - created_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - droplet_installation
                  - meta
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '404':
          description: droplet not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                droplet_uuid:
                  type: string
              required:
                - droplet_uuid
  /api/droplet_installations/{uuid}:
    get:
      summary: Show a droplet installation
      tags:
        - Droplet Installations
      operationId: showDropletInstallation
      security:
        - bearer_auth: []
      parameters:
        - name: uuid
          in: path
          required: true
          description: The UUID of the droplet installation
          schema:
            type: string
      responses:
        '200':
          description: returns a single droplet installation
          content:
            application/json:
              schema:
                type: object
                properties:
                  droplet_installation:
                    title: DropletInstallation
                    type: object
                    properties:
                      uuid:
                        type: string
                      id:
                        type: integer
                      droplet_uuid:
                        example: drp_p4r9jsl305iduqrsl0ujdth35jhuy2al
                        type: string
                      droplet_name:
                        type: string
                      active:
                        type: boolean
                        default: true
                      authentication_token:
                        example: dit_1js8p2crwCzbkyRXjjccl8RDqCXYDnaDF
                        type: string
                      webhook_verification_token:
                        example: wvt_1js8p2crwCzbkyRXjjccl8RDqCXYDnaDF
                        type: string
                      created_at:
                        type: string
                        format: date-time
                      updated_at:
                        type: string
                        format: date-time
                    required:
                      - uuid
                      - id
                      - droplet_uuid
                      - droplet_name
                      - active
                      - authentication_token
                      - webhook_verification_token
                      - created_at
                      - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - droplet_installation
                  - meta
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '404':
          description: droplet installation not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
    put:
      summary: Update a droplet installation
      tags:
        - Droplet Installations
      operationId: updateDropletInstallation
      security:
        - bearer_auth: []
      parameters:
        - name: uuid
          in: path
          required: true
          description: The UUID of the droplet installation
          schema:
            type: string
      responses:
        '200':
          description: droplet installation updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  droplet_installation:
                    title: DropletInstallation
                    type: object
                    properties:
                      uuid:
                        type: string
                      id:
                        type: integer
                      droplet_uuid:
                        example: drp_p4r9jsl305iduqrsl0ujdth35jhuy2al
                        type: string
                      droplet_name:
                        type: string
                      active:
                        type: boolean
                        default: true
                      updated_at:
                        type: string
                        format: date-time
                    required:
                      - uuid
                      - id
                      - droplet_uuid
                      - droplet_name
                      - active
                      - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - droplet_installation
                  - meta
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '404':
          description: droplet installation not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                uuid:
                  type: string
                droplet_installation:
                  type: object
                  properties:
                    active:
                      type: boolean
                  required:
                    - active
              required:
                - uuid
                - droplet_installation
    delete:
      summary: Delete a droplet installation
      tags:
        - Droplet Installations
      operationId: destroyDropletInstallation
      security:
        - bearer_auth: []
      parameters:
        - name: uuid
          in: path
          required: true
          description: The UUID of the droplet installation
          schema:
            type: string
      responses:
        '200':
          description: droplet installation deleted successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  droplet_installation:
                    title: DropletInstallation
                    type: object
                    properties:
                      uuid:
                        type: string
                      id:
                        type: integer
                    required:
                      - uuid
                      - id
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - droplet_installation
                  - meta
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '404':
          description: droplet installation not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/droplets/{uuid}/companies:
    get:
      summary: returns an array of companies using a droplet
      tags:
        - Droplets
      operationId: showDropletCompanies
      security:
        - bearer_auth: []
      parameters:
        - name: uuid
          in: path
          required: true
          schema:
            type: string
        - name: pagination
          in: query
          schema:
            type: object
            properties:
              page:
                type: integer
                exclusiveMinimum: 0
              per_page:
                type: integer
                exclusiveMinimum: 0
                maximum: 100
            required: []
      responses:
        '200':
          description: returns list of companies subscribed to the droplet
          content:
            application/json:
              schema:
                type: object
                properties:
                  companies:
                    type: array
                    items:
                      title: Company
                      type: object
                      properties:
                        id:
                          type: integer
                        name:
                          example: Acme, Inc.
                          type: string
                        active:
                          type:
                            - boolean
                            - 'null'
                          default: true
                      required:
                        - id
                        - name
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      pagination:
                        type: object
                        properties:
                          current_page:
                            type: integer
                            example: 1
                          total_pages:
                            type: integer
                            example: 10
                          total_count:
                            type: integer
                            example: 100
                          per_page:
                            type: integer
                            example: 10
        '401':
          description: unauthorized
  /api/droplets:
    get:
      summary: An array of available droplets
      tags:
        - Droplets
      operationId: indexDroplets
      security:
        - bearer_auth: []
      parameters:
        - name: pagination
          in: query
          schema:
            type: object
            properties:
              page:
                type: integer
                exclusiveMinimum: 0
              per_page:
                type: integer
                exclusiveMinimum: 0
                maximum: 100
              category:
                type: string
            required: []
      responses:
        '200':
          description: returns a list of droplets
          content:
            application/json:
              schema:
                type: object
                properties:
                  droplets:
                    type: array
                    items:
                      title: Droplet
                      type: object
                      properties:
                        uuid:
                          type: string
                        name:
                          type: string
                        categories:
                          items:
                            type: string
                          type: array
                        active:
                          type:
                            - boolean
                            - 'null'
                          default: false
                        publicly_available:
                          type:
                            - boolean
                            - 'null'
                          default: false
                        embed_url:
                          type:
                            - string
                            - 'null'
                        created_at:
                          type: string
                          format: date-time
                        settings:
                          title: Droplet::Settings
                          type:
                            - object
                            - 'null'
                          properties:
                            marketplace_page:
                              title: Droplet::MarketplacePage
                              type:
                                - object
                                - 'null'
                              properties:
                                title:
                                  type: string
                                logo_url:
                                  type:
                                    - string
                                    - 'null'
                                summary:
                                  type:
                                    - string
                                    - 'null'
                              required:
                                - title
                            details_page:
                              title: Droplet::DetailsPage
                              type:
                                - object
                                - 'null'
                              properties:
                                title:
                                  type: string
                                logo_url:
                                  type:
                                    - string
                                    - 'null'
                                summary:
                                  type:
                                    - string
                                    - 'null'
                                features:
                                  type:
                                    - array
                                    - 'null'
                                  items:
                                    title: Droplet::Feature
                                    type: object
                                    properties:
                                      name:
                                        type: string
                                      summary:
                                        type:
                                          - string
                                          - 'null'
                                      details:
                                        type:
                                          - string
                                          - 'null'
                                      image_url:
                                        type:
                                          - string
                                          - 'null'
                                      video_url:
                                        type:
                                          - string
                                          - 'null'
                                    required:
                                      - name
                              required:
                                - title
                            service_operational_countries:
                              items:
                                type: string
                                pattern: ^[A-Z]{3}$
                                description: >-
                                  An array of ISO3 country codes for which the
                                  droplet is operational. A null value indicates
                                  that the service operates everywhere. An empty
                                  array indicates that the service operates
                                  nowhere.
                                example: '["USA", "CAN"]'
                              type:
                                - array
                                - 'null'
                          required: []
                      required:
                        - uuid
                        - name
                        - categories
                        - created_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      pagination:
                        type: object
                        properties:
                          current_page:
                            type: integer
                            example: 1
                          total_pages:
                            type: integer
                            example: 10
                          total_count:
                            type: integer
                            example: 100
                          per_page:
                            type: integer
                            example: 10
                required:
                  - droplets
                  - meta
    post:
      summary: creates a droplet
      tags:
        - Droplets
      operationId: createDroplet
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: droplet created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  droplet:
                    title: Droplet
                    type: object
                    properties:
                      uuid:
                        type: string
                      name:
                        type: string
                      categories:
                        items:
                          type: string
                        type: array
                      active:
                        type:
                          - boolean
                          - 'null'
                        default: false
                      publicly_available:
                        type:
                          - boolean
                          - 'null'
                        default: false
                      embed_url:
                        type:
                          - string
                          - 'null'
                      created_at:
                        type: string
                        format: date-time
                      settings:
                        title: Droplet::Settings
                        type:
                          - object
                          - 'null'
                        properties:
                          marketplace_page:
                            title: Droplet::MarketplacePage
                            type:
                              - object
                              - 'null'
                            properties:
                              title:
                                type: string
                              logo_url:
                                type:
                                  - string
                                  - 'null'
                              summary:
                                type:
                                  - string
                                  - 'null'
                            required:
                              - title
                          details_page:
                            title: Droplet::DetailsPage
                            type:
                              - object
                              - 'null'
                            properties:
                              title:
                                type: string
                              logo_url:
                                type:
                                  - string
                                  - 'null'
                              summary:
                                type:
                                  - string
                                  - 'null'
                              features:
                                type:
                                  - array
                                  - 'null'
                                items:
                                  title: Droplet::Feature
                                  type: object
                                  properties:
                                    name:
                                      type: string
                                    summary:
                                      type:
                                        - string
                                        - 'null'
                                    details:
                                      type:
                                        - string
                                        - 'null'
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                    video_url:
                                      type:
                                        - string
                                        - 'null'
                                  required:
                                    - name
                            required:
                              - title
                          service_operational_countries:
                            items:
                              type: string
                              pattern: ^[A-Z]{3}$
                              description: >-
                                An array of ISO3 country codes for which the
                                droplet is operational. A null value indicates
                                that the service operates everywhere. An empty
                                array indicates that the service operates
                                nowhere.
                              example: '["USA", "CAN"]'
                            type:
                              - array
                              - 'null'
                        required: []
                    required:
                      - uuid
                      - name
                      - categories
                      - created_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - droplet
                  - meta
        '422':
          description: invalid droplet parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                droplet:
                  type: object
                  properties:
                    name:
                      type: string
                      minLength: 1
                    embed_url:
                      type: string
                      minLength: 1
                    settings:
                      type: object
                      properties:
                        marketplace_page:
                          type: object
                          properties:
                            title:
                              type: string
                              minLength: 1
                            summary:
                              type: string
                              minLength: 1
                            logo_url:
                              type: string
                              minLength: 1
                          required: []
                        details_page:
                          type: object
                          properties:
                            title:
                              type: string
                              minLength: 1
                            summary:
                              type: string
                              minLength: 1
                            logo_url:
                              type: string
                              minLength: 1
                            features:
                              type: array
                              items:
                                type: object
                                properties:
                                  name:
                                    type: string
                                    minLength: 1
                                  summary:
                                    type: string
                                    minLength: 1
                                  details:
                                    type: string
                                    minLength: 1
                                  image_url:
                                    type: string
                                    minLength: 1
                                  video_url:
                                    type: string
                                    minLength: 1
                                required:
                                  - name
                                  - summary
                                  - details
                          required: []
                        service_operational_countries:
                          type: array
                          items:
                            type: string
                      required: []
                    categories:
                      type: array
                      items:
                        type: string
                  required:
                    - name
                    - embed_url
              required:
                - droplet
  /api/droplets/{uuid}:
    get:
      summary: shows a droplet
      tags:
        - Droplets
      operationId: showDroplet
      security:
        - bearer_auth: []
      parameters:
        - name: uuid
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: returns a single droplet
          content:
            application/json:
              schema:
                type: object
                properties:
                  droplet:
                    title: Droplet
                    type: object
                    properties:
                      uuid:
                        type: string
                      name:
                        type: string
                      categories:
                        items:
                          type: string
                        type: array
                      active:
                        type:
                          - boolean
                          - 'null'
                        default: false
                      publicly_available:
                        type:
                          - boolean
                          - 'null'
                        default: false
                      embed_url:
                        type:
                          - string
                          - 'null'
                      created_at:
                        type: string
                        format: date-time
                      settings:
                        title: Droplet::Settings
                        type:
                          - object
                          - 'null'
                        properties:
                          marketplace_page:
                            title: Droplet::MarketplacePage
                            type:
                              - object
                              - 'null'
                            properties:
                              title:
                                type: string
                              logo_url:
                                type:
                                  - string
                                  - 'null'
                              summary:
                                type:
                                  - string
                                  - 'null'
                            required:
                              - title
                          details_page:
                            title: Droplet::DetailsPage
                            type:
                              - object
                              - 'null'
                            properties:
                              title:
                                type: string
                              logo_url:
                                type:
                                  - string
                                  - 'null'
                              summary:
                                type:
                                  - string
                                  - 'null'
                              features:
                                type:
                                  - array
                                  - 'null'
                                items:
                                  title: Droplet::Feature
                                  type: object
                                  properties:
                                    name:
                                      type: string
                                    summary:
                                      type:
                                        - string
                                        - 'null'
                                    details:
                                      type:
                                        - string
                                        - 'null'
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                    video_url:
                                      type:
                                        - string
                                        - 'null'
                                  required:
                                    - name
                            required:
                              - title
                          service_operational_countries:
                            items:
                              type: string
                              pattern: ^[A-Z]{3}$
                              description: >-
                                An array of ISO3 country codes for which the
                                droplet is operational. A null value indicates
                                that the service operates everywhere. An empty
                                array indicates that the service operates
                                nowhere.
                              example: '["USA", "CAN"]'
                            type:
                              - array
                              - 'null'
                        required: []
                      updated_at:
                        type: string
                        format: date-time
                      owner_company:
                        title: Company
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: Acme, Inc.
                            type: string
                        required:
                          - id
                          - name
                    required:
                      - uuid
                      - name
                      - categories
                      - created_at
                      - updated_at
                      - owner_company
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - droplet
                  - meta
        '404':
          description: droplet not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
    put:
      summary: updates a droplet
      description: >-
        Update an existing droplet. Regular users can update most fields
        (active, name, embed_url, settings, categories) on droplets owned by
        their company. Only root admins can update publicly_available and
        company_id fields. Root admins can update any droplet.
      tags:
        - Droplets
      operationId: updateDroplet
      security:
        - bearer_auth: []
      parameters:
        - name: uuid
          in: path
          required: true
          description: Droplet UUID
          schema:
            type: string
      responses:
        '200':
          description: droplet updated successfully by root admin with root admin fields
          content:
            application/json:
              schema:
                type: object
                properties:
                  droplet:
                    title: Droplet
                    type: object
                    properties:
                      uuid:
                        type: string
                      name:
                        type: string
                      categories:
                        items:
                          type: string
                        type: array
                      active:
                        type:
                          - boolean
                          - 'null'
                        default: false
                      publicly_available:
                        type:
                          - boolean
                          - 'null'
                        default: false
                      embed_url:
                        type:
                          - string
                          - 'null'
                      created_at:
                        type: string
                        format: date-time
                      settings:
                        title: Droplet::Settings
                        type:
                          - object
                          - 'null'
                        properties:
                          marketplace_page:
                            title: Droplet::MarketplacePage
                            type:
                              - object
                              - 'null'
                            properties:
                              title:
                                type: string
                              logo_url:
                                type:
                                  - string
                                  - 'null'
                              summary:
                                type:
                                  - string
                                  - 'null'
                            required:
                              - title
                          details_page:
                            title: Droplet::DetailsPage
                            type:
                              - object
                              - 'null'
                            properties:
                              title:
                                type: string
                              logo_url:
                                type:
                                  - string
                                  - 'null'
                              summary:
                                type:
                                  - string
                                  - 'null'
                              features:
                                type:
                                  - array
                                  - 'null'
                                items:
                                  title: Droplet::Feature
                                  type: object
                                  properties:
                                    name:
                                      type: string
                                    summary:
                                      type:
                                        - string
                                        - 'null'
                                    details:
                                      type:
                                        - string
                                        - 'null'
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                    video_url:
                                      type:
                                        - string
                                        - 'null'
                                  required:
                                    - name
                            required:
                              - title
                          service_operational_countries:
                            items:
                              type: string
                              pattern: ^[A-Z]{3}$
                              description: >-
                                An array of ISO3 country codes for which the
                                droplet is operational. A null value indicates
                                that the service operates everywhere. An empty
                                array indicates that the service operates
                                nowhere.
                              example: '["USA", "CAN"]'
                            type:
                              - array
                              - 'null'
                        required: []
                      updated_at:
                        type: string
                        format: date-time
                      owner_company:
                        title: Company
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: Acme, Inc.
                            type: string
                        required:
                          - id
                          - name
                    required:
                      - uuid
                      - name
                      - categories
                      - created_at
                      - updated_at
                      - owner_company
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - droplet
                  - meta
        '401':
          description: unauthorized when non-root admin tries to update root admin fields
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '404':
          description: droplet not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: invalid droplet parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                uuid:
                  type: string
                  minLength: 1
                droplet:
                  type: object
                  properties:
                    active:
                      type: boolean
                      not:
                        type: 'null'
                    publicly_available:
                      type: boolean
                      not:
                        type: 'null'
                    company_id:
                      type: integer
                      not:
                        type: 'null'
                    name:
                      type: string
                      minLength: 1
                    embed_url:
                      type: string
                      minLength: 1
                    settings:
                      type: object
                      properties:
                        marketplace_page:
                          type: object
                          properties:
                            title:
                              type: string
                              minLength: 1
                            summary:
                              type: string
                              minLength: 1
                            logo_url:
                              type: string
                              minLength: 1
                          required: []
                        details_page:
                          type: object
                          properties:
                            title:
                              type: string
                              minLength: 1
                            summary:
                              type: string
                              minLength: 1
                            logo_url:
                              type: string
                              minLength: 1
                            features:
                              type: array
                              items:
                                type: object
                                properties:
                                  name:
                                    type: string
                                    minLength: 1
                                  summary:
                                    type: string
                                    minLength: 1
                                  details:
                                    type: string
                                    minLength: 1
                                  image_url:
                                    type: string
                                    minLength: 1
                                  video_url:
                                    type: string
                                    minLength: 1
                                required:
                                  - name
                                  - summary
                                  - details
                          required: []
                        service_operational_countries:
                          type: array
                          items:
                            type: string
                      required: []
                    categories:
                      type: array
                      items:
                        type: string
                  required: []
              required:
                - uuid
                - droplet
        description: Droplet update parameters
    delete:
      summary: deletes a droplet
      tags:
        - Droplets
      operationId: destroyDroplet
      security:
        - bearer_auth: []
      parameters:
        - name: uuid
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: droplet deleted successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  droplet:
                    type: object
                    properties:
                      uuid:
                        type: string
                    required:
                      - uuid
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                required:
                  - droplet
                  - meta
        '404':
          description: droplet not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/enrollment_packs:
    get:
      summary: List all enrollment packs
      tags:
        - Enrollment Packs
      operationId: listEnrollmentPacks
      security:
        - bearer_auth: []
      parameters:
        - name: page
          in: query
          required: false
          description: Page number
          schema:
            type: integer
        - name: per_page
          in: query
          required: false
          description: Items per page
          schema:
            type: integer
        - name: sorted_by
          in: query
          required: false
          description: Sort order
          schema:
            type: string
        - name: search_query
          in: query
          required: false
          description: Search term
          schema:
            type: string
        - name: status
          in: query
          required: false
          description: Filter by status
          schema:
            type: string
        - name: with_country_id
          in: query
          schema:
            type: array
            items:
              type: integer
          required: false
          description: Filter by country IDs
        - name: language
          in: query
          required: false
          description: Language filter
          schema:
            type: string
      responses:
        '200':
          description: enrollment packs found
          content:
            application/json:
              schema:
                type: object
                properties:
                  enrollment_packs:
                    type: array
                    items:
                      type: object
                      required:
                        - enrollment_pack_id
                        - slug
                        - title
                        - active
                        - enrollment_fee
                        - membership_after_one_month
                        - membership_optional
                        - status
                        - additional_volume
                      properties:
                        enrollment_pack_id:
                          type: integer
                        slug:
                          type: string
                        token:
                          type: string
                        title:
                          type: string
                        active:
                          type: boolean
                        description:
                          oneOf:
                            - type: object
                              properties:
                                id:
                                  type: integer
                                name:
                                  type: string
                                body:
                                  type: string
                                locale:
                                  type: string
                                record_type:
                                  type: string
                                record_id:
                                  type: integer
                                created_at:
                                  type: string
                                  format: date-time
                                updated_at:
                                  type: string
                                  format: date-time
                            - type: 'null'
                        enrollment_fee:
                          type:
                            - string
                            - 'null'
                        membership_after_one_month:
                          type: boolean
                        membership_optional:
                          type: boolean
                        status:
                          type: string
                        additional_volume:
                          type:
                            - integer
                            - 'null'
                        application_theme_template_id:
                          type:
                            - integer
                            - 'null'
                        country_ids:
                          type: array
                          items:
                            type: integer
                        member_enrollable_products:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                              product_id:
                                type: integer
                              variant_id:
                                type: integer
                        subscription_enrollable_products:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                              product_id:
                                type: integer
                              variant_id:
                                type: integer
                              subscription_plan_id:
                                type: integer
                        images:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                              image_url:
                                type: string
                              position:
                                type: integer
                        enrollment_pack_agreements:
                          type: array
                          items:
                            type: object
                            required:
                              - id
                              - agreement_id
                              - required
                            properties:
                              id:
                                type: integer
                              agreement_id:
                                type: integer
                              required:
                                type: boolean
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      pagination:
                        type: object
                        properties:
                          current_page:
                            type: integer
                            example: 1
                          total_pages:
                            type: integer
                            example: 10
                          total_count:
                            type: integer
                            example: 100
                          per_page:
                            type: integer
                            example: 10
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
    post:
      summary: Create a new enrollment pack
      tags:
        - Enrollment Packs
      operationId: createEnrollmentPack
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: enrollment pack created
          content:
            application/json:
              schema:
                type: object
                properties:
                  enrollment_pack:
                    type: object
                    required:
                      - enrollment_pack_id
                      - slug
                      - title
                      - active
                      - enrollment_fee
                      - membership_after_one_month
                      - membership_optional
                      - status
                      - additional_volume
                    properties:
                      enrollment_pack_id:
                        type: integer
                      slug:
                        type: string
                      token:
                        type: string
                      title:
                        type: string
                      active:
                        type: boolean
                      description:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                              name:
                                type: string
                              body:
                                type: string
                              locale:
                                type: string
                              record_type:
                                type: string
                              record_id:
                                type: integer
                              created_at:
                                type: string
                                format: date-time
                              updated_at:
                                type: string
                                format: date-time
                          - type: 'null'
                      enrollment_fee:
                        type:
                          - string
                          - 'null'
                      membership_after_one_month:
                        type: boolean
                      membership_optional:
                        type: boolean
                      status:
                        type: string
                      additional_volume:
                        type:
                          - integer
                          - 'null'
                      application_theme_template_id:
                        type:
                          - integer
                          - 'null'
                      country_ids:
                        type: array
                        items:
                          type: integer
                      member_enrollable_products:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            product_id:
                              type: integer
                            variant_id:
                              type: integer
                      subscription_enrollable_products:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            product_id:
                              type: integer
                            variant_id:
                              type: integer
                            subscription_plan_id:
                              type: integer
                      images:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            image_url:
                              type: string
                            position:
                              type: integer
                      enrollment_pack_agreements:
                        type: array
                        items:
                          type: object
                          required:
                            - id
                            - agreement_id
                            - required
                          properties:
                            id:
                              type: integer
                            agreement_id:
                              type: integer
                            required:
                              type: boolean
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '422':
          description: invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                enrollment_pack:
                  type: object
                  properties:
                    title:
                      type: string
                      minLength: 1
                    description:
                      type: string
                    active:
                      type: boolean
                    membership_after_one_month:
                      type: boolean
                    membership_optional:
                      type: boolean
                    enrollment_fee:
                      type: number
                    application_theme_template_id:
                      type: integer
                    country_ids:
                      type: array
                      items:
                        type: integer
                    additional_volume:
                      type: integer
                    member_enrollable_products_attributes:
                      type: array
                      items:
                        type: object
                        properties:
                          variant_id:
                            type: integer
                        required:
                          - variant_id
                    subscription_enrollable_products_attributes:
                      type: array
                      items:
                        type: object
                        properties:
                          variant_id:
                            type: integer
                          subscription_plan_id:
                            type: integer
                        required:
                          - variant_id
                          - subscription_plan_id
                    images_attributes:
                      type: array
                      items:
                        type: object
                        properties:
                          image_url:
                            type: string
                          position:
                            type: integer
                        required:
                          - image_url
                          - position
                    enrollment_pack_agreements:
                      type: array
                      items:
                        type: object
                        properties:
                          agreement_id:
                            type: integer
                          required:
                            type: boolean
                        required:
                          - agreement_id
                          - required
                  required:
                    - title
                    - description
                language_iso:
                  type: string
                  minLength: 1
              required:
                - enrollment_pack
  /api/enrollment_packs/bulk_status_update:
    patch:
      summary: Bulk update enrollment pack status
      tags:
        - Enrollment Packs
      operationId: bulkUpdateEnrollmentPackStatus
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: enrollment packs updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  updated_count:
                    type: integer
                  ids:
                    type: array
                    items:
                      type: integer
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '422':
          description: invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                ids:
                  type: array
                  items:
                    type: string
                status:
                  type: string
                  enum:
                    - active
                    - draft
              required:
                - ids
                - status
  /api/enrollment_packs/{id}:
    get:
      summary: Retrieves a specific enrollment pack
      tags:
        - Enrollment Packs
      operationId: getEnrollmentPack
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Enrollment pack ID
          schema:
            type: string
        - name: language_iso
          in: query
          required: false
          schema:
            type: string
      responses:
        '200':
          description: enrollment pack found
          content:
            application/json:
              schema:
                type: object
                properties:
                  enrollment_pack:
                    type: object
                    required:
                      - enrollment_pack_id
                      - slug
                      - title
                      - active
                      - enrollment_fee
                      - membership_after_one_month
                      - membership_optional
                      - status
                      - additional_volume
                    properties:
                      enrollment_pack_id:
                        type: integer
                      slug:
                        type: string
                      token:
                        type: string
                      title:
                        type: string
                      active:
                        type: boolean
                      description:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                              name:
                                type: string
                              body:
                                type: string
                              locale:
                                type: string
                              record_type:
                                type: string
                              record_id:
                                type: integer
                              created_at:
                                type: string
                                format: date-time
                              updated_at:
                                type: string
                                format: date-time
                          - type: 'null'
                      enrollment_fee:
                        type:
                          - string
                          - 'null'
                      membership_after_one_month:
                        type: boolean
                      membership_optional:
                        type: boolean
                      status:
                        type: string
                      additional_volume:
                        type:
                          - integer
                          - 'null'
                      application_theme_template_id:
                        type:
                          - integer
                          - 'null'
                      country_ids:
                        type: array
                        items:
                          type: integer
                      member_enrollable_products:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            product_id:
                              type: integer
                            variant_id:
                              type: integer
                      subscription_enrollable_products:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            product_id:
                              type: integer
                            variant_id:
                              type: integer
                            subscription_plan_id:
                              type: integer
                      images:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            image_url:
                              type: string
                            position:
                              type: integer
                      enrollment_pack_agreements:
                        type: array
                        items:
                          type: object
                          required:
                            - id
                            - agreement_id
                            - required
                          properties:
                            id:
                              type: integer
                            agreement_id:
                              type: integer
                            required:
                              type: boolean
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '404':
          description: enrollment pack not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
    delete:
      summary: Delete an enrollment pack
      tags:
        - Enrollment Packs
      operationId: deleteEnrollmentPack
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: enrollment pack deleted
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  enrollment_pack:
                    type: object
                    properties:
                      id:
                        type: integer
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '404':
          description: enrollment pack not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
    patch:
      summary: Update an enrollment pack
      tags:
        - Enrollment Packs
      operationId: updateEnrollmentPack
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: enrollment pack updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  enrollment_pack:
                    type: object
                    required:
                      - enrollment_pack_id
                      - slug
                      - title
                      - active
                      - enrollment_fee
                      - membership_after_one_month
                      - membership_optional
                      - status
                      - additional_volume
                    properties:
                      enrollment_pack_id:
                        type: integer
                      slug:
                        type: string
                      token:
                        type: string
                      title:
                        type: string
                      active:
                        type: boolean
                      description:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: integer
                              name:
                                type: string
                              body:
                                type: string
                              locale:
                                type: string
                              record_type:
                                type: string
                              record_id:
                                type: integer
                              created_at:
                                type: string
                                format: date-time
                              updated_at:
                                type: string
                                format: date-time
                          - type: 'null'
                      enrollment_fee:
                        type:
                          - string
                          - 'null'
                      membership_after_one_month:
                        type: boolean
                      membership_optional:
                        type: boolean
                      status:
                        type: string
                      additional_volume:
                        type:
                          - integer
                          - 'null'
                      application_theme_template_id:
                        type:
                          - integer
                          - 'null'
                      country_ids:
                        type: array
                        items:
                          type: integer
                      member_enrollable_products:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            product_id:
                              type: integer
                            variant_id:
                              type: integer
                      subscription_enrollable_products:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            product_id:
                              type: integer
                            variant_id:
                              type: integer
                            subscription_plan_id:
                              type: integer
                      images:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            image_url:
                              type: string
                            position:
                              type: integer
                      enrollment_pack_agreements:
                        type: array
                        items:
                          type: object
                          required:
                            - id
                            - agreement_id
                            - required
                          properties:
                            id:
                              type: integer
                            agreement_id:
                              type: integer
                            required:
                              type: boolean
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '404':
          description: enrollment pack not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  minLength: 1
                enrollment_pack:
                  type: object
                  properties:
                    title:
                      type: string
                      minLength: 1
                    description:
                      type: string
                    active:
                      type: boolean
                    membership_after_one_month:
                      type: boolean
                    membership_optional:
                      type: boolean
                    enrollment_fee:
                      type: number
                    application_theme_template_id:
                      type: integer
                    country_ids:
                      type: array
                      items:
                        type: integer
                    additional_volume:
                      type: integer
                    member_enrollable_products_attributes:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: integer
                          variant_id:
                            type: integer
                          _destroy:
                            type: boolean
                        required:
                          - variant_id
                    subscription_enrollable_products_attributes:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: integer
                          variant_id:
                            type: integer
                          subscription_plan_id:
                            type: integer
                          _destroy:
                            type: boolean
                        required:
                          - variant_id
                          - subscription_plan_id
                    images_attributes:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: integer
                          image_url:
                            type: string
                          position:
                            type: integer
                          _destroy:
                            type: boolean
                        required:
                          - image_url
                          - position
                    enrollment_pack_agreements:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: integer
                          agreement_id:
                            type: integer
                          required:
                            type: boolean
                          _destroy:
                            type: boolean
                        required:
                          - agreement_id
                          - required
                  required: []
                language_iso:
                  type: string
                  minLength: 1
              required:
                - id
                - enrollment_pack
    parameters:
      - name: id
        in: path
        required: true
        description: Enrollment pack ID
        schema:
          type: string
  /api/enrollments/{enrollment_token}/field/{field_id}:
    post:
      summary: Create a field answer
      tags:
        - Enrollments
      operationId: createEnrollmentFieldAnswer
      parameters:
        - name: enrollment_token
          in: path
          required: true
          schema:
            type: string
        - name: field_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: enrollment field answer created
          content:
            application/json:
              schema:
                type: object
                properties:
                  enrollment_field_answer:
                    type: object
                    properties:
                      id:
                        type:
                          - number
                          - string
                        example: 23
                      response:
                        type: string
                        example: SSN-123-45-6789
                      form_element_id:
                        type:
                          - number
                          - string
                        example: 12
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2025-02-03T08:04:10Z'
        '404':
          description: enrollment not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    properties:
                      field:
                        type: array
                        items:
                          type: string
                        example:
                          - 'Not found. field_id: 123'
                      enrollment:
                        type: array
                        items:
                          type: string
                        example:
                          - 'Not found. token: 123'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2025-02-03T08:04:10Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                answer:
                  type:
                    - string
                    - 'null'
                  example: 123-45-6789
        required: true
  /api/enrollments/{enrollment_token}/answer/{field_answer_id}:
    patch:
      summary: Update a field answer
      tags:
        - Enrollments
      operationId: updateEnrollmentFieldAnswer
      parameters:
        - name: enrollment_token
          in: path
          required: true
          schema:
            type: string
        - name: field_answer_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: enrollment field answer updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  enrollment_field_answer:
                    type: object
                    properties:
                      id:
                        type:
                          - number
                          - string
                        example: 23
                      response:
                        type: string
                        example: SSN-123-45-6789
                      form_element_id:
                        type:
                          - number
                          - string
                        example: 12
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2025-02-03T08:04:10Z'
        '404':
          description: enrollment field answer not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    properties:
                      field_answer:
                        type: array
                        items:
                          type: string
                        example:
                          - 'Not found. field_answer_id: 123'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2025-02-03T08:04:10Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                answer:
                  type:
                    - string
                    - 'null'
                  example: Jane Kelly
        required: true
  /api/enrollments/{enrollment_token}/file/{field_id}:
    post:
      summary: Create a field answer with a file
      tags:
        - Enrollments
      operationId: createEnrollmentFileFieldAnswer
      parameters:
        - name: enrollment_token
          in: path
          required: true
          schema:
            type: string
        - name: field_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: enrollment file field answer created
          content:
            application/json:
              schema:
                type: object
                properties:
                  enrollment_field_answer:
                    type: object
                    properties:
                      id:
                        type:
                          - number
                          - string
                        example: 23
                      response:
                        type: string
                        example: SSN-123-45-6789
                      form_element_id:
                        type:
                          - number
                          - string
                        example: 12
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2025-02-03T08:04:10Z'
        '404':
          description: enrollment not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    properties:
                      enrollment:
                        type: array
                        items:
                          type: string
                        example:
                          - 'Not found. token: 123'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2025-02-03T08:04:10Z'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
                  description: >-
                    All image file types, tiff and pdf. Empty string is accepted
                    to create a form response with an empty value.
              required:
                - file
        required: true
  /api/enrollments/{enrollment_token}:
    get:
      summary: Get enrollment with fields and answers
      tags:
        - Enrollments
      operationId: getEnrollmentWithFieldsAndAnswers
      parameters:
        - name: enrollment_token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: enrollment found
          content:
            application/json:
              schema:
                type: object
                properties:
                  enroll:
                    type: object
                    properties:
                      title:
                        type: string
                        example: Must fill out this enrollment
                  enrollment:
                    type: object
                    properties:
                      state:
                        type: string
                        enum:
                          - complete
                          - incomplete
                        example: complete
                      enrollment_fields:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type:
                                - number
                                - string
                              example: 1
                            field_type:
                              type: string
                              example: input
                            title:
                              type: string
                              example: Title
                            metadata:
                              type:
                                - string
                                - 'null'
                              example: >-
                                {"label":"Name","required":true,"targetIndex":2,"element_type":"file_upload","translations":[],"is_form_field":true,"auto_translate":true,"field_data_value":""}
                            placement:
                              type: string
                              enum:
                                - general
                                - post_purchase
                                - pre_purchase
                              example: post_purchase
                            order:
                              type:
                                - number
                                - 'null'
                              example: 1
                            response:
                              type:
                                - string
                                - 'null'
                              example: Jane Kelly
                            field_answer_id:
                              type:
                                - number
                                - 'null'
                              example: 10
                  company:
                    type: object
                    properties:
                      id:
                        type: integer
                      name:
                        type: string
                      primary_domain_hostname:
                        type:
                          - string
                          - 'null'
                        example: fluid.com
                      subdomain:
                        type:
                          - string
                          - 'null'
                        example: myco
                      logo_url:
                        type:
                          - string
                          - 'null'
                        example: https://example.com/logo.png
                      fluid_shop:
                        type:
                          - string
                          - 'null'
                        example: https://fluid-sample-shop.fluid.com
                      collect_phone:
                        type: boolean
                        example: true
                      require_phone:
                        type: boolean
                        example: false
                      require_billing_zip:
                        type: boolean
                        example: false
                      checkout_primary_button_color:
                        type:
                          - string
                          - 'null'
                        example: '#000000'
                      checkout_primary_text_color:
                        type:
                          - string
                          - 'null'
                        example: '#FFFFFF'
                      checkout_secondary_button_color:
                        type:
                          - string
                          - 'null'
                        example: '#FFFFFF'
                      checkout_secondary_text_color:
                        type:
                          - string
                          - 'null'
                        example: '#000000'
                      favicon_url:
                        type:
                          - string
                          - 'null'
                        example: https://example.com/favicon.ico
                      order_on_behalf:
                        type: boolean
                        example: false
                      use_juspay_gateway:
                        type: boolean
                        example: false
                      reward_points_enabled:
                        type: boolean
                        example: false
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2025-02-03T08:04:10Z'
  /api/companies/{company_id}/entities:
    get:
      summary: List company entities
      tags:
        - Entities
      operationId: listCompanyEntities
      security:
        - bearer_auth: []
      parameters:
        - name: company_id
          in: path
          required: true
          example: 1
          schema:
            type: integer
      responses:
        '200':
          description: entities retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  entities:
                    type: array
                    items:
                      title: Company::Entity
                      type: object
                      properties:
                        id:
                          type: integer
                        legal_name:
                          example: Acme Corporation Inc.
                          type: string
                        classification:
                          example: Corporation
                          type:
                            - string
                            - 'null'
                        trading_name:
                          example: Acme Corp
                          type:
                            - string
                            - 'null'
                        country_iso:
                          example: US
                          type:
                            - string
                            - 'null'
                        address1:
                          example: 123 Business Street
                          type:
                            - string
                            - 'null'
                        address2:
                          example: Suite 100
                          type:
                            - string
                            - 'null'
                        city:
                          example: New York
                          type:
                            - string
                            - 'null'
                        province:
                          example: NY
                          type:
                            - string
                            - 'null'
                        postal_code:
                          example: '10001'
                          type:
                            - string
                            - 'null'
                        registration_number:
                          example: '123456789'
                          type:
                            - string
                            - 'null'
                        date_of_incorporation:
                          example: '2020-01-15'
                          type:
                            - string
                            - 'null'
                        primary_mcc:
                          example: 5411
                          type:
                            - integer
                            - 'null'
                        secondary_mcc:
                          example: 5999
                          type:
                            - integer
                            - 'null'
                        phone_country_code:
                          example: '+1'
                          type:
                            - string
                            - 'null'
                        phone:
                          example: 555-123-4567
                          type:
                            - string
                            - 'null'
                        website:
                          example: https://acme.com
                          type:
                            - string
                            - 'null'
                        tax_id:
                          example: GB123456789
                          type:
                            - string
                            - 'null'
                        principal_same_as_registered_address:
                          example: false
                          type: boolean
                        primary:
                          example: false
                          type: boolean
                        status:
                          example: active
                          type: string
                        business_registration_file_url:
                          example: https://example.com/business-registration.pdf
                          type:
                            - string
                            - 'null'
                        business_registration_file_name:
                          example: business-registration.pdf
                          type:
                            - string
                            - 'null'
                        business_license_file_url:
                          example: https://example.com/business-license.pdf
                          type:
                            - string
                            - 'null'
                        business_license_file_name:
                          example: business-license.pdf
                          type:
                            - string
                            - 'null'
                        articles_of_incorporation_file_url:
                          example: https://example.com/articles-of-incorporation.pdf
                          type:
                            - string
                            - 'null'
                        articles_of_incorporation_file_name:
                          example: articles-of-incorporation.pdf
                          type:
                            - string
                            - 'null'
                        last_3_months_processing_statements_file_url:
                          example: https://example.com/processing-statements.pdf
                          type:
                            - string
                            - 'null'
                        last_3_months_processing_statements_file_name:
                          example: processing-statements.pdf
                          type:
                            - string
                            - 'null'
                        business_identification_number:
                          example: '123456789'
                          type:
                            - string
                            - 'null'
                        w_9_file_url:
                          example: https://example.com/w-9.pdf
                          type:
                            - string
                            - 'null'
                        w_9_file_name:
                          example: w-9.pdf
                          type:
                            - string
                            - 'null'
                        business_registration_certificate_file_url:
                          example: >-
                            https://example.com/business-registration-certificate.pdf
                          type:
                            - string
                            - 'null'
                        business_registration_certificate_file_name:
                          example: business-registration-certificate.pdf
                          type:
                            - string
                            - 'null'
                        created_at:
                          example: '2025-01-15T10:30:00Z'
                          type: string
                        updated_at:
                          example: '2025-01-15T10:30:00Z'
                          type: string
                        registered_address:
                          title: Address
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                            address1:
                              example: 123 Main St
                              type: string
                            address2:
                              example: Apt 4B
                              type:
                                - string
                                - 'null'
                            address3:
                              example: Building 5
                              type:
                                - string
                                - 'null'
                            city:
                              example: New York
                              type: string
                            state:
                              example: NY
                              type: string
                            subdivision_code:
                              example: NY
                              type:
                                - string
                                - 'null'
                            postal_code:
                              example: '10001'
                              type: string
                            country_code:
                              example: US
                              type:
                                - string
                                - 'null'
                          required:
                            - id
                            - address1
                            - city
                            - state
                            - postal_code
                        principal_address:
                          title: Address
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                            address1:
                              example: 123 Main St
                              type: string
                            address2:
                              example: Apt 4B
                              type:
                                - string
                                - 'null'
                            address3:
                              example: Building 5
                              type:
                                - string
                                - 'null'
                            city:
                              example: New York
                              type: string
                            state:
                              example: NY
                              type: string
                            subdivision_code:
                              example: NY
                              type:
                                - string
                                - 'null'
                            postal_code:
                              example: '10001'
                              type: string
                            country_code:
                              example: US
                              type:
                                - string
                                - 'null'
                          required:
                            - id
                            - address1
                            - city
                            - state
                            - postal_code
                      required:
                        - id
                        - legal_name
                        - principal_same_as_registered_address
                        - primary
                        - status
                        - created_at
                        - updated_at
                  meta:
                    type: object
                required:
                  - entities
                  - meta
        '401':
          description: unauthorized - company access denied
    post:
      summary: Create company entity
      tags:
        - Entities
      operationId: createCompanyEntity
      security:
        - bearer_auth: []
      parameters:
        - name: company_id
          in: path
          required: true
          example: 1
          schema:
            type: integer
      responses:
        '201':
          description: entity created
          content:
            application/json:
              schema:
                type: object
                properties:
                  entity:
                    title: Company::Entity
                    type: object
                    properties:
                      id:
                        type: integer
                      legal_name:
                        example: Acme Corporation Inc.
                        type: string
                      classification:
                        example: Corporation
                        type:
                          - string
                          - 'null'
                      trading_name:
                        example: Acme Corp
                        type:
                          - string
                          - 'null'
                      country_iso:
                        example: US
                        type:
                          - string
                          - 'null'
                      address1:
                        example: 123 Business Street
                        type:
                          - string
                          - 'null'
                      address2:
                        example: Suite 100
                        type:
                          - string
                          - 'null'
                      city:
                        example: New York
                        type:
                          - string
                          - 'null'
                      province:
                        example: NY
                        type:
                          - string
                          - 'null'
                      postal_code:
                        example: '10001'
                        type:
                          - string
                          - 'null'
                      registration_number:
                        example: '123456789'
                        type:
                          - string
                          - 'null'
                      date_of_incorporation:
                        example: '2020-01-15'
                        type:
                          - string
                          - 'null'
                      primary_mcc:
                        example: 5411
                        type:
                          - integer
                          - 'null'
                      secondary_mcc:
                        example: 5999
                        type:
                          - integer
                          - 'null'
                      phone_country_code:
                        example: '+1'
                        type:
                          - string
                          - 'null'
                      phone:
                        example: 555-123-4567
                        type:
                          - string
                          - 'null'
                      website:
                        example: https://acme.com
                        type:
                          - string
                          - 'null'
                      tax_id:
                        example: GB123456789
                        type:
                          - string
                          - 'null'
                      principal_same_as_registered_address:
                        example: false
                        type: boolean
                      primary:
                        example: false
                        type: boolean
                      status:
                        example: active
                        type: string
                      business_registration_file_url:
                        example: https://example.com/business-registration.pdf
                        type:
                          - string
                          - 'null'
                      business_registration_file_name:
                        example: business-registration.pdf
                        type:
                          - string
                          - 'null'
                      business_license_file_url:
                        example: https://example.com/business-license.pdf
                        type:
                          - string
                          - 'null'
                      business_license_file_name:
                        example: business-license.pdf
                        type:
                          - string
                          - 'null'
                      articles_of_incorporation_file_url:
                        example: https://example.com/articles-of-incorporation.pdf
                        type:
                          - string
                          - 'null'
                      articles_of_incorporation_file_name:
                        example: articles-of-incorporation.pdf
                        type:
                          - string
                          - 'null'
                      last_3_months_processing_statements_file_url:
                        example: https://example.com/processing-statements.pdf
                        type:
                          - string
                          - 'null'
                      last_3_months_processing_statements_file_name:
                        example: processing-statements.pdf
                        type:
                          - string
                          - 'null'
                      business_identification_number:
                        example: '123456789'
                        type:
                          - string
                          - 'null'
                      w_9_file_url:
                        example: https://example.com/w-9.pdf
                        type:
                          - string
                          - 'null'
                      w_9_file_name:
                        example: w-9.pdf
                        type:
                          - string
                          - 'null'
                      business_registration_certificate_file_url:
                        example: >-
                          https://example.com/business-registration-certificate.pdf
                        type:
                          - string
                          - 'null'
                      business_registration_certificate_file_name:
                        example: business-registration-certificate.pdf
                        type:
                          - string
                          - 'null'
                      created_at:
                        example: '2025-01-15T10:30:00Z'
                        type: string
                      updated_at:
                        example: '2025-01-15T10:30:00Z'
                        type: string
                      registered_address:
                        title: Address
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                          address1:
                            example: 123 Main St
                            type: string
                          address2:
                            example: Apt 4B
                            type:
                              - string
                              - 'null'
                          address3:
                            example: Building 5
                            type:
                              - string
                              - 'null'
                          city:
                            example: New York
                            type: string
                          state:
                            example: NY
                            type: string
                          subdivision_code:
                            example: NY
                            type:
                              - string
                              - 'null'
                          postal_code:
                            example: '10001'
                            type: string
                          country_code:
                            example: US
                            type:
                              - string
                              - 'null'
                        required:
                          - id
                          - address1
                          - city
                          - state
                          - postal_code
                      principal_address:
                        title: Address
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                          address1:
                            example: 123 Main St
                            type: string
                          address2:
                            example: Apt 4B
                            type:
                              - string
                              - 'null'
                          address3:
                            example: Building 5
                            type:
                              - string
                              - 'null'
                          city:
                            example: New York
                            type: string
                          state:
                            example: NY
                            type: string
                          subdivision_code:
                            example: NY
                            type:
                              - string
                              - 'null'
                          postal_code:
                            example: '10001'
                            type: string
                          country_code:
                            example: US
                            type:
                              - string
                              - 'null'
                        required:
                          - id
                          - address1
                          - city
                          - state
                          - postal_code
                    required:
                      - id
                      - legal_name
                      - principal_same_as_registered_address
                      - primary
                      - status
                      - created_at
                      - updated_at
                  meta:
                    type: object
                required:
                  - entity
                  - meta
        '401':
          description: unauthorized - company access denied
        '422':
          description: validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Entity could not be created
                  errors:
                    type: object
                    example:
                      entity:
                        legal_name:
                          - can't be blank
                  meta:
                    type: object
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                entity:
                  type: object
                  properties:
                    legal_name:
                      type: string
                    classification:
                      type: string
                    trading_name:
                      type: string
                    country_iso:
                      type: string
                    address1:
                      type: string
                    address2:
                      type: string
                    city:
                      type: string
                    province:
                      type: string
                    postal_code:
                      type: string
                    registration_number:
                      type: string
                    date_of_incorporation:
                      type: string
                    primary_mcc:
                      type: integer
                    secondary_mcc:
                      type: integer
                    phone_country_code:
                      type: string
                    phone:
                      type: string
                    website:
                      type: string
                    tax_id:
                      type: string
                    principal_same_as_registered_address:
                      type: boolean
                    primary:
                      type: boolean
                    status:
                      type: string
                      enum:
                        - active
                        - inactive
                    business_registration_file_url:
                      type: string
                    business_registration_file_name:
                      type: string
                    business_license_file_url:
                      type: string
                    business_license_file_name:
                      type: string
                    articles_of_incorporation_file_url:
                      type: string
                    articles_of_incorporation_file_name:
                      type: string
                    last_3_months_processing_statements_file_url:
                      type: string
                    last_3_months_processing_statements_file_name:
                      type: string
                    business_identification_number:
                      type: string
                    w_9_file_name:
                      type: string
                    w_9_file_url:
                      type: string
                    business_registration_certificate_file_name:
                      type: string
                    business_registration_certificate_file_url:
                      type: string
                    principal_address:
                      type: object
                      properties:
                        address1:
                          type: string
                        address2:
                          type: string
                        address3:
                          type: string
                        city:
                          type: string
                        state:
                          type: string
                        postal_code:
                          type: string
                        country_code:
                          type: string
                      required: []
                    registered_address:
                      type: object
                      properties:
                        address1:
                          type: string
                        address2:
                          type: string
                        address3:
                          type: string
                        city:
                          type: string
                        state:
                          type: string
                        postal_code:
                          type: string
                        country_code:
                          type: string
                      required: []
                  required:
                    - legal_name
                company_id:
                  type: integer
              required:
                - entity
                - company_id
  /api/companies/{company_id}/entities/{id}:
    get:
      summary: Get company entity
      tags:
        - Entities
      operationId: getCompanyEntity
      security:
        - bearer_auth: []
      parameters:
        - name: company_id
          in: path
          required: true
          example: 1
          schema:
            type: integer
        - name: id
          in: path
          required: true
          example: 1
          schema:
            type: integer
      responses:
        '200':
          description: entity retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  entity:
                    title: Company::Entity
                    type: object
                    properties:
                      id:
                        type: integer
                      legal_name:
                        example: Acme Corporation Inc.
                        type: string
                      classification:
                        example: Corporation
                        type:
                          - string
                          - 'null'
                      trading_name:
                        example: Acme Corp
                        type:
                          - string
                          - 'null'
                      country_iso:
                        example: US
                        type:
                          - string
                          - 'null'
                      address1:
                        example: 123 Business Street
                        type:
                          - string
                          - 'null'
                      address2:
                        example: Suite 100
                        type:
                          - string
                          - 'null'
                      city:
                        example: New York
                        type:
                          - string
                          - 'null'
                      province:
                        example: NY
                        type:
                          - string
                          - 'null'
                      postal_code:
                        example: '10001'
                        type:
                          - string
                          - 'null'
                      registration_number:
                        example: '123456789'
                        type:
                          - string
                          - 'null'
                      date_of_incorporation:
                        example: '2020-01-15'
                        type:
                          - string
                          - 'null'
                      primary_mcc:
                        example: 5411
                        type:
                          - integer
                          - 'null'
                      secondary_mcc:
                        example: 5999
                        type:
                          - integer
                          - 'null'
                      phone_country_code:
                        example: '+1'
                        type:
                          - string
                          - 'null'
                      phone:
                        example: 555-123-4567
                        type:
                          - string
                          - 'null'
                      website:
                        example: https://acme.com
                        type:
                          - string
                          - 'null'
                      tax_id:
                        example: GB123456789
                        type:
                          - string
                          - 'null'
                      principal_same_as_registered_address:
                        example: false
                        type: boolean
                      primary:
                        example: false
                        type: boolean
                      status:
                        example: active
                        type: string
                      business_registration_file_url:
                        example: https://example.com/business-registration.pdf
                        type:
                          - string
                          - 'null'
                      business_registration_file_name:
                        example: business-registration.pdf
                        type:
                          - string
                          - 'null'
                      business_license_file_url:
                        example: https://example.com/business-license.pdf
                        type:
                          - string
                          - 'null'
                      business_license_file_name:
                        example: business-license.pdf
                        type:
                          - string
                          - 'null'
                      articles_of_incorporation_file_url:
                        example: https://example.com/articles-of-incorporation.pdf
                        type:
                          - string
                          - 'null'
                      articles_of_incorporation_file_name:
                        example: articles-of-incorporation.pdf
                        type:
                          - string
                          - 'null'
                      last_3_months_processing_statements_file_url:
                        example: https://example.com/processing-statements.pdf
                        type:
                          - string
                          - 'null'
                      last_3_months_processing_statements_file_name:
                        example: processing-statements.pdf
                        type:
                          - string
                          - 'null'
                      business_identification_number:
                        example: '123456789'
                        type:
                          - string
                          - 'null'
                      w_9_file_url:
                        example: https://example.com/w-9.pdf
                        type:
                          - string
                          - 'null'
                      w_9_file_name:
                        example: w-9.pdf
                        type:
                          - string
                          - 'null'
                      business_registration_certificate_file_url:
                        example: >-
                          https://example.com/business-registration-certificate.pdf
                        type:
                          - string
                          - 'null'
                      business_registration_certificate_file_name:
                        example: business-registration-certificate.pdf
                        type:
                          - string
                          - 'null'
                      created_at:
                        example: '2025-01-15T10:30:00Z'
                        type: string
                      updated_at:
                        example: '2025-01-15T10:30:00Z'
                        type: string
                      registered_address:
                        title: Address
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                          address1:
                            example: 123 Main St
                            type: string
                          address2:
                            example: Apt 4B
                            type:
                              - string
                              - 'null'
                          address3:
                            example: Building 5
                            type:
                              - string
                              - 'null'
                          city:
                            example: New York
                            type: string
                          state:
                            example: NY
                            type: string
                          subdivision_code:
                            example: NY
                            type:
                              - string
                              - 'null'
                          postal_code:
                            example: '10001'
                            type: string
                          country_code:
                            example: US
                            type:
                              - string
                              - 'null'
                        required:
                          - id
                          - address1
                          - city
                          - state
                          - postal_code
                      principal_address:
                        title: Address
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                          address1:
                            example: 123 Main St
                            type: string
                          address2:
                            example: Apt 4B
                            type:
                              - string
                              - 'null'
                          address3:
                            example: Building 5
                            type:
                              - string
                              - 'null'
                          city:
                            example: New York
                            type: string
                          state:
                            example: NY
                            type: string
                          subdivision_code:
                            example: NY
                            type:
                              - string
                              - 'null'
                          postal_code:
                            example: '10001'
                            type: string
                          country_code:
                            example: US
                            type:
                              - string
                              - 'null'
                        required:
                          - id
                          - address1
                          - city
                          - state
                          - postal_code
                    required:
                      - id
                      - legal_name
                      - principal_same_as_registered_address
                      - primary
                      - status
                      - created_at
                      - updated_at
                  meta:
                    type: object
                required:
                  - entity
                  - meta
        '401':
          description: unauthorized - company access denied
        '404':
          description: entity not found
    put:
      summary: Update company entity
      tags:
        - Entities
      operationId: updateCompanyEntity
      security:
        - bearer_auth: []
      parameters:
        - name: company_id
          in: path
          required: true
          example: 1
          schema:
            type: integer
        - name: id
          in: path
          required: true
          example: 1
          schema:
            type: integer
      responses:
        '200':
          description: entity updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  entity:
                    title: Company::Entity
                    type: object
                    properties:
                      id:
                        type: integer
                      legal_name:
                        example: Acme Corporation Inc.
                        type: string
                      classification:
                        example: Corporation
                        type:
                          - string
                          - 'null'
                      trading_name:
                        example: Acme Corp
                        type:
                          - string
                          - 'null'
                      country_iso:
                        example: US
                        type:
                          - string
                          - 'null'
                      address1:
                        example: 123 Business Street
                        type:
                          - string
                          - 'null'
                      address2:
                        example: Suite 100
                        type:
                          - string
                          - 'null'
                      city:
                        example: New York
                        type:
                          - string
                          - 'null'
                      province:
                        example: NY
                        type:
                          - string
                          - 'null'
                      postal_code:
                        example: '10001'
                        type:
                          - string
                          - 'null'
                      registration_number:
                        example: '123456789'
                        type:
                          - string
                          - 'null'
                      date_of_incorporation:
                        example: '2020-01-15'
                        type:
                          - string
                          - 'null'
                      primary_mcc:
                        example: 5411
                        type:
                          - integer
                          - 'null'
                      secondary_mcc:
                        example: 5999
                        type:
                          - integer
                          - 'null'
                      phone_country_code:
                        example: '+1'
                        type:
                          - string
                          - 'null'
                      phone:
                        example: 555-123-4567
                        type:
                          - string
                          - 'null'
                      website:
                        example: https://acme.com
                        type:
                          - string
                          - 'null'
                      tax_id:
                        example: GB123456789
                        type:
                          - string
                          - 'null'
                      principal_same_as_registered_address:
                        example: false
                        type: boolean
                      primary:
                        example: false
                        type: boolean
                      status:
                        example: active
                        type: string
                      business_registration_file_url:
                        example: https://example.com/business-registration.pdf
                        type:
                          - string
                          - 'null'
                      business_registration_file_name:
                        example: business-registration.pdf
                        type:
                          - string
                          - 'null'
                      business_license_file_url:
                        example: https://example.com/business-license.pdf
                        type:
                          - string
                          - 'null'
                      business_license_file_name:
                        example: business-license.pdf
                        type:
                          - string
                          - 'null'
                      articles_of_incorporation_file_url:
                        example: https://example.com/articles-of-incorporation.pdf
                        type:
                          - string
                          - 'null'
                      articles_of_incorporation_file_name:
                        example: articles-of-incorporation.pdf
                        type:
                          - string
                          - 'null'
                      last_3_months_processing_statements_file_url:
                        example: https://example.com/processing-statements.pdf
                        type:
                          - string
                          - 'null'
                      last_3_months_processing_statements_file_name:
                        example: processing-statements.pdf
                        type:
                          - string
                          - 'null'
                      business_identification_number:
                        example: '123456789'
                        type:
                          - string
                          - 'null'
                      w_9_file_url:
                        example: https://example.com/w-9.pdf
                        type:
                          - string
                          - 'null'
                      w_9_file_name:
                        example: w-9.pdf
                        type:
                          - string
                          - 'null'
                      business_registration_certificate_file_url:
                        example: >-
                          https://example.com/business-registration-certificate.pdf
                        type:
                          - string
                          - 'null'
                      business_registration_certificate_file_name:
                        example: business-registration-certificate.pdf
                        type:
                          - string
                          - 'null'
                      created_at:
                        example: '2025-01-15T10:30:00Z'
                        type: string
                      updated_at:
                        example: '2025-01-15T10:30:00Z'
                        type: string
                      registered_address:
                        title: Address
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                          address1:
                            example: 123 Main St
                            type: string
                          address2:
                            example: Apt 4B
                            type:
                              - string
                              - 'null'
                          address3:
                            example: Building 5
                            type:
                              - string
                              - 'null'
                          city:
                            example: New York
                            type: string
                          state:
                            example: NY
                            type: string
                          subdivision_code:
                            example: NY
                            type:
                              - string
                              - 'null'
                          postal_code:
                            example: '10001'
                            type: string
                          country_code:
                            example: US
                            type:
                              - string
                              - 'null'
                        required:
                          - id
                          - address1
                          - city
                          - state
                          - postal_code
                      principal_address:
                        title: Address
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                          address1:
                            example: 123 Main St
                            type: string
                          address2:
                            example: Apt 4B
                            type:
                              - string
                              - 'null'
                          address3:
                            example: Building 5
                            type:
                              - string
                              - 'null'
                          city:
                            example: New York
                            type: string
                          state:
                            example: NY
                            type: string
                          subdivision_code:
                            example: NY
                            type:
                              - string
                              - 'null'
                          postal_code:
                            example: '10001'
                            type: string
                          country_code:
                            example: US
                            type:
                              - string
                              - 'null'
                        required:
                          - id
                          - address1
                          - city
                          - state
                          - postal_code
                    required:
                      - id
                      - legal_name
                      - principal_same_as_registered_address
                      - primary
                      - status
                      - created_at
                      - updated_at
                  meta:
                    type: object
                required:
                  - entity
                  - meta
        '401':
          description: unauthorized - company access denied
        '404':
          description: entity not found
        '422':
          description: validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Entity could not be created
                  errors:
                    type: object
                    example:
                      entity:
                        legal_name:
                          - can't be blank
                  meta:
                    type: object
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                entity:
                  type: object
                  properties:
                    legal_name:
                      type: string
                    classification:
                      type: string
                    trading_name:
                      type: string
                    country_iso:
                      type: string
                    address1:
                      type: string
                    address2:
                      type: string
                    city:
                      type: string
                    province:
                      type: string
                    postal_code:
                      type: string
                    registration_number:
                      type: string
                    date_of_incorporation:
                      type: string
                    primary_mcc:
                      type: integer
                    secondary_mcc:
                      type: integer
                    phone_country_code:
                      type: string
                    phone:
                      type: string
                    website:
                      type: string
                    tax_id:
                      type: string
                    principal_same_as_registered_address:
                      type: boolean
                    primary:
                      type: boolean
                    status:
                      type: string
                      enum:
                        - active
                        - inactive
                    business_registration_file_url:
                      type: string
                    business_registration_file_name:
                      type: string
                    business_license_file_url:
                      type: string
                    business_license_file_name:
                      type: string
                    articles_of_incorporation_file_url:
                      type: string
                    articles_of_incorporation_file_name:
                      type: string
                    last_3_months_processing_statements_file_url:
                      type: string
                    last_3_months_processing_statements_file_name:
                      type: string
                    business_identification_number:
                      type: string
                    w_9_file_name:
                      type: string
                    w_9_file_url:
                      type: string
                    business_registration_certificate_file_name:
                      type: string
                    business_registration_certificate_file_url:
                      type: string
                    principal_address:
                      type: object
                      properties:
                        address1:
                          type: string
                        address2:
                          type: string
                        address3:
                          type: string
                        city:
                          type: string
                        state:
                          type: string
                        postal_code:
                          type: string
                        country_code:
                          type: string
                      required: []
                    registered_address:
                      type: object
                      properties:
                        address1:
                          type: string
                        address2:
                          type: string
                        address3:
                          type: string
                        city:
                          type: string
                        state:
                          type: string
                        postal_code:
                          type: string
                        country_code:
                          type: string
                      required: []
                  required: []
                company_id:
                  type: integer
                id:
                  type: integer
              required:
                - entity
                - company_id
                - id
    delete:
      summary: Delete company entity
      tags:
        - Entities
      operationId: deleteCompanyEntity
      security:
        - bearer_auth: []
      parameters:
        - name: company_id
          in: path
          required: true
          example: 1
          schema:
            type: integer
        - name: id
          in: path
          required: true
          example: 1
          schema:
            type: integer
      responses:
        '204':
          description: entity deleted
        '401':
          description: unauthorized - company access denied
        '404':
          description: entity not found
  /api/company/events:
    post:
      tags:
        - Events
      summary: Create Company Event
      description: >-
        Add a new event for the company with details like title, dates,
        location, and optional media content.
      operationId: createCompanyEvent
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/createrequest10'
                - example:
                    event:
                      title: Type Race
                      description: >-
                        Fluid Type Racing Game. Winner gets all expenses paid 1
                        month vacation trip to Bali.
                      start_date: '2024-03-28'
                      end_date: '2024-04-01'
                      start_time: '9:56:0'
                      end_time: '19:56:0'
                      time_zone: Asia/Kathmandu
                      url: https://google.com
                      active: true
                      venue: Pokhara
                      available_countries:
                        - us
                        - in
                        - fin
                      images_attributes:
                        - image_url: >-
                            https://images.furnituredealer.net/img/products/liberty_furniture/color/double%20bridge--816253672_152-cd-gts-b6.jpg
                          position: 1
                        - image_url: >-
                            https://images.furnituredealer.net/img/products/steve_silver/color/david-1172854226_di100c-b1.jpg
            example:
              event:
                title: Type Race
                description: >-
                  Fluid Type Racing Game. Winner gets all expenses paid 1 month
                  vacation trip to Bali.
                start_date: '2024-03-28'
                end_date: '2024-04-01'
                start_time: '9:56:0'
                end_time: '19:56:0'
                time_zone: Asia/Kathmandu
                url: https://google.com
                active: true
                venue: Pokhara
                available_countries:
                  - us
                  - in
                  - fin
                images_attributes:
                  - image_url: >-
                      https://images.furnituredealer.net/img/products/liberty_furniture/color/double%20bridge--816253672_152-cd-gts-b6.jpg
                    position: 1
                  - image_url: >-
                      https://images.furnituredealer.net/img/products/steve_silver/color/david-1172854226_di100c-b1.jpg
        required: true
      responses:
        '200':
          description: ''
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
      deprecated: false
      security:
        - bearer: []
    get:
      tags:
        - Events
      summary: List Company Events
      description: Retrieves a list of events associated with the company.
      operationId: listCompanyEvents
      parameters: []
      responses:
        '200':
          description: ''
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
      deprecated: false
      security:
        - bearer: []
  /api/company/events/{eventId}:
    patch:
      tags:
        - Events
      summary: Update Company Event
      description: Updates the details of a specific company event
      operationId: updateCompanyEvent
      parameters:
        - name: eventId
          in: path
          required: true
          schema:
            type: integer
          description: The unique identifier of the event to update
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/updaterequest9'
                - example:
                    event:
                      title: Type Race
                      description: >-
                        Fluid Type Racing Game. Winner gets all expense paid 1
                        month vacation trip to Bali. The winner will also get
                        the salary/wages for the vacation month.
                      available_countries:
                        - npl
                        - us
            example:
              event:
                title: Type Race
                description: >-
                  Fluid Type Racing Game. Winner gets all expense paid 1 month
                  vacation trip to Bali. The winner will also get the
                  salary/wages for the vacation month.
                available_countries:
                  - npl
                  - us
        required: true
      responses:
        '200':
          description: ''
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
      deprecated: false
      security:
        - bearer: []
    get:
      tags:
        - Events
      summary: Get Company Event Details
      description: Retrieves the details of a specific event for a company.
      operationId: getCompanyEvent
      parameters:
        - name: eventId
          in: path
          required: true
          schema:
            type: integer
          description: The unique identifier of the company event
      responses:
        '200':
          description: ''
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
      deprecated: false
      security:
        - bearer: []
    delete:
      tags:
        - Events
      summary: Delete Company Event
      description: Deletes a specific event associated with the company.
      operationId: deleteCompanyEvent
      parameters:
        - name: eventId
          in: path
          required: true
          schema:
            type: integer
          description: The unique identifier of the event to delete
      responses:
        '200':
          description: ''
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
      deprecated: false
      security:
        - bearer: []
  /api/company/events/{eventId}/send_notifications:
    get:
      tags:
        - Events
      summary: Send Event Notifications
      description: >-
        Sends notifications about an event to concerned parties based on
        specified countries.
      operationId: sendEventNotifications
      parameters:
        - name: eventId
          in: path
          required: true
          schema:
            type: integer
          description: The unique identifier of the event to send notifications for
      responses:
        '200':
          description: ''
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
      deprecated: false
      security:
        - bearer: []
  /api/v1/fairshare/orders/{order_id}/journey:
    get:
      summary: Retrieves visitor journey for an order
      tags:
        - Fair Share Order Journey
      operationId: getOrderJourney
      security:
        - bearer_auth: []
      parameters:
        - name: order_id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  order_journey:
                    type: object
                    properties:
                      id:
                        type: integer
                      visitor_token:
                        type: string
                      journey_started_at:
                        type: string
                        format: date-time
                      journey_duration:
                        type: integer
                      order_details:
                        type: object
                        properties:
                          order_date:
                            type: string
                            format: date-time
                          order_type:
                            type:
                              - string
                              - 'null'
                      product_details:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          image_url:
                            type: string
                        required:
                          - id
                          - name
                          - image_url
                      share_details:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                          token:
                            type: string
                          name:
                            type: string
                          sent_at:
                            type: string
                            format: date-time
                      activities:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            activity_type:
                              type: string
                            company_id:
                              type: integer
                            created_at:
                              type: string
                              format: date-time
                            updated_at:
                              type: string
                              format: date-time
                            occurred_at:
                              type: string
                              format: date-time
                            fairshare:
                              type: boolean
                            metadata:
                              type: object
                            source:
                              type: string
                            trackable_token:
                              type:
                                - string
                                - 'null'
                            trackable_type:
                              type: string
                            user_company_id:
                              type:
                                - 'null'
                                - integer
                            visitor_token:
                              type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: array
                    items:
                      type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
  /api/settings/fantasy_points:
    get:
      summary: Get fantasy points configuration
      tags:
        - Fantasy Points
      security:
        - bearer_auth: []
      responses:
        '200':
          description: fantasy points configuration found
          content:
            application/json:
              examples:
                success_response:
                  value:
                    id: 96778814
                    fantasy_call_points:
                      points: 5
                      description: When a user clicks to call someone from the CRM.
                    fantasy_email_points:
                      points: 3
                      description: When a user clicks to email a contact from the CRM.
                    fantasy_order_points:
                      points: 25
                      description: Given to affiliate when a sample order is finalized.
                    fantasy_direct_share_points:
                      points: 5
                      description: Given when when a SmartLink is opened by a visitor.
                    fantasy_share_views_points:
                      points: 1
                      description: Given for every unique general share view.
                    fantasy_new_contact_points:
                      points: 10
                      description: New contact (or lead) added to the CRM.
                    fantasy_upload_points:
                      points: 15
                      description: Earned when an upload from a user is shared.
                    fantasy_training_points:
                      points: 3
                      description: When a training video is watched and completed.
                    fantasy_enroll_points:
                      points: 50
                      description: Points earned when someone enrolls.
                    fantasy_new_customer_points:
                      points: 5
                      description: Points earned when a new customer is added.
                    fantasy_purchase_from_app_points:
                      points: 5
                      description: Points earned when a purchase is made from the app.
                    meta:
                      request_id: 4f785c75-ba10-4169-9d86-cc30df3dacc5
                      timestamp: '2025-05-28T08:26:49Z'
              schema:
                type: object
                properties:
                  id:
                    type: integer
                    example: 96778814
                  fantasy_call_points:
                    type: object
                    properties:
                      points:
                        type: integer
                        example: 5
                      description:
                        type: string
                        example: When a user clicks to call someone from the CRM.
                  fantasy_email_points:
                    type: object
                    properties:
                      points:
                        type: integer
                        example: 3
                      description:
                        type: string
                        example: When a user clicks to email a contact from the CRM.
                  fantasy_order_points:
                    type: object
                    properties:
                      points:
                        type: integer
                        example: 25
                      description:
                        type: string
                        example: Given to affiliate when a sample order is finalized.
                  fantasy_direct_share_points:
                    type: object
                    properties:
                      points:
                        type: integer
                        example: 5
                      description:
                        type: string
                        example: Given when when a SmartLink is opened by a visitor.
                  fantasy_share_views_points:
                    type: object
                    properties:
                      points:
                        type: integer
                        example: 1
                      description:
                        type: string
                        example: Given for every unique general share view.
                  fantasy_new_contact_points:
                    type: object
                    properties:
                      points:
                        type: integer
                        example: 10
                      description:
                        type: string
                        example: New contact (or lead) added to the CRM.
                  fantasy_upload_points:
                    type: object
                    properties:
                      points:
                        type: integer
                        example: 15
                      description:
                        type: string
                        example: Earned when an upload from a user is shared.
                  fantasy_training_points:
                    type: object
                    properties:
                      points:
                        type: integer
                        example: 3
                      description:
                        type: string
                        example: When a training video is watched and completed.
                  fantasy_enroll_points:
                    type: object
                    properties:
                      points:
                        type: integer
                        example: 50
                      description:
                        type: string
                        example: Points earned when someone enrolls.
                  fantasy_new_customer_points:
                    type: object
                    properties:
                      points:
                        type: integer
                        example: 5
                      description:
                        type: string
                        example: Points earned when a new customer is added.
                  fantasy_purchase_from_app_points:
                    type: object
                    properties:
                      points:
                        type: integer
                        example: 5
                      description:
                        type: string
                        example: Points earned when a purchase is made from the app.
                  name:
                    type: string
                    example: Acme, Inc.
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 4f785c75-ba10-4169-9d86-cc30df3dacc5
                      timestamp:
                        type: string
                        example: '2025-05-28T08:26:49Z'
        '401':
          description: unauthorized
          content:
            application/json:
              examples:
                unauthorized_response:
                  value:
                    message: Invalid credentials.
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
    put:
      summary: Update fantasy points configuration
      tags:
        - Fantasy Points
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: fantasy points configuration updated - training points
          content:
            application/json:
              examples:
                update_success_response:
                  value:
                    fantasy_call_points:
                      points: 10
                      description: When a user clicks to call someone from the CRM.
                    meta:
                      request_id: 0ab310b9-345d-4d59-8a90-d332e7163eab
                      timestamp: '2025-05-28T08:26:49Z'
                update_training_points_response:
                  value:
                    fantasy_training_points:
                      points: 25
                      description: When a training video is watched and completed.
                    meta:
                      request_id: 6ecb9167-422e-455c-a514-fb88fb6fd088
                      timestamp: '2025-05-28T08:26:49Z'
              schema:
                type: object
                properties:
                  fantasy_call_points:
                    type: object
                    properties:
                      points:
                        type: integer
                        example: 10
                      description:
                        type: string
                        example: When a user clicks to call someone from the CRM.
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 6ecb9167-422e-455c-a514-fb88fb6fd088
                      timestamp:
                        type: string
                        example: '2025-05-28T08:26:49Z'
                  fantasy_training_points:
                    type: object
                    properties:
                      points:
                        type: integer
                        example: 25
                      description:
                        type: string
                        example: When a training video is watched and completed.
        '401':
          description: unauthorized
          content:
            application/json:
              examples:
                unauthorized_response:
                  value:
                    message: Invalid credentials.
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '422':
          description: invalid request
          content:
            application/json:
              examples:
                validation_error_response:
                  value:
                    error_message: Invalid parameters
                    errors:
                      fantasy_call_points:
                        - must be greater than 0
                    meta:
                      request_id: 7c28e974-3643-42d8-8efd-514d9f606061
                      timestamp: '2025-05-28T08:26:50Z'
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameters
                  errors:
                    type: object
                    properties:
                      fantasy_call_points:
                        type: array
                        items:
                          type: string
                        example:
                          - must be greater than 0
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 7c28e974-3643-42d8-8efd-514d9f606061
                      timestamp:
                        type: string
                        example: '2025-05-28T08:26:50Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              oneOf:
                - type: object
                  properties:
                    fantasy_call_points:
                      type: integer
                      example: 5
                  required:
                    - fantasy_call_points
                - type: object
                  properties:
                    fantasy_email_points:
                      type: integer
                      example: 3
                  required:
                    - fantasy_email_points
                - type: object
                  properties:
                    fantasy_order_points:
                      type: integer
                      example: 25
                  required:
                    - fantasy_order_points
                - type: object
                  properties:
                    fantasy_direct_share_points:
                      type: integer
                      example: 5
                  required:
                    - fantasy_direct_share_points
                - type: object
                  properties:
                    fantasy_share_views_points:
                      type: integer
                      example: 1
                  required:
                    - fantasy_share_views_points
                - type: object
                  properties:
                    fantasy_new_contact_points:
                      type: integer
                      example: 10
                  required:
                    - fantasy_new_contact_points
                - type: object
                  properties:
                    fantasy_upload_points:
                      type: integer
                      example: 15
                  required:
                    - fantasy_upload_points
                - type: object
                  properties:
                    fantasy_training_points:
                      type: integer
                      example: 3
                  required:
                    - fantasy_training_points
                - type: object
                  properties:
                    fantasy_enroll_points:
                      type: integer
                      example: 50
                  required:
                    - fantasy_enroll_points
                - type: object
                  properties:
                    fantasy_new_customer_points:
                      type: integer
                      example: 5
                  required:
                    - fantasy_new_customer_points
                - type: object
                  properties:
                    fantasy_purchase_from_app_points:
                      type: integer
                      example: 5
                  required:
                    - fantasy_purchase_from_app_points
              description: Must contain exactly one fantasy point parameter
  /api/v202506/feature_flags:
    get:
      summary: Lists all feature flags for the current company
      tags:
        - Feature Flags
      operationId: listFeatureFlags
      security:
        - bearer_auth: []
      responses:
        '200':
          description: successfully returns feature flags
          content:
            application/json:
              schema:
                type: object
                properties:
                  feature_flags:
                    type: object
                    additionalProperties:
                      type: boolean
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                    required:
                      - request_id
                      - timestamp
                required:
                  - feature_flags
                  - meta
        '401':
          description: unauthorized - not company admin
    post:
      summary: Creates a new feature flag for the company
      tags:
        - Feature Flags
      operationId: createFeatureFlag
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: successfully creates the feature flag
          content:
            application/json:
              schema:
                type: object
                properties:
                  feature_flags:
                    type: object
                    additionalProperties:
                      type: boolean
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                    required:
                      - request_id
                      - timestamp
                required:
                  - feature_flags
                  - meta
        '401':
          description: unauthorized - not company admin
        '422':
          description: bad request - missing flag_name
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                flag_name:
                  type: string
              required:
                - flag_name
    put:
      summary: Updates feature flags for the company
      tags:
        - Feature Flags
      operationId: updateFeatureFlags
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: successfully updates feature flags with string values
          content:
            application/json:
              schema:
                type: object
                properties:
                  feature_flags:
                    type: object
                    additionalProperties:
                      type: boolean
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                    required:
                      - request_id
                      - timestamp
                required:
                  - feature_flags
                  - meta
        '401':
          description: unauthorized - not company admin
        '422':
          description: bad request - missing flags
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                flags:
                  type: object
                  additionalProperties:
                    type: boolean
              required:
                - flags
  /api/v202506/feature_flags/{flag_name}:
    delete:
      summary: Deletes a feature flag from the company
      tags:
        - Feature Flags
      operationId: deleteFeatureFlag
      security:
        - bearer_auth: []
      parameters:
        - name: flag_name
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: successfully deletes the feature flag
          content:
            application/json:
              schema:
                type: object
                properties:
                  feature_flags:
                    type: object
                    additionalProperties:
                      type: boolean
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                    required:
                      - request_id
                      - timestamp
                required:
                  - feature_flags
                  - meta
        '401':
          description: unauthorized - not company admin
        '404':
          description: not found - flag does not exist
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                    required:
                      - request_id
                      - timestamp
                required:
                  - error_message
                  - errors
                  - meta
  /api/file_resources:
    get:
      summary: Returns a list of file resources
      tags:
        - File Resources
      operationId: listFileResources
      security:
        - bearer_auth: []
      parameters:
        - name: pagination
          in: query
          schema:
            type: object
            properties:
              page:
                type: integer
              per_page:
                type: integer
              search_query:
                type: string
              sorted_by:
                type: string
              size_greater_than:
                type: string
              size_less_than:
                type: string
              with_types:
                type: array
                items:
                  type: string
            required: []
      responses:
        '200':
          description: returns list of file resources
          content:
            application/json:
              schema:
                type: object
                properties:
                  file_resources:
                    type: array
                    items:
                      title: FileResource
                      type: object
                      properties:
                        id:
                          type: integer
                        url:
                          example: https://example.com/file.jpg
                          type: string
                        preview_image_url:
                          example: https://example.com/preview.jpg
                          type:
                            - string
                            - 'null'
                        alt_text:
                          type:
                            - string
                            - 'null'
                        handle:
                          type:
                            - string
                            - 'null'
                        content_type:
                          type: string
                        content_size:
                          type: integer
                          minimum: 1
                          maximum: 2147483647
                        content:
                          type:
                            - string
                            - 'null'
                        relateable_id:
                          type:
                            - integer
                            - 'null'
                        relateable_type:
                          type:
                            - string
                            - 'null'
                        metadata:
                          type:
                            - object
                            - 'null'
                          default: '{}'
                        created_at:
                          type: string
                          format: date-time
                        updated_at:
                          type: string
                          format: date-time
                        filename:
                          type: string
                          pattern: ^[^/\0]+$
                        version:
                          example: '1'
                          type:
                            - string
                            - 'null'
                        non_binary:
                          example: true
                          type: boolean
                        references_count:
                          example:
                            ApplicationThemeTemplate: 2
                          type: object
                        dam_ready:
                          example: true
                          type: boolean
                        dam_processing_status:
                          example: ready
                          type:
                            - string
                            - 'null'
                        dam_tags:
                          example:
                            - en-us
                            - web
                          type:
                            - array
                            - 'null'
                        dam_upload_queued:
                          example: false
                          type: boolean
                      required:
                        - id
                        - url
                        - content_type
                        - content_size
                        - created_at
                        - updated_at
                        - filename
                        - non_binary
                        - references_count
                        - dam_ready
                        - dam_upload_queued
                  meta:
                    type: object
                    properties:
                      total_count:
                        type: integer
                      total_pages:
                        type: integer
                      current_page:
                        type: integer
                      request_id:
                        type: string
                      timestamp:
                        type: string
        '401':
          description: unauthorized
    post:
      summary: Creates a file resource
      tags:
        - File Resources
      operationId: createFileResource
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: file resource created
          content:
            application/json:
              schema:
                type: object
                properties:
                  file_resource:
                    title: FileResource
                    type: object
                    properties:
                      id:
                        type: integer
                      url:
                        example: https://example.com/file.jpg
                        type: string
                      preview_image_url:
                        example: https://example.com/preview.jpg
                        type:
                          - string
                          - 'null'
                      alt_text:
                        type:
                          - string
                          - 'null'
                      handle:
                        type:
                          - string
                          - 'null'
                      content_type:
                        type: string
                      content_size:
                        type: integer
                        minimum: 1
                        maximum: 2147483647
                      content:
                        type:
                          - string
                          - 'null'
                      relateable_id:
                        type:
                          - integer
                          - 'null'
                      relateable_type:
                        type:
                          - string
                          - 'null'
                      metadata:
                        type:
                          - object
                          - 'null'
                        default: '{}'
                      created_at:
                        type: string
                        format: date-time
                      updated_at:
                        type: string
                        format: date-time
                      filename:
                        type: string
                        pattern: ^[^/\0]+$
                      version:
                        example: '1'
                        type:
                          - string
                          - 'null'
                      non_binary:
                        example: true
                        type: boolean
                      references_count:
                        example:
                          ApplicationThemeTemplate: 2
                        type: object
                      dam_ready:
                        example: true
                        type: boolean
                      dam_processing_status:
                        example: ready
                        type:
                          - string
                          - 'null'
                      dam_tags:
                        example:
                          - en-us
                          - web
                        type:
                          - array
                          - 'null'
                      dam_upload_queued:
                        example: false
                        type: boolean
                    required:
                      - id
                      - url
                      - content_type
                      - content_size
                      - created_at
                      - updated_at
                      - filename
                      - non_binary
                      - references_count
                      - dam_ready
                      - dam_upload_queued
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
        '422':
          description: invalid parameters
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                file_resource:
                  title: FileResource
                  type: object
                  properties:
                    id:
                      type: integer
                    url:
                      example: https://example.com/file.jpg
                      type: string
                    preview_image_url:
                      example: https://example.com/preview.jpg
                      type:
                        - string
                        - 'null'
                    alt_text:
                      type:
                        - string
                        - 'null'
                    handle:
                      type:
                        - string
                        - 'null'
                    content_type:
                      type: string
                    content_size:
                      type: integer
                      minimum: 1
                      maximum: 2147483647
                    content:
                      type:
                        - string
                        - 'null'
                    relateable_id:
                      type:
                        - integer
                        - 'null'
                    relateable_type:
                      type:
                        - string
                        - 'null'
                    metadata:
                      type:
                        - object
                        - 'null'
                      default: '{}'
                    created_at:
                      type: string
                      format: date-time
                    updated_at:
                      type: string
                      format: date-time
                    filename:
                      type: string
                      pattern: ^[^/\0]+$
                    version:
                      example: '1'
                      type:
                        - string
                        - 'null'
                    non_binary:
                      example: true
                      type: boolean
                    references_count:
                      example:
                        ApplicationThemeTemplate: 2
                      type: object
                    dam_ready:
                      example: true
                      type: boolean
                    dam_processing_status:
                      example: ready
                      type:
                        - string
                        - 'null'
                    dam_tags:
                      example:
                        - en-us
                        - web
                      type:
                        - array
                        - 'null'
                    dam_upload_queued:
                      example: false
                      type: boolean
                  required:
                    - id
                    - url
                    - content_type
                    - content_size
                    - created_at
                    - updated_at
                    - filename
                    - non_binary
                    - references_count
                    - dam_ready
                    - dam_upload_queued
              required:
                - file_resource
  /api/file_resources/{id}:
    get:
      summary: Shows a file resource
      tags:
        - File Resources
      operationId: showFileResource
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: returns a single file resource
          content:
            application/json:
              schema:
                type: object
                properties:
                  file_resource:
                    title: FileResource
                    type: object
                    properties:
                      id:
                        type: integer
                      url:
                        example: https://example.com/file.jpg
                        type: string
                      preview_image_url:
                        example: https://example.com/preview.jpg
                        type:
                          - string
                          - 'null'
                      alt_text:
                        type:
                          - string
                          - 'null'
                      handle:
                        type:
                          - string
                          - 'null'
                      content_type:
                        type: string
                      content_size:
                        type: integer
                        minimum: 1
                        maximum: 2147483647
                      content:
                        type:
                          - string
                          - 'null'
                      relateable_id:
                        type:
                          - integer
                          - 'null'
                      relateable_type:
                        type:
                          - string
                          - 'null'
                      metadata:
                        type:
                          - object
                          - 'null'
                        default: '{}'
                      created_at:
                        type: string
                        format: date-time
                      updated_at:
                        type: string
                        format: date-time
                      filename:
                        type: string
                        pattern: ^[^/\0]+$
                      version:
                        example: '1'
                        type:
                          - string
                          - 'null'
                      non_binary:
                        example: true
                        type: boolean
                      references_count:
                        example:
                          ApplicationThemeTemplate: 2
                        type: object
                      dam_ready:
                        example: true
                        type: boolean
                      dam_processing_status:
                        example: ready
                        type:
                          - string
                          - 'null'
                      dam_tags:
                        example:
                          - en-us
                          - web
                        type:
                          - array
                          - 'null'
                      dam_upload_queued:
                        example: false
                        type: boolean
                    required:
                      - id
                      - url
                      - content_type
                      - content_size
                      - created_at
                      - updated_at
                      - filename
                      - non_binary
                      - references_count
                      - dam_ready
                      - dam_upload_queued
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
        '404':
          description: file resource not found
    patch:
      summary: Updates a file resource
      tags:
        - File Resources
      operationId: updateFileResource
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: file resource updated with text content
          content:
            application/json:
              schema:
                type: object
                properties:
                  file_resource:
                    title: FileResource
                    type: object
                    properties:
                      id:
                        type: integer
                      url:
                        example: https://example.com/file.jpg
                        type: string
                      preview_image_url:
                        example: https://example.com/preview.jpg
                        type:
                          - string
                          - 'null'
                      alt_text:
                        type:
                          - string
                          - 'null'
                      handle:
                        type:
                          - string
                          - 'null'
                      content_type:
                        type: string
                      content_size:
                        type: integer
                        minimum: 1
                        maximum: 2147483647
                      content:
                        type:
                          - string
                          - 'null'
                      relateable_id:
                        type:
                          - integer
                          - 'null'
                      relateable_type:
                        type:
                          - string
                          - 'null'
                      metadata:
                        type:
                          - object
                          - 'null'
                        default: '{}'
                      created_at:
                        type: string
                        format: date-time
                      updated_at:
                        type: string
                        format: date-time
                      filename:
                        type: string
                        pattern: ^[^/\0]+$
                      version:
                        example: '1'
                        type:
                          - string
                          - 'null'
                      non_binary:
                        example: true
                        type: boolean
                      references_count:
                        example:
                          ApplicationThemeTemplate: 2
                        type: object
                      dam_ready:
                        example: true
                        type: boolean
                      dam_processing_status:
                        example: ready
                        type:
                          - string
                          - 'null'
                      dam_tags:
                        example:
                          - en-us
                          - web
                        type:
                          - array
                          - 'null'
                      dam_upload_queued:
                        example: false
                        type: boolean
                    required:
                      - id
                      - url
                      - content_type
                      - content_size
                      - created_at
                      - updated_at
                      - filename
                      - non_binary
                      - references_count
                      - dam_ready
                      - dam_upload_queued
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
        '404':
          description: file resource not found
        '409':
          description: conflict when both file and content provided
        '422':
          description: invalid parameters
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                file_resource:
                  type: object
                  properties:
                    filename:
                      type: string
                    alt_text:
                      type: string
                    file:
                      type: string
                      format: binary
                      description: File upload for content replacement
                    content:
                      type: string
                      description: Text content for file replacement
                    content_type:
                      type: string
                      description: MIME type for content
                    tags:
                      type: array
                      items:
                        type: string
                      description: Tags for DAM asset
                    url:
                      type: string
                    content_size:
                      type: integer
                    preview_image_url:
                      type: string
                    handle:
                      type: string
              required:
                - file_resource
    delete:
      summary: Deletes a file resource
      tags:
        - File Resources
      operationId: destroyFileResource
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: file resource deleted
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
        '404':
          description: file resource not found
  /api/file_resources/bulk_create:
    post:
      summary: Creates multiple file resources
      tags:
        - File Resources
      operationId: bulkCreateFileResources
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: file resources created
          content:
            application/json:
              schema:
                type: object
                properties:
                  file_resources:
                    type: array
                    items:
                      title: FileResource
                      type: object
                      properties:
                        id:
                          type: integer
                        url:
                          example: https://example.com/file.jpg
                          type: string
                        preview_image_url:
                          example: https://example.com/preview.jpg
                          type:
                            - string
                            - 'null'
                        alt_text:
                          type:
                            - string
                            - 'null'
                        handle:
                          type:
                            - string
                            - 'null'
                        content_type:
                          type: string
                        content_size:
                          type: integer
                          minimum: 1
                          maximum: 2147483647
                        content:
                          type:
                            - string
                            - 'null'
                        relateable_id:
                          type:
                            - integer
                            - 'null'
                        relateable_type:
                          type:
                            - string
                            - 'null'
                        metadata:
                          type:
                            - object
                            - 'null'
                          default: '{}'
                        created_at:
                          type: string
                          format: date-time
                        updated_at:
                          type: string
                          format: date-time
                        filename:
                          type: string
                          pattern: ^[^/\0]+$
                        version:
                          example: '1'
                          type:
                            - string
                            - 'null'
                        non_binary:
                          example: true
                          type: boolean
                        references_count:
                          example:
                            ApplicationThemeTemplate: 2
                          type: object
                        dam_ready:
                          example: true
                          type: boolean
                        dam_processing_status:
                          example: ready
                          type:
                            - string
                            - 'null'
                        dam_tags:
                          example:
                            - en-us
                            - web
                          type:
                            - array
                            - 'null'
                        dam_upload_queued:
                          example: false
                          type: boolean
                      required:
                        - id
                        - url
                        - content_type
                        - content_size
                        - created_at
                        - updated_at
                        - filename
                        - non_binary
                        - references_count
                        - dam_ready
                        - dam_upload_queued
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
        '422':
          description: invalid parameters
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                file_resources:
                  type: array
                  items:
                    type: object
              required:
                - file_resources
  /api/file_resources/bulk_destroy:
    delete:
      summary: Deletes multiple file resources
      tags:
        - File Resources
      operationId: bulkDestroyFileResources
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: file resources deleted
          content:
            application/json:
              schema:
                type: object
                properties:
                  ids:
                    type: array
                    items:
                      type: integer
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                      destroyed_count:
                        type: integer
        '422':
          description: invalid parameters
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                ids:
                  type: array
                  items:
                    type: integer
              required:
                - ids
  /api/fluid_orchestration/status:
    get:
      summary: Get orchestration status
      description: >-
        Returns the FluidOrchestration status including active configuration,
        default fallback, and available payment accounts
      tags:
        - Fluid Orchestration
      operationId: getFluidOrchestrationStatus
      security:
        - bearer_auth: []
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  active_configuration:
                    type:
                      - object
                      - 'null'
                    properties:
                      id:
                        type: integer
                        example: 1
                      name:
                        type: string
                        example: Volume Based Routing
                      configuration_type:
                        type: string
                        enum:
                          - volume_based
                          - rule_based
                        example: volume_based
                      description:
                        type:
                          - string
                          - 'null'
                        example: 50/50 split between processors
                      active:
                        type: boolean
                        example: true
                      settings:
                        type: object
                      created_at:
                        type: string
                        format: datetime
                      updated_at:
                        type: string
                        format: datetime
                  default_fallback:
                    type: object
                    properties:
                      priority_order:
                        type: array
                        items:
                          type: object
                          properties:
                            payment_account_id:
                              type: integer
                              example: 1
                            name:
                              type: string
                              example: Braintree
                            adapter_class:
                              type: string
                              example: ActiveMerchant::Billing::BraintreeGateway
                            priority:
                              type: integer
                              example: 1
                            active:
                              type: boolean
                              example: true
                  available_payment_accounts:
                    type: array
                    items:
                      title: Commerce::PaymentAccount
                      type: object
                      properties:
                        id:
                          type: integer
                        uuid:
                          example: pa_abc123xyz
                          type:
                            - string
                            - 'null'
                        name:
                          example: Production NMI Gateway
                          type: string
                        adapter_class:
                          example: ActiveMerchant::Billing::NmiGateway
                          type: string
                        integration_class:
                          example: CreditCard
                          type: string
                        apple_pay_enabled:
                          example: true
                          type: boolean
                        google_pay_enabled:
                          example: true
                          type: boolean
                        sandbox:
                          example: false
                          type: boolean
                        countries:
                          example:
                            - US
                            - CA
                          type: array
                      required:
                        - id
                        - name
                        - adapter_class
                        - integration_class
                        - apple_pay_enabled
                        - google_pay_enabled
                        - sandbox
                        - countries
                  supported_conditions:
                    type: array
                    items:
                      type: object
                      properties:
                        key:
                          type: string
                          example: payment_source
                        type:
                          type: string
                          example: enum
                        description:
                          type: string
                          example: The payment source type
                        values:
                          type:
                            - array
                            - 'null'
                          items:
                            type: string
                          example:
                            - card
                            - apple_pay
                            - google_pay
                  configuration_types:
                    type: array
                    items:
                      type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - available_payment_accounts
                  - supported_conditions
                  - configuration_types
  /api/fluid_orchestration/configurations:
    get:
      summary: List orchestration configurations
      description: Returns all FluidOrchestration configurations for the company
      tags:
        - Fluid Orchestration - Configurations
      operationId: listFluidOrchestrationConfigurations
      security:
        - bearer_auth: []
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  configurations:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        name:
                          type: string
                        configuration_type:
                          type: string
                          enum:
                            - volume_based
                            - rule_based
                        description:
                          type:
                            - string
                            - 'null'
                        active:
                          type: boolean
                        settings:
                          type: object
                        created_at:
                          type: string
                          format: datetime
                        updated_at:
                          type: string
                          format: datetime
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - configurations
    post:
      summary: Create rule-based configuration
      description: >-
        Create a new rule-based FluidOrchestration configuration that routes
        traffic based on conditions like payment source, country, or amount
      tags:
        - Fluid Orchestration - Rule Based
      operationId: createRuleBasedFluidOrchestrationConfiguration
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: success - rule based
          content:
            application/json:
              schema:
                type: object
                properties:
                  configuration:
                    type: object
                    properties:
                      id:
                        type: integer
                      name:
                        type: string
                        example: Rule Based Routing
                      configuration_type:
                        type: string
                        example: rule_based
                      description:
                        type:
                          - string
                          - 'null'
                      active:
                        type: boolean
                        example: false
                      settings:
                        type: object
                        properties:
                          distributions:
                            type: array
                            items:
                              type: object
                              properties:
                                payment_account_id:
                                  type: integer
                                percentage:
                                  type: number
                          rules:
                            type: array
                            items:
                              type: object
                              properties:
                                name:
                                  type: string
                                priority:
                                  type: integer
                                payment_account_id:
                                  type: integer
                                conditions:
                                  type: object
                      created_at:
                        type: string
                        format: datetime
                      updated_at:
                        type: string
                        format: datetime
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - configuration
        '422':
          description: unprocessable entity - invalid payment source
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                configuration:
                  type: object
                  properties:
                    name:
                      type: string
                      example: Rule Based Routing
                    configuration_type:
                      type: string
                      enum:
                        - rule_based
                      example: rule_based
                    description:
                      type: string
                      example: Route Apple Pay to NMI, high value to Braintree
                    settings:
                      type: object
                      properties:
                        rules:
                          type: array
                          items:
                            type: object
                            properties:
                              name:
                                type: string
                                example: Apple Pay to NMI
                              priority:
                                type: integer
                                example: 1
                              payment_account_id:
                                type: integer
                                example: 1
                              conditions:
                                type: object
                                properties:
                                  payment_source:
                                    type: string
                                    enum:
                                      - card
                                      - apple_pay
                                      - google_pay
                                    example: apple_pay
                                  country_iso:
                                    type: array
                                    items:
                                      type: string
                                    example:
                                      - US
                                      - CA
                                  amount_greater_than:
                                    type: number
                                    example: 100
                                  amount_less_than:
                                    type: number
                                    example: 1000
                                  currency_code:
                                    type: string
                                    example: USD
                            required:
                              - name
                              - priority
                              - payment_account_id
                      required:
                        - rules
                  required:
                    - name
                    - configuration_type
                    - settings
              required:
                - configuration
  /api/fluid_orchestration/configurations/{id}:
    patch:
      summary: Update orchestration configuration
      description: Update an existing FluidOrchestration configuration
      tags:
        - Fluid Orchestration - Configurations
      operationId: updateFluidOrchestrationConfiguration
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  configuration:
                    type: object
                    properties:
                      id:
                        type: integer
                      name:
                        type: string
                      configuration_type:
                        type: string
                      description:
                        type:
                          - string
                          - 'null'
                      active:
                        type: boolean
                      settings:
                        type: object
                      created_at:
                        type: string
                        format: datetime
                      updated_at:
                        type: string
                        format: datetime
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - configuration
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                configuration:
                  type: object
                  properties:
                    name:
                      type: string
                    description:
                      type: string
                    settings:
                      type: object
              required:
                - configuration
    delete:
      summary: Delete orchestration configuration
      description: >-
        Delete a FluidOrchestration configuration. Cannot delete an active
        configuration.
      tags:
        - Fluid Orchestration - Configurations
      operationId: deleteFluidOrchestrationConfiguration
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  deleted:
                    type: boolean
                    example: true
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - deleted
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: unprocessable entity - cannot delete active configuration
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/fluid_orchestration/configurations/{id}/activate:
    post:
      summary: Activate orchestration configuration
      description: >-
        Activate a FluidOrchestration configuration. This will deactivate any
        other active configurations.
      tags:
        - Fluid Orchestration - Configurations
      operationId: activateFluidOrchestrationConfiguration
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  configuration:
                    type: object
                    properties:
                      id:
                        type: integer
                      name:
                        type: string
                      configuration_type:
                        type: string
                      description:
                        type:
                          - string
                          - 'null'
                      active:
                        type: boolean
                        example: true
                      settings:
                        type: object
                      created_at:
                        type: string
                        format: datetime
                      updated_at:
                        type: string
                        format: datetime
                  deactivated_configurations:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        name:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - configuration
                  - deactivated_configurations
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/fluid_orchestration/configurations/{id}/deactivate:
    post:
      summary: Deactivate orchestration configuration
      description: >-
        Deactivate a FluidOrchestration configuration. When no configuration is
        active, the default fallback will be used for routing.
      tags:
        - Fluid Orchestration - Configurations
      operationId: deactivateFluidOrchestrationConfiguration
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  configuration:
                    type: object
                    properties:
                      id:
                        type: integer
                      name:
                        type: string
                      configuration_type:
                        type: string
                      description:
                        type:
                          - string
                          - 'null'
                      active:
                        type: boolean
                        example: false
                      settings:
                        type: object
                      created_at:
                        type: string
                        format: datetime
                      updated_at:
                        type: string
                        format: datetime
                  message:
                    type: string
                    example: >-
                      Configuration deactivated. Default fallback will be used
                      for routing.
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - configuration
                  - message
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: unprocessable entity - configuration is not active
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/fluid_orchestration/default_fallback:
    get:
      summary: Get default fallback order
      description: >-
        Returns the priority-ordered list of payment accounts used as fallback
        when no routing rules match or no active configuration exists
      tags:
        - Fluid Orchestration - Default Fallback
      operationId: getFluidOrchestrationDefaultFallback
      security:
        - bearer_auth: []
      responses:
        '200':
          description: success - with fallback configured
          content:
            application/json:
              schema:
                type: object
                properties:
                  default_fallback:
                    type: object
                    properties:
                      priority_order:
                        type: array
                        items:
                          type: object
                          properties:
                            payment_account_id:
                              type: integer
                              example: 1
                            name:
                              type: string
                              example: Braintree Gateway
                            adapter_class:
                              type: string
                              example: ActiveMerchant::Billing::BraintreeGateway
                            priority:
                              type: integer
                              example: 1
                            active:
                              type: boolean
                              example: true
                          required:
                            - payment_account_id
                            - name
                            - adapter_class
                            - priority
                            - active
                    required:
                      - priority_order
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - default_fallback
    patch:
      summary: Update default fallback order
      description: >-
        Reorder the priority of payment accounts in the default fallback list.
        Each entry requires payment_account_id and priority.
      tags:
        - Fluid Orchestration - Default Fallback
      operationId: updateFluidOrchestrationDefaultFallback
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: success - reorder fallback
          content:
            application/json:
              schema:
                type: object
                properties:
                  default_fallback:
                    type: object
                    properties:
                      priority_order:
                        type: array
                        items:
                          type: object
                          properties:
                            payment_account_id:
                              type: integer
                            name:
                              type: string
                            adapter_class:
                              type: string
                            priority:
                              type: integer
                            active:
                              type: boolean
                          required:
                            - payment_account_id
                            - name
                            - adapter_class
                            - priority
                            - active
                    required:
                      - priority_order
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - default_fallback
        '422':
          description: unprocessable entity - invalid payment account
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                priority_order:
                  type: array
                  description: >-
                    Array of priority entries with payment account ID and
                    priority number
                  items:
                    type: object
                    properties:
                      payment_account_id:
                        type: integer
                        example: 1
                      priority:
                        type: integer
                        example: 1
                    required:
                      - payment_account_id
                      - priority
                  example:
                    - payment_account_id: 3
                      priority: 1
                    - payment_account_id: 1
                      priority: 2
                    - payment_account_id: 2
                      priority: 3
              required:
                - priority_order
  /api/fluid_pay/payment_methods:
    get:
      summary: Retrieves payment methods for a customer
      tags:
        - Fluid Pay
      operationId: getFluidPayPaymentMethods
      parameters:
        - name: jwt
          in: query
          required: true
          description: JWT token containing customer authentication
          schema:
            type: string
        - name: page
          in: query
          required: false
          description: Page number
          schema:
            type: integer
        - name: per_page
          in: query
          required: false
          description: Number of items per page
          schema:
            type: integer
      responses:
        '200':
          description: payment methods retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  fluid_pay_account:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      default_payment_method_id:
                        type: integer
                        example: 456
                    required:
                      - id
                      - default_payment_method_id
                  payment_methods:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 123
                        source:
                          type: string
                          example: card
                        default:
                          type: boolean
                          example: true
                        payment_type:
                          type: string
                          example: Credit Card
                        details:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 123
                            type:
                              type: string
                              example: CreditCard
                            card_type:
                              type:
                                - string
                                - 'null'
                              example: visa
                            card_brand:
                              type:
                                - string
                                - 'null'
                              example: Visa
                            last4_digits:
                              type:
                                - string
                                - 'null'
                              example: '6789'
                              description: Deprecated
                            last_four:
                              type:
                                - string
                                - 'null'
                              example: '6789'
                            exp_month:
                              type:
                                - string
                                - 'null'
                              example: '12'
                            exp_year:
                              type:
                                - string
                                - 'null'
                              example: '2025'
                            logo_url:
                              type:
                                - string
                                - 'null'
                              example: >-
                                https://assets.fluid.app/images/payment_icons/visa.svg
                        payload:
                          type: object
                        created_at:
                          type: string
                          format: date-time
                          example: '2021-01-01T00:00:00Z'
                        updated_at:
                          type: string
                          format: date-time
                          example: '2021-01-01T00:00:00Z'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        format: date-time
                        example: '2021-01-01T00:00:00Z'
                      pagination:
                        type: object
                        properties:
                          current_page:
                            type: integer
                            example: 1
                          total_pages:
                            type: integer
                            example: 1
                          total_count:
                            type: integer
                            example: 1
                          per_page:
                            type: integer
                            example: 10
                required:
                  - fluid_pay_account
                  - payment_methods
                  - meta
        '400':
          description: missing JWT token
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: JWT is required
        '401':
          description: expired JWT token
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Token has expired
        '404':
          description: customer not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Customer not found
  /api/fluid_pay/addresses:
    get:
      summary: Retrieves addresses for a customer
      tags:
        - Fluid Pay
      operationId: getFluidPayAddresses
      parameters:
        - name: jwt
          in: query
          required: true
          description: JWT token containing customer authentication
          schema:
            type: string
        - name: page
          in: query
          required: false
          description: Page number
          schema:
            type: integer
        - name: per_page
          in: query
          required: false
          description: Number of items per page
          schema:
            type: integer
      responses:
        '200':
          description: addresses retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  fluid_pay_account:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      default_address_id:
                        type: integer
                        example: 456
                    required:
                      - id
                      - default_address_id
                  addresses:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 123
                        name:
                          type: string
                          example: My Home Address
                        first_name:
                          type: string
                          example: My
                        last_name:
                          type: string
                          example: Address
                        address1:
                          type: string
                          example: 123 Main St
                        address2:
                          type:
                            - string
                            - 'null'
                          example: Apt 1
                        address3:
                          type:
                            - string
                            - 'null'
                          example: Block 123
                        city:
                          type: string
                          example: Carrollton
                        state:
                          type: string
                          example: TX
                        postal_code:
                          type: string
                          example: '75007'
                        subdivision_code:
                          type:
                            - string
                            - 'null'
                          example: TX
                        country_code:
                          type: string
                          example: US
                        default:
                          type: boolean
                          example: false
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        format: date-time
                        example: '2021-01-01T00:00:00Z'
                      pagination:
                        type: object
                        properties:
                          current_page:
                            type: integer
                            example: 1
                          total_pages:
                            type: integer
                            example: 1
                          total_count:
                            type: integer
                            example: 1
                          per_page:
                            type: integer
                            example: 10
                required:
                  - fluid_pay_account
                  - addresses
                  - meta
        '400':
          description: missing JWT token
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: JWT is required
        '401':
          description: expired JWT token
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Token has expired
  /api/fluid_pay/create_address:
    post:
      summary: Creates a new address for fluid pay account
      tags:
        - Fluid Pay
      operationId: createFluidPayAddress
      parameters:
        - name: jwt
          in: query
          required: true
          description: JWT token containing customer authentication
          example: eyJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJjdX...
          schema:
            type: string
      responses:
        '201':
          description: address created
          content:
            application/json:
              schema:
                type: object
                properties:
                  fluid_pay_account:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                    required:
                      - id
                  address:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 980190974
                      address1:
                        type: string
                        example: 5833 Dottie Rapids
                      address2:
                        type:
                          - string
                          - 'null'
                        example: 521 Lupine Dr
                      address3:
                        type:
                          - string
                          - 'null'
                        example: 84555 Christiansen Grove
                      city:
                        type: string
                        example: San Jose
                      country_code:
                        type:
                          - string
                          - 'null'
                        example: US
                      default:
                        type: boolean
                        example: false
                      name:
                        type:
                          - string
                          - 'null'
                        example: Mitchell Stream
                      postal_code:
                        type: string
                        example: ''
                      state:
                        type: string
                        example: Rancho Palos Verdes
                      subdivision_code:
                        type:
                          - string
                          - 'null'
                        example: 1231
                      first_name:
                        type:
                          - string
                          - 'null'
                        example: Mitchell
                      last_name:
                        type:
                          - string
                          - 'null'
                        example: Stream
                    required:
                      - id
                      - address2
                      - city
                      - state
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - fluid_pay_account
                  - address
                  - meta
        '422':
          description: validation errors
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: unprocessable entity
                  errors:
                    type: object
                    properties:
                      address:
                        type: array
                        items:
                          type: string
                          example: already exists
                    example:
                      address:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2025-02-03T08:04:10Z'
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                address:
                  type: object
                  properties:
                    first_name:
                      type: string
                      example: John
                    last_name:
                      type: string
                      example: Doe
                    address1:
                      type: string
                      example: 123 Main St
                    address2:
                      type: string
                      example: Apt 4B
                    city:
                      type: string
                      example: Boise
                    state:
                      type: string
                      example: ID
                    postal_code:
                      type: string
                      example: '83702'
                    country_code:
                      type: string
                      example: US
                      description: >-
                        country_id takes precedence if both country_id and
                        country_code provided.
                    country_id:
                      type: integer
                      example: 1
                      description: Takes precedence over country_code if both are provided.
                    default:
                      type: boolean
                      example: false
                  required:
                    - address1
                    - city
                    - state
                    - postal_code
        required: true
  /api/fluid_pay/update_address/{address_id}:
    patch:
      summary: Updates an existing address
      tags:
        - Fluid Pay
      operationId: updateFluidPayAddress
      parameters:
        - name: jwt
          in: query
          required: true
          description: JWT token containing customer authentication
          example: eyJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJjdX...
          schema:
            type: string
        - name: address_id
          in: path
          required: true
          description: ID of the existing address to update
          example: 123
          schema:
            type: integer
      responses:
        '200':
          description: address updated with existing id
          content:
            application/json:
              schema:
                type: object
                properties:
                  fluid_pay_account:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                    required:
                      - id
                  address:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 980190974
                      address1:
                        type: string
                        example: 5833 Dottie Rapids
                      address2:
                        type:
                          - string
                          - 'null'
                        example: 521 Lupine Dr
                      address3:
                        type:
                          - string
                          - 'null'
                        example: 84555 Christiansen Grove
                      city:
                        type: string
                        example: San Jose
                      country_code:
                        type:
                          - string
                          - 'null'
                        example: US
                      default:
                        type: boolean
                        example: false
                      name:
                        type:
                          - string
                          - 'null'
                        example: Mitchell Stream
                      postal_code:
                        type: string
                        example: ''
                      state:
                        type: string
                        example: Rancho Palos Verdes
                      subdivision_code:
                        type:
                          - string
                          - 'null'
                        example: 1231
                      first_name:
                        type:
                          - string
                          - 'null'
                        example: Mitchell
                      last_name:
                        type:
                          - string
                          - 'null'
                        example: Stream
                    required:
                      - id
                      - address2
                      - city
                      - state
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - fluid_pay_account
                  - address
                  - meta
        '404':
          description: address not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    properties:
                      address:
                        type: array
                        items:
                          type: string
                          example: not found
                    example:
                      address:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2025-02-03T08:04:10Z'
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                address:
                  type: object
                  properties:
                    address1:
                      type: string
                      example: 123 Main St
                    address2:
                      type: string
                      example: Apt 4B
                    city:
                      type: string
                      example: Kathmandu
                    state:
                      type: string
                      example: Bagmati
                    postal_code:
                      type: string
                      example: '44600'
                    country_id:
                      type: integer
                      example: 1
                      description: Takes precedence over country_code if both are provided.
                    country_code:
                      type: string
                      example: NP
                      description: >-
                        country_id takes precedence if both country_id and
                        country_code provided.
                    first_name:
                      type: string
                      example: John
                    last_name:
                      type: string
                      example: Doe
                    default:
                      type: boolean
                      example: false
                  required:
                    - address1
                    - city
                    - state
                    - postal_code
        required: true
  /api/fluid_pay/delete_address/{address_id}:
    delete:
      summary: Deletes an existing address
      tags:
        - Fluid Pay
      operationId: deleteFluidPayAddress
      parameters:
        - name: jwt
          in: query
          required: true
          description: JWT token containing customer authentication
          example: eyJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJjdX...
          schema:
            type: string
        - name: address_id
          in: path
          required: true
          description: ID of the existing address to delete
          example: 123
          schema:
            type: integer
      responses:
        '200':
          description: address deleted
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Address removed
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2025-02-03T08:04:10Z'
                required:
                  - message
                  - meta
  /api/fluid_pay/create_payment_method:
    post:
      summary: Creates a new payment method
      tags:
        - Fluid Pay
      operationId: createFluidPayPaymentMethod
      parameters:
        - name: jwt
          in: query
          required: true
          description: JWT token containing customer authentication
          example: eyJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJjdX...
          schema:
            type: string
      responses:
        '200':
          description: payment method created
          content:
            application/json:
              schema:
                type: object
                properties:
                  fluid_pay_account:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      default_payment_method_id:
                        type: integer
                        example: 456
                    required:
                      - id
                      - default_payment_method_id
                  card:
                    type: object
                  payment_method:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      source:
                        type: string
                        example: card
                      default:
                        type: boolean
                        example: true
                      payment_type:
                        type: string
                        example: Credit Card
                      details:
                        type: object
                        properties:
                          id:
                            type:
                              - integer
                              - 'null'
                            example: 123
                          type:
                            type:
                              - string
                              - 'null'
                            example: CreditCard
                          card_type:
                            type:
                              - string
                              - 'null'
                            example: master
                          card_brand:
                            type:
                              - string
                              - 'null'
                            example: Master
                          last4_digits:
                            type:
                              - string
                              - 'null'
                            example: '4444'
                          last_four:
                            type:
                              - string
                              - 'null'
                            example: '4444'
                          exp_month:
                            type:
                              - integer
                              - string
                              - 'null'
                            example: '3'
                          exp_year:
                            type:
                              - integer
                              - string
                              - 'null'
                            example: '2032'
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: >-
                              https://assets.fluid.app/images/payment_icons/master.svg
                      payload:
                        type: object
                      created_at:
                        type: string
                        format: date-time
                        example: '2021-01-01T00:00:00Z'
                      updated_at:
                        type: string
                        format: date-time
                        example: '2021-01-01T00:00:00Z'
                  was_created:
                    type: boolean
                    example: true
                    description: payment method created or reused existing one
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        format: date-time
                        example: '2021-01-01T00:00:00Z'
                required:
                  - fluid_pay_account
                  - payment_method
                  - was_created
                  - meta
        '422':
          description: unprocessable entity when card processing fails
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: string
                    example:
                      - Card verification failed
                  error_message:
                    type: string
                    example: Card verification failed
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        format: date-time
                        example: '2021-01-01T00:00:00Z'
                required:
                  - errors
                  - error_message
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: string
                  description: Type of payment method
                  enum:
                    - credit_card
                    - paypal
                country_code:
                  type: string
                  description: Country ISO code
                  example: US
                default_payment_method:
                  type: boolean
                  description: Set default payment method
                  example: true
                payment_method:
                  type: object
                  properties:
                    token:
                      type: string
                      description: Payment method token from Spreedly or VGS aliased PAN
                      enum:
                        - SPREEDLY_TOKEN
                        - VGS_TOKEN
                      example: SPREEDLY_TOKEN
                    token_provider:
                      type: string
                      description: Token provider
                      enum:
                        - spreedly
                        - vgs
                      example: spreedly
                    last_four:
                      type: string
                      description: Last four digits of the card
                      example: '4242'
                    card_type:
                      type: string
                      description: Card type
                      enum:
                        - visa
                        - master
                        - amex
                    exp_month:
                      type: string
                      description: Expiration month
                      example: '3'
                    exp_year:
                      type: string
                      description: Expiration year
                      example: '2032'
                    card_holder:
                      type: string
                      description: Card holder name
                      example: Joe Jones
                    vault_card_id:
                      type: string
                      description: Vault card ID
                      example: '1234567890'
                    card_fingerprint:
                      type: string
                      description: Card fingerprint
                      example: '1234567890'
                  required:
                    - token
                billing_address:
                  type: object
                  properties:
                    address1:
                      type: string
                      description: Address line 1
                      example: 123 Main St
                    address2:
                      type: string
                      description: Address line 2
                      example: Apt 4B
                    city:
                      type: string
                      description: City
                      example: New York
                    state:
                      type: string
                      description: State
                      example: NY
                    zip:
                      type: string
                      description: Zip code
                      example: '10001'
                    country_code:
                      type: string
                      description: Country code
                      example: US
                payment_account:
                  type: string
                  example: pa_MyW8X11CuEbZyGHUi0DOHZrlzFE1cXhA
                  description: >-
                    Payment account UUID; when supplied, it overrides implicit
                    payment account inference.
                set_customer_payment_method:
                  type: boolean
                  example: true
                  description: >-
                    When true, associates the payment method with the customer.
                    When false or not provided, associates the payment method
                    with the fluid_pay_account.
              required:
                - type
                - country_code
                - payment_method
        required: true
        description: Payment method object containing token and other details
  /api/fluid_pay/delete_payment_method/{payment_method_id}:
    delete:
      summary: Deletes an existing payment method
      tags:
        - Fluid Pay
      operationId: deleteFluidPayPaymentMethod
      parameters:
        - name: jwt
          in: query
          required: true
          description: JWT token containing customer authentication
          example: eyJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJjdX...
          schema:
            type: string
        - name: payment_method_id
          in: path
          required: true
          description: ID of the existing payment method to delete
          example: 123
          schema:
            type: integer
      responses:
        '200':
          description: payment_method deleted
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Payment Method removed
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2025-02-03T08:04:10Z'
                required:
                  - message
                  - meta
  /api/fluid_pay/update_payment_method/{payment_method_id}:
    patch:
      summary: Update default payment method
      tags:
        - Fluid Pay
      operationId: updateFluidPayPaymentMethod
      parameters:
        - name: jwt
          in: query
          required: true
          description: JWT token containing customer authentication
          example: eyJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJjdX...
          schema:
            type: string
        - name: payment_method_id
          in: path
          required: true
          description: ID of the existing payment method to set as default
          example: 123
          schema:
            type: integer
      responses:
        '200':
          description: payment_method setted as default
          content:
            application/json:
              schema:
                type: object
                properties:
                  fluid_pay_account:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                    required:
                      - id
                  default_payment_method:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      source:
                        type: string
                        example: card
                      default:
                        type: boolean
                        example: true
                      payment_type:
                        type: string
                        example: Credit Card
                      details:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 123
                          type:
                            type: string
                            example: CreditCard
                          card_type:
                            type:
                              - string
                              - 'null'
                            example: visa
                          card_brand:
                            type:
                              - string
                              - 'null'
                            example: Visa
                          last4_digits:
                            type:
                              - string
                              - 'null'
                            example: '6789'
                            description: Deprecated
                          last_four:
                            type:
                              - string
                              - 'null'
                            example: '6789'
                          exp_month:
                            type:
                              - string
                              - 'null'
                            example: '12'
                          exp_year:
                            type:
                              - string
                              - 'null'
                            example: '2025'
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: >-
                              https://assets.fluid.app/images/payment_icons/visa.svg
                      payload:
                        type: object
                      created_at:
                        type: string
                        format: date-time
                        example: '2021-01-01T00:00:00Z'
                      updated_at:
                        type: string
                        format: date-time
                        example: '2021-01-01T00:00:00Z'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - fluid_pay_account
                  - default_payment_method
                  - meta
        '422':
          description: payment_method already assigned as default
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: unprocessable entity
                  errors:
                    type: object
                    properties:
                      payment_method:
                        type: array
                        items:
                          type: string
                          example: already assigned as default
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2025-02-03T08:04:10Z'
  /api/fluid_pay/me:
    get:
      summary: Retrieves fluid pay account and its customer using jwt token
      tags:
        - Fluid Pay
      operationId: fetchFluidPayAccountWithCustomer
      parameters:
        - name: jwt
          in: query
          required: true
          description: JWT token containing customer authentication
          example: eyJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJjdX...
          schema:
            type: string
      responses:
        '200':
          description: fluid pay account with customer retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  fluid_pay_account:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      email:
                        type: string
                        format: email
                        example: dipen@gmail.com
                      first_name:
                        type:
                          - string
                          - 'null'
                        example: John
                      last_name:
                        type:
                          - string
                          - 'null'
                        example: Doe
                      phone:
                        type:
                          - string
                          - 'null'
                        example: '016611225'
                      address_count:
                        type: integer
                        example: 17
                      payment_methods_count:
                        type: integer
                        example: 2
                      language_iso:
                        type:
                          - string
                          - 'null'
                        example: en
                    required:
                      - id
                      - email
                      - address_count
                      - payment_methods_count
                  customer:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 10
                      user_company_id:
                        type:
                          - integer
                          - 'null'
                      account_id:
                        type: string
                        example: AU11V9IT8XV1RXYT
                      active:
                        type: boolean
                        example: false
                      active_subscriptions_count:
                        type: integer
                        example: 0
                      addresses:
                        type: array
                        items:
                          type: object
                        example: []
                      created_at:
                        type: string
                        format: date-time
                        example: '2025-01-28T11:24:32Z'
                      customer_notes:
                        type: array
                        items:
                          type: object
                        example: []
                      default_address:
                        type:
                          - object
                          - 'null'
                        example: null
                      display_total_spent:
                        type: string
                        example: $0.00 (USD)
                      email:
                        type: string
                        format: email
                        example: dipen@gmail.com
                      first_name:
                        type:
                          - string
                          - 'null'
                        example: John
                      last_name:
                        type:
                          - string
                          - 'null'
                        example: Doe
                      full_name:
                        type: string
                        example: John Doe
                      inactive_subscriptions_count:
                        type: integer
                        example: 0
                      last_order_id:
                        type:
                          - string
                          - 'null'
                        example: null
                      metadata:
                        type: object
                        additionalProperties: true
                        example: {}
                      notes:
                        type:
                          - string
                          - 'null'
                        example: null
                      orders_count:
                        type: integer
                        example: 0
                      phone:
                        type:
                          - string
                          - 'null'
                        example: '016611225'
                      payment_methods:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 967023914
                            company_id:
                              type: integer
                              example: 96778814
                            created_at:
                              type: string
                              example: '2025-11-11T04:59:05Z'
                            logo_url:
                              type:
                                - string
                                - 'null'
                              example: >-
                                https://assets.fluid.app/images/payment_icons/visa.svg
                            payload:
                              type: object
                              example:
                                exp_year: '2030'
                                card_type: visa
                                exp_month: '01'
                                card_last_four: '1234'
                                token_provider: spreedly
                            source:
                              type: string
                              example: card
                            updated_at:
                              type: string
                              example: '2025-11-11T04:59:05Z'
                            user_id:
                              type:
                                - integer
                                - 'null'
                              example: null
                      total_spent:
                        type:
                          - number
                          - string
                        example: 0
                      verified_email:
                        type: boolean
                        example: false
                      is_rep:
                        type: boolean
                        example: true
                      is_discarded:
                        type: boolean
                        example: false
                      jwt:
                        type: string
                        example: eyJhbGciO1NiJ9.eyJhdXcyNjN9.AZ-4PAgFwVyGp
                      external_id:
                        type:
                          - string
                          - 'null'
                        example: '1234567890'
                      role:
                        type: string
                        example: customer
                        enum:
                          - customer
                          - preferred_customer
                          - rep
                      metafields:
                        type: array
                        items:
                          title: LegacyMetafield
                          type: object
                          properties:
                            id:
                              type: integer
                            namespace:
                              description: >-
                                A container for related metafields. Commonly
                                used to group metafields by app or
                                functionality.
                              example: custom
                              type: string
                              maxLength: 20
                              pattern: ^[a-zA-Z0-9_]+$
                            key:
                              description: >-
                                The unique identifier for the metafield within
                                its namespace. Must be unique per namespace and
                                owner.
                              example: material
                              type: string
                              maxLength: 30
                              pattern: ^[a-zA-Z0-9_]+$
                            value:
                              description: >-
                                The actual data stored in the metafield. Type
                                depends on value_type.
                              example: cotton
                              type:
                                - string
                                - object
                            value_type:
                              description: >-
                                The data type that defines how the value should
                                be interpreted and validated.
                              example: single_line_text_field
                              type: string
                            description:
                              description: >-
                                Optional human-readable description explaining
                                the purpose of this metafield.
                              example: The primary material used in this product
                              type:
                                - string
                                - 'null'
                            owner_type:
                              description: >-
                                The type of resource that this metafield belongs
                                to (polymorphic association).
                              example: Product
                              type: string
                            owner_id:
                              description: >-
                                The ID of the specific resource that this
                                metafield belongs to.
                              example: 12345
                              type: integer
                            created_at:
                              description: Timestamp when the metafield was created.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            updated_at:
                              description: Timestamp when the metafield was last updated.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            metafield_definition:
                              title: MetafieldDefinition
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                company_id:
                                  description: >-
                                    The ID of the company that owns this
                                    metafield definition.
                                  example: 1
                                  type: integer
                                namespace:
                                  description: >-
                                    A container for related metafield
                                    definitions. Used to group definitions by
                                    app or functionality. Must be unique within
                                    company and owner_resource.
                                  example: product_details
                                  type: string
                                  maxLength: 20
                                  pattern: ^[a-zA-Z0-9_]+$
                                key:
                                  description: >-
                                    The unique identifier for the metafield
                                    definition within its namespace and
                                    owner_resource. Combined with namespace and
                                    owner_resource, this must be unique per
                                    company.
                                  example: material_type
                                  type: string
                                  maxLength: 30
                                  pattern: ^[a-zA-Z0-9_]+$
                                name:
                                  description: >-
                                    Human-readable display name for the
                                    metafield definition, shown in admin
                                    interfaces and forms.
                                  example: Material Type
                                  type: string
                                  maxLength: 100
                                description:
                                  description: >-
                                    Detailed explanation of what this metafield
                                    definition represents, how it should be
                                    used, and any special instructions for
                                    content creators.
                                  example: >-
                                    Specify the primary material composition of
                                    the product (e.g., cotton, polyester, silk).
                                    This will be displayed on the product detail
                                    page.
                                  type:
                                    - string
                                    - 'null'
                                value_type:
                                  description: >-
                                    The data type that defines how metafield
                                    values should be validated, stored, and
                                    displayed. Determines which validation rules
                                    are available.
                                  example: single_line_text_field
                                  type: string
                                validation_rules:
                                  description: >-
                                    JSON object containing validation
                                    constraints that will be applied to
                                    metafield values. Available rules depend on
                                    the value_type.
                                  example:
                                    choices:
                                      - cotton
                                      - polyester
                                      - silk
                                      - wool
                                      - linen
                                      - bamboo
                                    max: 50
                                    min: 2
                                  type:
                                    - object
                                    - 'null'
                                owner_resource:
                                  description: >-
                                    The type of resource (model class name) that
                                    metafields using this definition can be
                                    attached to. Must match the polymorphic
                                    owner_type.
                                  example: Product
                                  type: string
                                pinned:
                                  description: >-
                                    Whether this definition should be
                                    prominently displayed or prioritized in
                                    admin interfaces and forms.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                position:
                                  default: 0
                                  description: >-
                                    Sort order for displaying this definition
                                    relative to others in the same category and
                                    owner_resource. Lower numbers appear first.
                                  example: 1
                                  type:
                                    - integer
                                    - 'null'
                                locked:
                                  description: >-
                                    Whether this metafield definition is locked,
                                    preventing direct updates or deletions of
                                    metafields using this definition.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                created_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    created.
                                  example: '2024-01-15T10:30:00Z'
                                  type: string
                                  format: date-time
                                updated_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    last updated.
                                  example: '2024-02-20T14:45:00Z'
                                  type: string
                                  format: date-time
                                list_type:
                                  description: >-
                                    Whether this definition is for list-type
                                    metafields that store arrays of values.
                                  example: false
                                  type: boolean
                                reference_type:
                                  description: >-
                                    Whether this definition is for
                                    reference-type metafields that store
                                    references to other resources.
                                  example: false
                                  type: boolean
                                supported_validations:
                                  description: >-
                                    Array of validation rule names that are
                                    supported for this value_type.
                                  example:
                                    - min
                                    - max
                                    - choices
                                    - regex
                                  type: array
                                validation_description:
                                  description: >-
                                    Human-readable description of what the
                                    value_type represents and its constraints.
                                  example: Single line text up to 5000 characters
                                  type: string
                                category_ids:
                                  description: >-
                                    Array of category IDs that this metafield
                                    definition is associated with for
                                    organizational purposes.
                                  example:
                                    - 1
                                    - 2
                                    - 3
                                  items:
                                    type: integer
                                  type: array
                              required:
                                - id
                                - company_id
                                - namespace
                                - key
                                - name
                                - value_type
                                - owner_resource
                                - created_at
                                - updated_at
                                - list_type
                                - reference_type
                                - supported_validations
                                - validation_description
                                - category_ids
                          required:
                            - id
                            - namespace
                            - key
                            - value
                            - value_type
                            - owner_type
                            - owner_id
                            - created_at
                            - updated_at
                    required:
                      - id
                      - account_id
                      - active
                      - email
                      - first_name
                      - last_name
                      - full_name
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2025-02-03T08:04:10Z'
                required:
                  - fluid_pay_account
                  - customer
                  - meta
        '401':
          description: invalid JWT token
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Invalid token
  /api/fluid_pay/update_me:
    patch:
      summary: Update current customer
      description: Update current customer
      tags:
        - Fluid Pay
      operationId: updateMe
      parameters:
        - name: jwt
          in: query
          required: true
          description: JWT token containing customer authentication
          example: eyJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJjdX...
          schema:
            type: string
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  fluid_pay_account:
                    title: Commerce::FluidPayAccount
                    type: object
                    properties:
                      id:
                        type: integer
                      first_name:
                        example: John
                        type:
                          - string
                          - 'null'
                      last_name:
                        example: Doe
                        type:
                          - string
                          - 'null'
                      email:
                        example: john_doe@example.com
                        type: string
                      phone:
                        example: '+1234567890'
                        type:
                          - string
                          - 'null'
                      created_at:
                        example: '2025-03-10T00:00:00Z'
                        type: string
                        format: date-time
                      updated_at:
                        example: '2025-03-10T00:00:00Z'
                        type: string
                        format: date-time
                      settings:
                        example: {}
                        type:
                          - object
                          - 'null'
                      slug:
                        example: john-doe
                        type: string
                      language:
                        title: Language
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                          name:
                            example: English
                            type:
                              - string
                              - 'null'
                          iso:
                            example: en
                            type:
                              - string
                              - 'null'
                        required:
                          - id
                      default_address:
                        title: Address
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                          name:
                            example: John Doe
                            type: string
                          address1:
                            example: 123 Main St
                            type: string
                          address2:
                            example: Apt 4B
                            type:
                              - string
                              - 'null'
                          address3:
                            example: Building 5
                            type:
                              - string
                              - 'null'
                          city:
                            example: New York
                            type: string
                          state:
                            example: NY
                            type: string
                          subdivision_code:
                            example: NY
                            type:
                              - string
                              - 'null'
                          postal_code:
                            example: '10001'
                            type: string
                          country_code:
                            example: US
                            type:
                              - string
                              - 'null'
                          default:
                            description: >-
                              Use this address by default when there are
                              multiple addresses
                            example: true
                            type:
                              - boolean
                              - 'null'
                            default: false
                          first_name:
                            example: John
                            type: string
                          last_name:
                            example: Doe
                            type: string
                        required:
                          - id
                          - name
                          - address1
                          - city
                          - state
                          - postal_code
                          - first_name
                          - last_name
                      default_payment_method:
                        title: Commerce::PaymentMethod
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                          source:
                            type: string
                            enum:
                              - apple_pay
                              - paypal
                              - card
                              - iap
                              - bread
                              - affirm
                              - google_pay
                              - klarna
                              - droplet
                              - citcon
                              - ppro
                          payload:
                            type:
                              - object
                              - 'null'
                          company_id:
                            type:
                              - integer
                              - 'null'
                          created_at:
                            type: string
                            format: date-time
                          updated_at:
                            type: string
                            format: date-time
                          logo_url:
                            type: string
                          user_id:
                            example: 101
                            type:
                              - integer
                              - 'null'
                        required:
                          - id
                          - source
                          - created_at
                          - updated_at
                          - logo_url
                    required:
                      - id
                      - email
                      - created_at
                      - updated_at
                      - slug
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - fluid_pay_account
                  - meta
        '404':
          description: not found - language
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                fluid_pay_account:
                  type: object
                  properties:
                    first_name:
                      type: string
                      minLength: 1
                    last_name:
                      type: string
                      minLength: 1
                    email:
                      type: string
                      minLength: 1
                    phone:
                      type: string
                      minLength: 1
                    language_iso:
                      type: string
                      minLength: 1
                  required: []
              required:
                - jwt
                - fluid_pay_account
  /api/fluid_pay/vault:
    get:
      summary: Vault Access Token
      description: Get VGS Vault Access Token
      tags:
        - Fluid Pay
      operationId: getVaultAccessToken
      parameters:
        - name: jwt
          in: query
          required: true
          description: JWT token containing customer authentication
          example: eyJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJjdX...
          schema:
            type: string
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  vault:
                    type: object
                    properties:
                      vault_id:
                        type: string
                        example: vault_id
                      environment:
                        type: string
                        example: sandbox
                      access_token:
                        type: string
                        example: eyJhbGciOiJIUzI1NiJ9....
                      route_id:
                        type: string
                        example: route_id_123
                    required:
                      - vault_id
                      - environment
                      - access_token
                      - route_id
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - vault
                  - meta
  /api/forms/{form_id}/form_elements:
    get:
      summary: List form elements
      description: List all form elements for a form
      tags:
        - Form Elements
      operationId: listFormElements
      security:
        - bearer_auth: []
      parameters:
        - name: form_id
          in: path
          required: true
          description: Form ID
          schema:
            type: integer
        - name: page
          in: query
          required: false
          description: Page number
          schema:
            type: integer
        - name: per_page
          in: query
          required: false
          description: Number of items per page
          schema:
            type: integer
        - name: filterrific
          in: query
          required: false
          description: Filterrific parameters
          schema:
            type: string
      responses:
        '200':
          description: successful
  /api/forms/{form_id}/form_elements/{id}:
    get:
      summary: Show form element
      description: Show a form element
      tags:
        - Form Elements
      operationId: showFormElement
      security:
        - bearer_auth: []
      parameters:
        - name: form_id
          in: path
          required: true
          description: Form ID
          schema:
            type: integer
        - name: id
          in: path
          required: true
          description: Form element ID
          schema:
            type: integer
      responses:
        '200':
          description: successful
  /api/forms:
    get:
      summary: List forms
      description: List all forms for a company
      tags:
        - Forms
      operationId: listForms
      security:
        - bearer_auth: []
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        countries:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                              iso:
                                type: string
                              name:
                                type: string
                        description:
                          type:
                            - string
                            - 'null'
                        form_components:
                          type:
                            - string
                            - 'null'
                        form_redirect:
                          type:
                            - string
                            - 'null'
                        form_respondents_count:
                          type: integer
                        form_type:
                          type:
                            - string
                            - 'null'
                        status:
                          type: string
                        title:
                          type: string
                        updated_at:
                          type: string
                          format: date_time
                  pagination:
                    type: object
                    properties:
                      current_page:
                        type: integer
                      next_page:
                        type:
                          - integer
                          - 'null'
                      prev_page:
                        type:
                          - integer
                          - 'null'
                      total_pages:
                        type: integer
                      total_count:
                        type: integer
                  filters:
                    type: object
                    properties:
                      sorted_by:
                        type: array
                        items:
                          type: array
                          items:
                            type: string
    post:
      summary: Create a form
      description: Create a new form
      tags:
        - Forms
      operationId: createForm
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: created
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  form:
                    type: object
                    properties:
                      id:
                        type: integer
                      countries:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            iso:
                              type: string
                            name:
                              type: string
                      description:
                        type:
                          - string
                          - 'null'
                      form_components:
                        type:
                          - string
                          - 'null'
                      form_redirect:
                        type:
                          - string
                          - 'null'
                      form_respondents_count:
                        type: integer
                      form_type:
                        type: string
                      status:
                        type: string
                      title:
                        type: string
                      updated_at:
                        type: string
                        format: date_time
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  errors:
                    type: array
                    items:
                      type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                  example: New Form
                  description: Title of the form
                description:
                  type: string
                  example: Form description
                  description: Description of the form
              required:
                - title
  /api/forms/{id}/respondents:
    get:
      summary: List form respondents
      description: List all respondents for a form
      tags:
        - Forms
      operationId: listFormRespondents
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Form ID
          schema:
            type: integer
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        form_completion_status:
                          type: string
                        respondent:
                          type: object
                          properties:
                            id:
                              type: integer
                            email:
                              type: string
                            full_name:
                              type: string
                            status:
                              type: string
                            token:
                              type: string
                        respondent_type:
                          type: string
                        response:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                              form_element_id:
                                type: integer
                              response:
                                type: string
                        updated_at:
                          type: string
                          format: date_time
                  pagination:
                    type: object
                    properties:
                      current_page:
                        type: integer
                      next_page:
                        type:
                          - integer
                          - 'null'
                      prev_page:
                        type:
                          - integer
                          - 'null'
                      total_pages:
                        type: integer
                      total_count:
                        type: integer
                  filters:
                    type: object
                    properties:
                      sorted_by:
                        type: array
                        items:
                          type: array
                          items:
                            type: string
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
  /api/forms/{id}/respond:
    post:
      summary: Respond to a form
      description: Respond to a form
      tags:
        - Forms
      operationId: respondToForm
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Form ID
          schema:
            type: integer
      responses:
        '201':
          description: created
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  responses:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        form_element_id:
                          type: integer
                        form_respondent_id:
                          type: integer
                        response:
                          type: string
                        created_at:
                          type: string
                          format: date_time
                        updated_at:
                          type: string
                          format: date_time
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                form_response:
                  type: object
                  properties:
                    contact:
                      type: object
                      properties:
                        first_name:
                          type: string
                        last_name:
                          type: string
                        email:
                          type: string
                    responses:
                      type: array
                      items:
                        type: object
                        properties:
                          form_element_id:
                            type: integer
                          answer:
                            type: string
              required:
                - form_response
  /api/forms/statistics:
    get:
      summary: Get form statistics
      description: Get statistics for a form
      tags:
        - Forms
      operationId: getFormStatistics
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: query
          required: true
          description: Form ID
          schema:
            type: integer
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_forms:
                    type: integer
                  total_responses:
                    type: integer
                  completed_responses:
                    type: integer
                  completion_rate:
                    type: number
                    format: float
                  today_responses:
                    type: integer
                  yesterday_responses:
                    type: integer
  /api/forms/{id}/send_mail:
    post:
      summary: Send form via email
      description: Send a form via email
      tags:
        - Forms
      operationId: sendFormViaEmail
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Form ID
          schema:
            type: integer
      responses:
        '200':
          description: email sent
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                email:
                  type: string
                  example: user@example.com
                  description: Email address to send the form to
              required:
                - email
  /api/forms/{id}:
    put:
      summary: Update a form
      description: Update an existing form
      tags:
        - Forms
      operationId: updateForm
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Form ID
          schema:
            type: integer
      responses:
        '200':
          description: updated with form components
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  form:
                    type: object
                    properties:
                      id:
                        type: integer
                      countries:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            iso:
                              type: string
                            name:
                              type: string
                      description:
                        type:
                          - string
                          - 'null'
                      form_components:
                        type:
                          - string
                          - 'null'
                      form_redirect:
                        type:
                          - string
                          - 'null'
                      form_respondents_count:
                        type: integer
                      form_type:
                        type: string
                      status:
                        type: string
                      title:
                        type: string
                      updated_at:
                        type: string
                        format: date_time
        '404':
          description: form not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
        '422':
          description: unprocessable entity - invalid parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: array
                    items:
                      type: string
                  error:
                    type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                form:
                  type: object
                  properties:
                    title:
                      type: string
                      example: Updated Form Title
                      description: Title of the form
                    description:
                      type: string
                      example: Updated form description
                      description: Description of the form
                    status:
                      type: string
                      example: active
                      description: Status of the form
                    form_type:
                      type: string
                      example: general
                      description: Type of the form
                    form_components:
                      type: string
                      example: >-
                        [{"element_type":"input","label":"Name","field_data_value":"name"}]
                      description: JSON string of form components
                    form_redirect:
                      type: string
                      example: https://example.com/thank-you
                      description: Redirect URL after form submission
                    default:
                      type: boolean
                      example: false
                      description: Whether this is the default form
                    country_ids:
                      type: array
                      items:
                        type: integer
                      example:
                        - 1
                        - 2
                      description: Array of country IDs
              required:
                - form
    delete:
      summary: Delete a form
      description: Delete a form
      tags:
        - Forms
      operationId: deleteForm
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Form ID
          schema:
            type: integer
      responses:
        '200':
          description: deleted
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
  /api/forms/{id}/duplicate:
    post:
      summary: Duplicate a form
      description: Duplicate a form
      tags:
        - Forms
      operationId: duplicateForm
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Form ID
          schema:
            type: integer
      responses:
        '200':
          description: duplicated with different id
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  countries:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        iso:
                          type: string
                        name:
                          type: string
                  description:
                    type:
                      - string
                      - 'null'
                  form_components:
                    type:
                      - string
                      - 'null'
                  form_redirect:
                    type:
                      - string
                      - 'null'
                  form_respondents_count:
                    type: integer
                  form_type:
                    type: string
                  status:
                    type: string
                  title:
                    type: string
                  updated_at:
                    type: string
                    format: date_time
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
  /api/global_embeds:
    get:
      summary: List global embeds
      description: Get all global embeds with optional filters
      tags:
        - Global Embeds
      operationId: listGlobalEmbeds
      security:
        - bearer_auth: []
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            default: 1
          required: false
          description: Page number for pagination
        - name: per_page
          in: query
          schema:
            type: integer
            default: 10
          required: false
          description: Number of records per page
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  global_embeds:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        name:
                          type: string
                        content:
                          type: string
                        status:
                          type: string
                        placement:
                          type: string
                        created_at:
                          type: string
                          format: date-time
                        updated_at:
                          type: string
                          format: date-time
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
                      pagination:
                        type: object
                        properties:
                          current_page:
                            type: integer
                          total_pages:
                            type: integer
                          total_count:
                            type: integer
                          per_page:
                            type: integer
    post:
      summary: Create a global embed
      description: Create a new global embed
      tags:
        - Global Embeds
      operationId: createGlobalEmbed
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: global embed created
          content:
            application/json:
              schema:
                type: object
                properties:
                  global_embed:
                    type: object
                    properties:
                      id:
                        type: integer
                      name:
                        type: string
                      content:
                        type: string
                      status:
                        type: string
                      placement:
                        type: string
                      created_at:
                        type: string
                        format: date-time
                      updated_at:
                        type: string
                        format: date-time
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                global_embed:
                  type: object
                  required:
                    - name
                    - content
                  properties:
                    name:
                      type: string
                    content:
                      type: string
                    status:
                      type: string
                      enum:
                        - draft
                        - active
                    placement:
                      type: string
                      enum:
                        - head
                        - body
  /api/global_embeds/{id}:
    get:
      summary: Get a global embed
      description: Get a specific global embed by ID
      tags:
        - Global Embeds
      operationId: getGlobalEmbed
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: global embed found
          content:
            application/json:
              schema:
                type: object
                properties:
                  global_embed:
                    type: object
                    properties:
                      id:
                        type: integer
                      name:
                        type: string
                      content:
                        type: string
                      status:
                        type: string
                      placement:
                        type: string
                      created_at:
                        type: string
                        format: date-time
                      updated_at:
                        type: string
                        format: date-time
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: global embed not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
    put:
      summary: Update a global embed
      description: Update an existing global embed
      tags:
        - Global Embeds
      operationId: updateGlobalEmbed
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: global embed updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  global_embed:
                    type: object
                    properties:
                      id:
                        type: integer
                      name:
                        type: string
                      content:
                        type: string
                      status:
                        type: string
                      placement:
                        type: string
                      created_at:
                        type: string
                        format: date-time
                      updated_at:
                        type: string
                        format: date-time
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                global_embed:
                  type: object
                  properties:
                    name:
                      type: string
                    content:
                      type: string
                    status:
                      type: string
                      enum:
                        - draft
                        - active
                    placement:
                      type: string
                      enum:
                        - head
                        - body
    delete:
      summary: Delete a global embed
      description: Deletes a specific global embed
      tags:
        - Global Embeds
      operationId: deleteGlobalEmbed
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: global embed deleted
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
  /api/impersonation:
    post:
      summary: Impersonate a company
      tags:
        - Impersonation
      security:
        - bearer_auth: []
      operationId: impersonateCompany
      description: Impersonate a company. Accessible only by root admins.
      parameters:
        - name: Authorization
          in: header
          required: true
          description: Bearer token for authentication
          schema:
            type: string
      responses:
        '201':
          description: Company impersonation successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  impersonating:
                    type: boolean
                    example: true
                  company:
                    type: object
                    properties:
                      id:
                        type: integer
                      name:
                        type: string
                      active:
                        type: boolean
                      fluid_shop:
                        type: string
                      logo_url:
                        type: string
                    required:
                      - id
                      - name
                      - active
                  jwt:
                    type: string
                    example: eyJhbGciOiJIUzI1NiJ9...
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - impersonating
                  - company
                  - jwt
                  - meta
        '401':
          description: Unauthorized - Invalid credentials
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '403':
          description: Forbidden - User is not authorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not authorized.
                required:
                  - error
        '404':
          description: Company not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Company not found
                  errors:
                    type: object
                    properties:
                      company:
                        type: array
                        items:
                          type: string
                        example:
                          - Company not found.
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - error_message
                  - errors
                  - meta
        '422':
          description: Unprocessable Entity - Validation errors
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Validation failed
                  errors:
                    type: object
                    properties:
                      impersonation:
                        type: array
                        items:
                          type: string
                        example:
                          - Failed to generate impersonation token
                      company_id:
                        type: array
                        items:
                          type: string
                        example:
                          - is required
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                company_id:
                  type: integer
                  description: Company ID to impersonate
              required:
                - company_id
    delete:
      summary: Exit company impersonation
      tags:
        - Impersonation
      security:
        - bearer_auth: []
      operationId: exitImpersonateCompany
      description: >-
        Exit company impersonation and return to original admin session. Must be
        authenticated with impersonation token.
      parameters:
        - name: Authorization
          in: header
          required: true
          description: Bearer impersonation token (not user token)
          schema:
            type: string
      responses:
        '200':
          description: Impersonation ended successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  user_company:
                    type: object
                    properties:
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          active:
                            type: boolean
                          fluid_shop:
                            type: string
                          logo_url:
                            type: string
                        required:
                          - id
                          - name
                          - active
                      jwt:
                        type: string
                    required:
                      - company
                      - jwt
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - user_company
                  - meta
        '401':
          description: Unauthorized - Expired impersonation token
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '403':
          description: Forbidden - Non-root admin cannot exit impersonation
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not authorized.
                required:
                  - error
  /api/inventory_levels:
    get:
      summary: List inventory levels
      description: List all inventory levels with filters
      tags:
        - Inventory Levels
      operationId: listInventoryLevels
      security:
        - bearer_auth: []
      parameters:
        - name: variant_ids
          in: query
          required: false
          description: Comma-separated variant_ids. Required if warehouse_ids empty
          schema:
            type: string
        - name: warehouse_ids
          in: query
          required: false
          description: Comma-separated warehouse_ids. Required if variant_ids empty
          schema:
            type: string
        - name: published_to
          in: query
          required: false
          description: >-
            coma-separated values (allowed values: Retail Store, Rep Store,
            Share tab)
          schema:
            type: string
        - name: product_tags
          in: query
          required: false
          description: Product tags
          schema:
            type: string
        - name: available_greater_than
          in: query
          required: false
          description: Inventory level available greater than
          schema:
            type: string
        - name: available_less_than
          in: query
          required: false
          description: Inventory level available less than
          schema:
            type: string
        - name: unavailable_greater_than
          in: query
          required: false
          description: Inventory level unavailable greater than
          schema:
            type: string
        - name: unavailable_less_than
          in: query
          required: false
          description: Inventory level unavailable less than
          schema:
            type: string
        - name: committed_greater_than
          in: query
          required: false
          description: Inventory level committed greater than
          schema:
            type: string
        - name: committed_less_than
          in: query
          required: false
          description: Inventory level committed less than
          schema:
            type: string
        - name: on_hand_greater_than
          in: query
          required: false
          description: Inventory level on hand greater than
          schema:
            type: string
        - name: on_hand_less_than
          in: query
          required: false
          description: Inventory level on hand less than
          schema:
            type: string
        - name: search
          in: query
          required: false
          description: Search text
          schema:
            type: string
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  inventory_levels:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        committed:
                          type: integer
                        available:
                          type: integer
                        on_hand:
                          type: integer
                        unavailable:
                          type: integer
                        adjustments:
                          type:
                            - array
                            - object
                            - 'null'
                          example: {}
                        unavailable_item_counts_by_category:
                          type:
                            - array
                            - 'null'
                          description: Array of unavailable item counts categorized by type
                          items:
                            type:
                              - object
                              - 'null'
                            required:
                              - category_type
                              - value
                            properties:
                              category_type:
                                type: string
                                description: The type/category of unavailable items
                                example: damaged
                              value:
                                type: integer
                                description: >-
                                  The count of unavailable items for this
                                  category
                                example: 10
                            additionalProperties: false
                          example:
                            - category_type: damaged
                              value: 10
                            - category_type: Quality control
                              value: 20
                        variant:
                          type: object
                          properties:
                            id:
                              type: integer
                            product_id:
                              type: integer
                            sku:
                              type: string
                            title:
                              type: string
                            track_quantity:
                              type: boolean
                            keep_selling:
                              type: boolean
                        product:
                          type: object
                          properties:
                            image:
                              type: string
                            title:
                              type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: datetime
                      total_count:
                        type: integer
                      total_pages:
                        type: integer
                      page_size:
                        type: integer
                      current_page:
                        type: integer
        '400':
          description: error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Warehouse ids or variant ids must be passed
                  errors:
                    type: array
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
  /api/inventory_levels/{id}:
    delete:
      summary: Delete inventory level
      description: Delete a single inventory level
      tags:
        - Inventory Levels
      operationId: deleteInventoryLevel
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Id of inventory level to be deleted.
          example: '1'
          schema:
            type: string
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  inventory_level:
                    type: object
                    properties:
                      id:
                        type: integer
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: 'Couldn''t find inventory level with id: 1'
                  errors:
                    type: array
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
        '422':
          description: error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: 'Failed to delete inventory level with id: 1'
                  errors:
                    type: array
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
  /api/inventory_levels/set:
    post:
      summary: Set Inventory Level
      description: >-
        Updates an inventory level if found or creates if not found for given
        variant in a warehouse. Adds an audit log entry for the operation.
      tags:
        - Inventory Levels
      operationId: updateOrCreateInventoryLevel
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: Inventory level updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  inventory_level:
                    type: object
                    properties:
                      id:
                        type: integer
                      committed:
                        type: integer
                      available:
                        type: integer
                      on_hand:
                        type: integer
                      unavailable:
                        type: integer
                      warning:
                        type:
                          - string
                          - 'null'
                      adjustments:
                        type:
                          - array
                          - object
                          - 'null'
                      unavailable_item_counts_by_category:
                        type:
                          - array
                          - object
                          - 'null'
                      variant:
                        type: object
                        properties:
                          id:
                            type: integer
                          sku:
                            type: string
                          track_quantity:
                            type: boolean
                          keep_selling:
                            type: boolean
                      product:
                        type: object
                        properties:
                          id:
                            type: integer
                          title:
                            type: string
                          image_url:
                            type: string
                      warehouse:
                        type: object
                        properties:
                          id:
                            type: integer
                          country:
                            type: object
                            properties:
                              id:
                                type: integer
                              name:
                                type: string
                              iso:
                                type: string
                          address:
                            type: object
                            properties:
                              id:
                                type: integer
                              city:
                                type: string
                              state:
                                type: string
                              address1:
                                type: string
                              postal_code:
                                type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '201':
          description: Inventory level created
          content:
            application/json:
              schema:
                type: object
                properties:
                  inventory_level:
                    type: object
                    properties:
                      id:
                        type: integer
                      committed:
                        type: integer
                      available:
                        type: integer
                      on_hand:
                        type: integer
                      unavailable:
                        type: integer
                      warning:
                        type:
                          - string
                          - 'null'
                      adjustments:
                        type:
                          - array
                          - object
                          - 'null'
                      unavailable_item_counts_by_category:
                        type:
                          - array
                          - object
                          - 'null'
                      variant:
                        type: object
                        properties:
                          id:
                            type: integer
                          sku:
                            type: string
                          track_quantity:
                            type: boolean
                          keep_selling:
                            type: boolean
                      product:
                        type: object
                        properties:
                          id:
                            type: integer
                          title:
                            type: string
                          image_url:
                            type: string
                      warehouse:
                        type: object
                        properties:
                          id:
                            type: integer
                          country:
                            type: object
                            properties:
                              id:
                                type: integer
                              name:
                                type: string
                              iso:
                                type: string
                          address:
                            type: object
                            properties:
                              id:
                                type: integer
                              city:
                                type: string
                              state:
                                type: string
                              address1:
                                type: string
                              postal_code:
                                type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '400':
          description: Bad Request - invalid warehouse and variant IDs
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: >-
                      Validation failed: Warehouse must exist, Variant must
                      exist
                  errors:
                    type: array
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '422':
          description: Invalid request - missing required parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameters
                  errors:
                    type: object
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                inventory_level:
                  type: object
                  properties:
                    variant_id:
                      type: integer
                      example: 1
                      description: ID of the variant
                    warehouse_id:
                      type: integer
                      example: 1
                      description: ID of the warehouse
                    on_hand:
                      type: integer
                      example: 10
                      description: Quantity on hand
                    available:
                      type: integer
                      example: 5
                      description: Available quantity
                    unavailable:
                      type: integer
                      example: 0
                      description: Unavailable quantity
                    committed:
                      type: integer
                      example: 5
                      description: Committed quantity
                    reason:
                      type: string
                      example: Stock adjustment
                      description: Reason for the change
                  required:
                    - variant_id
                    - warehouse_id
  /api/inventory_levels/adjust:
    post:
      summary: Adjust inventory level
      description: >-
        Adjust attribute of an inventory level. It also changes the value of
        corresponding attribute (for e.g: decreasing value of committed
        increases value of available). Also logs entry for the operation.
      tags:
        - Inventory Levels
      operationId: adjustInventoryLevel
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: Adjusts committed with negative quantity
          content:
            application/json:
              schema:
                type: object
                properties:
                  inventory_level:
                    type: object
                    properties:
                      id:
                        type: integer
                      committed:
                        type: integer
                      available:
                        type: integer
                      on_hand:
                        type: integer
                      unavailable:
                        type: integer
                      warning:
                        type:
                          - string
                          - 'null'
                      adjustments:
                        type:
                          - array
                          - object
                          - 'null'
                      unavailable_item_counts_by_category:
                        type:
                          - array
                          - object
                          - 'null'
                      variant:
                        type: object
                        properties:
                          id:
                            type: integer
                          sku:
                            type: string
                          track_quantity:
                            type: boolean
                          keep_selling:
                            type: boolean
                      product:
                        type: object
                        properties:
                          id:
                            type: integer
                          title:
                            type: string
                          image_url:
                            type: string
                      warehouse:
                        type: object
                        properties:
                          id:
                            type: integer
                          country:
                            type: object
                            properties:
                              id:
                                type: integer
                              name:
                                type: string
                              iso:
                                type: string
                          address:
                            type: object
                            properties:
                              id:
                                type: integer
                              city:
                                type: string
                              state:
                                type: string
                              address1:
                                type: string
                              postal_code:
                                type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '400':
          description: Invalid adjustment attribute
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: array
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: Inventory level not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: array
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '422':
          description: Invalid attributes
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                inventory_level:
                  type: object
                  properties:
                    id:
                      type: integer
                    adjustment_attribute:
                      type: string
                      enum:
                        - on_hand
                        - available
                        - unavailable
                        - committed
                    quantity:
                      type: integer
                    reason:
                      type: string
                  required:
                    - id
                    - adjustment_attribute
                    - quantity
                    - reason
  /api/inventory_levels/bulk_delete:
    delete:
      summary: Delete multiple inventory levels
      description: Bulk delete inventory levels
      tags:
        - Inventory Levels
      operationId: deleteInventoryLevelBulk
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  delete_statuses:
                    type: array
                    example:
                      - inventory_level_id: 1
                        deleted: true
                      - inventory_level_id: 2
                        deleted: false
                        error: 'Couldn''t find inventory level with id: 2'
                    items:
                      type: object
                      properties:
                        inventory_level_id:
                          type: integer
                        deleted:
                          type: boolean
                        error:
                          type:
                            - string
                            - 'null'
                      required:
                        - inventory_level_id
                        - deleted
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - delete_statuses
        '400':
          description: error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Deleting the inventory levels failed
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        inventory_level_id:
                          type: integer
                          example: 1
                        deleted:
                          type: boolean
                          example: false
                        error:
                          type: string
                          example: 'Couldn''t find inventory level with id: 1'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
        '422':
          description: error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameters
                  errors:
                    type: object
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                inventory_level_ids:
                  type: array
                  items:
                    type: integer
              required:
                - inventory_level_ids
        required: true
        description: Array of inventory level ids to be deleted
  /api/inventory_levels/export_csv:
    get:
      summary: Export inventory level csv
      description: >-
        Export inventory levels filtered by variant_ids or warehouse_ids in csv
        format
      tags:
        - Inventory Levels
      operationId: exportInventoryLevels
      security:
        - bearer_auth: []
      parameters:
        - name: variant_ids
          in: query
          required: false
          description: Comma-separated variant_ids. Required if warehouse_ids empty
          schema:
            type: string
        - name: warehouse_ids
          in: query
          required: false
          description: Comma-separated warehouse_ids. Required if variant_ids empty
          schema:
            type: string
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  export_url:
                    type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '400':
          description: error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Warehouse ids or variant ids must be passed
                  errors:
                    type: array
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
  /api/inventory_levels/presigned_csv_url:
    post:
      summary: Generate a signed URL to upload csv for bulk importing inventory levels
      description: >-
        Generate a signed URL to allow users without credentials to perform
        upload (time-limited access to Cloud Storage)
      tags:
        - Inventory Levels
      operationId: generateSignedURLForBulkImport
      security:
        - bearer_auth: []
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  url:
                    type: string
                    example: https://path/to/file/sth.csv
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - url
        '400':
          description: error
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: fail
                  data:
                    type: object
                    properties:
                      error:
                        type: string
                required:
                  - status
  /api/inventory_levels/import_csv:
    post:
      summary: Import inventory level with csv url or with a csv file
      description: Import inventory levels from csv url
      tags:
        - Inventory Levels
      operationId: bulkImportInventoryLevels
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  created:
                    type: integer
                    example: 10
                  updated:
                    type: integer
                    example: 5
                  failed:
                    type: integer
                    example: 2
                  invalid_rows:
                    type: integer
                    example: 1
                  import_status_url:
                    type: string
                    example: https://fake-url.com/file.csv
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - created
                  - updated
                  - failed
                  - invalid_rows
                  - import_status_url
        '400':
          description: error
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: fail
                  data:
                    type: object
                    properties:
                      error:
                        type: string
                required:
                  - status
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
                  description: CSV file uploaded as multipart form-data
                url:
                  type: string
                  example: https://example.com/path/to/csv
                  description: URL to fetch the CSV file
        required: true
  /api/inventory_levels/bulk_update:
    patch:
      summary: Update multiple inventory levels
      description: Update multiple inventory levels at once
      tags:
        - Inventory Levels
      operationId: updateMultipleInventoryLevels
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  inventory_levels:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        committed:
                          type: integer
                        available:
                          type: integer
                        on_hand:
                          type: integer
                        unavailable:
                          type: integer
                        adjustments:
                          type:
                            - array
                            - object
                            - 'null'
                          example: {}
                        unavailable_item_counts_by_category:
                          type:
                            - array
                            - 'null'
                          description: Array of unavailable item counts categorized by type
                          items:
                            type:
                              - object
                              - 'null'
                            required:
                              - category_type
                              - value
                            properties:
                              category_type:
                                type: string
                                description: The type/category of unavailable items
                                example: damaged
                              value:
                                type: integer
                                description: >-
                                  The count of unavailable items for this
                                  category
                                example: 10
                            additionalProperties: false
                          example:
                            - category_type: damaged
                              value: 10
                            - category_type: Quality control
                              value: 20
                        variant:
                          type: object
                          properties:
                            id:
                              type: integer
                            product_id:
                              type: integer
                            sku:
                              type: string
                            title:
                              type: string
                            track_quantity:
                              type: boolean
                            keep_selling:
                              type: boolean
                        product:
                          type: object
                          properties:
                            image:
                              type: string
                            title:
                              type: string
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        inventory_level_id:
                          type: integer
                          example: 1
                        error_message:
                          type: string
                          example: 'Couldn''t find inventory level with id: 1'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '400':
          description: error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Updaing the inventory levels failed
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        inventory_level_id:
                          type: integer
                          example: 1
                        error_message:
                          type: string
                          example: >-
                            There was an error in updating inventory level with
                            id: 1
                      required:
                        - inventory_level_id
                        - error_message
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
        '404':
          description: error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Inventory levels not found
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        inventory_level_id:
                          type: integer
                          example: 1
                        error_message:
                          type: string
                          example: 'Couldn''t find InventoryLevel with id: 1'
                      required:
                        - inventory_level_id
                        - error_message
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                inventory_levels:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 0
                      on_hand:
                        type: integer
                        example: 0
                      available:
                        type: integer
                        example: 0
                      unavailable:
                        type: integer
                        example: 0
                      committed:
                        type: integer
                        example: 0
                      reason:
                        type: string
                        example: lost some items on fire accident
                      unavailable_item_counts_by_category:
                        type: array
                        example: []
                      track_quantity:
                        type: boolean
                        example: true
                      keep_selling:
                        type: boolean
                        example: false
                    required:
                      - id
  /api/company/labels:
    get:
      summary: List Labels
      tags:
        - Labels
      security:
        - bearer_auth: []
      operationId: listLabels
      responses:
        '200':
          description: labels found
          content:
            application/json:
              schema:
                type: object
                properties:
                  label:
                    type: array
                    items:
                      title: Label
                      type: object
                      properties:
                        id:
                          type: integer
                        status:
                          type: string
                          enum:
                            - active
                            - inactive
                        title:
                          example: Trending
                          type: string
                        background:
                          example: '#F8C856'
                          type:
                            - string
                            - 'null'
                        color:
                          example: '#000000'
                          type:
                            - string
                            - 'null'
                        icon:
                          example: rocket.svg
                          type:
                            - string
                            - 'null'
                      required:
                        - id
                        - status
                        - title
                        - background
                        - color
                        - icon
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
    post:
      summary: Create Label
      tags:
        - Labels
      security:
        - bearer_auth: []
      operationId: createLabel
      parameters:
        - name: lang
          in: query
          required: false
          description: Language code (e.g., 'en', 'es')
          schema:
            type: string
      responses:
        '201':
          description: label created
          content:
            application/json:
              schema:
                type: object
                properties:
                  label:
                    title: Label
                    type: object
                    properties:
                      id:
                        type: integer
                      status:
                        type: string
                        enum:
                          - active
                          - inactive
                      title:
                        example: Trending
                        type: string
                      background:
                        example: '#F8C856'
                        type:
                          - string
                          - 'null'
                      color:
                        example: '#000000'
                        type:
                          - string
                          - 'null'
                      icon:
                        example: rocket.svg
                        type:
                          - string
                          - 'null'
                    required:
                      - id
                      - status
                      - title
                      - background
                      - color
                      - icon
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: unprocessable entity
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                label:
                  type: object
                  properties:
                    title:
                      type: string
                    icon:
                      type: string
                    background:
                      type: string
                    color:
                      type: string
                    status:
                      type: string
                  required:
                    - title
                    - icon
              required:
                - label
        required: true
  /api/company/labels/clear_cache:
    post:
      summary: Clear Cache
      tags:
        - Labels
      security:
        - bearer_auth: []
      operationId: clearCache
      responses:
        '200':
          description: cache clear job enqueued
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: Success message
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/company/labels/{id}:
    get:
      summary: Show Label
      tags:
        - Labels
      security:
        - bearer_auth: []
      operationId: showLabel
      parameters:
        - name: lang
          in: query
          required: false
          description: Language code (e.g., 'en', 'es')
          schema:
            type: string
      responses:
        '200':
          description: label found with lang parameter
          content:
            application/json:
              schema:
                type: object
                properties:
                  label:
                    title: Label
                    type: object
                    properties:
                      id:
                        type: integer
                      status:
                        type: string
                        enum:
                          - active
                          - inactive
                      title:
                        example: Trending
                        type: string
                      background:
                        example: '#F8C856'
                        type:
                          - string
                          - 'null'
                      color:
                        example: '#000000'
                        type:
                          - string
                          - 'null'
                      icon:
                        example: rocket.svg
                        type:
                          - string
                          - 'null'
                    required:
                      - id
                      - status
                      - title
                      - background
                      - color
                      - icon
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '404':
          description: label not found
    put:
      summary: Update Label
      tags:
        - Labels
      security:
        - bearer_auth: []
      operationId: updateLabel
      parameters: []
      responses:
        '200':
          description: label status updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  label:
                    title: Label
                    type: object
                    properties:
                      id:
                        type: integer
                      status:
                        type: string
                        enum:
                          - active
                          - inactive
                      title:
                        example: Trending
                        type: string
                      background:
                        example: '#F8C856'
                        type:
                          - string
                          - 'null'
                      color:
                        example: '#000000'
                        type:
                          - string
                          - 'null'
                      icon:
                        example: rocket.svg
                        type:
                          - string
                          - 'null'
                    required:
                      - id
                      - status
                      - title
                      - background
                      - color
                      - icon
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '404':
          description: label not found
        '422':
          description: unprocessable entity
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: integer
                lang:
                  type: string
                label:
                  type: object
                  properties:
                    title:
                      type: string
                    icon:
                      type: string
                    background:
                      type: string
                    color:
                      type: string
                    status:
                      type: string
                  required: []
              required:
                - id
                - label
        required: true
    delete:
      summary: Destroy Label
      tags:
        - Labels
      security:
        - bearer_auth: []
      operationId: destroyLabel
      responses:
        '200':
          description: label destroyed
          content:
            application/json:
              schema:
                type: object
                properties:
                  label:
                    title: Label
                    type: object
                    properties:
                      id:
                        type: integer
                      status:
                        type: string
                        enum:
                          - active
                          - inactive
                      title:
                        example: Trending
                        type: string
                      background:
                        example: '#F8C856'
                        type:
                          - string
                          - 'null'
                      color:
                        example: '#000000'
                        type:
                          - string
                          - 'null'
                      icon:
                        example: rocket.svg
                        type:
                          - string
                          - 'null'
                    required:
                      - id
                      - status
                      - title
                      - background
                      - color
                      - icon
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '404':
          description: label not found
        '422':
          description: unprocessable entity
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
  /api/settings/languages:
    get:
      summary: List company languages
      tags:
        - Languages
      security:
        - bearer_auth: []
      operationId: listCompanyLanguages
      description: >-
        List all available languages and their configuration status for the
        company. Shows which languages are active for the company.
      parameters:
        - name: active
          in: query
          schema:
            type: boolean
          required: false
          description: Filter by active status
      responses:
        '200':
          description: Available languages retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  languages:
                    type: array
                    items:
                      title: Language
                      type: object
                      properties:
                        id:
                          type: integer
                        name:
                          example: English
                          type:
                            - string
                            - 'null'
                        iso:
                          example: en
                          type:
                            - string
                            - 'null'
                        company_users_count:
                          example: 100
                          type: integer
                        active_in_company:
                          example: true
                          type: boolean
                      required:
                        - id
                        - company_users_count
                        - active_in_company
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - languages
                  - meta
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
    post:
      summary: Configure company language
      tags:
        - Languages
      security:
        - bearer_auth: []
      operationId: configureCompanyLanguage
      description: >-
        Add a new language to the company's configuration. This will enable the
        language for use within the company.
      parameters: []
      responses:
        '200':
          description: Language added successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  language:
                    title: Language
                    type: object
                    properties:
                      id:
                        type: integer
                      name:
                        example: English
                        type:
                          - string
                          - 'null'
                      iso:
                        example: en
                        type:
                          - string
                          - 'null'
                      company_users_count:
                        example: 100
                        type: integer
                      active_in_company:
                        example: true
                        type: boolean
                    required:
                      - id
                      - company_users_count
                      - active_in_company
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - language
                  - meta
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '422':
          description: Invalid parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: integer
              required:
                - id
  /api/settings/languages/{id}:
    delete:
      summary: Remove company language
      tags:
        - Languages
      security:
        - bearer_auth: []
      operationId: removeCompanyLanguage
      description: >-
        Remove a language from the company's configuration. This will disable
        the language for use within the company.
      responses:
        '200':
          description: Language removed successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Language removed successfully
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - success
                  - meta
                  - message
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '404':
          description: Language not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
    parameters:
      - name: id
        in: path
        required: true
        description: Language ID to be removed from company configuration
        schema:
          type: integer
  /api/company/libraries:
    get:
      tags:
        - Libraries
      summary: List Company Libraries
      description: Retrieves a list of libraries associated with the company.
      operationId: listCompanyLibraries
      parameters: []
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/index9'
                description: ''
      deprecated: false
      security:
        - bearer: []
    post:
      tags:
        - Libraries
      summary: Create Company Library
      description: >-
        Creates a new library for a company with specified resources and
        settings.
      operationId: createCompanyLibrary
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/createrequest12'
                - example:
                    library:
                      title: Library from API
                      affiliate_id: 1
                      library_items_attributes:
                        - relateable_type: Product
                          relateable_id: 1
                          order: 3
                        - relateable_type: Medium
                          relateable_id: 1
                          order: 2
                        - relateable_type: Product
                          relateable_id: 2
                          order: 1
            example:
              library:
                title: Library from API
                affiliate_id: 1
                library_items_attributes:
                  - relateable_type: Product
                    relateable_id: 1
                    order: 3
                  - relateable_type: Medium
                    relateable_id: 1
                    order: 2
                  - relateable_type: Product
                    relateable_id: 2
                    order: 1
        required: true
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/create9'
      deprecated: false
      security:
        - bearer: []
  /api/company/libraries/{id}:
    get:
      tags:
        - Libraries
      summary: Get Company Library Details
      description: Retrieves the details of a specific company library.
      operationId: getCompanyLibrary
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The unique identifier of the company library
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/show8'
                  - example:
                      id: 361
                      title: New library
                      slug: new-library
                      share_link: null
                      views: 0
                      leads: 0
                      company_library: null
                      affiliate_id: 2707
                      label: null
                      display_tag: null
                      library_items: []
              example:
                id: 361
                title: New library
                slug: new-library
                share_link: null
                views: 0
                leads: 0
                company_library: null
                affiliate_id: 2707
                label: null
                display_tag: null
                library_items: []
      deprecated: false
      security:
        - bearer: []
    delete:
      tags:
        - Libraries
      summary: Delete Library
      description: Deletes a specific library from the company's collection.
      operationId: deleteLibrary
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique identifier of the library to delete
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                type: string
                example: Library deleted successfully.
              example: Library deleted successfully.
      deprecated: false
      security:
        - bearer: []
    patch:
      tags:
        - Libraries
      summary: Update Company Library
      description: >-
        Updates an existing library for a company with specified title,
        affiliate information, and library items.
      operationId: updateCompanyLibrary
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
          description: The unique identifier of the library to update
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/updaterequest11'
                - example:
                    library:
                      title: Edited Title
                      affiliate_id: 5
                      company_library: true
            example:
              library:
                title: Edited Title
                affiliate_id: 5
                company_library: true
        required: true
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/update8'
      deprecated: false
      security:
        - bearer: []
  /api/company/libraries/{library_id}/add_item_to_library:
    put:
      tags:
        - Libraries
      summary: Add Item to Library
      description: Add an item to a specific library within the company.
      operationId: addItemToLibrary
      parameters:
        - name: library_id
          in: path
          required: true
          schema:
            type: string
          description: ID of the library to add the item to
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/add_item_request'
                - example:
                    library_item:
                      relateable_type: Product
                      relateable_id: 3
                      order: 1
            example:
              library_item:
                relateable_type: Product
                relateable_id: 3
                order: 1
        required: true
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/add_item'
      deprecated: false
      security:
        - bearer: []
  /api/company/libraries/{id}/destroy_library_item:
    delete:
      tags:
        - Libraries
      summary: Delete Library Item
      description: Delete a specific library item associated with a company.
      operationId: deleteLibraryItem
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The ID of the library
        - name: library_item_id
          in: query
          required: true
          schema:
            type: string
          description: The ID of the library item to be deleted
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/remove_item'
      deprecated: false
      security:
        - bearer: []
  /api/company/libraries/{id}/clone_company_library:
    post:
      tags:
        - Libraries
      summary: Clone Company Library
      description: >-
        Creates a copy of an existing company library with all its associated
        items and settings.
      operationId: cloneCompanyLibrary
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The ID of the company library to clone
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/clone_company_library_request'
                - example:
                    affiliate_id: 2707
            example:
              affiliate_id: 2707
        required: true
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/clone_company_library'
                  - example:
                      id: 1276
                      title: Edited Title-Copy
                      slug: edited-title-copy
                      share_link: null
                      views: 0
                      leads: 0
                      company_library: null
                      affiliate_id: 2707
                      label: null
                      display_tag: null
                      library_items:
                        - id: 1359
                          order: 1
                          relateable_type: Product
                          relateable:
                            id: 2206
                            active: true
                            title: wallpaper
                            description:
                              id: 4745
                              name: description
                              body: <div>wallpaper</div>
                              record_type: Product
                              record_id: 2206
                              created_at: '2022-12-19T08:59:48.650Z'
                              updated_at: '2022-12-19T08:59:48.650Z'
                              locale: null
                            stripped: wallpaper
                            price: null
                            display_price: ''
                            subscription_price: null
                            display_subscription_price: null
                            wholesale_price: null
                            display_wholesale_price: ''
                            wholesale_subscription_price: null
                            display_wholesale_subscription_price: null
                            shipping: '1.0'
                            image:
                              mini: >-
                                https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
                              detail: >-
                                https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
                              full: >-
                                https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
                            image_url: >-
                              https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
                            sku: wallpaper
                            country_code: bt
                            country_id: null
                            views: 0
                            leads: 0
                            share_link: null
                            commission: '10.0'
                            public: true
                            shopify_id: null
                            shopify_handle: null
                            in_stock: true
                            vendor: null
                            price_range:
                              - Rs.78.00
                              - Rs.78.00
                            price_range_formatted: Rs.78.00
                            unlimited_inventory: false
                            default_variant:
                              id: 19537
                              product_id: 2206
                              shopify_id: null
                              title: '5'
                              sku: null
                              position: 12611
                              inventory_policy: none
                              taxable: true
                              inventory_quantity: -3
                              created_at: '2022-12-23T09:31:41.111Z'
                              updated_at: '2024-08-03T20:54:57.333Z'
                              external_id: null
                              variant_country_id: null
                              image_url: null
                              image_path: null
                              is_master: false
                              discarded_at: null
                              price: null
                              weight: null
                              size: null
                              physical: null
                              unit_of_weight: null
                              height: 0
                              width: 0
                              length: 0
                              unit_of_size: null
                              hs_code: null
                              country_of_origin: null
                              customs_information_shipping: null
                              active: true
                              bar_code: null
                              track_quantity: null
                              keep_selling: null
                              option_attrs: []
                              allow_subscription: true
                              subscription_only: false
                              limit_subscription: false
                              subscription_max_qty: null
                              shipping_included_in_price: false
                              subscription_interval: 1
                            currency_symbol: $
                            currency_code: USD
                            average_rating: 0
                            option_values: null
                            publish_to_retail_store: true
                            publish_to_rep_store: true
                            publish_to_share_tab: true
                            hide_rating?: true
                            hide_reviews?: true
                            prompts_enabled: false
                            label: null
                            display_tag: null
                            images:
                              - id: 2053
                                image:
                                  mini: >-
                                    https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
                                  detail: >-
                                    https://ik.imagekit.io/fluid/s3/tr:n-video_poster/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
                                  full: >-
                                    https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
                                image_url: >-
                                  https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
                                position: null
                                shopify_id: null
                            countries:
                              - id: 24
                                iso_name: BHUTAN
                                iso: BT
                                iso3: BTN
                                name: Bhutan
                                numcode: 64
                                active: true
                                currency_code: BTN
                                currency_symbol: Nu.
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 92
                                iso_name: INDIA
                                iso: IN
                                iso3: IND
                                name: India
                                numcode: 356
                                active: true
                                currency_code: INR
                                currency_symbol: ₹
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 214
                                iso_name: UNITED STATES
                                iso: US
                                iso3: USA
                                name: United States
                                numcode: 840
                                active: true
                                currency_code: USD
                                currency_symbol: $
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 141
                                iso_name: NEPAL
                                iso: NP
                                iso3: NPL
                                name: Nepal
                                numcode: 524
                                active: true
                                currency_code: NPR
                                currency_symbol: Rs.
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 1
                                iso_name: AFGHANISTAN
                                iso: AF
                                iso3: AFG
                                name: Afghanistan
                                numcode: 4
                                active: true
                                currency_code: AFN
                                currency_symbol: ؋
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                            variants:
                              - id: 19537
                                title: '5'
                                image_url: null
                                buyable: true
                                option_value_ids:
                                  - 121
                                allow_subscription: true
                                subscription_only: false
                                shipping_included_in_price: false
                                variant_countries:
                                  - id: 127470
                                    price: '78.0'
                                    shipping: '1.0'
                                    tax: '1.0'
                                    currency_code: NPR
                                    currency_symbol: Rs.
                                    display_price: Rs.78.00
                                    country_iso: NP
                                    subscription_price: '78.0'
                                    display_wholesale_price: Rs.0.00
                                    display_wholesale_subscription_price: Rs.0.00
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 141
                                      iso: NP
                                      iso_name: NEPAL
                                      iso3: NPL
                                      name: Nepal
                                      tax_rate: 0
                                  - id: 127469
                                    price: '78.0'
                                    shipping: '1.0'
                                    tax: '1.0'
                                    currency_code: BTN
                                    currency_symbol: Nu.
                                    display_price: Nu.78.00
                                    country_iso: BT
                                    subscription_price: '78.0'
                                    display_wholesale_price: Nu.0.00
                                    display_wholesale_subscription_price: Nu.0.00
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 24
                                      iso: BT
                                      iso_name: BHUTAN
                                      iso3: BTN
                                      name: Bhutan
                                      tax_rate: 0
                                  - id: 127471
                                    price: '78.0'
                                    shipping: '1.0'
                                    tax: '1.0'
                                    currency_code: AFN
                                    currency_symbol: ؋
                                    display_price: ؋78.00
                                    country_iso: AF
                                    subscription_price: '78.0'
                                    display_wholesale_price: ؋0.00
                                    display_wholesale_subscription_price: ؋0.00
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 1
                                      iso: AF
                                      iso_name: AFGHANISTAN
                                      iso3: AFG
                                      name: Afghanistan
                                      tax_rate: 0
                              - id: 19538
                                title: '2'
                                image_url: null
                                buyable: true
                                option_value_ids:
                                  - 122
                                allow_subscription: true
                                subscription_only: false
                                shipping_included_in_price: false
                                variant_countries:
                                  - id: 127473
                                    price: '78.0'
                                    shipping: '1.0'
                                    tax: '1.0'
                                    currency_code: NPR
                                    currency_symbol: Rs.
                                    display_price: Rs.78.00
                                    country_iso: NP
                                    subscription_price: '78.0'
                                    display_wholesale_price: Rs.0.00
                                    display_wholesale_subscription_price: Rs.0.00
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 141
                                      iso: NP
                                      iso_name: NEPAL
                                      iso3: NPL
                                      name: Nepal
                                      tax_rate: 0
                                  - id: 127472
                                    price: '78.0'
                                    shipping: '1.0'
                                    tax: '1.0'
                                    currency_code: BTN
                                    currency_symbol: Nu.
                                    display_price: Nu.78.00
                                    country_iso: BT
                                    subscription_price: '78.0'
                                    display_wholesale_price: Nu.0.00
                                    display_wholesale_subscription_price: Nu.0.00
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 24
                                      iso: BT
                                      iso_name: BHUTAN
                                      iso3: BTN
                                      name: Bhutan
                                      tax_rate: 0
                                  - id: 127474
                                    price: '78.0'
                                    shipping: '1.0'
                                    tax: '1.0'
                                    currency_code: AFN
                                    currency_symbol: ؋
                                    display_price: ؋78.00
                                    country_iso: AF
                                    subscription_price: '78.0'
                                    display_wholesale_price: ؋0.00
                                    display_wholesale_subscription_price: ؋0.00
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 1
                                      iso: AF
                                      iso_name: AFGHANISTAN
                                      iso3: AFG
                                      name: Afghanistan
                                      tax_rate: 0
                              - id: 19539
                                title: '3'
                                image_url: null
                                buyable: true
                                option_value_ids:
                                  - 123
                                allow_subscription: true
                                subscription_only: false
                                shipping_included_in_price: false
                                variant_countries:
                                  - id: 127476
                                    price: '78.0'
                                    shipping: '1.0'
                                    tax: '1.0'
                                    currency_code: NPR
                                    currency_symbol: Rs.
                                    display_price: Rs.78.00
                                    country_iso: NP
                                    subscription_price: '78.0'
                                    display_wholesale_price: Rs.0.00
                                    display_wholesale_subscription_price: Rs.0.00
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 141
                                      iso: NP
                                      iso_name: NEPAL
                                      iso3: NPL
                                      name: Nepal
                                      tax_rate: 0
                                  - id: 127475
                                    price: '78.0'
                                    shipping: '1.0'
                                    tax: '1.0'
                                    currency_code: BTN
                                    currency_symbol: Nu.
                                    display_price: Nu.78.00
                                    country_iso: BT
                                    subscription_price: '78.0'
                                    display_wholesale_price: Nu.0.00
                                    display_wholesale_subscription_price: Nu.0.00
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 24
                                      iso: BT
                                      iso_name: BHUTAN
                                      iso3: BTN
                                      name: Bhutan
                                      tax_rate: 0
                                  - id: 127477
                                    price: '78.0'
                                    shipping: '1.0'
                                    tax: '1.0'
                                    currency_code: AFN
                                    currency_symbol: ؋
                                    display_price: ؋78.00
                                    country_iso: AF
                                    subscription_price: '78.0'
                                    display_wholesale_price: ؋0.00
                                    display_wholesale_subscription_price: ؋0.00
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 1
                                      iso: AF
                                      iso_name: AFGHANISTAN
                                      iso3: AFG
                                      name: Afghanistan
                                      tax_rate: 0
                            options:
                              - id: 31
                                title: variant
                                position: 21
                                presentation: variant
                            prompts: []
                            enroll_products: []
                            enrollment_packs: []
                        - id: 1358
                          order: 2
                          relateable_type: Medium
                          relateable:
                            id: 4431
                            user_id: null
                            media_type: share
                            media_format: png
                            image_url: >-
                              https://ik.imagekit.io/fluid/s3/tr:n-video_poster/hCCYL9UwQw6UjENqRy84_kittya+snow+leopard+close1667812853.jpg
                            video_url: ''
                            pdf_url: ''
                            title: null
                            description:
                              id: 4695
                              name: description
                              body: <div>iui</div>
                              record_type: Medium
                              record_id: 4431
                              created_at: '2022-11-28T11:17:27.644Z'
                              updated_at: '2022-11-28T11:17:27.644Z'
                              locale: null
                            stripped: iui
                            kind: image
                            active: true
                            visibility: null
                            share_link: null
                            views: 0
                            leads: 0
                            watch: null
                            video_status: null
                            duration: 0
                            cta_url: ''
                            cta_button_text: Learn More
                            cta_enabled: false
                            cta_action_type: visit_on_click
                            video_shopping_enabled: false
                            prompts_enabled: false
                            label: null
                            display_tag: null
                            prompts: []
                            attached_shareables: []
                        - id: 1357
                          order: 3
                          relateable_type: Product
                          relateable:
                            id: 2198
                            active: true
                            title: not again
                            description:
                              id: 4729
                              name: description
                              body: <div>no not again never</div>
                              record_type: Product
                              record_id: 2198
                              created_at: '2022-12-19T08:37:40.643Z'
                              updated_at: '2022-12-19T08:37:40.643Z'
                              locale: null
                            stripped: no not again never
                            price: null
                            display_price: ''
                            subscription_price: null
                            display_subscription_price: null
                            wholesale_price: null
                            display_wholesale_price: ''
                            wholesale_subscription_price: null
                            display_wholesale_subscription_price: null
                            shipping: '1.0'
                            image:
                              mini: >-
                                https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg
                              detail: >-
                                https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg
                              full: >-
                                https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg
                            image_url: >-
                              https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg
                            sku: not again
                            country_code: bt
                            country_id: null
                            views: 0
                            leads: 0
                            share_link: null
                            commission: '10.0'
                            public: true
                            shopify_id: null
                            shopify_handle: null
                            in_stock: true
                            vendor: null
                            price_range:
                              - Rs.0.00
                              - Rs.156.00
                            price_range_formatted: Rs.0.00 - Rs.156.00
                            unlimited_inventory: false
                            default_variant:
                              id: 19511
                              product_id: 2198
                              shopify_id: null
                              title: null
                              sku: not again
                              position: 12580
                              inventory_policy: none
                              taxable: true
                              inventory_quantity: 1
                              created_at: '2022-12-19T08:37:40.716Z'
                              updated_at: '2024-03-13T07:38:28.858Z'
                              external_id: null
                              variant_country_id: null
                              image_url: null
                              image_path: null
                              is_master: true
                              discarded_at: null
                              price: null
                              weight: ''
                              size: ''
                              physical: null
                              unit_of_weight: null
                              height: 0
                              width: 0
                              length: 0
                              unit_of_size: null
                              hs_code: null
                              country_of_origin: null
                              customs_information_shipping: null
                              active: true
                              bar_code: null
                              track_quantity: null
                              keep_selling: null
                              option_attrs: []
                              allow_subscription: true
                              subscription_only: false
                              limit_subscription: false
                              subscription_max_qty: null
                              shipping_included_in_price: false
                              subscription_interval: 1
                            currency_symbol: $
                            currency_code: USD
                            average_rating: 0
                            option_values: null
                            publish_to_retail_store: true
                            publish_to_rep_store: true
                            publish_to_share_tab: true
                            hide_rating?: true
                            hide_reviews?: true
                            prompts_enabled: false
                            label: null
                            display_tag: null
                            images:
                              - id: 2047
                                image:
                                  mini: >-
                                    https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/7Mtcu95PROKoBjsvrmgc_download.jpeg
                                  detail: >-
                                    https://ik.imagekit.io/fluid/s3/tr:n-video_poster/7Mtcu95PROKoBjsvrmgc_download.jpeg
                                  full: >-
                                    https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg
                                image_url: >-
                                  https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg
                                position: null
                                shopify_id: null
                            countries:
                              - id: 24
                                iso_name: BHUTAN
                                iso: BT
                                iso3: BTN
                                name: Bhutan
                                numcode: 64
                                active: true
                                currency_code: BTN
                                currency_symbol: Nu.
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 92
                                iso_name: INDIA
                                iso: IN
                                iso3: IND
                                name: India
                                numcode: 356
                                active: true
                                currency_code: INR
                                currency_symbol: ₹
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 214
                                iso_name: UNITED STATES
                                iso: US
                                iso3: USA
                                name: United States
                                numcode: 840
                                active: true
                                currency_code: USD
                                currency_symbol: $
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 141
                                iso_name: NEPAL
                                iso: NP
                                iso3: NPL
                                name: Nepal
                                numcode: 524
                                active: true
                                currency_code: NPR
                                currency_symbol: Rs.
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 1
                                iso_name: AFGHANISTAN
                                iso: AF
                                iso3: AFG
                                name: Afghanistan
                                numcode: 4
                                active: true
                                currency_code: AFN
                                currency_symbol: ؋
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                            variants:
                              - id: 19511
                                title: null
                                image_url: null
                                buyable: true
                                option_value_ids: []
                                allow_subscription: true
                                subscription_only: false
                                shipping_included_in_price: false
                                variant_countries:
                                  - id: 125486
                                    price: '156.0'
                                    shipping: '1.0'
                                    tax: '1.0'
                                    currency_code: BTN
                                    currency_symbol: Nu.
                                    display_price: Nu.156.00
                                    country_iso: BT
                                    subscription_price: '156.0'
                                    display_wholesale_price: Nu.0.00
                                    display_wholesale_subscription_price: Nu.0.00
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 24
                                      iso: BT
                                      iso_name: BHUTAN
                                      iso3: BTN
                                      name: Bhutan
                                      tax_rate: 0
                            options: []
                            prompts: []
                            enroll_products: []
                            enrollment_packs: []
                        - id: 1356
                          order: 4
                          relateable_type: Product
                          relateable:
                            id: 2204
                            active: true
                            title: lengthy image
                            description:
                              id: 4741
                              name: description
                              body: <div>lengthy image</div>
                              record_type: Product
                              record_id: 2204
                              created_at: '2022-12-19T08:58:13.978Z'
                              updated_at: '2022-12-19T08:58:13.978Z'
                              locale: null
                            stripped: lengthy image
                            price: null
                            display_price: ''
                            subscription_price: null
                            display_subscription_price: null
                            wholesale_price: null
                            display_wholesale_price: ''
                            wholesale_subscription_price: null
                            display_wholesale_subscription_price: null
                            shipping: '1.0'
                            image:
                              mini: >-
                                https://ik.imagekit.io/fluid/s3/VMYnhvE3QZNIN65Djnis_lengthy+image.png
                              detail: >-
                                https://ik.imagekit.io/fluid/s3/VMYnhvE3QZNIN65Djnis_lengthy+image.png
                              full: >-
                                https://ik.imagekit.io/fluid/s3/VMYnhvE3QZNIN65Djnis_lengthy+image.png
                            image_url: >-
                              https://ik.imagekit.io/fluid/s3/VMYnhvE3QZNIN65Djnis_lengthy+image.png
                            sku: lengthy image
                            country_code: bt
                            country_id: null
                            views: 0
                            leads: 0
                            share_link: null
                            commission: '10.0'
                            public: true
                            shopify_id: null
                            shopify_handle: null
                            in_stock: true
                            vendor: null
                            price_range:
                              - Rs.0.00
                              - Rs.89.00
                            price_range_formatted: Rs.0.00 - Rs.89.00
                            unlimited_inventory: false
                            default_variant:
                              id: 19517
                              product_id: 2204
                              shopify_id: null
                              title: null
                              sku: lengthy image
                              position: 12588
                              inventory_policy: none
                              taxable: true
                              inventory_quantity: 1
                              created_at: '2022-12-19T08:58:14.026Z'
                              updated_at: '2024-08-03T20:54:57.333Z'
                              external_id: null
                              variant_country_id: null
                              image_url: null
                              image_path: null
                              is_master: true
                              discarded_at: null
                              price: null
                              weight: ''
                              size: ''
                              physical: null
                              unit_of_weight: null
                              height: 0
                              width: 0
                              length: 0
                              unit_of_size: null
                              hs_code: null
                              country_of_origin: null
                              customs_information_shipping: null
                              active: true
                              bar_code: null
                              track_quantity: null
                              keep_selling: null
                              option_attrs: []
                              allow_subscription: true
                              subscription_only: false
                              limit_subscription: false
                              subscription_max_qty: null
                              shipping_included_in_price: false
                              subscription_interval: 1
                            currency_symbol: $
                            currency_code: USD
                            average_rating: 0
                            option_values: null
                            publish_to_retail_store: true
                            publish_to_rep_store: true
                            publish_to_share_tab: true
                            hide_rating?: true
                            hide_reviews?: true
                            prompts_enabled: false
                            label: null
                            display_tag: null
                            images:
                              - id: 2052
                                image:
                                  mini: >-
                                    https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/VMYnhvE3QZNIN65Djnis_lengthy+image.png
                                  detail: >-
                                    https://ik.imagekit.io/fluid/s3/tr:n-video_poster/VMYnhvE3QZNIN65Djnis_lengthy+image.png
                                  full: >-
                                    https://ik.imagekit.io/fluid/s3/VMYnhvE3QZNIN65Djnis_lengthy+image.png
                                image_url: >-
                                  https://ik.imagekit.io/fluid/s3/VMYnhvE3QZNIN65Djnis_lengthy+image.png
                                position: null
                                shopify_id: null
                            countries:
                              - id: 24
                                iso_name: BHUTAN
                                iso: BT
                                iso3: BTN
                                name: Bhutan
                                numcode: 64
                                active: true
                                currency_code: BTN
                                currency_symbol: Nu.
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 92
                                iso_name: INDIA
                                iso: IN
                                iso3: IND
                                name: India
                                numcode: 356
                                active: true
                                currency_code: INR
                                currency_symbol: ₹
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 214
                                iso_name: UNITED STATES
                                iso: US
                                iso3: USA
                                name: United States
                                numcode: 840
                                active: true
                                currency_code: USD
                                currency_symbol: $
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 141
                                iso_name: NEPAL
                                iso: NP
                                iso3: NPL
                                name: Nepal
                                numcode: 524
                                active: true
                                currency_code: NPR
                                currency_symbol: Rs.
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 1
                                iso_name: AFGHANISTAN
                                iso: AF
                                iso3: AFG
                                name: Afghanistan
                                numcode: 4
                                active: true
                                currency_code: AFN
                                currency_symbol: ؋
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                            variants:
                              - id: 19517
                                title: null
                                image_url: null
                                buyable: true
                                option_value_ids: []
                                allow_subscription: true
                                subscription_only: false
                                shipping_included_in_price: false
                                variant_countries:
                                  - id: 125495
                                    price: '89.0'
                                    shipping: '1.0'
                                    tax: '1.0'
                                    currency_code: BTN
                                    currency_symbol: Nu.
                                    display_price: Nu.89.00
                                    country_iso: BT
                                    subscription_price: '89.0'
                                    display_wholesale_price: Nu.0.00
                                    display_wholesale_subscription_price: Nu.0.00
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 24
                                      iso: BT
                                      iso_name: BHUTAN
                                      iso3: BTN
                                      name: Bhutan
                                      tax_rate: 0
                            options: []
                            prompts: []
                            enroll_products: []
                            enrollment_packs: []
              example:
                id: 1276
                title: Edited Title-Copy
                slug: edited-title-copy
                share_link: null
                views: 0
                leads: 0
                company_library: null
                affiliate_id: 2707
                label: null
                display_tag: null
                library_items:
                  - id: 1359
                    order: 1
                    relateable_type: Product
                    relateable:
                      id: 2206
                      active: true
                      title: wallpaper
                      description:
                        id: 4745
                        name: description
                        body: <div>wallpaper</div>
                        record_type: Product
                        record_id: 2206
                        created_at: '2022-12-19T08:59:48.650Z'
                        updated_at: '2022-12-19T08:59:48.650Z'
                        locale: null
                      stripped: wallpaper
                      price: null
                      display_price: ''
                      subscription_price: null
                      display_subscription_price: null
                      wholesale_price: null
                      display_wholesale_price: ''
                      wholesale_subscription_price: null
                      display_wholesale_subscription_price: null
                      shipping: '1.0'
                      image:
                        mini: >-
                          https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
                        detail: >-
                          https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
                        full: >-
                          https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
                      image_url: >-
                        https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
                      sku: wallpaper
                      country_code: bt
                      country_id: null
                      views: 0
                      leads: 0
                      share_link: null
                      commission: '10.0'
                      public: true
                      shopify_id: null
                      shopify_handle: null
                      in_stock: true
                      vendor: null
                      price_range:
                        - Rs.78.00
                        - Rs.78.00
                      price_range_formatted: Rs.78.00
                      unlimited_inventory: false
                      default_variant:
                        id: 19537
                        product_id: 2206
                        shopify_id: null
                        title: '5'
                        sku: null
                        position: 12611
                        inventory_policy: none
                        taxable: true
                        inventory_quantity: -3
                        created_at: '2022-12-23T09:31:41.111Z'
                        updated_at: '2024-08-03T20:54:57.333Z'
                        external_id: null
                        variant_country_id: null
                        image_url: null
                        image_path: null
                        is_master: false
                        discarded_at: null
                        price: null
                        weight: null
                        size: null
                        physical: null
                        unit_of_weight: null
                        height: 0
                        width: 0
                        length: 0
                        unit_of_size: null
                        hs_code: null
                        country_of_origin: null
                        customs_information_shipping: null
                        active: true
                        bar_code: null
                        track_quantity: null
                        keep_selling: null
                        option_attrs: []
                        allow_subscription: true
                        subscription_only: false
                        limit_subscription: false
                        subscription_max_qty: null
                        shipping_included_in_price: false
                        subscription_interval: 1
                      currency_symbol: $
                      currency_code: USD
                      average_rating: 0
                      option_values: null
                      publish_to_retail_store: true
                      publish_to_rep_store: true
                      publish_to_share_tab: true
                      hide_rating?: true
                      hide_reviews?: true
                      prompts_enabled: false
                      label: null
                      display_tag: null
                      images:
                        - id: 2053
                          image:
                            mini: >-
                              https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
                            detail: >-
                              https://ik.imagekit.io/fluid/s3/tr:n-video_poster/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
                            full: >-
                              https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
                          image_url: >-
                            https://ik.imagekit.io/fluid/s3/DIU9LXh2TCODrSsHEALH_Top-HD-sad-quotes-for-whatsapp-status-in-hindi-Pics-Images-Download-Free.gif
                          position: null
                          shopify_id: null
                      countries:
                        - id: 24
                          iso_name: BHUTAN
                          iso: BT
                          iso3: BTN
                          name: Bhutan
                          numcode: 64
                          active: true
                          currency_code: BTN
                          currency_symbol: Nu.
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 92
                          iso_name: INDIA
                          iso: IN
                          iso3: IND
                          name: India
                          numcode: 356
                          active: true
                          currency_code: INR
                          currency_symbol: ₹
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 214
                          iso_name: UNITED STATES
                          iso: US
                          iso3: USA
                          name: United States
                          numcode: 840
                          active: true
                          currency_code: USD
                          currency_symbol: $
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 141
                          iso_name: NEPAL
                          iso: NP
                          iso3: NPL
                          name: Nepal
                          numcode: 524
                          active: true
                          currency_code: NPR
                          currency_symbol: Rs.
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 1
                          iso_name: AFGHANISTAN
                          iso: AF
                          iso3: AFG
                          name: Afghanistan
                          numcode: 4
                          active: true
                          currency_code: AFN
                          currency_symbol: ؋
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                      variants:
                        - id: 19537
                          title: '5'
                          image_url: null
                          buyable: true
                          option_value_ids:
                            - 121
                          allow_subscription: true
                          subscription_only: false
                          shipping_included_in_price: false
                          variant_countries:
                            - id: 127470
                              price: '78.0'
                              shipping: '1.0'
                              tax: '1.0'
                              currency_code: NPR
                              currency_symbol: Rs.
                              display_price: Rs.78.00
                              country_iso: NP
                              subscription_price: '78.0'
                              display_wholesale_price: Rs.0.00
                              display_wholesale_subscription_price: Rs.0.00
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 141
                                iso: NP
                                iso_name: NEPAL
                                iso3: NPL
                                name: Nepal
                                tax_rate: 0
                            - id: 127469
                              price: '78.0'
                              shipping: '1.0'
                              tax: '1.0'
                              currency_code: BTN
                              currency_symbol: Nu.
                              display_price: Nu.78.00
                              country_iso: BT
                              subscription_price: '78.0'
                              display_wholesale_price: Nu.0.00
                              display_wholesale_subscription_price: Nu.0.00
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 24
                                iso: BT
                                iso_name: BHUTAN
                                iso3: BTN
                                name: Bhutan
                                tax_rate: 0
                            - id: 127471
                              price: '78.0'
                              shipping: '1.0'
                              tax: '1.0'
                              currency_code: AFN
                              currency_symbol: ؋
                              display_price: ؋78.00
                              country_iso: AF
                              subscription_price: '78.0'
                              display_wholesale_price: ؋0.00
                              display_wholesale_subscription_price: ؋0.00
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 1
                                iso: AF
                                iso_name: AFGHANISTAN
                                iso3: AFG
                                name: Afghanistan
                                tax_rate: 0
                        - id: 19538
                          title: '2'
                          image_url: null
                          buyable: true
                          option_value_ids:
                            - 122
                          allow_subscription: true
                          subscription_only: false
                          shipping_included_in_price: false
                          variant_countries:
                            - id: 127473
                              price: '78.0'
                              shipping: '1.0'
                              tax: '1.0'
                              currency_code: NPR
                              currency_symbol: Rs.
                              display_price: Rs.78.00
                              country_iso: NP
                              subscription_price: '78.0'
                              display_wholesale_price: Rs.0.00
                              display_wholesale_subscription_price: Rs.0.00
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 141
                                iso: NP
                                iso_name: NEPAL
                                iso3: NPL
                                name: Nepal
                                tax_rate: 0
                            - id: 127472
                              price: '78.0'
                              shipping: '1.0'
                              tax: '1.0'
                              currency_code: BTN
                              currency_symbol: Nu.
                              display_price: Nu.78.00
                              country_iso: BT
                              subscription_price: '78.0'
                              display_wholesale_price: Nu.0.00
                              display_wholesale_subscription_price: Nu.0.00
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 24
                                iso: BT
                                iso_name: BHUTAN
                                iso3: BTN
                                name: Bhutan
                                tax_rate: 0
                            - id: 127474
                              price: '78.0'
                              shipping: '1.0'
                              tax: '1.0'
                              currency_code: AFN
                              currency_symbol: ؋
                              display_price: ؋78.00
                              country_iso: AF
                              subscription_price: '78.0'
                              display_wholesale_price: ؋0.00
                              display_wholesale_subscription_price: ؋0.00
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 1
                                iso: AF
                                iso_name: AFGHANISTAN
                                iso3: AFG
                                name: Afghanistan
                                tax_rate: 0
                        - id: 19539
                          title: '3'
                          image_url: null
                          buyable: true
                          option_value_ids:
                            - 123
                          allow_subscription: true
                          subscription_only: false
                          shipping_included_in_price: false
                          variant_countries:
                            - id: 127476
                              price: '78.0'
                              shipping: '1.0'
                              tax: '1.0'
                              currency_code: NPR
                              currency_symbol: Rs.
                              display_price: Rs.78.00
                              country_iso: NP
                              subscription_price: '78.0'
                              display_wholesale_price: Rs.0.00
                              display_wholesale_subscription_price: Rs.0.00
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 141
                                iso: NP
                                iso_name: NEPAL
                                iso3: NPL
                                name: Nepal
                                tax_rate: 0
                            - id: 127475
                              price: '78.0'
                              shipping: '1.0'
                              tax: '1.0'
                              currency_code: BTN
                              currency_symbol: Nu.
                              display_price: Nu.78.00
                              country_iso: BT
                              subscription_price: '78.0'
                              display_wholesale_price: Nu.0.00
                              display_wholesale_subscription_price: Nu.0.00
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 24
                                iso: BT
                                iso_name: BHUTAN
                                iso3: BTN
                                name: Bhutan
                                tax_rate: 0
                            - id: 127477
                              price: '78.0'
                              shipping: '1.0'
                              tax: '1.0'
                              currency_code: AFN
                              currency_symbol: ؋
                              display_price: ؋78.00
                              country_iso: AF
                              subscription_price: '78.0'
                              display_wholesale_price: ؋0.00
                              display_wholesale_subscription_price: ؋0.00
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 1
                                iso: AF
                                iso_name: AFGHANISTAN
                                iso3: AFG
                                name: Afghanistan
                                tax_rate: 0
                      options:
                        - id: 31
                          title: variant
                          position: 21
                          presentation: variant
                      prompts: []
                      enroll_products: []
                      enrollment_packs: []
                  - id: 1358
                    order: 2
                    relateable_type: Medium
                    relateable:
                      id: 4431
                      user_id: null
                      media_type: share
                      media_format: png
                      image_url: >-
                        https://ik.imagekit.io/fluid/s3/tr:n-video_poster/hCCYL9UwQw6UjENqRy84_kittya+snow+leopard+close1667812853.jpg
                      video_url: ''
                      pdf_url: ''
                      title: null
                      description:
                        id: 4695
                        name: description
                        body: <div>iui</div>
                        record_type: Medium
                        record_id: 4431
                        created_at: '2022-11-28T11:17:27.644Z'
                        updated_at: '2022-11-28T11:17:27.644Z'
                        locale: null
                      stripped: iui
                      kind: image
                      active: true
                      visibility: null
                      share_link: null
                      views: 0
                      leads: 0
                      watch: null
                      video_status: null
                      duration: 0
                      cta_url: ''
                      cta_button_text: Learn More
                      cta_enabled: false
                      cta_action_type: visit_on_click
                      video_shopping_enabled: false
                      prompts_enabled: false
                      label: null
                      display_tag: null
                      prompts: []
                      attached_shareables: []
                  - id: 1357
                    order: 3
                    relateable_type: Product
                    relateable:
                      id: 2198
                      active: true
                      title: not again
                      description:
                        id: 4729
                        name: description
                        body: <div>no not again never</div>
                        record_type: Product
                        record_id: 2198
                        created_at: '2022-12-19T08:37:40.643Z'
                        updated_at: '2022-12-19T08:37:40.643Z'
                        locale: null
                      stripped: no not again never
                      price: null
                      display_price: ''
                      subscription_price: null
                      display_subscription_price: null
                      wholesale_price: null
                      display_wholesale_price: ''
                      wholesale_subscription_price: null
                      display_wholesale_subscription_price: null
                      shipping: '1.0'
                      image:
                        mini: >-
                          https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg
                        detail: >-
                          https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg
                        full: >-
                          https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg
                      image_url: >-
                        https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg
                      sku: not again
                      country_code: bt
                      country_id: null
                      views: 0
                      leads: 0
                      share_link: null
                      commission: '10.0'
                      public: true
                      shopify_id: null
                      shopify_handle: null
                      in_stock: true
                      vendor: null
                      price_range:
                        - Rs.0.00
                        - Rs.156.00
                      price_range_formatted: Rs.0.00 - Rs.156.00
                      unlimited_inventory: false
                      default_variant:
                        id: 19511
                        product_id: 2198
                        shopify_id: null
                        title: null
                        sku: not again
                        position: 12580
                        inventory_policy: none
                        taxable: true
                        inventory_quantity: 1
                        created_at: '2022-12-19T08:37:40.716Z'
                        updated_at: '2024-03-13T07:38:28.858Z'
                        external_id: null
                        variant_country_id: null
                        image_url: null
                        image_path: null
                        is_master: true
                        discarded_at: null
                        price: null
                        weight: ''
                        size: ''
                        physical: null
                        unit_of_weight: null
                        height: 0
                        width: 0
                        length: 0
                        unit_of_size: null
                        hs_code: null
                        country_of_origin: null
                        customs_information_shipping: null
                        active: true
                        bar_code: null
                        track_quantity: null
                        keep_selling: null
                        option_attrs: []
                        allow_subscription: true
                        subscription_only: false
                        limit_subscription: false
                        subscription_max_qty: null
                        shipping_included_in_price: false
                        subscription_interval: 1
                      currency_symbol: $
                      currency_code: USD
                      average_rating: 0
                      option_values: null
                      publish_to_retail_store: true
                      publish_to_rep_store: true
                      publish_to_share_tab: true
                      hide_rating?: true
                      hide_reviews?: true
                      prompts_enabled: false
                      label: null
                      display_tag: null
                      images:
                        - id: 2047
                          image:
                            mini: >-
                              https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/7Mtcu95PROKoBjsvrmgc_download.jpeg
                            detail: >-
                              https://ik.imagekit.io/fluid/s3/tr:n-video_poster/7Mtcu95PROKoBjsvrmgc_download.jpeg
                            full: >-
                              https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg
                          image_url: >-
                            https://ik.imagekit.io/fluid/s3/7Mtcu95PROKoBjsvrmgc_download.jpeg
                          position: null
                          shopify_id: null
                      countries:
                        - id: 24
                          iso_name: BHUTAN
                          iso: BT
                          iso3: BTN
                          name: Bhutan
                          numcode: 64
                          active: true
                          currency_code: BTN
                          currency_symbol: Nu.
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 92
                          iso_name: INDIA
                          iso: IN
                          iso3: IND
                          name: India
                          numcode: 356
                          active: true
                          currency_code: INR
                          currency_symbol: ₹
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 214
                          iso_name: UNITED STATES
                          iso: US
                          iso3: USA
                          name: United States
                          numcode: 840
                          active: true
                          currency_code: USD
                          currency_symbol: $
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 141
                          iso_name: NEPAL
                          iso: NP
                          iso3: NPL
                          name: Nepal
                          numcode: 524
                          active: true
                          currency_code: NPR
                          currency_symbol: Rs.
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 1
                          iso_name: AFGHANISTAN
                          iso: AF
                          iso3: AFG
                          name: Afghanistan
                          numcode: 4
                          active: true
                          currency_code: AFN
                          currency_symbol: ؋
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                      variants:
                        - id: 19511
                          title: null
                          image_url: null
                          buyable: true
                          option_value_ids: []
                          allow_subscription: true
                          subscription_only: false
                          shipping_included_in_price: false
                          variant_countries:
                            - id: 125486
                              price: '156.0'
                              shipping: '1.0'
                              tax: '1.0'
                              currency_code: BTN
                              currency_symbol: Nu.
                              display_price: Nu.156.00
                              country_iso: BT
                              subscription_price: '156.0'
                              display_wholesale_price: Nu.0.00
                              display_wholesale_subscription_price: Nu.0.00
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 24
                                iso: BT
                                iso_name: BHUTAN
                                iso3: BTN
                                name: Bhutan
                                tax_rate: 0
                      options: []
                      prompts: []
                      enroll_products: []
                      enrollment_packs: []
                  - id: 1356
                    order: 4
                    relateable_type: Product
                    relateable:
                      id: 2204
                      active: true
                      title: lengthy image
                      description:
                        id: 4741
                        name: description
                        body: <div>lengthy image</div>
                        record_type: Product
                        record_id: 2204
                        created_at: '2022-12-19T08:58:13.978Z'
                        updated_at: '2022-12-19T08:58:13.978Z'
                        locale: null
                      stripped: lengthy image
                      price: null
                      display_price: ''
                      subscription_price: null
                      display_subscription_price: null
                      wholesale_price: null
                      display_wholesale_price: ''
                      wholesale_subscription_price: null
                      display_wholesale_subscription_price: null
                      shipping: '1.0'
                      image:
                        mini: >-
                          https://ik.imagekit.io/fluid/s3/VMYnhvE3QZNIN65Djnis_lengthy+image.png
                        detail: >-
                          https://ik.imagekit.io/fluid/s3/VMYnhvE3QZNIN65Djnis_lengthy+image.png
                        full: >-
                          https://ik.imagekit.io/fluid/s3/VMYnhvE3QZNIN65Djnis_lengthy+image.png
                      image_url: >-
                        https://ik.imagekit.io/fluid/s3/VMYnhvE3QZNIN65Djnis_lengthy+image.png
                      sku: lengthy image
                      country_code: bt
                      country_id: null
                      views: 0
                      leads: 0
                      share_link: null
                      commission: '10.0'
                      public: true
                      shopify_id: null
                      shopify_handle: null
                      in_stock: true
                      vendor: null
                      price_range:
                        - Rs.0.00
                        - Rs.89.00
                      price_range_formatted: Rs.0.00 - Rs.89.00
                      unlimited_inventory: false
                      default_variant:
                        id: 19517
                        product_id: 2204
                        shopify_id: null
                        title: null
                        sku: lengthy image
                        position: 12588
                        inventory_policy: none
                        taxable: true
                        inventory_quantity: 1
                        created_at: '2022-12-19T08:58:14.026Z'
                        updated_at: '2024-08-03T20:54:57.333Z'
                        external_id: null
                        variant_country_id: null
                        image_url: null
                        image_path: null
                        is_master: true
                        discarded_at: null
                        price: null
                        weight: ''
                        size: ''
                        physical: null
                        unit_of_weight: null
                        height: 0
                        width: 0
                        length: 0
                        unit_of_size: null
                        hs_code: null
                        country_of_origin: null
                        customs_information_shipping: null
                        active: true
                        bar_code: null
                        track_quantity: null
                        keep_selling: null
                        option_attrs: []
                        allow_subscription: true
                        subscription_only: false
                        limit_subscription: false
                        subscription_max_qty: null
                        shipping_included_in_price: false
                        subscription_interval: 1
                      currency_symbol: $
                      currency_code: USD
                      average_rating: 0
                      option_values: null
                      publish_to_retail_store: true
                      publish_to_rep_store: true
                      publish_to_share_tab: true
                      hide_rating?: true
                      hide_reviews?: true
                      prompts_enabled: false
                      label: null
                      display_tag: null
                      images:
                        - id: 2052
                          image:
                            mini: >-
                              https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/VMYnhvE3QZNIN65Djnis_lengthy+image.png
                            detail: >-
                              https://ik.imagekit.io/fluid/s3/tr:n-video_poster/VMYnhvE3QZNIN65Djnis_lengthy+image.png
                            full: >-
                              https://ik.imagekit.io/fluid/s3/VMYnhvE3QZNIN65Djnis_lengthy+image.png
                          image_url: >-
                            https://ik.imagekit.io/fluid/s3/VMYnhvE3QZNIN65Djnis_lengthy+image.png
                          position: null
                          shopify_id: null
                      countries:
                        - id: 24
                          iso_name: BHUTAN
                          iso: BT
                          iso3: BTN
                          name: Bhutan
                          numcode: 64
                          active: true
                          currency_code: BTN
                          currency_symbol: Nu.
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 92
                          iso_name: INDIA
                          iso: IN
                          iso3: IND
                          name: India
                          numcode: 356
                          active: true
                          currency_code: INR
                          currency_symbol: ₹
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 214
                          iso_name: UNITED STATES
                          iso: US
                          iso3: USA
                          name: United States
                          numcode: 840
                          active: true
                          currency_code: USD
                          currency_symbol: $
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 141
                          iso_name: NEPAL
                          iso: NP
                          iso3: NPL
                          name: Nepal
                          numcode: 524
                          active: true
                          currency_code: NPR
                          currency_symbol: Rs.
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 1
                          iso_name: AFGHANISTAN
                          iso: AF
                          iso3: AFG
                          name: Afghanistan
                          numcode: 4
                          active: true
                          currency_code: AFN
                          currency_symbol: ؋
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                      variants:
                        - id: 19517
                          title: null
                          image_url: null
                          buyable: true
                          option_value_ids: []
                          allow_subscription: true
                          subscription_only: false
                          shipping_included_in_price: false
                          variant_countries:
                            - id: 125495
                              price: '89.0'
                              shipping: '1.0'
                              tax: '1.0'
                              currency_code: BTN
                              currency_symbol: Nu.
                              display_price: Nu.89.00
                              country_iso: BT
                              subscription_price: '89.0'
                              display_wholesale_price: Nu.0.00
                              display_wholesale_subscription_price: Nu.0.00
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 24
                                iso: BT
                                iso_name: BHUTAN
                                iso3: BTN
                                name: Bhutan
                                tax_rate: 0
                      options: []
                      prompts: []
                      enroll_products: []
                      enrollment_packs: []
      deprecated: false
      security:
        - bearer: []
  /api/company/libraries/available_resources_for_playlists:
    get:
      tags:
        - Libraries
      summary: List Available Playlist Resources
      description: Retrieves the available resources that can be used in playlists.
      operationId: listAvailablePlaylistResources
      parameters: []
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                type: array
                items:
                  type: string
                description: ''
                example:
                  - Product
                  - Giveaway
                  - Medium
                  - Simulator
                  - Promotion
                  - CustomPage
                  - Library
                  - EnrollmentPack
              example:
                - Product
                - Giveaway
                - Medium
                - Simulator
                - Promotion
                - CustomPage
                - Library
                - EnrollmentPack
      deprecated: false
      security:
        - bearer: []
  /api/v202506/products/{product_id}/lighthouse:
    get:
      summary: Get latest Lighthouse scan for a product
      tags:
        - Lighthouse
      operationId: getLatestProductLighthouse
      description: Returns the most recent Lighthouse performance scan for a product
      security:
        - bearer_auth: []
      parameters:
        - name: product_id
          in: path
          required: true
          description: Product ID
          schema:
            type: integer
      responses:
        '200':
          description: latest Lighthouse scan found
          content:
            application/json:
              schema:
                type: object
                properties:
                  item:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      scanned_at:
                        type: string
                        format: date-time
                      device_type:
                        type:
                          - string
                          - 'null'
                        example: mobile
                        enum:
                          - mobile
                          - desktop
                      final_url:
                        type:
                          - string
                          - 'null'
                        example: https://example.com/product
                      fetch_time:
                        type:
                          - string
                          - 'null'
                        format: date-time
                      created_at:
                        type: string
                        format: date-time
                      updated_at:
                        type: string
                        format: date-time
                      core_metrics:
                        type: object
                        properties:
                          performance_score:
                            type:
                              - integer
                              - 'null'
                            example: 85
                            minimum: 0
                            maximum: 100
                          largest_contentful_paint:
                            type:
                              - number
                              - 'null'
                            example: 2500
                            description: LCP in milliseconds
                          largest_contentful_paint_rating:
                            type:
                              - string
                              - 'null'
                            enum:
                              - good
                              - needs-improvement
                              - poor
                              - null
                          first_input_delay:
                            type:
                              - number
                              - 'null'
                            example: 100
                            description: FID in milliseconds
                          first_input_delay_rating:
                            type:
                              - string
                              - 'null'
                            enum:
                              - good
                              - needs-improvement
                              - poor
                              - null
                          cumulative_layout_shift:
                            type:
                              - number
                              - 'null'
                            example: 0.05
                            description: CLS score
                          cumulative_layout_shift_rating:
                            type:
                              - string
                              - 'null'
                            enum:
                              - good
                              - needs-improvement
                              - poor
                              - null
                          time_to_interactive:
                            type:
                              - number
                              - 'null'
                            example: 3500
                            description: TTI in milliseconds
                          total_blocking_time:
                            type:
                              - number
                              - 'null'
                            example: 200
                            description: TBT in milliseconds
                          first_contentful_paint:
                            type:
                              - number
                              - 'null'
                            example: 1500
                            description: FCP in milliseconds
                          speed_index:
                            type:
                              - number
                              - 'null'
                            example: 3200
                            description: Speed Index in milliseconds
                          device_type:
                            type:
                              - string
                              - 'null'
                            example: mobile
                      category_scores:
                        type: object
                        additionalProperties:
                          type: integer
                          minimum: 0
                          maximum: 100
                        example:
                          performance: 85
                          accessibility: 92
                          best-practices: 88
                          seo: 95
                      optimization_opportunities:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            title:
                              type: string
                            description:
                              type: string
                            score:
                              type: number
                            display_value:
                              type: string
                            savings_ms:
                              type:
                                - number
                                - 'null'
                            savings_bytes:
                              type:
                                - number
                                - 'null'
                    required:
                      - id
                      - scanned_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - item
                  - meta
        '404':
          description: no Lighthouse scans found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/v202506/products/{product_id}/lighthouses:
    get:
      summary: List all Lighthouse scans for a product
      tags:
        - Lighthouse
      operationId: listProductLighthouses
      description: Returns a paginated list of all Lighthouse scans for a product
      security:
        - bearer_auth: []
      parameters:
        - name: product_id
          in: path
          required: true
          description: Product ID
          schema:
            type: integer
        - name: page
          in: query
          required: false
          description: Page number
          schema:
            type: integer
        - name: per_page
          in: query
          required: false
          description: Items per page
          schema:
            type: integer
      responses:
        '200':
          description: Lighthouse scans retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 1
                        scanned_at:
                          type: string
                          format: date-time
                        device_type:
                          type:
                            - string
                            - 'null'
                          example: mobile
                          enum:
                            - mobile
                            - desktop
                        final_url:
                          type:
                            - string
                            - 'null'
                          example: https://example.com/product
                        fetch_time:
                          type:
                            - string
                            - 'null'
                          format: date-time
                        created_at:
                          type: string
                          format: date-time
                        updated_at:
                          type: string
                          format: date-time
                        core_metrics:
                          type: object
                          properties:
                            performance_score:
                              type:
                                - integer
                                - 'null'
                              example: 85
                              minimum: 0
                              maximum: 100
                            largest_contentful_paint:
                              type:
                                - number
                                - 'null'
                              example: 2500
                              description: LCP in milliseconds
                            largest_contentful_paint_rating:
                              type:
                                - string
                                - 'null'
                              enum:
                                - good
                                - needs-improvement
                                - poor
                                - null
                            first_input_delay:
                              type:
                                - number
                                - 'null'
                              example: 100
                              description: FID in milliseconds
                            first_input_delay_rating:
                              type:
                                - string
                                - 'null'
                              enum:
                                - good
                                - needs-improvement
                                - poor
                                - null
                            cumulative_layout_shift:
                              type:
                                - number
                                - 'null'
                              example: 0.05
                              description: CLS score
                            cumulative_layout_shift_rating:
                              type:
                                - string
                                - 'null'
                              enum:
                                - good
                                - needs-improvement
                                - poor
                                - null
                            time_to_interactive:
                              type:
                                - number
                                - 'null'
                              example: 3500
                              description: TTI in milliseconds
                            total_blocking_time:
                              type:
                                - number
                                - 'null'
                              example: 200
                              description: TBT in milliseconds
                            first_contentful_paint:
                              type:
                                - number
                                - 'null'
                              example: 1500
                              description: FCP in milliseconds
                            speed_index:
                              type:
                                - number
                                - 'null'
                              example: 3200
                              description: Speed Index in milliseconds
                            device_type:
                              type:
                                - string
                                - 'null'
                              example: mobile
                        category_scores:
                          type: object
                          additionalProperties:
                            type: integer
                            minimum: 0
                            maximum: 100
                          example:
                            performance: 85
                            accessibility: 92
                            best-practices: 88
                            seo: 95
                        optimization_opportunities:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                              title:
                                type: string
                              description:
                                type: string
                              score:
                                type: number
                              display_value:
                                type: string
                              savings_ms:
                                type:
                                  - number
                                  - 'null'
                              savings_bytes:
                                type:
                                  - number
                                  - 'null'
                      required:
                        - id
                        - scanned_at
                  pagination:
                    type: object
                    properties:
                      current_page:
                        type: integer
                      total_pages:
                        type: integer
                      total_count:
                        type: integer
                      per_page:
                        type: integer
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - items
                  - pagination
                  - meta
    post:
      summary: Create a new Lighthouse scan
      tags:
        - Lighthouse
      operationId: createProductLighthouse
      description: Creates a new Lighthouse performance scan record for a product
      security:
        - bearer_auth: []
      parameters:
        - name: product_id
          in: path
          required: true
          description: Product ID
          schema:
            type: integer
      responses:
        '201':
          description: Lighthouse scan created
          content:
            application/json:
              schema:
                type: object
                properties:
                  item:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      scanned_at:
                        type: string
                        format: date-time
                      device_type:
                        type:
                          - string
                          - 'null'
                        example: mobile
                        enum:
                          - mobile
                          - desktop
                      final_url:
                        type:
                          - string
                          - 'null'
                        example: https://example.com/product
                      fetch_time:
                        type:
                          - string
                          - 'null'
                        format: date-time
                      created_at:
                        type: string
                        format: date-time
                      updated_at:
                        type: string
                        format: date-time
                      core_metrics:
                        type: object
                        properties:
                          performance_score:
                            type:
                              - integer
                              - 'null'
                            example: 85
                            minimum: 0
                            maximum: 100
                          largest_contentful_paint:
                            type:
                              - number
                              - 'null'
                            example: 2500
                            description: LCP in milliseconds
                          largest_contentful_paint_rating:
                            type:
                              - string
                              - 'null'
                            enum:
                              - good
                              - needs-improvement
                              - poor
                              - null
                          first_input_delay:
                            type:
                              - number
                              - 'null'
                            example: 100
                            description: FID in milliseconds
                          first_input_delay_rating:
                            type:
                              - string
                              - 'null'
                            enum:
                              - good
                              - needs-improvement
                              - poor
                              - null
                          cumulative_layout_shift:
                            type:
                              - number
                              - 'null'
                            example: 0.05
                            description: CLS score
                          cumulative_layout_shift_rating:
                            type:
                              - string
                              - 'null'
                            enum:
                              - good
                              - needs-improvement
                              - poor
                              - null
                          time_to_interactive:
                            type:
                              - number
                              - 'null'
                            example: 3500
                            description: TTI in milliseconds
                          total_blocking_time:
                            type:
                              - number
                              - 'null'
                            example: 200
                            description: TBT in milliseconds
                          first_contentful_paint:
                            type:
                              - number
                              - 'null'
                            example: 1500
                            description: FCP in milliseconds
                          speed_index:
                            type:
                              - number
                              - 'null'
                            example: 3200
                            description: Speed Index in milliseconds
                          device_type:
                            type:
                              - string
                              - 'null'
                            example: mobile
                      category_scores:
                        type: object
                        additionalProperties:
                          type: integer
                          minimum: 0
                          maximum: 100
                        example:
                          performance: 85
                          accessibility: 92
                          best-practices: 88
                          seo: 95
                      optimization_opportunities:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            title:
                              type: string
                            description:
                              type: string
                            score:
                              type: number
                            display_value:
                              type: string
                            savings_ms:
                              type:
                                - number
                                - 'null'
                            savings_bytes:
                              type:
                                - number
                                - 'null'
                    required:
                      - id
                      - scanned_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - item
                  - meta
        '422':
          description: invalid parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                lighthouse:
                  type: object
                  properties:
                    scanned_at:
                      type: string
                      format: date-time
                      example: '2026-01-12T10:00:00Z'
                    result:
                      type: object
                      description: >-
                        Full Lighthouse API response from Google PageSpeed
                        Insights
                      example:
                        lighthouseResult:
                          finalUrl: https://example.com/product
                          categories:
                            performance:
                              score: 0.85
                  required:
                    - scanned_at
                    - result
              required:
                - lighthouse
  /api/v202506/products/{product_id}/lighthouses/{id}:
    get:
      summary: Get a specific Lighthouse scan
      tags:
        - Lighthouse
      operationId: getProductLighthouse
      description: Returns details of a specific Lighthouse scan with full result data
      security:
        - bearer_auth: []
      parameters:
        - name: product_id
          in: path
          required: true
          description: Product ID
          schema:
            type: integer
        - name: id
          in: path
          required: true
          description: Lighthouse ID
          schema:
            type: integer
      responses:
        '200':
          description: Lighthouse scan found
          content:
            application/json:
              schema:
                type: object
                properties:
                  item:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      scanned_at:
                        type: string
                        format: date-time
                      device_type:
                        type:
                          - string
                          - 'null'
                        example: mobile
                        enum:
                          - mobile
                          - desktop
                      final_url:
                        type:
                          - string
                          - 'null'
                        example: https://example.com/product
                      fetch_time:
                        type:
                          - string
                          - 'null'
                        format: date-time
                      created_at:
                        type: string
                        format: date-time
                      updated_at:
                        type: string
                        format: date-time
                      core_metrics:
                        type: object
                        properties:
                          performance_score:
                            type:
                              - integer
                              - 'null'
                            example: 85
                            minimum: 0
                            maximum: 100
                          largest_contentful_paint:
                            type:
                              - number
                              - 'null'
                            example: 2500
                            description: LCP in milliseconds
                          largest_contentful_paint_rating:
                            type:
                              - string
                              - 'null'
                            enum:
                              - good
                              - needs-improvement
                              - poor
                              - null
                          first_input_delay:
                            type:
                              - number
                              - 'null'
                            example: 100
                            description: FID in milliseconds
                          first_input_delay_rating:
                            type:
                              - string
                              - 'null'
                            enum:
                              - good
                              - needs-improvement
                              - poor
                              - null
                          cumulative_layout_shift:
                            type:
                              - number
                              - 'null'
                            example: 0.05
                            description: CLS score
                          cumulative_layout_shift_rating:
                            type:
                              - string
                              - 'null'
                            enum:
                              - good
                              - needs-improvement
                              - poor
                              - null
                          time_to_interactive:
                            type:
                              - number
                              - 'null'
                            example: 3500
                            description: TTI in milliseconds
                          total_blocking_time:
                            type:
                              - number
                              - 'null'
                            example: 200
                            description: TBT in milliseconds
                          first_contentful_paint:
                            type:
                              - number
                              - 'null'
                            example: 1500
                            description: FCP in milliseconds
                          speed_index:
                            type:
                              - number
                              - 'null'
                            example: 3200
                            description: Speed Index in milliseconds
                          device_type:
                            type:
                              - string
                              - 'null'
                            example: mobile
                      category_scores:
                        type: object
                        additionalProperties:
                          type: integer
                          minimum: 0
                          maximum: 100
                        example:
                          performance: 85
                          accessibility: 92
                          best-practices: 88
                          seo: 95
                      optimization_opportunities:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            title:
                              type: string
                            description:
                              type: string
                            score:
                              type: number
                            display_value:
                              type: string
                            savings_ms:
                              type:
                                - number
                                - 'null'
                            savings_bytes:
                              type:
                                - number
                                - 'null'
                      result:
                        type: object
                        description: Full Lighthouse API response JSON
                    required:
                      - id
                      - scanned_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - item
                  - meta
        '404':
          description: Lighthouse scan not found
    patch:
      summary: Update a Lighthouse scan
      tags:
        - Lighthouse
      operationId: updateProductLighthouse
      description: Updates an existing Lighthouse scan
      security:
        - bearer_auth: []
      parameters:
        - name: product_id
          in: path
          required: true
          description: Product ID
          schema:
            type: integer
        - name: id
          in: path
          required: true
          description: Lighthouse ID
          schema:
            type: integer
      responses:
        '200':
          description: Lighthouse scan updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  item:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      scanned_at:
                        type: string
                        format: date-time
                      device_type:
                        type:
                          - string
                          - 'null'
                        example: mobile
                        enum:
                          - mobile
                          - desktop
                      final_url:
                        type:
                          - string
                          - 'null'
                        example: https://example.com/product
                      fetch_time:
                        type:
                          - string
                          - 'null'
                        format: date-time
                      created_at:
                        type: string
                        format: date-time
                      updated_at:
                        type: string
                        format: date-time
                      core_metrics:
                        type: object
                        properties:
                          performance_score:
                            type:
                              - integer
                              - 'null'
                            example: 85
                            minimum: 0
                            maximum: 100
                          largest_contentful_paint:
                            type:
                              - number
                              - 'null'
                            example: 2500
                            description: LCP in milliseconds
                          largest_contentful_paint_rating:
                            type:
                              - string
                              - 'null'
                            enum:
                              - good
                              - needs-improvement
                              - poor
                              - null
                          first_input_delay:
                            type:
                              - number
                              - 'null'
                            example: 100
                            description: FID in milliseconds
                          first_input_delay_rating:
                            type:
                              - string
                              - 'null'
                            enum:
                              - good
                              - needs-improvement
                              - poor
                              - null
                          cumulative_layout_shift:
                            type:
                              - number
                              - 'null'
                            example: 0.05
                            description: CLS score
                          cumulative_layout_shift_rating:
                            type:
                              - string
                              - 'null'
                            enum:
                              - good
                              - needs-improvement
                              - poor
                              - null
                          time_to_interactive:
                            type:
                              - number
                              - 'null'
                            example: 3500
                            description: TTI in milliseconds
                          total_blocking_time:
                            type:
                              - number
                              - 'null'
                            example: 200
                            description: TBT in milliseconds
                          first_contentful_paint:
                            type:
                              - number
                              - 'null'
                            example: 1500
                            description: FCP in milliseconds
                          speed_index:
                            type:
                              - number
                              - 'null'
                            example: 3200
                            description: Speed Index in milliseconds
                          device_type:
                            type:
                              - string
                              - 'null'
                            example: mobile
                      category_scores:
                        type: object
                        additionalProperties:
                          type: integer
                          minimum: 0
                          maximum: 100
                        example:
                          performance: 85
                          accessibility: 92
                          best-practices: 88
                          seo: 95
                      optimization_opportunities:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            title:
                              type: string
                            description:
                              type: string
                            score:
                              type: number
                            display_value:
                              type: string
                            savings_ms:
                              type:
                                - number
                                - 'null'
                            savings_bytes:
                              type:
                                - number
                                - 'null'
                    required:
                      - id
                      - scanned_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - item
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                lighthouse:
                  type: object
                  properties:
                    scanned_at:
                      type: string
                      format: date-time
                    result:
                      type: object
              required:
                - lighthouse
    delete:
      summary: Delete a Lighthouse scan
      tags:
        - Lighthouse
      operationId: deleteProductLighthouse
      description: Deletes a Lighthouse scan record
      security:
        - bearer_auth: []
      parameters:
        - name: product_id
          in: path
          required: true
          description: Product ID
          schema:
            type: integer
        - name: id
          in: path
          required: true
          description: Lighthouse ID
          schema:
            type: integer
      responses:
        '200':
          description: Lighthouse scan deleted
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/mcc_codes:
    get:
      summary: List MCC codes
      tags:
        - MCC Codes
      operationId: listCommerceMccCodes
      description: >-
        Get list of supported Merchant Category Codes (MCC) for business
        classification
      security:
        - bearer_auth: []
      responses:
        '200':
          description: MCC codes retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  mcc_codes:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: integer
                          example: 5411
                        name:
                          type: string
                          example: Grocery Stores, Supermarkets
                        code:
                          type: string
                          example: grocery_stores_supermarkets
                      required:
                        - value
                        - name
                        - code
                  meta:
                    type: object
                    properties:
                      request_id:
                        type:
                          - string
                          - 'null'
                        example: c8e25ea4-c230-47f2-9dd3-67320518efb7
                      timestamp:
                        type: string
                        example: '2025-09-16T04:01:05Z'
                    required:
                      - request_id
                      - timestamp
                required:
                  - mcc_codes
                  - meta
  /api/company/media/{id}:
    delete:
      summary: Delete company media
      operationId: deleteCompanyMedia
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
            example: 1
            description: Media ID
      responses:
        '200':
          description: Media deleted successfully
          content:
            application/json:
              schema:
                type: string
        '400':
          description: Media not found
          content:
            application/json:
              schema:
                type: string
                properties:
                  errors:
                    type: array
                    items:
                      type: string
                example: Medium not found
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
      description: Delete a media item (soft delete)
      tags:
        - Media
    get:
      summary: Get company media
      description: Get a specific media item by ID
      tags:
        - Media
      operationId: getCompanyMedia
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
            example: 1
            description: Media ID
        - name: language_iso
          in: query
          schema:
            type: string
          required: false
          description: Language code for translations (e.g., 'en', 'es', 'de')
      responses:
        '200':
          description: Media retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediumSerializer'
        '400':
          description: Media not found
          content:
            application/json:
              schema:
                type: string
                example: Medium not found
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
    put:
      summary: Update company media
      description: Update an existing media item
      tags:
        - Media
      operationId: updateCompanyMedia
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
            example: 1
            description: Media ID
      responses:
        '200':
          description: Media updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  medium:
                    $ref: '#/components/schemas/MediumSerializer'
                  meta:
                    $ref: '#/components/schemas/Meta'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '404':
          description: Media not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                  meta:
                    $ref: '#/components/schemas/Meta'
        '422':
          description: Validation errors
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      medium:
                        type: object
                  meta:
                    $ref: '#/components/schemas/Meta'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MediaUpdate'
  /api/company/media:
    get:
      summary: List company media
      description: >-
        Get all company media with pagination and filtering. Only returns
        'share' type media by default.
      tags:
        - Media
      operationId: listCompanyMedia
      security:
        - bearer_auth: []
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            default: 1
          required: false
          description: Page number for pagination
        - name: per_page
          in: query
          schema:
            type: integer
            default: 10
          required: false
          description: Number of records per page
        - name: search_query
          in: query
          schema:
            type: string
          required: false
          description: Search by title
        - name: sorted_by
          in: query
          schema:
            type: string
          required: false
          description: Sort order (title_desc, created_at_desc, etc)
        - name: status
          in: query
          schema:
            type: string
            enum:
              - active
              - inactive
          required: false
          description: Filter by status (active/inactive)
        - name: language_iso
          in: query
          schema:
            type: string
          required: false
          description: Language code for translations (e.g., 'en', 'es', 'de')
      responses:
        '200':
          description: Company media retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  oneOf:
                    - type: object
                      properties:
                        pagination:
                          type: object
                          properties:
                            current:
                              type: integer
                            previous:
                              type:
                                - integer
                                - 'null'
                            next:
                              type:
                                - integer
                                - 'null'
                            per_page:
                              type: integer
                            pages:
                              type: integer
                            count:
                              type: integer
                    - type: object
                      properties:
                        items:
                          type: array
                          items:
                            $ref: '#/components/schemas/MediumSerializer'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials
                required:
                  - message
    post:
      summary: Create company media
      description: Create a new media item for the company
      tags:
        - Media
      operationId: createCompanyMedia
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: Media created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  medium:
                    $ref: '#/components/schemas/MediumSerializer'
                  meta:
                    $ref: '#/components/schemas/Meta'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials
                required:
                  - message
        '422':
          description: Validation errors
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      medium:
                        type: object
                  meta:
                    $ref: '#/components/schemas/Meta'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MediaCreate'
  /api/company/media/{id}/send_to_top:
    get:
      summary: Send media to top
      description: >-
        Move a media item to the top of the list by updating its created_at
        timestamp
      tags:
        - Media
      operationId: sendCompanyMediaToTop
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
            example: 1
            description: Media ID
      responses:
        '200':
          description: Media sent to top successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediumSerializer'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
        '422':
          description: Failed to send to top
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: object
  /api/media:
    get:
      summary: List media
      description: Get all media with pagination and filtering
      tags:
        - Media
      operationId: listMedia
      security:
        - bearer_auth: []
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            default: 1
          required: false
          description: Page number for pagination
        - name: per_page
          in: query
          schema:
            type: integer
            default: 10
          required: false
          description: Number of records per page
        - name: search_query
          in: query
          schema:
            type: string
          required: false
          description: Search by title
        - name: sorted_by
          in: query
          schema:
            type: string
            default: title_desc
          required: false
          description: Sort order (title_desc, created_at_desc, etc)
        - name: status
          in: query
          schema:
            type: string
          required: false
          description: Filter by status (active/inactive)
        - name: language_iso
          in: query
          schema:
            type: string
          required: false
          description: Language code for translations (e.g., 'en', 'es', 'de')
      responses:
        '200':
          description: Media retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MediumSerializer'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedError'
  /api/company/media/create:
    post:
      tags:
        - Media
      summary: Create Media Content
      description: >-
        Creates a new media content item with specified details including title,
        type, description and optional attributes like images, videos, PDFs, or
        presentations. Supports various media types and configurations including
        CTA actions, video shopping features, and subtitle options.
      operationId: createMedia
      parameters:
        - name: title
          in: query
          required: true
          schema:
            type: string
          description: Title of the media content
        - name: media_type
          in: query
          required: true
          schema:
            type: string
            enum:
              - share
              - training
              - update
              - upload
          description: Type of media content
        - name: description
          in: query
          required: true
          schema:
            type: string
          description: Detailed description of the media content
        - name: language
          in: query
          required: false
          schema:
            type: string
          description: ISO language code for the media content
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/createrequest15'
                - example:
                    medium:
                      title: Subtitles Test
                      language: en
                      media_type: share
                      description: This is the body text of the medium
                      video_url: >-
                        https://videos.pexels.com/video-files/20576968/20576968-hd_1920_1080_25fps.mp4
                      available_countries:
                        - npl
                        - us
                        - ind
                        - fi
                      tags_attributes:
                        - name: meds
                      label:
                        title: AD
                      category: media_category
                      cta_enabled: true
                      cta_action_type: visit_on_click
                      cta_button_text: Learn More
                      cta_url: https://google.com
                      display_shop: true
                      video_shopping_enabled: true
                      attached_shareables_attributes:
                        - attachment_type: Product
                          timestamp: '00:00:05'
                        - attachment_type: Product
                          attachment_id: 7
                      subtitles:
                        - lang: en
                        - lang: de
                          src: >-
                            https://raw.githubusercontent.com/andreyvit/subtitle-tools/master/sample.srt
                      prompts_attributes:
                        - title: This is a Prompt
                          content: This is an example content of a prompt.
            example:
              medium:
                title: Subtitles Test
                language: en
                media_type: share
                description: This is the body text of the medium
                video_url: >-
                  https://videos.pexels.com/video-files/20576968/20576968-hd_1920_1080_25fps.mp4
                available_countries:
                  - npl
                  - us
                  - ind
                  - fi
                tags_attributes:
                  - name: meds
                label:
                  title: AD
                category: media_category
                cta_enabled: true
                cta_action_type: visit_on_click
                cta_button_text: Learn More
                cta_url: https://google.com
                display_shop: true
                video_shopping_enabled: true
                attached_shareables_attributes:
                  - attachment_type: Product
                    timestamp: '00:00:05'
                  - attachment_type: Product
                    attachment_id: 7
                subtitles:
                  - lang: en
                  - lang: de
                    src: >-
                      https://raw.githubusercontent.com/andreyvit/subtitle-tools/master/sample.srt
                prompts_attributes:
                  - title: This is a Prompt
                    content: This is an example content of a prompt.
        required: true
      responses:
        '200':
          description: ''
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
      deprecated: false
      security:
        - bearer: []
  /api/company/media/{id}/send_notifications:
    get:
      tags:
        - Media
      summary: Send Media Notifications to Affiliates
      description: >-
        Sends notifications about media content to affiliates in specified
        countries.
      operationId: sendMediaNotifications
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
          description: The ID of the media content
        - name: available_countries
          in: query
          required: true
          schema:
            type: string
          description: >-
            Comma-separated list of country ISO codes whose affiliates should be
            notified
      responses:
        '200':
          description: ''
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
      deprecated: false
      security:
        - bearer: []
  /api/menus/{menu_id}/menu_items:
    post:
      summary: Create menu item
      description: Create a new menu item
      tags:
        - Menus
      operationId: createMenuItem
      security:
        - bearer_auth: []
      parameters:
        - name: menu_id
          in: path
          required: true
          description: ID of the menu
          schema:
            type: integer
      responses:
        '201':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  menu_item:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      title:
                        type: string
                        example: Main Menu
                      linkable_id:
                        type:
                          - integer
                          - 'null'
                        example: 10
                      linkable_type:
                        type: string
                        example: Product
                      url:
                        type: string
                        example: /products/1
                      order:
                        type: integer
                        example: 1
                      parent_id:
                        type:
                          - integer
                          - 'null'
                        example: 0
                      linkable:
                        type: object
                        properties:
                          id:
                            type:
                              - integer
                              - 'null'
                            example: 20
                          type:
                            type: string
                            example: Product
                          title:
                            type:
                              - string
                              - 'null'
                            example: Category 1
                          image_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/category1.jpg
                      sub_menu_items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 2
                            title:
                              type: string
                              example: Sub Menu Item 1
                            url:
                              type: string
                              example: /products/2
                            linkable_id:
                              type:
                                - integer
                                - 'null'
                              example: 20
                            linkable_type:
                              type: string
                              example: Category
                            order:
                              type: integer
                              example: 2
                            parent_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            sub_menu_items:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 3
                                  title:
                                    type: string
                                    example: Sub Sub Menu Item 1
                                  linkable_id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 30
                                  linkable_type:
                                    type: string
                                    example: SubCategory
                                  order:
                                    type: integer
                                    example: 3
                                  parent_id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 2
                            linkable:
                              type: object
                              properties:
                                id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 20
                                type:
                                  type: string
                                  example: Product
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: Category 1
                                image_url:
                                  type:
                                    - string
                                    - 'null'
                                  example: https://example.com/category1.jpg
                        additionalProperties: true
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '422':
          description: unprocessable entity
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                  example: New Menu Item
                linkable_id:
                  type:
                    - integer
                    - 'null'
                  example: 10
                linkable_type:
                  type: string
                  example: Product
                order:
                  type: integer
                  example: 1
                parent_id:
                  type:
                    - integer
                    - 'null'
                  example: 0
        description: Menu item data
  /api/menus/{menu_id}/menu_items/{id}:
    get:
      summary: Get a menu item
      description: Retrieve a specific menu item by ID
      tags:
        - Menus
      operationId: getMenuItem
      security:
        - bearer_auth: []
      parameters:
        - name: menu_id
          in: path
          required: true
          description: ID of the menu
          schema:
            type: integer
        - name: id
          in: path
          required: true
          description: ID of the menu item
          schema:
            type: integer
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  menu_item:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      title:
                        type: string
                        example: Main Menu
                      linkable_id:
                        type:
                          - integer
                          - 'null'
                        example: 10
                      linkable_type:
                        type: string
                        example: Product
                      url:
                        type: string
                        example: /products/1
                      order:
                        type: integer
                        example: 1
                      parent_id:
                        type:
                          - integer
                          - 'null'
                        example: 0
                      linkable:
                        type: object
                        properties:
                          id:
                            type:
                              - integer
                              - 'null'
                            example: 20
                          type:
                            type: string
                            example: Product
                          title:
                            type:
                              - string
                              - 'null'
                            example: Category 1
                          image_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/category1.jpg
                      sub_menu_items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 2
                            title:
                              type: string
                              example: Sub Menu Item 1
                            url:
                              type: string
                              example: /products/2
                            linkable_id:
                              type:
                                - integer
                                - 'null'
                              example: 20
                            linkable_type:
                              type: string
                              example: Category
                            order:
                              type: integer
                              example: 2
                            parent_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            sub_menu_items:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 3
                                  title:
                                    type: string
                                    example: Sub Sub Menu Item 1
                                  linkable_id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 30
                                  linkable_type:
                                    type: string
                                    example: SubCategory
                                  order:
                                    type: integer
                                    example: 3
                                  parent_id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 2
                            linkable:
                              type: object
                              properties:
                                id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 20
                                type:
                                  type: string
                                  example: Product
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: Category 1
                                image_url:
                                  type:
                                    - string
                                    - 'null'
                                  example: https://example.com/category1.jpg
                        additionalProperties: true
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
    put:
      summary: Update a menu item
      description: Update a specific menu item by ID
      tags:
        - Menus
      operationId: updateMenuItem
      security:
        - bearer_auth: []
      parameters:
        - name: menu_id
          in: path
          required: true
          description: ID of the menu
          schema:
            type: integer
        - name: id
          in: path
          required: true
          description: ID of the menu item
          schema:
            type: integer
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  menu_item:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      title:
                        type: string
                        example: Main Menu
                      linkable_id:
                        type:
                          - integer
                          - 'null'
                        example: 10
                      linkable_type:
                        type: string
                        example: Product
                      url:
                        type: string
                        example: /products/1
                      order:
                        type: integer
                        example: 1
                      parent_id:
                        type:
                          - integer
                          - 'null'
                        example: 0
                      linkable:
                        type: object
                        properties:
                          id:
                            type:
                              - integer
                              - 'null'
                            example: 20
                          type:
                            type: string
                            example: Product
                          title:
                            type:
                              - string
                              - 'null'
                            example: Category 1
                          image_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/category1.jpg
                      sub_menu_items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 2
                            title:
                              type: string
                              example: Sub Menu Item 1
                            url:
                              type: string
                              example: /products/2
                            linkable_id:
                              type:
                                - integer
                                - 'null'
                              example: 20
                            linkable_type:
                              type: string
                              example: Category
                            order:
                              type: integer
                              example: 2
                            parent_id:
                              type:
                                - integer
                                - 'null'
                              example: 1
                            sub_menu_items:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 3
                                  title:
                                    type: string
                                    example: Sub Sub Menu Item 1
                                  linkable_id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 30
                                  linkable_type:
                                    type: string
                                    example: SubCategory
                                  order:
                                    type: integer
                                    example: 3
                                  parent_id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 2
                            linkable:
                              type: object
                              properties:
                                id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 20
                                type:
                                  type: string
                                  example: Product
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: Category 1
                                image_url:
                                  type:
                                    - string
                                    - 'null'
                                  example: https://example.com/category1.jpg
                        additionalProperties: true
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                  example: Updated Menu Item
                order:
                  type: integer
                  example: 2
                linkable_id:
                  type:
                    - integer
                    - 'null'
                  example: 20
                linkable_type:
                  type: string
                  example: Category
                parent_id:
                  type:
                    - integer
                    - 'null'
                  example: 1
                sub_menu_items_attributes:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 2
                      title:
                        type: string
                        example: Sub Menu Item 1
                      linkable_id:
                        type:
                          - integer
                          - 'null'
                        example: 20
                      linkable_type:
                        type: string
                        example: Category
                      order:
                        type: integer
                        example: 2
                      parent_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
        description: Menu item data
    delete:
      summary: Delete a menu item
      description: Delete a specific menu item by ID
      tags:
        - Menus
      operationId: deleteMenuItem
      security:
        - bearer_auth: []
      parameters:
        - name: menu_id
          in: path
          required: true
          description: ID of the menu
          schema:
            type: integer
        - name: id
          in: path
          required: true
          description: ID of the menu item
          schema:
            type: integer
      responses:
        '200':
          description: successful
        '404':
          description: not found
  /api/menus:
    get:
      summary: List menus
      description: Get all menus with optional filters
      tags:
        - Menus
      operationId: listMenus
      security:
        - bearer_auth: []
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            default: 1
          required: false
          description: Page number for pagination
        - name: per_page
          in: query
          schema:
            type: integer
            default: 10
          required: false
          description: Number of records per page
        - name: search_query
          in: query
          schema:
            type: string
          required: false
          description: Search query to filter menus by title
        - name: status
          in: query
          schema:
            type: string
            enum:
              - active
              - inactive
          required: false
          description: Filter by menu status (active or inactive)
        - name: country_ids
          in: query
          schema:
            type: array
            items:
              type: integer
          required: false
          description: Filter by country IDs
        - name: sorted_by
          in: query
          schema:
            type: string
            default: created_at_desc
          required: false
          description: >-
            Sorting criteria for menus, e.g., 'created_at_asc',
            'created_at_desc', 'title_asc', 'title_desc'
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  menus:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 1
                        company_id:
                          type:
                            - integer
                            - 'null'
                          example: 123
                        title:
                          type: string
                          example: Main Menu
                        active:
                          type: boolean
                          example: true
                        slug:
                          type: string
                          example: main-menu
                        created_at:
                          type: string
                          format: date_time
                          example: '2024-12-10T08:04:10Z'
                        updated_at:
                          type: string
                          format: date_time
                          example: '2024-12-10T08:04:10Z'
                        country_ids:
                          type: array
                          items:
                            type: integer
                          example:
                            - 1
                            - 2
                            - 3
                        menu_items:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              title:
                                type: string
                                example: Menu Item 1
                              linkable_id:
                                type:
                                  - integer
                                  - 'null'
                                example: 10
                              linkable_type:
                                type: string
                                example: Product
                              url:
                                type: string
                                example: /products/1
                              order:
                                type: integer
                                example: 1
                              parent_id:
                                type:
                                  - integer
                                  - 'null'
                                example: 0
                              linkable:
                                type: object
                                properties:
                                  id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 20
                                  type:
                                    type: string
                                    example: Product
                                  title:
                                    type:
                                      - string
                                      - 'null'
                                    example: Category 1
                                  image_url:
                                    type:
                                      - string
                                      - 'null'
                                    example: https://example.com/category1.jpg
                              sub_menu_items:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 2
                                    title:
                                      type: string
                                      example: Sub Menu Item 1
                                    url:
                                      type: string
                                      example: /products/2
                                    linkable_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: 20
                                    linkable_type:
                                      type: string
                                      example: Category
                                    order:
                                      type: integer
                                      example: 2
                                    parent_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: 1
                                    linkable:
                                      type: object
                                      properties:
                                        id:
                                          type:
                                            - integer
                                            - 'null'
                                          example: 20
                                        type:
                                          type: string
                                          example: Product
                                        title:
                                          type:
                                            - string
                                            - 'null'
                                          example: Category 1
                                        image_url:
                                          type:
                                            - string
                                            - 'null'
                                          example: https://example.com/category1.jpg
                                additionalProperties: true
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                      total_count:
                        type: integer
                        example: 42
                      total_pages:
                        type: integer
                        example: 3
                      current_page:
                        type: integer
                        example: 1
                      per_page:
                        type: integer
                        example: 10
    post:
      summary: Create a menu
      tags:
        - Menus
      operationId: createMenu
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: created
          content:
            application/json:
              schema:
                type: object
                properties:
                  menu:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      company_id:
                        type:
                          - integer
                          - 'null'
                        example: 123
                      title:
                        type: string
                        example: Main Menu
                      active:
                        type: boolean
                        example: true
                      slug:
                        type: string
                        example: main-menu
                      created_at:
                        type: string
                        format: date_time
                        example: '2024-12-10T08:04:10Z'
                      updated_at:
                        type: string
                        format: date_time
                        example: '2024-12-10T08:04:10Z'
                      country_ids:
                        type: array
                        items:
                          type: integer
                        example:
                          - 1
                          - 2
                          - 3
                      menu_items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            title:
                              type: string
                              example: Menu Item 1
                            linkable_id:
                              type:
                                - integer
                                - 'null'
                              example: 10
                            linkable_type:
                              type: string
                              example: Product
                            url:
                              type: string
                              example: /products/1
                            order:
                              type: integer
                              example: 1
                            parent_id:
                              type:
                                - integer
                                - 'null'
                              example: 0
                            linkable:
                              type: object
                              properties:
                                id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 20
                                type:
                                  type: string
                                  example: Product
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: Category 1
                                image_url:
                                  type:
                                    - string
                                    - 'null'
                                  example: https://example.com/category1.jpg
                            sub_menu_items:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 2
                                  title:
                                    type: string
                                    example: Sub Menu Item 1
                                  url:
                                    type: string
                                    example: /products/2
                                  linkable_id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 20
                                  linkable_type:
                                    type: string
                                    example: Category
                                  order:
                                    type: integer
                                    example: 2
                                  parent_id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 1
                                  linkable:
                                    type: object
                                    properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 20
                                      type:
                                        type: string
                                        example: Product
                                      title:
                                        type:
                                          - string
                                          - 'null'
                                        example: Category 1
                                      image_url:
                                        type:
                                          - string
                                          - 'null'
                                        example: https://example.com/category1.jpg
                              additionalProperties: true
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameters
                  errors:
                    type: object
                    properties:
                      menu:
                        type: object
                        properties:
                          title:
                            type: array
                            items:
                              type: string
                            example:
                              - must be filled
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                menu:
                  type: object
                  properties:
                    title:
                      type: string
                      example: Modern Theme
                      description: Title of the menu
                    active:
                      type: boolean
                      example: true
                      description: Whether the menu is active or not
                    country_ids:
                      type: array
                      items:
                        type: integer
                      example:
                        - 1
                        - 2
                        - 3
                      description: List of country IDs this menu is accessible in
                    menu_items_attributes:
                      type: array
                      items:
                        type: object
                        properties:
                          linkable_type:
                            type: string
                            example: Product
                          linkable_id:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          title:
                            type: string
                            example: Menu Item 1
                          order:
                            type: integer
                            example: 1
                          parent_id:
                            type: integer
                            example: 0
                          url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com
                  required:
                    - title
              required:
                - menu
  /api/menus/{id}:
    get:
      summary: Get a menu
      tags:
        - Menus
      operationId: getMenu
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Menu ID
          schema:
            type: integer
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  menu:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      company_id:
                        type:
                          - integer
                          - 'null'
                        example: 123
                      title:
                        type: string
                        example: Main Menu
                      active:
                        type: boolean
                        example: true
                      slug:
                        type: string
                        example: main-menu
                      created_at:
                        type: string
                        format: date_time
                        example: '2024-12-10T08:04:10Z'
                      updated_at:
                        type: string
                        format: date_time
                        example: '2024-12-10T08:04:10Z'
                      country_ids:
                        type: array
                        items:
                          type: integer
                        example:
                          - 1
                          - 2
                          - 3
                      menu_items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            title:
                              type: string
                              example: Menu Item 1
                            linkable_id:
                              type:
                                - integer
                                - 'null'
                              example: 10
                            linkable_type:
                              type: string
                              example: Product
                            url:
                              type: string
                              example: /products/1
                            order:
                              type: integer
                              example: 1
                            parent_id:
                              type:
                                - integer
                                - 'null'
                              example: 0
                            linkable:
                              type: object
                              properties:
                                id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 20
                                type:
                                  type: string
                                  example: Product
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: Category 1
                                image_url:
                                  type:
                                    - string
                                    - 'null'
                                  example: https://example.com/category1.jpg
                            sub_menu_items:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 2
                                  title:
                                    type: string
                                    example: Sub Menu Item 1
                                  url:
                                    type: string
                                    example: /products/2
                                  linkable_id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 20
                                  linkable_type:
                                    type: string
                                    example: Category
                                  order:
                                    type: integer
                                    example: 2
                                  parent_id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 1
                                  linkable:
                                    type: object
                                    properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 20
                                      type:
                                        type: string
                                        example: Product
                                      title:
                                        type:
                                          - string
                                          - 'null'
                                        example: Category 1
                                      image_url:
                                        type:
                                          - string
                                          - 'null'
                                        example: https://example.com/category1.jpg
                              additionalProperties: true
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Menu not found.
                  errors:
                    type: object
                    properties:
                      menu:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 'Menu not found.. id: 999999'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
                  - meta
    patch:
      summary: Update a menu
      tags:
        - Menus
      operationId: updateMenu
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Menu ID
          schema:
            type: integer
      responses:
        '200':
          description: success with menu items
          content:
            application/json:
              schema:
                type: object
                properties:
                  menu:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      company_id:
                        type:
                          - integer
                          - 'null'
                        example: 123
                      title:
                        type: string
                        example: Main Menu
                      active:
                        type: boolean
                        example: true
                      slug:
                        type: string
                        example: main-menu
                      created_at:
                        type: string
                        format: date_time
                        example: '2024-12-10T08:04:10Z'
                      updated_at:
                        type: string
                        format: date_time
                        example: '2024-12-10T08:04:10Z'
                      country_ids:
                        type: array
                        items:
                          type: integer
                        example:
                          - 1
                          - 2
                          - 3
                      menu_items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            title:
                              type: string
                              example: Menu Item 1
                            linkable_id:
                              type:
                                - integer
                                - 'null'
                              example: 10
                            linkable_type:
                              type: string
                              example: Product
                            url:
                              type: string
                              example: /products/1
                            order:
                              type: integer
                              example: 1
                            parent_id:
                              type:
                                - integer
                                - 'null'
                              example: 0
                            linkable:
                              type: object
                              properties:
                                id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 20
                                type:
                                  type: string
                                  example: Product
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: Category 1
                                image_url:
                                  type:
                                    - string
                                    - 'null'
                                  example: https://example.com/category1.jpg
                            sub_menu_items:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 2
                                  title:
                                    type: string
                                    example: Sub Menu Item 1
                                  url:
                                    type: string
                                    example: /products/2
                                  linkable_id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 20
                                  linkable_type:
                                    type: string
                                    example: Category
                                  order:
                                    type: integer
                                    example: 2
                                  parent_id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: 1
                                  linkable:
                                    type: object
                                    properties:
                                      id:
                                        type:
                                          - integer
                                          - 'null'
                                        example: 20
                                      type:
                                        type: string
                                        example: Product
                                      title:
                                        type:
                                          - string
                                          - 'null'
                                        example: Category 1
                                      image_url:
                                        type:
                                          - string
                                          - 'null'
                                        example: https://example.com/category1.jpg
                              additionalProperties: true
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Menu not found.
                  errors:
                    type: object
                    properties:
                      menu:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 'Menu not found.. id: 999999'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                menu:
                  type: object
                  properties:
                    title:
                      type: string
                      example: Updated Menu Title
                    active:
                      type: boolean
                      example: true
                    country_ids:
                      type: array
                      items:
                        type: integer
                      example:
                        - 1
                        - 2
                        - 3
                    menu_items_attributes:
                      type: array
                      items:
                        type: object
                        properties:
                          linkable_type:
                            type: string
                            example: Product
                          linkable_id:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          title:
                            type: string
                            example: Updated Menu Item
                          order:
                            type: integer
                            example: 1
                          parent_id:
                            type: integer
                            example: 0
                          id:
                            type: integer
                            example: 1
                          _destroy:
                            type: boolean
                            example: false
              required:
                - menu
    delete:
      summary: Delete a menu
      tags:
        - Menus
      operationId: deleteMenu
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Menu ID
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Menu was successfully destroyed.
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Menu not found.
                  errors:
                    type: object
                    properties:
                      menu:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 'Menu not found.. id: 999999'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
                  - meta
  /api/company/messaging/conversations/{conversationId}/messages.json:
    post:
      tags:
        - Messages
      summary: Create Conversation Message
      description: Create a message on a conversation.
      operationId: createConversationMessage
      parameters:
        - name: conversationId
          in: path
          required: true
          schema:
            type: string
          description: ID of the conversation to create message in
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/CreateRequest17'
                - example:
                    message:
                      body: How is it going?
                      theme: inquiry
                      type: DirectMessage
                      sent_at: '2022-02-21T11:46:42.379Z'
                      attachments_attributes:
                        - filename: test.jpg
                          url: https://picsum.photos/id/237/200/300
                          kind: image
                    user:
                      email: admin@fluid.app
            example:
              message:
                body: How is it going?
                theme: inquiry
                type: DirectMessage
                sent_at: '2022-02-21T11:46:42.379Z'
                attachments_attributes:
                  - filename: test.jpg
                    url: https://picsum.photos/id/237/200/300
                    kind: image
              user:
                email: admin@fluid.app
        required: true
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Create11'
                  - example:
                      id: 34
                      body: How is it going?
                      type: DirectMessage
                      created_at: '2024-08-19T17:04:58.312Z'
                      updated_at: '2024-08-19T17:04:58.702Z'
                      deleted_at: null
                      edited_at: null
                      conversation_id: 8
                      seen_by:
                        - id: 1
                          first_name: John
                          last_name: Admin
                          image_url: null
                          seen_at: '2024-08-19T17:04:58.562Z'
                      attachments:
                        - id: 2
                          url: https://picsum.photos/id/237/200/300
                          filename: test.jpg
                          kind: image
                          image_url: https://picsum.photos/id/237/200/300
                          image_path: null
                          content_type: null
                          attachable_type: Message
                          attachable_id: 34
                          thumbnail_url: https://picsum.photos/id/237/200/300
                          metadata: null
                          content_size: null
                      reaction_stats: null
                      reaction: null
                      metadata: null
                      seen_by_count: 1
                      emoji_only_count: 0
                      mentioned_recipients: []
                      sent_at: '2024-08-19T17:04:58.701Z'
                      replied_to_message: null
                      sender_recipient:
                        id: 1
                        first_name: John
                        last_name: Admin
                        image_url: null
                        discarded_at: null
                        blocked: false
                        blocker: false
              example:
                id: 34
                body: How is it going?
                type: DirectMessage
                created_at: '2024-08-19T17:04:58.312Z'
                updated_at: '2024-08-19T17:04:58.702Z'
                deleted_at: null
                edited_at: null
                conversation_id: 8
                seen_by:
                  - id: 1
                    first_name: John
                    last_name: Admin
                    image_url: null
                    seen_at: '2024-08-19T17:04:58.562Z'
                attachments:
                  - id: 2
                    url: https://picsum.photos/id/237/200/300
                    filename: test.jpg
                    kind: image
                    image_url: https://picsum.photos/id/237/200/300
                    image_path: null
                    content_type: null
                    attachable_type: Message
                    attachable_id: 34
                    thumbnail_url: https://picsum.photos/id/237/200/300
                    metadata: null
                    content_size: null
                reaction_stats: null
                reaction: null
                metadata: null
                seen_by_count: 1
                emoji_only_count: 0
                mentioned_recipients: []
                sent_at: '2024-08-19T17:04:58.701Z'
                replied_to_message: null
                sender_recipient:
                  id: 1
                  first_name: John
                  last_name: Admin
                  image_url: null
                  discarded_at: null
                  blocked: false
                  blocker: false
      deprecated: false
    get:
      tags:
        - Messages
      summary: Get Conversation Messages
      description: Retrieves all messages belonging to a specific conversation
      operationId: getConversationMessages
      parameters:
        - name: conversationId
          in: path
          required: true
          schema:
            type: integer
          description: Unique identifier of the conversation
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Index12'
                description: ''
                example:
                  - pagination:
                      current: 1
                      previous: null
                      next: null
                      per_page: 20
                      pages: 1
                      count: 1
                  - items:
                      - id: 34
                        body: How is it going?
                        type: DirectMessage
                        created_at: '2024-08-19T17:04:58.312Z'
                        updated_at: '2024-08-19T17:04:58.702Z'
                        deleted_at: null
                        edited_at: null
                        conversation_id: 8
                        seen_by:
                          - id: 1
                            first_name: John
                            last_name: Admin
                            image_url: null
                            seen_at: '2024-08-19T17:04:58.562Z'
                        attachments:
                          - id: 2
                            url: https://picsum.photos/id/237/200/300
                            filename: test.jpg
                            kind: image
                            image_url: https://picsum.photos/id/237/200/300
                            image_path: null
                            content_type: null
                            attachable_type: Message
                            attachable_id: 34
                            thumbnail_url: https://picsum.photos/id/237/200/300
                            metadata: null
                            content_size: null
                        reaction_stats: null
                        reaction: null
                        metadata:
                          links: []
                        seen_by_count: 1
                        emoji_only_count: 0
                        mentioned_recipients: []
                        sent_at: '2024-08-19T17:04:58.701Z'
                        replied_to_message: null
                        sender_recipient:
                          id: 1
                          first_name: John
                          last_name: Admin
                          image_url: null
                          discarded_at: null
                          blocked: false
                          blocker: false
              example:
                - pagination:
                    current: 1
                    previous: null
                    next: null
                    per_page: 20
                    pages: 1
                    count: 1
                - items:
                    - id: 34
                      body: How is it going?
                      type: DirectMessage
                      created_at: '2024-08-19T17:04:58.312Z'
                      updated_at: '2024-08-19T17:04:58.702Z'
                      deleted_at: null
                      edited_at: null
                      conversation_id: 8
                      seen_by:
                        - id: 1
                          first_name: John
                          last_name: Admin
                          image_url: null
                          seen_at: '2024-08-19T17:04:58.562Z'
                      attachments:
                        - id: 2
                          url: https://picsum.photos/id/237/200/300
                          filename: test.jpg
                          kind: image
                          image_url: https://picsum.photos/id/237/200/300
                          image_path: null
                          content_type: null
                          attachable_type: Message
                          attachable_id: 34
                          thumbnail_url: https://picsum.photos/id/237/200/300
                          metadata: null
                          content_size: null
                      reaction_stats: null
                      reaction: null
                      metadata:
                        links: []
                      seen_by_count: 1
                      emoji_only_count: 0
                      mentioned_recipients: []
                      sent_at: '2024-08-19T17:04:58.701Z'
                      replied_to_message: null
                      sender_recipient:
                        id: 1
                        first_name: John
                        last_name: Admin
                        image_url: null
                        discarded_at: null
                        blocked: false
                        blocker: false
      deprecated: false
  /api/v2/metafield_definitions:
    get:
      summary: List metafield definitions
      tags:
        - Metafield Definitions
      operationId: listMetafieldDefinitions
      description: Retrieve a list of metafield definitions for the authenticated company
      security:
        - bearer_auth: []
      parameters:
        - name: owner_resource
          in: query
          schema:
            type: string
            enum:
              - Product
              - Variant
              - Customer
              - Commerce::Order
              - Post
              - EnrollmentPack
              - Medium
              - Collection
              - Category
              - Library
              - Page
          required: false
          example: Product
          description: Filter by resource type
        - name: pinned
          in: query
          required: false
          description: Filter by pinned status
          example: true
          schema:
            type: boolean
        - name: search_query
          in: query
          required: false
          description: Search in name, description, namespace, or key
          example: material
          schema:
            type: string
        - name: page
          in: query
          schema:
            type: integer
            default: 1
          required: false
          description: Page number for pagination
        - name: per_page
          in: query
          schema:
            type: integer
            default: 20
          required: false
          description: Number of records per page
      responses:
        '200':
          description: Metafield definitions retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  metafield_definitions:
                    type: array
                    items:
                      title: MetafieldDefinition
                      type: object
                      properties:
                        id:
                          type: integer
                        company_id:
                          description: >-
                            The ID of the company that owns this metafield
                            definition.
                          example: 1
                          type: integer
                        namespace:
                          description: >-
                            A container for related metafield definitions. Used
                            to group definitions by app or functionality. Must
                            be unique within company and owner_resource.
                          example: product_details
                          type: string
                          maxLength: 20
                          pattern: ^[a-zA-Z0-9_]+$
                        key:
                          description: >-
                            The unique identifier for the metafield definition
                            within its namespace and owner_resource. Combined
                            with namespace and owner_resource, this must be
                            unique per company.
                          example: material_type
                          type: string
                          maxLength: 30
                          pattern: ^[a-zA-Z0-9_]+$
                        name:
                          description: >-
                            Human-readable display name for the metafield
                            definition, shown in admin interfaces and forms.
                          example: Material Type
                          type: string
                          maxLength: 100
                        description:
                          description: >-
                            Detailed explanation of what this metafield
                            definition represents, how it should be used, and
                            any special instructions for content creators.
                          example: >-
                            Specify the primary material composition of the
                            product (e.g., cotton, polyester, silk). This will
                            be displayed on the product detail page.
                          type:
                            - string
                            - 'null'
                        value_type:
                          description: >-
                            The data type that defines how metafield values
                            should be validated, stored, and displayed.
                            Determines which validation rules are available.
                          example: single_line_text_field
                          type: string
                        validation_rules:
                          description: >-
                            JSON object containing validation constraints that
                            will be applied to metafield values. Available rules
                            depend on the value_type.
                          example:
                            choices:
                              - cotton
                              - polyester
                              - silk
                              - wool
                              - linen
                              - bamboo
                            max: 50
                            min: 2
                          type:
                            - object
                            - 'null'
                        owner_resource:
                          description: >-
                            The type of resource (model class name) that
                            metafields using this definition can be attached to.
                            Must match the polymorphic owner_type.
                          example: Product
                          type: string
                        pinned:
                          description: >-
                            Whether this definition should be prominently
                            displayed or prioritized in admin interfaces and
                            forms.
                          example: false
                          type:
                            - boolean
                            - 'null'
                          default: false
                        position:
                          default: 0
                          description: >-
                            Sort order for displaying this definition relative
                            to others in the same category and owner_resource.
                            Lower numbers appear first.
                          example: 1
                          type:
                            - integer
                            - 'null'
                        locked:
                          description: >-
                            Whether this metafield definition is locked,
                            preventing direct updates or deletions of metafields
                            using this definition.
                          example: false
                          type:
                            - boolean
                            - 'null'
                          default: false
                        created_at:
                          description: Timestamp when the metafield definition was created.
                          example: '2024-01-15T10:30:00Z'
                          type: string
                          format: date-time
                        updated_at:
                          description: >-
                            Timestamp when the metafield definition was last
                            updated.
                          example: '2024-02-20T14:45:00Z'
                          type: string
                          format: date-time
                        list_type:
                          description: >-
                            Whether this definition is for list-type metafields
                            that store arrays of values.
                          example: false
                          type: boolean
                        reference_type:
                          description: >-
                            Whether this definition is for reference-type
                            metafields that store references to other resources.
                          example: false
                          type: boolean
                        supported_validations:
                          description: >-
                            Array of validation rule names that are supported
                            for this value_type.
                          example:
                            - min
                            - max
                            - choices
                            - regex
                          type: array
                        validation_description:
                          description: >-
                            Human-readable description of what the value_type
                            represents and its constraints.
                          example: Single line text up to 5000 characters
                          type: string
                        category_ids:
                          description: >-
                            Array of category IDs that this metafield definition
                            is associated with for organizational purposes.
                          example:
                            - 1
                            - 2
                            - 3
                          items:
                            type: integer
                          type: array
                        metafields_count:
                          description: >-
                            Number of metafields currently using this definition
                            (includes both legacy and embedded metafields).
                          example: 42
                          type: integer
                      required:
                        - id
                        - company_id
                        - namespace
                        - key
                        - name
                        - value_type
                        - owner_resource
                        - created_at
                        - updated_at
                        - list_type
                        - reference_type
                        - supported_validations
                        - validation_description
                        - category_ids
                        - metafields_count
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      pagination:
                        type: object
                        properties:
                          current_page:
                            type: integer
                            example: 1
                          total_pages:
                            type: integer
                            example: 10
                          total_count:
                            type: integer
                            example: 100
                          per_page:
                            type: integer
                            example: 10
        '422':
          description: Invalid parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
    post:
      summary: Create a metafield definition
      tags:
        - Metafield Definitions
      operationId: createMetafieldDefinition
      description: Create a new metafield definition
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: Metafield definition created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  metafield_definition:
                    title: MetafieldDefinition
                    type: object
                    properties:
                      id:
                        type: integer
                      company_id:
                        description: >-
                          The ID of the company that owns this metafield
                          definition.
                        example: 1
                        type: integer
                      namespace:
                        description: >-
                          A container for related metafield definitions. Used to
                          group definitions by app or functionality. Must be
                          unique within company and owner_resource.
                        example: product_details
                        type: string
                        maxLength: 20
                        pattern: ^[a-zA-Z0-9_]+$
                      key:
                        description: >-
                          The unique identifier for the metafield definition
                          within its namespace and owner_resource. Combined with
                          namespace and owner_resource, this must be unique per
                          company.
                        example: material_type
                        type: string
                        maxLength: 30
                        pattern: ^[a-zA-Z0-9_]+$
                      name:
                        description: >-
                          Human-readable display name for the metafield
                          definition, shown in admin interfaces and forms.
                        example: Material Type
                        type: string
                        maxLength: 100
                      description:
                        description: >-
                          Detailed explanation of what this metafield definition
                          represents, how it should be used, and any special
                          instructions for content creators.
                        example: >-
                          Specify the primary material composition of the
                          product (e.g., cotton, polyester, silk). This will be
                          displayed on the product detail page.
                        type:
                          - string
                          - 'null'
                      value_type:
                        description: >-
                          The data type that defines how metafield values should
                          be validated, stored, and displayed. Determines which
                          validation rules are available.
                        example: single_line_text_field
                        type: string
                      validation_rules:
                        description: >-
                          JSON object containing validation constraints that
                          will be applied to metafield values. Available rules
                          depend on the value_type.
                        example:
                          choices:
                            - cotton
                            - polyester
                            - silk
                            - wool
                            - linen
                            - bamboo
                          max: 50
                          min: 2
                        type:
                          - object
                          - 'null'
                      owner_resource:
                        description: >-
                          The type of resource (model class name) that
                          metafields using this definition can be attached to.
                          Must match the polymorphic owner_type.
                        example: Product
                        type: string
                      pinned:
                        description: >-
                          Whether this definition should be prominently
                          displayed or prioritized in admin interfaces and
                          forms.
                        example: false
                        type:
                          - boolean
                          - 'null'
                        default: false
                      position:
                        default: 0
                        description: >-
                          Sort order for displaying this definition relative to
                          others in the same category and owner_resource. Lower
                          numbers appear first.
                        example: 1
                        type:
                          - integer
                          - 'null'
                      locked:
                        description: >-
                          Whether this metafield definition is locked,
                          preventing direct updates or deletions of metafields
                          using this definition.
                        example: false
                        type:
                          - boolean
                          - 'null'
                        default: false
                      created_at:
                        description: Timestamp when the metafield definition was created.
                        example: '2024-01-15T10:30:00Z'
                        type: string
                        format: date-time
                      updated_at:
                        description: >-
                          Timestamp when the metafield definition was last
                          updated.
                        example: '2024-02-20T14:45:00Z'
                        type: string
                        format: date-time
                      list_type:
                        description: >-
                          Whether this definition is for list-type metafields
                          that store arrays of values.
                        example: false
                        type: boolean
                      reference_type:
                        description: >-
                          Whether this definition is for reference-type
                          metafields that store references to other resources.
                        example: false
                        type: boolean
                      supported_validations:
                        description: >-
                          Array of validation rule names that are supported for
                          this value_type.
                        example:
                          - min
                          - max
                          - choices
                          - regex
                        type: array
                      validation_description:
                        description: >-
                          Human-readable description of what the value_type
                          represents and its constraints.
                        example: Single line text up to 5000 characters
                        type: string
                      category_ids:
                        description: >-
                          Array of category IDs that this metafield definition
                          is associated with for organizational purposes.
                        example:
                          - 1
                          - 2
                          - 3
                        items:
                          type: integer
                        type: array
                    required:
                      - id
                      - company_id
                      - namespace
                      - key
                      - name
                      - value_type
                      - owner_resource
                      - created_at
                      - updated_at
                      - list_type
                      - reference_type
                      - supported_validations
                      - validation_description
                      - category_ids
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - metafield_definition
        '422':
          description: Unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                metafield_definition:
                  type: object
                  properties:
                    namespace:
                      type: string
                      description: >-
                        Namespace for the metafield definition (alphanumeric and
                        underscores only)
                      example: product_specs
                      maxLength: 20
                    key:
                      type: string
                      description: >-
                        Key for the metafield definition (alphanumeric and
                        underscores only)
                      example: material_type
                      maxLength: 30
                    name:
                      type: string
                      description: Display name for the metafield definition
                      example: Material Type
                      maxLength: 100
                    value_type:
                      type: string
                      description: Type of value this metafield will store
                      example: single_line_text_field
                      enum:
                        - single_line_text_field
                        - multi_line_text_field
                        - number_integer
                        - number_decimal
                        - boolean
                        - date
                        - date_time
                        - json
                        - color
                        - url
                        - weight
                        - volume
                        - dimension
                        - rating
                        - money
                        - file_reference
                        - page_reference
                        - product_reference
                        - variant_reference
                        - list.single_line_text_field
                        - list.number_integer
                        - list.color
                        - list.product_reference
                    owner_resource:
                      type: string
                      description: Resource type that owns this metafield definition
                      example: Product
                      enum:
                        - Product
                        - Variant
                        - Customer
                        - Commerce::Order
                        - Post
                        - EnrollmentPack
                        - Medium
                        - Collection
                        - Category
                        - Library
                        - Page
                    description:
                      type: string
                      description: Optional description of the metafield definition
                      example: The primary material used in manufacturing this product
                    category_ids:
                      type: array
                      items:
                        type: integer
                      description: >-
                        Optional array of category IDs for organizing metafield
                        definitions
                      example:
                        - 1
                        - 2
                    pinned:
                      type: boolean
                      description: >-
                        Whether this metafield definition should be pinned for
                        easy access
                      example: false
                      default: false
                    position:
                      type: integer
                      description: Position for ordering metafield definitions
                      example: 1
                    validation_rules:
                      type: object
                      description: Optional validation rules for the metafield values
                      example:
                        min: 1
                        max: 100
                        choices:
                          - small
                          - medium
                          - large
                    locked:
                      type: boolean
                      description: >-
                        Whether this metafield definition is locked, preventing
                        direct updates or deletions of metafields using this
                        definition
                      example: false
                      default: false
                  required:
                    - namespace
                    - key
                    - name
                    - value_type
                    - owner_resource
              required:
                - metafield_definition
  /api/v2/metafield_definitions/{id}:
    get:
      summary: Get a metafield definition
      tags:
        - Metafield Definitions
      operationId: getMetafieldDefinition
      description: Retrieve a single metafield definition by ID
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: The ID of the metafield definition to retrieve
          example: 123
          schema:
            type: integer
      responses:
        '200':
          description: Metafield definition retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  metafield_definition:
                    title: MetafieldDefinition
                    type: object
                    properties:
                      id:
                        type: integer
                      company_id:
                        description: >-
                          The ID of the company that owns this metafield
                          definition.
                        example: 1
                        type: integer
                      namespace:
                        description: >-
                          A container for related metafield definitions. Used to
                          group definitions by app or functionality. Must be
                          unique within company and owner_resource.
                        example: product_details
                        type: string
                        maxLength: 20
                        pattern: ^[a-zA-Z0-9_]+$
                      key:
                        description: >-
                          The unique identifier for the metafield definition
                          within its namespace and owner_resource. Combined with
                          namespace and owner_resource, this must be unique per
                          company.
                        example: material_type
                        type: string
                        maxLength: 30
                        pattern: ^[a-zA-Z0-9_]+$
                      name:
                        description: >-
                          Human-readable display name for the metafield
                          definition, shown in admin interfaces and forms.
                        example: Material Type
                        type: string
                        maxLength: 100
                      description:
                        description: >-
                          Detailed explanation of what this metafield definition
                          represents, how it should be used, and any special
                          instructions for content creators.
                        example: >-
                          Specify the primary material composition of the
                          product (e.g., cotton, polyester, silk). This will be
                          displayed on the product detail page.
                        type:
                          - string
                          - 'null'
                      value_type:
                        description: >-
                          The data type that defines how metafield values should
                          be validated, stored, and displayed. Determines which
                          validation rules are available.
                        example: single_line_text_field
                        type: string
                      validation_rules:
                        description: >-
                          JSON object containing validation constraints that
                          will be applied to metafield values. Available rules
                          depend on the value_type.
                        example:
                          choices:
                            - cotton
                            - polyester
                            - silk
                            - wool
                            - linen
                            - bamboo
                          max: 50
                          min: 2
                        type:
                          - object
                          - 'null'
                      owner_resource:
                        description: >-
                          The type of resource (model class name) that
                          metafields using this definition can be attached to.
                          Must match the polymorphic owner_type.
                        example: Product
                        type: string
                      pinned:
                        description: >-
                          Whether this definition should be prominently
                          displayed or prioritized in admin interfaces and
                          forms.
                        example: false
                        type:
                          - boolean
                          - 'null'
                        default: false
                      position:
                        default: 0
                        description: >-
                          Sort order for displaying this definition relative to
                          others in the same category and owner_resource. Lower
                          numbers appear first.
                        example: 1
                        type:
                          - integer
                          - 'null'
                      locked:
                        description: >-
                          Whether this metafield definition is locked,
                          preventing direct updates or deletions of metafields
                          using this definition.
                        example: false
                        type:
                          - boolean
                          - 'null'
                        default: false
                      created_at:
                        description: Timestamp when the metafield definition was created.
                        example: '2024-01-15T10:30:00Z'
                        type: string
                        format: date-time
                      updated_at:
                        description: >-
                          Timestamp when the metafield definition was last
                          updated.
                        example: '2024-02-20T14:45:00Z'
                        type: string
                        format: date-time
                      list_type:
                        description: >-
                          Whether this definition is for list-type metafields
                          that store arrays of values.
                        example: false
                        type: boolean
                      reference_type:
                        description: >-
                          Whether this definition is for reference-type
                          metafields that store references to other resources.
                        example: false
                        type: boolean
                      supported_validations:
                        description: >-
                          Array of validation rule names that are supported for
                          this value_type.
                        example:
                          - min
                          - max
                          - choices
                          - regex
                        type: array
                      validation_description:
                        description: >-
                          Human-readable description of what the value_type
                          represents and its constraints.
                        example: Single line text up to 5000 characters
                        type: string
                      category_ids:
                        description: >-
                          Array of category IDs that this metafield definition
                          is associated with for organizational purposes.
                        example:
                          - 1
                          - 2
                          - 3
                        items:
                          type: integer
                        type: array
                    required:
                      - id
                      - company_id
                      - namespace
                      - key
                      - name
                      - value_type
                      - owner_resource
                      - created_at
                      - updated_at
                      - list_type
                      - reference_type
                      - supported_validations
                      - validation_description
                      - category_ids
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - metafield_definition
        '404':
          description: Metafield definition not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
    patch:
      summary: Update a metafield definition
      tags:
        - Metafield Definitions
      operationId: updateMetafieldDefinition
      description: >-
        Update a metafield definition. Only name, description, category_ids,
        pinned, position, and locked can be updated.
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: The ID of the metafield definition to update
          example: 123
          schema:
            type: integer
      responses:
        '200':
          description: Metafield definition updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  metafield_definition:
                    title: MetafieldDefinition
                    type: object
                    properties:
                      id:
                        type: integer
                      company_id:
                        description: >-
                          The ID of the company that owns this metafield
                          definition.
                        example: 1
                        type: integer
                      namespace:
                        description: >-
                          A container for related metafield definitions. Used to
                          group definitions by app or functionality. Must be
                          unique within company and owner_resource.
                        example: product_details
                        type: string
                        maxLength: 20
                        pattern: ^[a-zA-Z0-9_]+$
                      key:
                        description: >-
                          The unique identifier for the metafield definition
                          within its namespace and owner_resource. Combined with
                          namespace and owner_resource, this must be unique per
                          company.
                        example: material_type
                        type: string
                        maxLength: 30
                        pattern: ^[a-zA-Z0-9_]+$
                      name:
                        description: >-
                          Human-readable display name for the metafield
                          definition, shown in admin interfaces and forms.
                        example: Material Type
                        type: string
                        maxLength: 100
                      description:
                        description: >-
                          Detailed explanation of what this metafield definition
                          represents, how it should be used, and any special
                          instructions for content creators.
                        example: >-
                          Specify the primary material composition of the
                          product (e.g., cotton, polyester, silk). This will be
                          displayed on the product detail page.
                        type:
                          - string
                          - 'null'
                      value_type:
                        description: >-
                          The data type that defines how metafield values should
                          be validated, stored, and displayed. Determines which
                          validation rules are available.
                        example: single_line_text_field
                        type: string
                      validation_rules:
                        description: >-
                          JSON object containing validation constraints that
                          will be applied to metafield values. Available rules
                          depend on the value_type.
                        example:
                          choices:
                            - cotton
                            - polyester
                            - silk
                            - wool
                            - linen
                            - bamboo
                          max: 50
                          min: 2
                        type:
                          - object
                          - 'null'
                      owner_resource:
                        description: >-
                          The type of resource (model class name) that
                          metafields using this definition can be attached to.
                          Must match the polymorphic owner_type.
                        example: Product
                        type: string
                      pinned:
                        description: >-
                          Whether this definition should be prominently
                          displayed or prioritized in admin interfaces and
                          forms.
                        example: false
                        type:
                          - boolean
                          - 'null'
                        default: false
                      position:
                        default: 0
                        description: >-
                          Sort order for displaying this definition relative to
                          others in the same category and owner_resource. Lower
                          numbers appear first.
                        example: 1
                        type:
                          - integer
                          - 'null'
                      locked:
                        description: >-
                          Whether this metafield definition is locked,
                          preventing direct updates or deletions of metafields
                          using this definition.
                        example: false
                        type:
                          - boolean
                          - 'null'
                        default: false
                      created_at:
                        description: Timestamp when the metafield definition was created.
                        example: '2024-01-15T10:30:00Z'
                        type: string
                        format: date-time
                      updated_at:
                        description: >-
                          Timestamp when the metafield definition was last
                          updated.
                        example: '2024-02-20T14:45:00Z'
                        type: string
                        format: date-time
                      list_type:
                        description: >-
                          Whether this definition is for list-type metafields
                          that store arrays of values.
                        example: false
                        type: boolean
                      reference_type:
                        description: >-
                          Whether this definition is for reference-type
                          metafields that store references to other resources.
                        example: false
                        type: boolean
                      supported_validations:
                        description: >-
                          Array of validation rule names that are supported for
                          this value_type.
                        example:
                          - min
                          - max
                          - choices
                          - regex
                        type: array
                      validation_description:
                        description: >-
                          Human-readable description of what the value_type
                          represents and its constraints.
                        example: Single line text up to 5000 characters
                        type: string
                      category_ids:
                        description: >-
                          Array of category IDs that this metafield definition
                          is associated with for organizational purposes.
                        example:
                          - 1
                          - 2
                          - 3
                        items:
                          type: integer
                        type: array
                    required:
                      - id
                      - company_id
                      - namespace
                      - key
                      - name
                      - value_type
                      - owner_resource
                      - created_at
                      - updated_at
                      - list_type
                      - reference_type
                      - supported_validations
                      - validation_description
                      - category_ids
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - metafield_definition
        '404':
          description: Metafield definition not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: Validation failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                metafield_definition:
                  type: object
                  properties:
                    name:
                      type: string
                      description: Display name for the metafield definition
                      example: Updated Material Type
                      maxLength: 100
                    description:
                      type: string
                      description: Description of the metafield definition
                      example: Updated description for the material type field
                    category_ids:
                      type: array
                      items:
                        type: integer
                      description: >-
                        Array of category IDs for organizing metafield
                        definitions. To remove any attachment, send an empty
                        array.
                      example:
                        - 1
                        - 2
                    pinned:
                      type: boolean
                      description: >-
                        Whether this metafield definition should be pinned for
                        easy access
                      example: true
                    position:
                      type: integer
                      description: Position for ordering metafield definitions
                      example: 5
                    locked:
                      type: boolean
                      description: >-
                        Whether this metafield definition is locked, preventing
                        direct updates or deletions of metafields using this
                        definition
                      example: true
              required:
                - metafield_definition
    delete:
      summary: Delete a metafield definition
      tags:
        - Metafield Definitions
      operationId: deleteMetafieldDefinition
      description: Delete a metafield definition by ID
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: The ID of the metafield definition to delete
          example: 123
          schema:
            type: integer
      responses:
        '200':
          description: Metafield definition deleted successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                    description: ID of the deleted metafield definition
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - id
        '404':
          description: Metafield definition not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/v2/metafield_definitions/supported_data_types:
    get:
      summary: Get supported data types
      tags:
        - Metafield Definitions
      operationId: getSupportedDataTypes
      description: >-
        Retrieve a list of all supported data types for metafield definitions
        along with their descriptions and supported validations
      security:
        - bearer_auth: []
      responses:
        '200':
          description: Supported data types retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  supported_data_types:
                    type: array
                    items:
                      type: object
                      properties:
                        value_type:
                          type: string
                          description: The value type identifier
                          example: single_line_text_field
                        description:
                          type: string
                          description: Human-readable description of the data type
                          example: Single line text field for short text values
                        supported_validations:
                          type: array
                          description: List of validation rules supported by this data type
                          items:
                            type: object
                            properties:
                              key:
                                type: string
                                description: The validation rule key
                                example: min
                              description:
                                type:
                                  - string
                                  - 'null'
                                description: Description of what this validation rule does
                                example: Minimum length for text fields
                            required:
                              - key
                              - description
                      required:
                        - value_type
                        - description
                        - supported_validations
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - supported_data_types
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
  /api/v2/metafields:
    post:
      summary: Create a metafield for a resource
      tags:
        - Metafields
      operationId: createMetafield
      description: Create a new metafield for a specific resource
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: metafield created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  metafield:
                    title: EmbeddedMetafield
                    type: object
                    properties:
                      namespace:
                        description: >-
                          A container for related metafields. Commonly used to
                          group metafields by app or functionality.
                        example: custom
                        type: string
                      key:
                        description: >-
                          The unique identifier for the metafield within its
                          namespace. Must be unique per namespace and owner.
                        example: material
                        type: string
                      value:
                        description: >-
                          The actual data stored in the metafield. Type depends
                          on value_type.
                        example: cotton
                        type:
                          - string
                          - integer
                          - object
                          - boolean
                          - number
                      value_type:
                        description: >-
                          The data type that defines how the value should be
                          interpreted and validated.
                        example: single_line_text_field
                        type: string
                      description:
                        description: >-
                          Optional human-readable description explaining the
                          purpose of this metafield.
                        example: The primary material used in this product
                        type:
                          - string
                          - 'null'
                      created_at:
                        description: Timestamp when the metafield was created.
                        example: '2021-01-01T00:00:00Z'
                        type: string
                      updated_at:
                        description: Timestamp when the metafield was last updated.
                        example: '2021-01-01T00:00:00Z'
                        type: string
                      locked:
                        description: >-
                          Whether this metafield is locked and cannot be updated
                          or deleted directly.
                        example: false
                        type:
                          - boolean
                          - 'null'
                          - 'null'
                    required:
                      - namespace
                      - key
                      - value
                      - value_type
                      - description
                      - created_at
                      - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - metafield
                  - meta
        '401':
          description: Unauthorized - Invalid credentials
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '404':
          description: resource not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: missing required parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                resource_type:
                  type: string
                  enum:
                    - category
                    - collection
                    - customer
                    - enrollment_pack
                    - library
                    - medium
                    - order
                    - page
                    - post
                    - product
                    - variant
                  example: product
                  description: Type of resource to create metafield for
                resource_id:
                  type: integer
                  example: 123
                  description: ID of the resource
                namespace:
                  type: string
                  example: seo
                  description: >-
                    Namespace for the metafield (max 20 characters, alphanumeric
                    and underscores only)
                key:
                  type: string
                  example: title
                  description: >-
                    Key for the metafield (max 30 characters, alphanumeric and
                    underscores only)
                value:
                  oneOf:
                    - type: string
                    - type: integer
                    - type: boolean
                    - type: object
                    - type: array
                  example: SEO Title
                  description: The value to store in the metafield
                value_type:
                  type: string
                  example: single_line_text_field
                  description: The type that defines how the value should be interpreted
                description:
                  type: string
                  example: Page title for SEO purposes
                  description: Optional description of the metafield's purpose
              required:
                - resource_type
                - resource_id
                - namespace
                - key
                - value
                - value_type
    delete:
      summary: Delete a metafield for a resource
      tags:
        - Metafields
      operationId: destroyMetafield
      description: Delete an existing metafield for a specific resource
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: metafield deleted successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Metafield deleted successfully
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - message
                  - meta
        '401':
          description: Unauthorized - Invalid credentials
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '404':
          description: metafield not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: missing required parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                resource_type:
                  type: string
                  enum:
                    - category
                    - collection
                    - customer
                    - enrollment_pack
                    - library
                    - medium
                    - order
                    - page
                    - post
                    - product
                    - variant
                  example: product
                  description: Type of resource to delete metafield from
                resource_id:
                  type: integer
                  example: 123
                  description: ID of the resource
                namespace:
                  type: string
                  example: seo
                  description: Namespace of the metafield to delete
                key:
                  type: string
                  example: title
                  description: Key of the metafield to delete
              required:
                - resource_type
                - resource_id
                - namespace
                - key
    get:
      summary: List metafields for a resource
      tags:
        - Metafields
      operationId: listMetafields
      description: Retrieve all metafields associated with a specific resource
      security:
        - bearer_auth: []
      parameters:
        - name: resource_type
          in: query
          required: true
          schema:
            type: string
            enum:
              - category
              - collection
              - customer
              - enrollment_pack
              - library
              - medium
              - order
              - page
              - post
              - product
              - variant
          example: product
          description: Type of resource to get metafields for
        - name: resource_id
          in: query
          required: true
          description: ID of the resource
          schema:
            type: integer
        - name: page
          in: query
          required: false
          description: 'Page number for pagination (default: 1)'
          schema:
            type: integer
        - name: per_page
          in: query
          required: false
          description: 'Number of items per page (default: 25)'
          schema:
            type: integer
      responses:
        '200':
          description: metafields retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  metafields:
                    type: array
                    items:
                      title: EmbeddedMetafield
                      type: object
                      properties:
                        namespace:
                          description: >-
                            A container for related metafields. Commonly used to
                            group metafields by app or functionality.
                          example: custom
                          type: string
                        key:
                          description: >-
                            The unique identifier for the metafield within its
                            namespace. Must be unique per namespace and owner.
                          example: material
                          type: string
                        value:
                          description: >-
                            The actual data stored in the metafield. Type
                            depends on value_type.
                          example: cotton
                          type:
                            - string
                            - integer
                            - object
                            - boolean
                            - number
                        value_type:
                          description: >-
                            The data type that defines how the value should be
                            interpreted and validated.
                          example: single_line_text_field
                          type: string
                        description:
                          description: >-
                            Optional human-readable description explaining the
                            purpose of this metafield.
                          example: The primary material used in this product
                          type:
                            - string
                            - 'null'
                        created_at:
                          description: Timestamp when the metafield was created.
                          example: '2021-01-01T00:00:00Z'
                          type: string
                        updated_at:
                          description: Timestamp when the metafield was last updated.
                          example: '2021-01-01T00:00:00Z'
                          type: string
                        locked:
                          description: >-
                            Whether this metafield is locked and cannot be
                            updated or deleted directly.
                          example: false
                          type:
                            - boolean
                            - 'null'
                            - 'null'
                      required:
                        - namespace
                        - key
                        - value
                        - value_type
                        - description
                        - created_at
                        - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      pagination:
                        type: object
                        properties:
                          current_page:
                            type: integer
                            example: 1
                          total_pages:
                            type: integer
                            example: 10
                          total_count:
                            type: integer
                            example: 100
                          per_page:
                            type: integer
                            example: 10
                required:
                  - metafields
                  - meta
        '401':
          description: Unauthorized - Invalid credentials
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '404':
          description: resource not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: missing parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/v2/metafields/show:
    get:
      summary: Get a specific metafield
      tags:
        - Metafields
      operationId: showMetafield
      description: Retrieve a specific metafield by namespace and key for a given resource
      security:
        - bearer_auth: []
      parameters:
        - name: resource_type
          in: query
          required: true
          schema:
            type: string
            enum:
              - category
              - collection
              - customer
              - enrollment_pack
              - library
              - medium
              - order
              - page
              - post
              - product
              - variant
          example: product
          description: Type of resource the metafield belongs to
        - name: resource_id
          in: query
          required: true
          description: ID of the resource
          schema:
            type: integer
        - name: namespace
          in: query
          required: true
          example: seo
          description: Namespace of the metafield
          schema:
            type: string
        - name: key
          in: query
          required: true
          example: title
          description: Key of the metafield
          schema:
            type: string
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  metafield:
                    title: EmbeddedMetafield
                    type: object
                    properties:
                      namespace:
                        description: >-
                          A container for related metafields. Commonly used to
                          group metafields by app or functionality.
                        example: custom
                        type: string
                      key:
                        description: >-
                          The unique identifier for the metafield within its
                          namespace. Must be unique per namespace and owner.
                        example: material
                        type: string
                      value:
                        description: >-
                          The actual data stored in the metafield. Type depends
                          on value_type.
                        example: cotton
                        type:
                          - string
                          - integer
                          - object
                          - boolean
                          - number
                      value_type:
                        description: >-
                          The data type that defines how the value should be
                          interpreted and validated.
                        example: single_line_text_field
                        type: string
                      description:
                        description: >-
                          Optional human-readable description explaining the
                          purpose of this metafield.
                        example: The primary material used in this product
                        type:
                          - string
                          - 'null'
                      created_at:
                        description: Timestamp when the metafield was created.
                        example: '2021-01-01T00:00:00Z'
                        type: string
                      updated_at:
                        description: Timestamp when the metafield was last updated.
                        example: '2021-01-01T00:00:00Z'
                        type: string
                      locked:
                        description: >-
                          Whether this metafield is locked and cannot be updated
                          or deleted directly.
                        example: false
                        type:
                          - boolean
                          - 'null'
                          - 'null'
                    required:
                      - namespace
                      - key
                      - value
                      - value_type
                      - description
                      - created_at
                      - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - metafield
                  - meta
        '401':
          description: Unauthorized - Invalid credentials
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '404':
          description: metafield not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: missing parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/v2/metafields/update_locked:
    patch:
      summary: Update a locked metafield for a resource
      tags:
        - Metafields
      operationId: updateLockedMetafield
      description: >-
        Update a locked metafield for a specific resource. This endpoint is
        specifically designed to update metafields that have been locked via
        their metafield definition. When a locked metafield is updated, a
        customer note is automatically created to track the change.
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: locked metafield updated successfully and customer note created
          content:
            application/json:
              schema:
                type: object
                properties:
                  metafield:
                    title: EmbeddedMetafield
                    type: object
                    properties:
                      namespace:
                        description: >-
                          A container for related metafields. Commonly used to
                          group metafields by app or functionality.
                        example: custom
                        type: string
                      key:
                        description: >-
                          The unique identifier for the metafield within its
                          namespace. Must be unique per namespace and owner.
                        example: material
                        type: string
                      value:
                        description: >-
                          The actual data stored in the metafield. Type depends
                          on value_type.
                        example: cotton
                        type:
                          - string
                          - integer
                          - object
                          - boolean
                          - number
                      value_type:
                        description: >-
                          The data type that defines how the value should be
                          interpreted and validated.
                        example: single_line_text_field
                        type: string
                      description:
                        description: >-
                          Optional human-readable description explaining the
                          purpose of this metafield.
                        example: The primary material used in this product
                        type:
                          - string
                          - 'null'
                      created_at:
                        description: Timestamp when the metafield was created.
                        example: '2021-01-01T00:00:00Z'
                        type: string
                      updated_at:
                        description: Timestamp when the metafield was last updated.
                        example: '2021-01-01T00:00:00Z'
                        type: string
                      locked:
                        description: >-
                          Whether this metafield is locked and cannot be updated
                          or deleted directly.
                        example: false
                        type:
                          - boolean
                          - 'null'
                          - 'null'
                    required:
                      - namespace
                      - key
                      - value
                      - value_type
                      - description
                      - created_at
                      - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - metafield
                  - meta
        '401':
          description: Unauthorized - Invalid credentials
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '404':
          description: metafield not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: missing required parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                resource_type:
                  type: string
                  enum:
                    - category
                    - collection
                    - customer
                    - enrollment_pack
                    - library
                    - medium
                    - order
                    - page
                    - post
                    - product
                    - variant
                  example: order
                  description: Type of resource to update locked metafield for
                resource_id:
                  type: integer
                  example: 123
                  description: ID of the resource
                namespace:
                  type: string
                  example: system
                  description: >-
                    Namespace for the metafield (max 20 characters, alphanumeric
                    and underscores only)
                key:
                  type: string
                  example: enrollment_status
                  description: >-
                    Key for the metafield (max 30 characters, alphanumeric and
                    underscores only)
                value:
                  oneOf:
                    - type: string
                    - type: integer
                    - type: boolean
                    - type: object
                    - type: array
                  example: active
                  description: The updated value to store in the locked metafield
                value_type:
                  type: string
                  example: single_line_text_field
                  description: The type that defines how the value should be interpreted
                description:
                  type: string
                  example: Updated enrollment status
                  description: Optional description of the metafield's purpose
              required:
                - resource_type
                - resource_id
                - namespace
                - key
                - value
                - value_type
  /api/v2/metafields/update:
    patch:
      summary: Update a metafield for a resource
      tags:
        - Metafields
      operationId: updateMetafield
      description: Update an existing metafield for a specific resource
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: metafield updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  metafield:
                    title: EmbeddedMetafield
                    type: object
                    properties:
                      namespace:
                        description: >-
                          A container for related metafields. Commonly used to
                          group metafields by app or functionality.
                        example: custom
                        type: string
                      key:
                        description: >-
                          The unique identifier for the metafield within its
                          namespace. Must be unique per namespace and owner.
                        example: material
                        type: string
                      value:
                        description: >-
                          The actual data stored in the metafield. Type depends
                          on value_type.
                        example: cotton
                        type:
                          - string
                          - integer
                          - object
                          - boolean
                          - number
                      value_type:
                        description: >-
                          The data type that defines how the value should be
                          interpreted and validated.
                        example: single_line_text_field
                        type: string
                      description:
                        description: >-
                          Optional human-readable description explaining the
                          purpose of this metafield.
                        example: The primary material used in this product
                        type:
                          - string
                          - 'null'
                      created_at:
                        description: Timestamp when the metafield was created.
                        example: '2021-01-01T00:00:00Z'
                        type: string
                      updated_at:
                        description: Timestamp when the metafield was last updated.
                        example: '2021-01-01T00:00:00Z'
                        type: string
                      locked:
                        description: >-
                          Whether this metafield is locked and cannot be updated
                          or deleted directly.
                        example: false
                        type:
                          - boolean
                          - 'null'
                          - 'null'
                    required:
                      - namespace
                      - key
                      - value
                      - value_type
                      - description
                      - created_at
                      - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - metafield
                  - meta
        '401':
          description: Unauthorized - Invalid credentials
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '404':
          description: metafield not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: missing required parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                resource_type:
                  type: string
                  enum:
                    - category
                    - collection
                    - customer
                    - enrollment_pack
                    - library
                    - medium
                    - order
                    - page
                    - post
                    - product
                    - variant
                  example: product
                  description: Type of resource to update metafield for
                resource_id:
                  type: integer
                  example: 123
                  description: ID of the resource
                namespace:
                  type: string
                  example: seo
                  description: >-
                    Namespace for the metafield (max 20 characters, alphanumeric
                    and underscores only)
                key:
                  type: string
                  example: title
                  description: >-
                    Key for the metafield (max 30 characters, alphanumeric and
                    underscores only)
                value:
                  oneOf:
                    - type: string
                    - type: integer
                    - type: boolean
                    - type: object
                    - type: array
                  example: Updated SEO Title
                  description: The updated value to store in the metafield
                value_type:
                  type: string
                  example: single_line_text_field
                  description: The type that defines how the value should be interpreted
                description:
                  type: string
                  example: Updated page title for SEO purposes
                  description: Optional description of the metafield's purpose
              required:
                - resource_type
                - resource_id
                - namespace
                - key
                - value
                - value_type
  /api/company/mobile_widgets:
    get:
      summary: Retrieve a paginated list of mobile widgets
      description: Retrieves a paginated list of mobile widgets.
      tags:
        - Mobile Widgets
      operationId: listMobileWidgets
      security:
        - bearer_auth: []
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            default: 1
          required: false
          description: Page number
        - name: per_page
          in: query
          schema:
            type: integer
            default: 20
          required: false
          description: Number of items per page
      responses:
        '200':
          description: mobile widgets retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  mobile_widgets:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 48
                        company_id:
                          type: integer
                          example: 298486374
                        name:
                          type: string
                          example: MWidget
                        embed_url:
                          type: string
                          example: https://unseenktm.com
                        height:
                          type: integer
                          example: 500
                          minimum: 100
                          maximum: 1000
                        cover_image_url:
                          type: string
                          example: https://www.example.com/test.jpg
                        page_scope:
                          type: object
                          properties:
                            home:
                              type: boolean
                              example: true
                            explore:
                              type: boolean
                              example: false
                        droplet_installation_id:
                          type:
                            - integer
                            - 'null'
                          example: 825425119
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: fcca8c13-a8de-4632-a3ef-4374f0dee632
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-05-19T20:01:35Z'
                      total_count:
                        type: integer
                        example: 1
                      total_pages:
                        type: integer
                        example: 1
                      current_page:
                        type: integer
                        example: 1
        '401':
          description: unauthorized
    post:
      summary: Create a new mobile widget
      description: Creates a new mobile widget for the company.
      tags:
        - Mobile Widgets
      operationId: createMobileWidget
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: mobile widget created
          content:
            application/json:
              schema:
                type: object
                properties:
                  mobile_widget:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 48
                      company_id:
                        type: integer
                        example: 298486374
                      name:
                        type: string
                        example: MWidget
                      embed_url:
                        type: string
                        example: https://unseenktm.com
                      height:
                        type: integer
                        example: 500
                        minimum: 100
                        maximum: 1000
                      cover_image_url:
                        type: string
                        example: https://www.example.com/test.jpg
                      page_scope:
                        type: object
                        properties:
                          home:
                            type: boolean
                            example: true
                          explore:
                            type: boolean
                            example: false
                      droplet_installation_id:
                        type:
                          - integer
                          - 'null'
                        example: 825425119
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 78559f54-b876-4a62-b69f-ed95355fe1d7
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-05-19T20:02:43Z'
        '401':
          description: unauthorized
        '422':
          description: invalid request
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  example: MWidget
                embed_url:
                  type: string
                  example: https://unseenktm.com
                height:
                  type: integer
                  example: 190
                  minimum: 100
                  maximum: 1000
                cover_image_url:
                  type: string
                  example: https://www.example.com/test.jpg
                page_scope:
                  type: object
                  properties:
                    home:
                      type: boolean
                      example: true
                    explore:
                      type: boolean
                      example: false
              required:
                - name
                - embed_url
                - height
                - cover_image_url
  /api/company/mobile_widgets/{id}:
    get:
      summary: Retrieve a specific mobile widget
      description: Retrieves a specific mobile widget by ID.
      tags:
        - Mobile Widgets
      operationId: getMobileWidget
      security:
        - bearer_auth: []
      responses:
        '200':
          description: mobile widget found
        '401':
          description: unauthorized
        '404':
          description: not found
    put:
      summary: Update a mobile widget
      description: Updates an existing mobile widget.
      tags:
        - Mobile Widgets
      operationId: updateMobileWidget
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: mobile widget updated
        '401':
          description: unauthorized
        '404':
          description: not found
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  example: Updated Widget
                embed_url:
                  type: string
                  example: updated.com
                height:
                  type: integer
                  example: 200
                  minimum: 100
                  maximum: 1000
                cover_image_url:
                  type: string
                  example: https://www.example.com/test.jpg
                page_scope:
                  type: object
                  properties:
                    home:
                      type: boolean
                      example: true
                    explore:
                      type: boolean
                      example: false
                droplet_installation_id:
                  type:
                    - integer
                    - 'null'
                  example: 825425119
              required: []
    delete:
      summary: Delete a mobile widget
      description: Deletes a mobile widget.
      tags:
        - Mobile Widgets
      operationId: deleteMobileWidget
      security:
        - bearer_auth: []
      responses:
        '200':
          description: mobile widget deleted
        '401':
          description: unauthorized
        '404':
          description: not found
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
  /api/multi_factor_authentications:
    get:
      summary: List MFA records for a specific user
      tags:
        - Multi-Factor Authentications
      parameters:
        - name: multi_factorable_id
          in: query
          required: true
          description: ID of the associated model
          schema:
            type: string
        - name: page
          in: query
          required: false
          description: Page number for pagination
          schema:
            type: integer
        - name: per_page
          in: query
          required: false
          description: Number of records per page
          schema:
            type: integer
        - name: search_query
          in: query
          required: false
          description: Search term for filtering by verification channel
          schema:
            type: string
        - name: sort_by
          in: query
          required: false
          description: Column to sort by (created_at, verification_channel, authenticated)
          schema:
            type: string
        - name: sort_direction
          in: query
          required: false
          description: Sort direction (asc, desc)
          schema:
            type: string
      responses:
        '200':
          description: MFA records retrieved successfully when passing User ID
          content:
            application/json:
              schema:
                type: object
                properties:
                  multi_factor_authentications:
                    type: array
                    items:
                      title: MultiFactorAuthentication
                      type: object
                      properties:
                        uuid:
                          type: string
                        verification_channel:
                          type: string
                        authenticated:
                          type: boolean
                          default: false
                        created_at:
                          type: string
                          format: date-time
                        verification_code:
                          type:
                            - string
                            - 'null'
                        verification_code_expires_at:
                          type:
                            - string
                            - 'null'
                          format: date-time
                      required:
                        - uuid
                        - verification_channel
                        - authenticated
                        - created_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                      pagination:
                        type: object
                        properties:
                          total_count:
                            type: integer
                          current_page:
                            type: integer
                          per_page:
                            type: integer
                        required:
                          - total_count
                          - current_page
                          - per_page
                    required:
                      - request_id
                      - timestamp
                      - pagination
                required:
                  - multi_factor_authentications
                  - meta
        '422':
          description: Invalid parameters
    post:
      summary: creates a multi-factor authentication
      tags:
        - Multi-Factor Authentications
      operationId: createMultiFactorAuthentication
      parameters: []
      responses:
        '201':
          description: multi-factor authentication created
          content:
            application/json:
              schema:
                type: object
                properties:
                  multi_factor_authentication:
                    title: MultiFactorAuthentication
                    type: object
                    properties:
                      uuid:
                        type: string
                      verification_channel:
                        example: test@example.com
                        type: string
                      verification_code_expires_at:
                        example: '2025-02-17T08:00:01Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      authenticated:
                        example: 'false'
                        type: boolean
                        default: false
                    required:
                      - uuid
                      - verification_channel
                      - authenticated
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: multi-factor authentication not created
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: unprocessable entity
                  errors:
                    type: object
                    properties:
                      multi_factor_authentication:
                        type: object
                        properties:
                          verification_channel:
                            type: array
                            example:
                              - is not one of the allowed channels
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                multi_factor_authentication:
                  type: object
                  properties:
                    multi_factorable_type:
                      type: string
                      minLength: 1
                    multi_factorable_id: {}
                    verification_channel:
                      type: string
                      minLength: 1
                    is_invitation:
                      type: boolean
                      not:
                        type: 'null'
                    is_resend:
                      type: boolean
                      not:
                        type: 'null'
                  required:
                    - multi_factorable_type
                    - verification_channel
              required:
                - multi_factor_authentication
  /api/multi_factor_authentications/{uuid}:
    get:
      summary: shows a multi-factor authentication
      tags:
        - Multi-Factor Authentications
      operationId: showMultiFactorAuthentication
      parameters:
        - name: uuid
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: multi-factor authentication shown
          content:
            application/json:
              schema:
                type: object
                properties:
                  multi_factor_authentication:
                    title: MultiFactorAuthentication
                    type: object
                    properties:
                      uuid:
                        type: string
                      multi_factorable_type:
                        type: string
                      multi_factorable_id:
                        type: integer
                      verification_channel:
                        type: string
                      verification_code_expires_at:
                        type:
                          - string
                          - 'null'
                        format: date-time
                      authenticated:
                        type: boolean
                        default: false
                      authentication_token:
                        type:
                          - string
                          - 'null'
                      authentication_token_expires_at:
                        type:
                          - string
                          - 'null'
                        format: date-time
                      created_at:
                        type: string
                        format: date-time
                    required:
                      - uuid
                      - multi_factorable_type
                      - multi_factorable_id
                      - verification_channel
                      - authenticated
                      - created_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '404':
          description: multi-factor authentication not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Multi-factor authentication not found
                  errors:
                    type: object
                    properties:
                      uuid:
                        type: array
                        example:
                          - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - error_message
                  - errors
                  - meta
        '410':
          description: multi-factor authentication token expired
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Multi-factor authentication token expired
                  errors:
                    type: object
                    properties:
                      multi_factor_authentication:
                        type: object
                        properties:
                          authentication_token:
                            type: array
                            example:
                              - expired
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - error_message
                  - errors
                  - meta
    put:
      summary: authenticates a multi-factor authentication
      tags:
        - Multi-Factor Authentications
      operationId: putMultiFactorAuthentication
      parameters:
        - name: uuid
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: multi-factor authentication authenticated
          content:
            application/json:
              schema:
                type: object
                properties:
                  multi_factor_authentication:
                    title: MultiFactorAuthentication
                    type: object
                    properties:
                      uuid:
                        type: string
                      authenticated:
                        type: boolean
                        default: false
                      authentication_token:
                        type:
                          - string
                          - 'null'
                      authentication_token_expires_at:
                        type:
                          - string
                          - 'null'
                        format: date-time
                    required:
                      - uuid
                      - authenticated
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - multi_factor_authentication
        '404':
          description: multi-factor authentication not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Multi-factor authentication not found
                  errors:
                    type: object
                    properties:
                      uuid:
                        type: array
                        example:
                          - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - error_message
                  - errors
                  - meta
        '410':
          description: multi-factor authentication expired
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Multi-factor authentication verification code expired
                  errors:
                    type: object
                    properties:
                      multi_factor_authentication:
                        type: object
                        properties:
                          verification_code:
                            type: array
                            example:
                              - expired
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - error_message
                  - errors
                  - meta
        '422':
          description: multi-factor authentication not authenticated
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid verification code
                  errors:
                    type: object
                    properties:
                      multi_factor_authentication:
                        type: object
                        properties:
                          verification_code:
                            type: array
                            example:
                              - invalid
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                uuid:
                  type: string
                  minLength: 1
                multi_factor_authentication:
                  type: object
                  properties:
                    verification_code:
                      type: string
                      minLength: 1
                  required:
                    - verification_code
              required:
                - uuid
                - multi_factor_authentication
    delete:
      summary: destroys a multi-factor authentication
      tags:
        - Multi-Factor Authentications
      operationId: destroyMultiFactorAuthentication
      parameters:
        - name: uuid
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: multi-factor authentication destroyed
          content:
            application/json:
              schema:
                type: object
                properties:
                  uuid:
                    type: string
                    example: mfa_13m8dhnortslzwqhvqoj9drga9e8eise
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '404':
          description: multi-factor authentication not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Multi-factor authentication not found
                  errors:
                    type: object
                    properties:
                      uuid:
                        type: array
                        example:
                          - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - error_message
                  - errors
                  - meta
  /api/company/notifications:
    get:
      summary: Get notifications for the current user
      tags:
        - Notifications
      operationId: indexCompanyNotifications
      security:
        - bearer_auth: []
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            default: 1
          required: false
          description: Page number for pagination
        - name: per_page
          in: query
          schema:
            type: integer
            default: 25
          required: false
          description: Number of records per page
        - name: read
          in: query
          schema:
            type: boolean
          required: false
          description: Filter by read status (true for read, false for unread)
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  notifications:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 1
                        title:
                          type:
                            - string
                            - 'null'
                          example: New message
                        body:
                          type: string
                          example: You have a new message
                        slug:
                          type:
                            - string
                            - 'null'
                          example: new_message
                        mail_processed_at:
                          type:
                            - string
                            - 'null'
                          format: date_time
                          example: '2025-01-16T04:22:43.809Z'
                        push_processed_at:
                          type:
                            - string
                            - 'null'
                          format: date_time
                          example: '2025-01-16T04:22:43.809Z'
                        created_at:
                          type: string
                          format: date_time
                          example: '2025-01-16T04:22:43.809Z'
                        updated_at:
                          type: string
                          format: date_time
                          example: '2025-01-16T04:22:43.809Z'
                        data:
                          type: object
                          description: Additional data for the notification
                        is_read:
                          type: boolean
                          example: false
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                      total_count:
                        type: integer
                        example: 42
                      total_pages:
                        type: integer
                        example: 3
                      current_page:
                        type: integer
                        example: 1
  /api/v1/onboardings:
    get:
      summary: Get onboarding status
      tags:
        - Onboarding
      operationId: getOnboardingStatus
      security:
        - bearer_auth: []
      responses:
        '200':
          description: onboarding status retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  onboarding:
                    type: object
                    properties:
                      sections:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            name:
                              type: string
                            steps:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                  name:
                                    type: string
                                  description:
                                    type:
                                      - string
                                      - 'null'
                                  status:
                                    type: string
                                    enum:
                                      - pending
                                      - completed
                                      - skipped
                                  time_estimate:
                                    type: integer
                                  allow_manual_completion:
                                    type: boolean
                            progress:
                              type: object
                              properties:
                                completed:
                                  type: integer
                                skipped:
                                  type: integer
                                pending:
                                  type: integer
                                total:
                                  type: integer
                                percentage:
                                  type: integer
                                time_remaining:
                                  type: integer
                                all_done:
                                  type: boolean
                      overall:
                        type: object
                        properties:
                          completed:
                            type: integer
                          skipped:
                            type: integer
                          pending:
                            type: integer
                          total:
                            type: integer
                          percentage:
                            type: integer
                          time_remaining:
                            type: integer
                      completed:
                        type: boolean
                      show_getting_started:
                        type: boolean
                  company_status:
                    type:
                      - string
                      - 'null'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                required:
                  - onboarding
                  - company_status
                  - meta
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
  /api/v1/onboardings/check_step:
    patch:
      summary: Check onboarding step
      tags:
        - Onboarding
      operationId: checkOnboardingStep
      description: >-
        Check if an onboarding step meets completion criteria and automatically
        complete it if eligible. This endpoint modifies state by marking steps
        as completed when they meet their defined criteria.
      security:
        - bearer_auth: []
      parameters:
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  step:
                    type: object
                    properties:
                      section:
                        type: string
                      step_id:
                        type: string
                      step_status:
                        type: string
                        enum:
                          - pending
                          - completed
                          - skipped
                      is_step_complete:
                        type: boolean
                    required:
                      - section
                      - step_id
                      - step_status
                      - is_step_complete
                  onboarding:
                    type: object
                    properties:
                      sections:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            name:
                              type: string
                            steps:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                  name:
                                    type: string
                                  description:
                                    type:
                                      - string
                                      - 'null'
                                  status:
                                    type: string
                                    enum:
                                      - pending
                                      - completed
                                      - skipped
                                  time_estimate:
                                    type: integer
                                  allow_manual_completion:
                                    type: boolean
                            progress:
                              type: object
                              properties:
                                completed:
                                  type: integer
                                skipped:
                                  type: integer
                                pending:
                                  type: integer
                                total:
                                  type: integer
                                percentage:
                                  type: integer
                                time_remaining:
                                  type: integer
                                all_done:
                                  type: boolean
                      overall:
                        type: object
                        properties:
                          completed:
                            type: integer
                          skipped:
                            type: integer
                          pending:
                            type: integer
                          total:
                            type: integer
                          percentage:
                            type: integer
                          time_remaining:
                            type: integer
                      completed:
                        type: boolean
                      show_getting_started:
                        type: boolean
                  company_status:
                    type:
                      - string
                      - 'null'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                required:
                  - step
                  - onboarding
                  - company_status
                  - meta
        '422':
          description: unprocessable entity - invalid step_id
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      section:
                        type: array
                        items:
                          type: string
                      step_id:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                section:
                  type: string
                  example: account
                step_id:
                  type: string
                  example: setup_user_roles
              required:
                - section
                - step_id
  /api/v1/onboardings/complete_step:
    patch:
      summary: Complete onboarding step manually
      tags:
        - Onboarding
      operationId: completeOnboardingStep
      description: >-
        Manually complete an onboarding step. This endpoint can only be used for
        steps that have 'allow_manual_completion' set to true. Steps without
        this flag will return a 403 Forbidden error.
      security:
        - bearer_auth: []
      parameters:
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
      responses:
        '200':
          description: step completed successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  step:
                    type: object
                    properties:
                      section:
                        type: string
                      step_id:
                        type: string
                      step_status:
                        type: string
                        enum:
                          - pending
                          - completed
                          - skipped
                    required:
                      - section
                      - step_id
                      - step_status
                  onboarding:
                    type: object
                    properties:
                      sections:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            name:
                              type: string
                            steps:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: string
                                  name:
                                    type: string
                                  description:
                                    type:
                                      - string
                                      - 'null'
                                  status:
                                    type: string
                                    enum:
                                      - pending
                                      - completed
                                      - skipped
                                  time_estimate:
                                    type: integer
                                  allow_manual_completion:
                                    type: boolean
                            progress:
                              type: object
                              properties:
                                completed:
                                  type: integer
                                skipped:
                                  type: integer
                                pending:
                                  type: integer
                                total:
                                  type: integer
                                percentage:
                                  type: integer
                                time_remaining:
                                  type: integer
                                all_done:
                                  type: boolean
                      overall:
                        type: object
                        properties:
                          completed:
                            type: integer
                          skipped:
                            type: integer
                          pending:
                            type: integer
                          total:
                            type: integer
                          percentage:
                            type: integer
                          time_remaining:
                            type: integer
                      completed:
                        type: boolean
                      show_getting_started:
                        type: boolean
                  company_status:
                    type:
                      - string
                      - 'null'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                required:
                  - step
                  - onboarding
                  - company_status
                  - meta
        '403':
          description: forbidden - manual completion not allowed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      base:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                required:
                  - error_message
                  - errors
                  - meta
        '422':
          description: unprocessable entity - invalid step_id
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      section:
                        type: array
                        items:
                          type: string
                      step_id:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                section:
                  type: string
                  example: data_sync
                step_id:
                  type: string
                  example: connect_data_source
              required:
                - section
                - step_id
  /api/companies/{company_id}/onboarding_info:
    get:
      summary: Get company onboarding info
      tags:
        - Onboarding Info
      operationId: getCompanyOnboardingInfo
      security:
        - bearer_auth: []
      parameters:
        - name: company_id
          in: path
          required: true
          example: 1
          schema:
            type: integer
      responses:
        '200':
          description: onboarding info retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  company:
                    title: Company
                    type: object
                    properties:
                      id:
                        type: integer
                      onboarding_info:
                        type:
                          - object
                          - 'null'
                    required:
                      - id
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f342713b-79c5-487f-b5eb-30b174e7b6d8
                      timestamp:
                        type: string
                        example: '2025-08-24T17:39:20Z'
                    required:
                      - request_id
                      - timestamp
                required:
                  - company
                  - meta
        '401':
          description: unauthorized - company access denied
    put:
      summary: Update company onboarding info
      tags:
        - Onboarding Info
      operationId: updateCompanyOnboardingInfo
      security:
        - bearer_auth: []
      parameters:
        - name: company_id
          in: path
          required: true
          example: 1
          schema:
            type: integer
      responses:
        '200':
          description: onboarding info updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  company:
                    title: Company
                    type: object
                    properties:
                      id:
                        type: integer
                      onboarding_info:
                        type:
                          - object
                          - 'null'
                    required:
                      - id
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f342713b-79c5-487f-b5eb-30b174e7b6d8
                      timestamp:
                        type: string
                        example: '2025-08-24T17:39:20Z'
                    required:
                      - request_id
                      - timestamp
                required:
                  - company
                  - meta
        '401':
          description: unauthorized - company access denied
        '422':
          description: validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Onboarding info could not be updated
                  errors:
                    type: object
                    example:
                      onboarding_info:
                        beneficial_individual_owner:
                          - must be true or false
                  meta:
                    type: object
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                onboarding_info:
                  type: object
                  properties:
                    beneficial_individual_owner:
                      type: boolean
                    beneficial_individual_owner_names:
                      type: array
                      items:
                        type: string
                    user_is_owner:
                      type: boolean
                    beneficial_business_owner:
                      type: boolean
                    other_legal_entities:
                      type: boolean
                    user_has_authority:
                      type: boolean
                    user_is_signatory:
                      type: boolean
                    has_paypal_business_account:
                      type: boolean
                    user_is_primary_decision_maker:
                      type: boolean
                    business_structure_complexity:
                      type: string
                    operates_internationally:
                      type: boolean
                    kyc_flow_current_step:
                      type: string
                    kyc_flow_completed_steps:
                      type: string
                    paypal_connected:
                      type: boolean
                    paypal_business_info_prefilled:
                      type: boolean
                    onboarding_steps:
                      type: object
                      properties:
                        basic_info:
                          type: integer
                        paypal_connect:
                          type: integer
                        business_info:
                          type: integer
                        legal_entities:
                          type: integer
                        bank_accounts_i:
                          type: integer
                        bank_accounts_ii:
                          type: integer
                        personal_info:
                          type: integer
                        relevant_persons:
                          type: integer
                        countries:
                          type: integer
                        alternate_payment_methods:
                          type: integer
                        data_migration:
                          type: integer
                        agreements_and_policies:
                          type: integer
                        underwriting:
                          type: integer
                        terms_and_conditions:
                          type: integer
                      required: []
                    countries_info:
                      type: array
                      items:
                        type: object
                        properties:
                          entity_id:
                            type: integer
                          currency:
                            type: string
                          settlement_currency:
                            type: string
                          entity_legally_registered:
                            type: boolean
                          country_id:
                            type: integer
                          country_iso:
                            type: string
                        required:
                          - entity_id
                          - currency
                          - settlement_currency
                          - entity_legally_registered
                          - country_id
                          - country_iso
                    data_migration:
                      type: object
                      properties:
                        active:
                          type: boolean
                        tokenization_provider:
                          type: string
                        estimated_token_count:
                          type: integer
                      required: []
                    underwriting_info:
                      type: object
                      properties:
                        company_description:
                          type: string
                          minLength: 1
                        management_stability:
                          type: string
                          minLength: 1
                        company_is_mlm:
                          type: boolean
                          not:
                            type: 'null'
                        mlm_ownership_structure:
                          type: string
                        mlm_ownership_structure_file_url:
                          type: string
                        mlm_ownership_structure_file_name:
                          type: string
                        uses_third_party_accounting:
                          type: string
                          minLength: 1
                        has_compliance_officer:
                          type: string
                          minLength: 1
                        compliance_officer_responsibilities:
                          type: string
                          minLength: 1
                        distributor_monitoring_policies:
                          type: string
                          minLength: 1
                        suspicious_activity_escalation_process:
                          type: string
                          minLength: 1
                        retains_outside_legal_counsel:
                          type: string
                          minLength: 1
                        commission_payment_method:
                          type: string
                        commission_payment_channels:
                          type: string
                        commission_payment_countries:
                          type: string
                        compensation_plan_file_url:
                          type: string
                        compensation_plan_file_name:
                          type: string
                        recruiter_commission_for_recruiting:
                          type: string
                        all_distributors_can_profit:
                          type: string
                        provides_average_compensation_report:
                          type: string
                        income_disclosure_statement_file_url:
                          type: string
                        income_disclosure_statement_file_name:
                          type: string
                        distributor_retention_turnover_rates:
                          type: string
                        distributor_identification_requirements:
                          type: string
                        distributor_pii_collected:
                          type: string
                        distributor_due_diligence:
                          type: string
                        distributor_country_restrictions:
                          type: string
                        distributor_decline_termination_reasons:
                          type: string
                        distributor_cross_border_sales:
                          type: string
                        distributor_training_description:
                          type: string
                        investigations_description:
                          type: string
                          minLength: 1
                        negative_media_events:
                          type: string
                          minLength: 1
                        bbb_rating:
                          type: string
                          minLength: 1
                        trustpilot_rating:
                          type: string
                          minLength: 1
                        fulfillment_agreement_file_url:
                          type: string
                        fulfillment_agreement_file_name:
                          type: string
                        manufacturing_agreement_file_url:
                          type: string
                        manufacturing_agreement_file_name:
                          type: string
                        financials_audited:
                          type: boolean
                        financials:
                          type: array
                          items:
                            type: object
                        projected_annual_sales_volume:
                          type: number
                        average_order_value:
                          type: number
                        cit_share_percentage:
                          type: number
                        mit_share_percentage:
                          type: number
                        terms_and_conditions:
                          type: object
                          properties:
                            link:
                              type: string
                            file_name:
                              type: string
                            file_url:
                              type: string
                          required: []
                        refund_or_return_policy:
                          type: object
                          properties:
                            link:
                              type: string
                            file_name:
                              type: string
                            file_url:
                              type: string
                          required: []
                        privacy_policy:
                          type: object
                          properties:
                            link:
                              type: string
                            file_name:
                              type: string
                            file_url:
                              type: string
                          required: []
                      required:
                        - company_description
                        - management_stability
                        - company_is_mlm
                        - uses_third_party_accounting
                        - has_compliance_officer
                        - compliance_officer_responsibilities
                        - distributor_monitoring_policies
                        - suspicious_activity_escalation_process
                        - retains_outside_legal_counsel
                        - investigations_description
                        - negative_media_events
                        - bbb_rating
                        - trustpilot_rating
                        - financials_audited
                        - financials
                        - cit_share_percentage
                        - mit_share_percentage
                        - terms_and_conditions
                        - refund_or_return_policy
                        - privacy_policy
                    terms_and_conditions_info:
                      type: object
                      properties:
                        terms_and_conditions_agreed:
                          type: boolean
                        terms_and_conditions_agreed_at:
                          type: string
                          format: time
                        terms_and_conditions_agreed_by:
                          type: integer
                      required:
                        - terms_and_conditions_agreed
                        - terms_and_conditions_agreed_at
                  required: []
              required:
                - onboarding_info
  /api/companies/{company_id}/onboarding_info/upload_document:
    post:
      summary: Upload document for company onboarding
      tags:
        - Onboarding Info
      operationId: uploadOnboardingDocument
      security:
        - bearer_auth: []
      parameters:
        - name: company_id
          in: path
          required: true
          example: 1
          schema:
            type: integer
      responses:
        '200':
          description: document uploaded without document_type
          content:
            application/json:
              schema:
                type: object
                properties:
                  url:
                    type: string
                    format: uri
                    example: >-
                      https://storage.googleapis.com/bucket/path/to/file.pdf?X-Goog-Algorithm=...
                    description: Signed URL for the uploaded file (expires in 12 hours)
                  object_path:
                    type: string
                    example: >-
                      uploads/20240101/uuid/acme_passport_document_20240101120000.pdf
                    description: GCS object path for reference
                  filename:
                    type: string
                    example: acme_passport_document_20240101120000.pdf
                    description: Generated filename for the uploaded document
                  content_type:
                    type: string
                    example: application/pdf
                    description: Detected MIME type of the uploaded file
                  document_type:
                    type:
                      - string
                      - 'null'
                    example: null
                    description: Document type identifier if provided
                  size:
                    type: integer
                    example: 245678
                    description: File size in bytes
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f342713b-79c5-487f-b5eb-30b174e7b6d8
                      timestamp:
                        type: string
                        example: '2025-08-24T17:39:20Z'
                    required:
                      - request_id
                      - timestamp
                required:
                  - url
                  - object_path
                  - filename
                  - content_type
                  - size
                  - meta
        '401':
          description: unauthorized - company access denied
        '404':
          description: company not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: company not found
                  errors:
                    type: object
                    example:
                      company:
                        - Company not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                    required:
                      - request_id
                      - timestamp
                required:
                  - error_message
                  - errors
                  - meta
        '422':
          description: file too large
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: unprocessable entity
                  errors:
                    type: object
                    example:
                      file:
                        - File size must be less than 10MB
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                    required:
                      - request_id
                      - timestamp
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: string
        required: true
        description: >-
          Document file to upload. Maximum file size: 10MB. Accepts all file
          types.
  /api/companies/{company_id}/onboarding_info/terms_and_conditions:
    get:
      summary: Get terms and conditions URL for company onboarding
      tags:
        - Onboarding Info
      operationId: getCompanyOnboardingTermsAndConditions
      security:
        - bearer_auth: []
      parameters:
        - name: company_id
          in: path
          required: true
          example: 1
          schema:
            type: integer
      responses:
        '200':
          description: terms and conditions URL retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  terms_and_conditions:
                    type: object
                    properties:
                      url:
                        type: string
                        format: uri
                        example: >-
                          https://checkout.fluid.app/agreements/839?languageIso=en
                    required:
                      - url
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f342713b-79c5-487f-b5eb-30b174e7b6d8
                      timestamp:
                        type: string
                        example: '2025-08-24T17:39:20Z'
                    required:
                      - request_id
                      - timestamp
                required:
                  - terms_and_conditions
                  - meta
        '401':
          description: unauthorized - company access denied
  /api/companies/{company_id}/onboarding_info/refresh_url:
    post:
      summary: Refresh expiring URL for company onboarding
      tags:
        - Onboarding Info
      operationId: refreshOnboardingUrl
      security:
        - bearer_auth: []
      parameters:
        - name: company_id
          in: path
          required: true
          example: 1
          schema:
            type: integer
      responses:
        '200':
          description: URL not expiring soon, returns original URL
          content:
            application/json:
              schema:
                type: object
                properties:
                  url:
                    type: string
                    format: uri
                    example: >-
                      https://storage.googleapis.com/bucket/path/to/file.pdf?X-Goog-Algorithm=...
                    description: Refreshed signed URL (expires in 12 hours)
                  original_url:
                    type: string
                    format: uri
                    example: >-
                      https://storage.googleapis.com/bucket/path/to/file.pdf?X-Goog-Algorithm=...
                    description: Original URL that was refreshed
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f342713b-79c5-487f-b5eb-30b174e7b6d8
                      timestamp:
                        type: string
                        example: '2025-08-24T17:39:20Z'
                    required:
                      - request_id
                      - timestamp
                required:
                  - url
                  - original_url
                  - meta
        '401':
          description: unauthorized - company access denied
        '422':
          description: validation error - invalid url format
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameters
                  errors:
                    type: object
                    example:
                      url:
                        - must be a valid HTTP or HTTPS URL
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                    required:
                      - request_id
                      - timestamp
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  format: uri
                  example: >-
                    https://storage.googleapis.com/bucket/path/to/file.pdf?X-Goog-Algorithm=GOOG4-RSA-SHA256&X-Goog-Credential=...&X-Goog-Date=20240101T120000Z&X-Goog-Expires=3600&X-Goog-SignedHeaders=host&X-Goog-Signature=...
              required:
                - url
  /api/company/v1/options/{option_id}/option_values/bulk_update:
    patch:
      summary: Bulk update option values
      tags:
        - Option Values
      operationId: bulkUpdateOptionValues
      security:
        - bearer_auth: []
      parameters:
        - name: option_id
          in: path
          required: true
          description: Option ID
          schema:
            type: integer
      responses:
        '200':
          description: >-
            Option values with same title in different options remain
            independent
          content:
            application/json:
              schema:
                type: object
                properties:
                  option_values:
                    type: array
                    items:
                      title: OptionValue
                      type: object
                      properties:
                        id:
                          type: integer
                        title:
                          type: string
                        position:
                          type:
                            - integer
                            - 'null'
                          default: 1
                        presentation:
                          type:
                            - string
                            - 'null'
                        created_at:
                          type: string
                          format: date-time
                        updated_at:
                          type: string
                          format: date-time
                      required:
                        - id
                        - title
                        - created_at
                        - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - option_values
                  - meta
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '404':
          description: Option not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: Invalid parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                option_values:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      title:
                        type: string
                        example: green
                    required:
                      - id
                      - title
              required:
                - option_values
  /api/order_fulfillments:
    get:
      summary: List order fulfillments
      description: List all order fulfillments
      tags:
        - Order Fulfillments
      operationId: listOrderFulfillments
      security:
        - bearer_auth: []
      parameters:
        - name: order_id
          in: query
          required: false
          description: Filter by order ID
          schema:
            type: integer
        - name: page
          in: query
          required: false
          description: Page number
          schema:
            type: integer
        - name: per_page
          in: query
          required: false
          description: Items per page
          schema:
            type: integer
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  json:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        created_at:
                          type: string
                          format: date-time
                        updated_at:
                          type: string
                          format: date-time
                        order_item_fulfillments:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                              quantity:
                                type: integer
                                example: 1
                              item_id:
                                type: integer
                              order_fulfillment_id:
                                type: integer
                              created_at:
                                type: string
                                format: date-time
                              updated_at:
                                type: string
                                format: date-time
                            required:
                              - id
                              - quantity
                              - created_at
                              - updated_at
                        tracking_informations:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                              tracking_number:
                                type: string
                                example: 1Z999AA10123456784
                              shipping_carrier:
                                type: string
                                example: UPS
                              created_at:
                                type: string
                                format: date-time
                              updated_at:
                                type: string
                                format: date-time
                        meta:
                          type: object
                          properties:
                            request_id:
                              type: string
                            timestamp:
                              type: string
                              format: date-time
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
                      pagination:
                        type: object
                        properties:
                          current_page:
                            type: integer
                          total_pages:
                            type: integer
                          total_count:
                            type: integer
                          per_page:
                            type: integer
    post:
      summary: Create order fulfillment
      tags:
        - Order Fulfillments
      operationId: createOrderFulfillment
      description: Create a new order fulfillment
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: created
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  created_at:
                    type: string
                    format: date-time
                  updated_at:
                    type: string
                    format: date-time
                  order_item_fulfillments:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        quantity:
                          type: integer
                          example: 1
                        item_id:
                          type: integer
                        order_fulfillment_id:
                          type: integer
                        created_at:
                          type: string
                          format: date-time
                        updated_at:
                          type: string
                          format: date-time
                      required:
                        - id
                        - quantity
                        - created_at
                        - updated_at
                  tracking_informations:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        tracking_number:
                          type: string
                          example: 1Z999AA10123456784
                        shipping_carrier:
                          type: string
                          example: UPS
                        created_at:
                          type: string
                          format: date-time
                        updated_at:
                          type: string
                          format: date-time
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
        '404':
          description: order not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      base:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                order_id:
                  type: integer
                order_items:
                  type: array
                  items:
                    type: object
                    properties:
                      item_id:
                        type: integer
                      quantity:
                        type: integer
                    required:
                      - item_id
                      - quantity
                tracking_informations:
                  type: array
                  items:
                    type: object
                    properties:
                      tracking_number:
                        type: string
                      shipping_carrier:
                        type: string
                    required:
                      - tracking_number
                send_fulfillment_notification:
                  type: boolean
              required:
                - order_id
                - order_items
  /api/order_fulfillments/{id}:
    get:
      summary: Show order fulfillment
      tags:
        - Order Fulfillments
      operationId: showOrderFulfillment
      description: Show a specific order fulfillment
      security:
        - bearer_auth: []
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  created_at:
                    type: string
                    format: date-time
                  updated_at:
                    type: string
                    format: date-time
                  order_item_fulfillments:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        quantity:
                          type: integer
                          example: 1
                        item_id:
                          type: integer
                        order_fulfillment_id:
                          type: integer
                        created_at:
                          type: string
                          format: date-time
                        updated_at:
                          type: string
                          format: date-time
                      required:
                        - id
                        - quantity
                        - created_at
                        - updated_at
                  tracking_informations:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        tracking_number:
                          type: string
                          example: 1Z999AA10123456784
                        shipping_carrier:
                          type: string
                          example: UPS
                        created_at:
                          type: string
                          format: date-time
                        updated_at:
                          type: string
                          format: date-time
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      base:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
    put:
      summary: Update order fulfillment
      tags:
        - Order Fulfillments
      operationId: updateOrderFulfillment
      description: Update an order fulfillment
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  created_at:
                    type: string
                    format: date-time
                  updated_at:
                    type: string
                    format: date-time
                  order_item_fulfillments:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        quantity:
                          type: integer
                          example: 1
                        item_id:
                          type: integer
                        order_fulfillment_id:
                          type: integer
                        created_at:
                          type: string
                          format: date-time
                        updated_at:
                          type: string
                          format: date-time
                      required:
                        - id
                        - quantity
                        - created_at
                        - updated_at
                  tracking_informations:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        tracking_number:
                          type: string
                          example: 1Z999AA10123456784
                        shipping_carrier:
                          type: string
                          example: UPS
                        created_at:
                          type: string
                          format: date-time
                        updated_at:
                          type: string
                          format: date-time
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      base:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                order_items:
                  type: array
                  items:
                    type: object
                    properties:
                      item_id:
                        type: integer
                      quantity:
                        type: integer
                    required:
                      - item_id
                      - quantity
                tracking_informations:
                  type: array
                  items:
                    type: object
                    properties:
                      tracking_number:
                        type: string
                      shipping_carrier:
                        type: string
                    required:
                      - tracking_number
                send_fulfillment_notification:
                  type: boolean
    delete:
      summary: Delete order fulfillment
      tags:
        - Order Fulfillments
      operationId: deleteOrderFulfillment
      description: Delete an order fulfillment
      security:
        - bearer_auth: []
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      base:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
    parameters:
      - name: id
        in: path
        description: Order Fulfillment ID
        required: true
        schema:
          type: integer
  /api/v202506/orders:
    get:
      summary: List Commerce Orders
      description: List all commerce orders
      tags:
        - Orders
      operationId: listCommerceOrders
      security:
        - bearer_auth: []
      parameters:
        - name: page[cursor]
          in: query
          required: false
          description: Cursor for pagination
          example: null
          schema:
            type: string
        - name: page[limit]
          in: query
          required: false
          description: Number of orders per page (max 100)
          example: 25
          schema:
            type: integer
        - name: start_date
          in: query
          required: false
          description: Start date
          example: '2025-01-01'
          schema:
            type: string
        - name: end_date
          in: query
          required: false
          description: End date
          example: '2025-01-31'
          schema:
            type: string
        - name: customer_id
          in: query
          required: false
          description: Customer ID
          example: 123
          schema:
            type: integer
        - name: user_company_id
          in: query
          required: false
          description: User company ID
          example: 456
          schema:
            type: integer
        - name: search
          in: query
          required: false
          description: Search keyword
          example: john doe
          schema:
            type: string
        - name: within_days
          in: query
          required: false
          description: Limit results to within the last N days
          example: 30
          schema:
            type: integer
        - name: subscription_id
          in: query
          required: false
          description: Subscription ID
          example: 123
          schema:
            type: integer
        - name: status
          in: query
          required: false
          description: Status filter
          schema:
            type: string
            enum:
              - all
              - draft
              - awaiting_shipment
              - awaiting_payment
              - archived
              - cancelled
          example: awaiting_shipment
        - name: type
          in: query
          required: false
          description: Type of Order
          schema:
            type: string
            enum:
              - sample_order
              - customer_order
              - member_order
              - enrollment_order
              - autoship_order
          example: autoship
        - name: cart_source
          in: query
          required: false
          description: Cart source
          schema:
            type: string
            enum:
              - web
              - mobile
              - external
              - admin
          example: store_type
        - name: country_isos
          in: query
          required: false
          description: Country ISOs
          example: US,CA
          schema:
            type: string
        - name: sort
          in: query
          required: false
          description: >
            Sort orders by specified field. Prefix with - for descending.
            Available options:

            created_at, -created_at, id, -id, status, -status, customer,
            -customer,

            amount, -amount, no_of_quantities, -no_of_quantities
          example: '-created_at'
          schema:
            type: string
        - name: force_stats
          in: query
          required: false
          description: Force stats calculation for large datasets
          example: true
          schema:
            type: boolean
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                properties:
                  orders:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 1
                        external_id:
                          type:
                            - string
                            - 'null'
                          example: EXT-12345
                        amount:
                          type: string
                          example: '0.0'
                        amount_in_base:
                          type: string
                          example: '10.0'
                        base_to_currency_rate:
                          type:
                            - string
                            - 'null'
                          example: '1.35'
                        shipping_in_base:
                          type:
                            - string
                            - 'null'
                          example: '7.99'
                        tax_in_base:
                          type:
                            - string
                            - 'null'
                          example: '12.79'
                        subtotal_in_base:
                          type:
                            - string
                            - 'null'
                          example: '139.21'
                        enrollment_fee_in_base:
                          type:
                            - string
                            - 'null'
                          example: '0.0'
                        discount_in_base:
                          type:
                            - string
                            - 'null'
                          example: '0.0'
                        total_display_amount:
                          type: string
                          example: $100.50
                          description: Formatted amount with currency symbol
                        total_cv:
                          type: integer
                          example: 25
                          description: Total Commission Volume for the order
                        total_qv:
                          type: integer
                          example: 30
                          description: Total Qualifying Volume for the order
                        bill_to:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            name:
                              type:
                                - string
                                - 'null'
                              example: John Doe
                            first_name:
                              type:
                                - string
                                - 'null'
                              example: John
                            last_name:
                              type:
                                - string
                                - 'null'
                              example: Doe
                            address1:
                              type: string
                              example: 123 Main St
                            address2:
                              type:
                                - string
                                - 'null'
                              example: Apt 4B
                            address3:
                              type:
                                - string
                                - 'null'
                              example: Building 5
                            city:
                              type: string
                              example: New York
                            state:
                              type: string
                              example: NY
                            postal_code:
                              type: string
                              example: '10001'
                            country_code:
                              type: string
                              example: US
                              description: >-
                                country_id takes precedence if both country_id
                                and country_code provided.
                            subdivision_code:
                              type:
                                - string
                                - 'null'
                              example: NY
                            default:
                              type: boolean
                              example: true
                        billing_address:
                          type:
                            - object
                            - 'null'
                          properties:
                            name:
                              type:
                                - string
                                - 'null'
                              example: John Doe
                            address1:
                              type:
                                - string
                                - 'null'
                              example: 123 Main St
                            address2:
                              type:
                                - string
                                - 'null'
                              example: Apt 4B
                            address3:
                              type:
                                - string
                                - 'null'
                              example: Building 5
                            city:
                              type:
                                - string
                                - 'null'
                              example: New York
                            state:
                              type:
                                - string
                                - 'null'
                              example: NY
                            postal_code:
                              type:
                                - string
                                - 'null'
                              example: '10001'
                            country_code:
                              type:
                                - string
                                - 'null'
                              example: US
                            subdivision_code:
                              type:
                                - string
                                - 'null'
                              example: NY
                        created_at:
                          type: string
                          example: '2025-04-25T08:54:27Z'
                        currency_code:
                          type: string
                          example: USD
                        split_payment:
                          type:
                            - object
                            - 'null'
                          properties:
                            points_amount:
                              type: integer
                              example: 500
                            points_currency_value:
                              type: number
                              example: 5
                            card_amount:
                              type: number
                              example: 95
                            points_ledger_id:
                              type: integer
                              example: 123
                            card_payment_id:
                              type:
                                - integer
                                - 'null'
                              example: 456
                        points_applied:
                          type: integer
                          example: 500
                          description: Total points used for this order
                        points_applied_amount_in_currency:
                          type: number
                          example: 5
                          description: Total points in currency amount used for this order
                        order_total_after_points_redemption:
                          type: number
                          example: 95
                          description: >-
                            The order total (actual card payment) after points
                            redemption
                        discount_codes:
                          type: array
                          items:
                            type: string
                          example:
                            - DISCOUNT1
                            - DISCOUNT2
                          description: Discount codes applied to the order
                        free_shipping:
                          type: boolean
                          example: false
                          description: Whether the order has free shipping
                        customer:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            account_id:
                              type: string
                              example: MD5J8DKWII3U7VB6
                            created_at:
                              type: string
                              example: '2025-04-25T08:49:09Z'
                            default_address:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1
                                name:
                                  type:
                                    - string
                                    - 'null'
                                  example: John Doe
                                first_name:
                                  type:
                                    - string
                                    - 'null'
                                  example: John
                                last_name:
                                  type:
                                    - string
                                    - 'null'
                                  example: Doe
                                address1:
                                  type: string
                                  example: 123 Main St
                                address2:
                                  type:
                                    - string
                                    - 'null'
                                  example: Apt 4B
                                address3:
                                  type:
                                    - string
                                    - 'null'
                                  example: Building 5
                                city:
                                  type: string
                                  example: New York
                                state:
                                  type: string
                                  example: NY
                                postal_code:
                                  type: string
                                  example: '10001'
                                country_code:
                                  type: string
                                  example: US
                                  description: >-
                                    country_id takes precedence if both
                                    country_id and country_code provided.
                                subdivision_code:
                                  type:
                                    - string
                                    - 'null'
                                  example: NY
                                default:
                                  type: boolean
                                  example: true
                            email:
                              type: string
                              example: john.doe1@fluid.app
                            first_name:
                              type: string
                              example: Morgan1
                            full_name:
                              type: string
                              example: Morgan1 Olson1
                            last_name:
                              type: string
                              example: Olson1
                            phone:
                              type: string
                              example: '78939067241'
                            external_id:
                              type:
                                - string
                                - 'null'
                              example: ext123456
                            is_discarded:
                              type: boolean
                              example: false
                            role:
                              type: string
                              example: customer
                              enum:
                                - customer
                                - preferred_customer
                                - rep
                            payment_methods:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 967023914
                                  company_id:
                                    type: integer
                                    example: 96778814
                                  created_at:
                                    type: string
                                    example: '2025-11-11T04:59:05Z'
                                  logo_url:
                                    type:
                                      - string
                                      - 'null'
                                    example: >-
                                      https://assets.fluid.app/images/payment_icons/visa.svg
                                  payload:
                                    type: object
                                    example:
                                      exp_year: '2030'
                                      card_type: visa
                                      exp_month: '01'
                                      card_last_four: '1234'
                                      token_provider: spreedly
                                  source:
                                    type: string
                                    example: card
                                  updated_at:
                                    type: string
                                    example: '2025-11-11T04:59:05Z'
                                  user_id:
                                    type:
                                      - integer
                                      - 'null'
                                    example: null
                        email:
                          type:
                            - string
                            - 'null'
                          example: john.doe1@fluid.app
                        first_name:
                          type:
                            - string
                            - 'null'
                          example: Morgan
                        items:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              ordered_variant:
                                type: array
                                items: {}
                                example: []
                              price:
                                type: string
                                example: '83.72'
                              price_in_currency:
                                type: string
                                example: $83.72 USD
                              quantity:
                                type: integer
                                example: 4
                              sku:
                                type:
                                  - string
                                  - 'null'
                                example: null
                              tax:
                                type: string
                                example: '0.0'
                              title:
                                type: string
                                example: Rev. Mable Morissette
                              total:
                                type: string
                                example: '334.88'
                              cv_total:
                                type: integer
                                example: 100
                              qv_total:
                                type: integer
                                example: 100
                              display_to_customer:
                                type: boolean
                                example: true
                              source_subscription:
                                type:
                                  - object
                                  - 'null'
                                properties:
                                  subscription_token:
                                    type: string
                                    example: sb_1234567890
                                  status:
                                    type: string
                                    example: active
                              bundled_items:
                                type: array
                                items: {}
                                example:
                                  - variant_id:
                                      type: integer
                                    product_id:
                                      type: integer
                                    product_title:
                                      type: string
                                    variant_title:
                                      type: string
                                    option_titles:
                                      type: array
                                      items:
                                        type: string
                                    quantity:
                                      type: integer
                                    display_to_customer:
                                      type: boolean
                                  - variant_id:
                                      type: integer
                                    product_id:
                                      type: integer
                                    product_title:
                                      type: string
                                    variant_title:
                                      type: string
                                    option_titles:
                                      type: array
                                      items:
                                        type: string
                                    quantity:
                                      type: integer
                                    display_to_customer:
                                      type: boolean
                              variant:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  title:
                                    type:
                                      - string
                                      - 'null'
                                    example: Sample Variant
                                  image_path:
                                    type:
                                      - string
                                      - 'null'
                                    example: /images/sample.png
                                  image_url:
                                    type:
                                      - string
                                      - 'null'
                                    example: https://example.com/images/sample.png
                                  primary_image:
                                    type:
                                      - string
                                      - 'null'
                                    example: https://example.com/images/primary.png
                                  price:
                                    type:
                                      - string
                                      - 'null'
                                    example: '34.44'
                                  price_in_currency:
                                    type:
                                      - string
                                      - 'null'
                                    example: $34.44
                                  sku:
                                    type:
                                      - string
                                      - 'null'
                                    example: SKU12345
                                  options:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        title:
                                          type: string
                                          example: Size
                                        value:
                                          type: string
                                          example: XL
                                  product:
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                        example: 1
                                      title:
                                        type: string
                                        example: Sample Product
                                      introduction:
                                        type:
                                          - string
                                          - 'null'
                                        example: Sample Short Description
                                      cv:
                                        type: integer
                                        example: 10
                                      cv_in_currency:
                                        type: string
                                        example: $10.00
                                      external_id:
                                        type:
                                          - string
                                          - 'null'
                                        example: ext-prod-123
                                      image_path:
                                        type:
                                          - string
                                          - 'null'
                                        example: /images/product.png
                                      image_url:
                                        type:
                                          - string
                                          - 'null'
                                        example: https://example.com/images/product.png
                                      price:
                                        type: string
                                        example: '29.99'
                                      price_in_currency:
                                        type: string
                                        example: $29.99
                                      sku:
                                        type:
                                          - string
                                          - 'null'
                                        example: SKU12345
                                      tax:
                                        type: string
                                        example: '2.99'
                                      tax_in_currency:
                                        type: string
                                        example: $2.99
                                      metadata:
                                        type: object
                                        example:
                                          shopify_product_id: 9876054868270
                                      metafields:
                                        type: array
                                        items:
                                          title: LegacyMetafield
                                          type: object
                                          properties:
                                            namespace:
                                              description: >-
                                                A container for related metafields.
                                                Commonly used to group metafields by app
                                                or functionality.
                                              example: custom
                                              type: string
                                              maxLength: 20
                                              pattern: ^[a-zA-Z0-9_]+$
                                            key:
                                              description: >-
                                                The unique identifier for the metafield
                                                within its namespace. Must be unique per
                                                namespace and owner.
                                              example: material
                                              type: string
                                              maxLength: 30
                                              pattern: ^[a-zA-Z0-9_]+$
                                            value:
                                              description: >-
                                                The actual data stored in the metafield.
                                                Type depends on value_type.
                                              example: cotton
                                              type:
                                                - string
                                                - integer
                                                - object
                                                - boolean
                                                - number
                                            value_type:
                                              description: >-
                                                The data type that defines how the value
                                                should be interpreted and validated.
                                              example: single_line_text_field
                                              type: string
                                            description:
                                              description: >-
                                                Optional human-readable description
                                                explaining the purpose of this
                                                metafield.
                                              example: >-
                                                The primary material used in this
                                                product
                                              type:
                                                - string
                                                - 'null'
                                            created_at:
                                              description: >-
                                                Timestamp when the metafield was
                                                created.
                                              example: '2021-01-01T00:00:00Z'
                                              type: string
                                              format: date-time
                                            updated_at:
                                              description: >-
                                                Timestamp when the metafield was last
                                                updated.
                                              example: '2021-01-01T00:00:00Z'
                                              type: string
                                              format: date-time
                                            locked:
                                              description: >-
                                                Whether this metafield is locked and
                                                cannot be updated or deleted directly.
                                              example: false
                                              type:
                                                - boolean
                                                - 'null'
                                                - 'null'
                                            metafield_definition:
                                              description: >-
                                                The definition that defines validation
                                                rules and structure for this metafield
                                              type:
                                                - 'null'
                                                - object
                                          required:
                                            - namespace
                                            - key
                                            - value
                                            - value_type
                                            - description
                                            - created_at
                                            - updated_at
                                            - metafield_definition
                        last_name:
                          type:
                            - string
                            - 'null'
                          example: Olson
                        note:
                          type:
                            - string
                            - 'null'
                          example: Order notes
                        order_number:
                          type: string
                          example: '1001'
                        ship_to:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            name:
                              type:
                                - string
                                - 'null'
                              example: John Doe
                            first_name:
                              type:
                                - string
                                - 'null'
                              example: John
                            last_name:
                              type:
                                - string
                                - 'null'
                              example: Doe
                            address1:
                              type: string
                              example: 123 Main St
                            address2:
                              type:
                                - string
                                - 'null'
                              example: Apt 4B
                            address3:
                              type:
                                - string
                                - 'null'
                              example: Building 5
                            city:
                              type: string
                              example: New York
                            state:
                              type: string
                              example: NY
                            postal_code:
                              type: string
                              example: '10001'
                            country_code:
                              type: string
                              example: US
                              description: >-
                                country_id takes precedence if both country_id
                                and country_code provided.
                            subdivision_code:
                              type:
                                - string
                                - 'null'
                              example: NY
                            default:
                              type: boolean
                              example: true
                        shipping_address:
                          type:
                            - object
                            - 'null'
                          properties:
                            name:
                              type:
                                - string
                                - 'null'
                              example: John Doe
                            address1:
                              type:
                                - string
                                - 'null'
                              example: 123 Main St
                            address2:
                              type:
                                - string
                                - 'null'
                              example: Apt 4B
                            address3:
                              type:
                                - string
                                - 'null'
                              example: Building 5
                            city:
                              type:
                                - string
                                - 'null'
                              example: New York
                            state:
                              type:
                                - string
                                - 'null'
                              example: NY
                            postal_code:
                              type:
                                - string
                                - 'null'
                              example: '10001'
                            country_code:
                              type:
                                - string
                                - 'null'
                              example: US
                            subdivision_code:
                              type:
                                - string
                                - 'null'
                              example: NY
                        shipping:
                          type: string
                          example: '0.0'
                        status:
                          type: string
                          example: awaiting_payment
                        fulfillment_status:
                          type: string
                          example: fulfilled
                        order_status:
                          type: string
                          example: Completed
                        financial_status:
                          type: string
                          example: Paid
                        tax:
                          type: string
                          example: '0.0'
                        token:
                          type: string
                          example: fo_5gczy7wuboaugpn0hemvec
                        currency_symbol:
                          type: string
                          example: $
                        items_count:
                          type: integer
                          example: 10
                        quantity_count:
                          type: integer
                          example: 10
                        updated_at:
                          type: string
                          example: '2025-04-25T08:54:27Z'
                        warehouse_id:
                          type:
                            - integer
                            - 'null'
                          example: 1
                        order_on_behalf_of:
                          type: boolean
                          example: false
                        source:
                          type: string
                          example: web
                          enum:
                            - mobile
                            - web
                            - admin
                            - backoffice
                            - subscription
                        subscription:
                          type:
                            - object
                            - 'null'
                          properties:
                            subscription_token:
                              type: string
                              example: sb_1234567890
                            status:
                              type: string
                              example: active
                        subscriptions:
                          type:
                            - array
                          items:
                            type:
                              - object
                            properties:
                              subscription_token:
                                type: string
                                example: sb_1234567890
                              status:
                                type: string
                                example: active
                  meta:
                    type: object
                    additionalProperties: true
                    properties:
                      request_id:
                        type: string
                        example: 5d72c7cd-54c5-449d-93f5-6da4631cd267
                      timestamp:
                        type: string
                        example: '2025-04-25T09:13:38Z'
                      pagination:
                        type: object
                        additionalProperties: true
                        properties:
                          total_pages:
                            type: integer
                            example: 1
                          total_count:
                            type: integer
                            example: 1
                          limit:
                            type: integer
                            example: 20
                          cursor:
                            type:
                              - string
                              - 'null'
                            example: null
                          prev_cursor:
                            type:
                              - string
                              - 'null'
                            example: null
                          next_cursor:
                            type:
                              - string
                              - 'null'
                            example: null
                          current_page:
                            type: integer
                            example: 1
                          per_page:
                            type: integer
                            example: 20
                      average_cv:
                        type: number
                        example: 20
                      total_cv:
                        type: number
                        example: 60
                      average_amount_base:
                        type: number
                        example: 200
                      total_amount_base:
                        type: number
                        example: 600
                      fulfilled_orders_count:
                        type: integer
                        example: 2
                required:
                  - orders
                  - meta
  /api/v202506/orders/{id}:
    get:
      summary: Retrieve Commerce Order
      description: Retrieve a commerce order
      tags:
        - Orders
      operationId: retrieveCommerceOrder
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Order ID
          schema:
            type: integer
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  order:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      external_id:
                        type:
                          - string
                          - 'null'
                        example: EXT-12345
                      amount:
                        type: string
                        example: '0.0'
                      amount_in_base:
                        type: string
                        example: '10.0'
                      base_to_currency_rate:
                        type:
                          - string
                          - 'null'
                        example: '1.35'
                      shipping_in_base:
                        type:
                          - string
                          - 'null'
                        example: '7.99'
                      tax_in_base:
                        type:
                          - string
                          - 'null'
                        example: '12.79'
                      subtotal_in_base:
                        type:
                          - string
                          - 'null'
                        example: '139.21'
                      enrollment_fee_in_base:
                        type:
                          - string
                          - 'null'
                        example: '0.0'
                      discount_in_base:
                        type:
                          - string
                          - 'null'
                        example: '0.0'
                      total_display_amount:
                        type: string
                        example: $100.50
                        description: Formatted amount with currency symbol
                      total_cv:
                        type: integer
                        example: 25
                        description: Total Commission Volume for the order
                      total_qv:
                        type: integer
                        example: 30
                        description: Total Qualifying Volume for the order
                      bill_to:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      billing_address:
                        type:
                          - object
                          - 'null'
                        properties:
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          address1:
                            type:
                              - string
                              - 'null'
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type:
                              - string
                              - 'null'
                            example: New York
                          state:
                            type:
                              - string
                              - 'null'
                            example: NY
                          postal_code:
                            type:
                              - string
                              - 'null'
                            example: '10001'
                          country_code:
                            type:
                              - string
                              - 'null'
                            example: US
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                      created_at:
                        type: string
                        example: '2025-04-25T08:54:27Z'
                      currency_code:
                        type: string
                        example: USD
                      split_payment:
                        type:
                          - object
                          - 'null'
                        properties:
                          points_amount:
                            type: integer
                            example: 500
                          points_currency_value:
                            type: number
                            example: 5
                          card_amount:
                            type: number
                            example: 95
                          points_ledger_id:
                            type: integer
                            example: 123
                          card_payment_id:
                            type:
                              - integer
                              - 'null'
                            example: 456
                      points_applied:
                        type: integer
                        example: 500
                        description: Total points used for this order
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Total points in currency amount used for this order
                      order_total_after_points_redemption:
                        type: number
                        example: 95
                        description: >-
                          The order total (actual card payment) after points
                          redemption
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT1
                          - DISCOUNT2
                        description: Discount codes applied to the order
                      free_shipping:
                        type: boolean
                        example: false
                        description: Whether the order has free shipping
                      customer:
                        title: Customer
                        type: object
                        properties:
                          id:
                            type: integer
                          account_id:
                            type:
                              - string
                              - 'null'
                          first_name:
                            type:
                              - string
                              - 'null'
                          last_name:
                            type:
                              - string
                              - 'null'
                          full_name:
                            type: string
                          email:
                            type: string
                            pattern: >-
                              ^[a-zA-Z0-9.!\#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$
                          verified_email:
                            type:
                              - boolean
                              - 'null'
                            default: false
                          phone:
                            type:
                              - string
                              - 'null'
                          orders_count:
                            type:
                              - integer
                              - 'null'
                            default: 0
                          created_at:
                            type: string
                            format: date-time
                          display_total_spent:
                            type: string
                          metadata:
                            type: object
                            default: '{}'
                          user_company_id:
                            type:
                              - integer
                              - 'null'
                          external_id:
                            type:
                              - string
                              - 'null'
                          role:
                            type: string
                            enum:
                              - customer
                              - preferred_customer
                              - rep
                          last_order_id:
                            example: 101
                            type:
                              - integer
                              - 'null'
                          notes:
                            example: This is a note
                            type:
                              - string
                              - 'null'
                          active:
                            type: boolean
                          total_spent:
                            example: 100
                            type:
                              - number
                              - string
                          customer_notes:
                            type: array
                            items:
                              title: CustomerNote
                              type: object
                              properties:
                                id:
                                  type: integer
                                note:
                                  type: string
                                user_company_id:
                                  type:
                                    - integer
                                    - 'null'
                                customer_id:
                                  type: integer
                                resource_id:
                                  type:
                                    - integer
                                    - 'null'
                                resource_type:
                                  type:
                                    - string
                                    - 'null'
                                created_at:
                                  type: string
                                  format: date-time
                              required:
                                - id
                                - note
                                - customer_id
                                - created_at
                          default_address:
                            title: Address
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                              name:
                                example: John Doe
                                type: string
                              address1:
                                example: 123 Main St
                                type: string
                              address2:
                                example: Apt 4B
                                type:
                                  - string
                                  - 'null'
                              address3:
                                example: Building 5
                                type:
                                  - string
                                  - 'null'
                              city:
                                example: New York
                                type: string
                              state:
                                example: NY
                                type: string
                              subdivision_code:
                                example: NY
                                type:
                                  - string
                                  - 'null'
                              postal_code:
                                example: '10001'
                                type: string
                              country_code:
                                example: US
                                type:
                                  - string
                                  - 'null'
                              default:
                                description: >-
                                  Use this address by default when there are
                                  multiple addresses
                                example: true
                                type:
                                  - boolean
                                  - 'null'
                                default: false
                              first_name:
                                example: John
                                type: string
                              last_name:
                                example: Doe
                                type: string
                            required:
                              - id
                              - name
                              - address1
                              - city
                              - state
                              - postal_code
                              - first_name
                              - last_name
                          addresses:
                            type: array
                            items:
                              title: Address
                              type: object
                              properties:
                                id:
                                  type: integer
                                name:
                                  example: John Doe
                                  type: string
                                address1:
                                  example: 123 Main St
                                  type: string
                                address2:
                                  example: Apt 4B
                                  type:
                                    - string
                                    - 'null'
                                address3:
                                  example: Building 5
                                  type:
                                    - string
                                    - 'null'
                                city:
                                  example: New York
                                  type: string
                                state:
                                  example: NY
                                  type: string
                                subdivision_code:
                                  example: NY
                                  type:
                                    - string
                                    - 'null'
                                postal_code:
                                  example: '10001'
                                  type: string
                                country_code:
                                  example: US
                                  type:
                                    - string
                                    - 'null'
                                default:
                                  description: >-
                                    Use this address by default when there are
                                    multiple addresses
                                  example: true
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                first_name:
                                  example: John
                                  type: string
                                last_name:
                                  example: Doe
                                  type: string
                              required:
                                - id
                                - name
                                - address1
                                - city
                                - state
                                - postal_code
                                - first_name
                                - last_name
                          payment_methods:
                            type: array
                            items:
                              title: Commerce::PaymentMethod
                              type: object
                              properties:
                                id:
                                  type: integer
                                source:
                                  type: string
                                  enum:
                                    - apple_pay
                                    - paypal
                                    - card
                                    - iap
                                    - bread
                                    - affirm
                                    - google_pay
                                    - klarna
                                    - droplet
                                    - citcon
                                    - ppro
                                payload:
                                  type:
                                    - object
                                    - 'null'
                                company_id:
                                  type:
                                    - integer
                                    - 'null'
                                created_at:
                                  type: string
                                  format: date-time
                                updated_at:
                                  type: string
                                  format: date-time
                                logo_url:
                                  type: string
                                user_id:
                                  example: 101
                                  type:
                                    - integer
                                    - 'null'
                              required:
                                - id
                                - source
                                - created_at
                                - updated_at
                                - logo_url
                          is_rep:
                            example: true
                            type: boolean
                          is_discarded:
                            example: false
                            type: boolean
                          active_subscriptions_count:
                            example: 10
                            type: integer
                          inactive_subscriptions_count:
                            example: 10
                            type: integer
                          user_id:
                            type:
                              - number
                              - 'null'
                          total_orders:
                            type: number
                        required:
                          - id
                          - full_name
                          - email
                          - created_at
                          - display_total_spent
                          - metadata
                          - role
                          - active
                          - total_spent
                          - customer_notes
                          - addresses
                          - payment_methods
                          - is_rep
                          - is_discarded
                          - active_subscriptions_count
                          - inactive_subscriptions_count
                          - total_orders
                      email:
                        type:
                          - string
                          - 'null'
                        example: john.doe1@fluid.app
                      first_name:
                        type:
                          - string
                          - 'null'
                        example: Morgan
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            ordered_variant:
                              type: array
                              items: {}
                              example: []
                            price:
                              type: string
                              example: '83.72'
                            price_in_currency:
                              type: string
                              example: $83.72 USD
                            quantity:
                              type: integer
                              example: 4
                            sku:
                              type:
                                - string
                                - 'null'
                              example: null
                            tax:
                              type: string
                              example: '0.0'
                            title:
                              type: string
                              example: Rev. Mable Morissette
                            total:
                              type: string
                              example: '334.88'
                            cv_total:
                              type: integer
                              example: 100
                            qv_total:
                              type: integer
                              example: 100
                            display_to_customer:
                              type: boolean
                              example: true
                            source_subscription:
                              type:
                                - object
                                - 'null'
                              properties:
                                subscription_token:
                                  type: string
                                  example: sb_1234567890
                                status:
                                  type: string
                                  example: active
                            bundled_items:
                              type: array
                              items: {}
                              example:
                                - variant_id:
                                    type: integer
                                  product_id:
                                    type: integer
                                  product_title:
                                    type: string
                                  variant_title:
                                    type: string
                                  option_titles:
                                    type: array
                                    items:
                                      type: string
                                  quantity:
                                    type: integer
                                  display_to_customer:
                                    type: boolean
                                - variant_id:
                                    type: integer
                                  product_id:
                                    type: integer
                                  product_title:
                                    type: string
                                  variant_title:
                                    type: string
                                  option_titles:
                                    type: array
                                    items:
                                      type: string
                                  quantity:
                                    type: integer
                                  display_to_customer:
                                    type: boolean
                            variant:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: Sample Variant
                                image_path:
                                  type:
                                    - string
                                    - 'null'
                                  example: /images/sample.png
                                image_url:
                                  type:
                                    - string
                                    - 'null'
                                  example: https://example.com/images/sample.png
                                primary_image:
                                  type:
                                    - string
                                    - 'null'
                                  example: https://example.com/images/primary.png
                                price:
                                  type:
                                    - string
                                    - 'null'
                                  example: '34.44'
                                price_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $34.44
                                sku:
                                  type:
                                    - string
                                    - 'null'
                                  example: SKU12345
                                options:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      title:
                                        type: string
                                        example: Size
                                      value:
                                        type: string
                                        example: XL
                                product:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type: string
                                      example: Sample Product
                                    introduction:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Short Description
                                    cv:
                                      type: integer
                                      example: 10
                                    cv_in_currency:
                                      type: string
                                      example: $10.00
                                    external_id:
                                      type:
                                        - string
                                        - 'null'
                                      example: ext-prod-123
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/product.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/product.png
                                    price:
                                      type: string
                                      example: '29.99'
                                    price_in_currency:
                                      type: string
                                      example: $29.99
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    tax:
                                      type: string
                                      example: '2.99'
                                    tax_in_currency:
                                      type: string
                                      example: $2.99
                                    metadata:
                                      type: object
                                      example:
                                        shopify_product_id: 9876054868270
                                    metafields:
                                      type: array
                                      items:
                                        title: LegacyMetafield
                                        type: object
                                        properties:
                                          namespace:
                                            description: >-
                                              A container for related metafields.
                                              Commonly used to group metafields by app
                                              or functionality.
                                            example: custom
                                            type: string
                                            maxLength: 20
                                            pattern: ^[a-zA-Z0-9_]+$
                                          key:
                                            description: >-
                                              The unique identifier for the metafield
                                              within its namespace. Must be unique per
                                              namespace and owner.
                                            example: material
                                            type: string
                                            maxLength: 30
                                            pattern: ^[a-zA-Z0-9_]+$
                                          value:
                                            description: >-
                                              The actual data stored in the metafield.
                                              Type depends on value_type.
                                            example: cotton
                                            type:
                                              - string
                                              - integer
                                              - object
                                              - boolean
                                              - number
                                          value_type:
                                            description: >-
                                              The data type that defines how the value
                                              should be interpreted and validated.
                                            example: single_line_text_field
                                            type: string
                                          description:
                                            description: >-
                                              Optional human-readable description
                                              explaining the purpose of this
                                              metafield.
                                            example: >-
                                              The primary material used in this
                                              product
                                            type:
                                              - string
                                              - 'null'
                                          created_at:
                                            description: >-
                                              Timestamp when the metafield was
                                              created.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          updated_at:
                                            description: >-
                                              Timestamp when the metafield was last
                                              updated.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          locked:
                                            description: >-
                                              Whether this metafield is locked and
                                              cannot be updated or deleted directly.
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                              - 'null'
                                          metafield_definition:
                                            description: >-
                                              The definition that defines validation
                                              rules and structure for this metafield
                                            type:
                                              - 'null'
                                              - object
                                        required:
                                          - namespace
                                          - key
                                          - value
                                          - value_type
                                          - description
                                          - created_at
                                          - updated_at
                                          - metafield_definition
                      last_name:
                        type:
                          - string
                          - 'null'
                        example: Olson
                      note:
                        type:
                          - string
                          - 'null'
                        example: Order notes
                      order_number:
                        type: string
                        example: '1001'
                      ship_to:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      shipping_address:
                        type:
                          - object
                          - 'null'
                        properties:
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          address1:
                            type:
                              - string
                              - 'null'
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type:
                              - string
                              - 'null'
                            example: New York
                          state:
                            type:
                              - string
                              - 'null'
                            example: NY
                          postal_code:
                            type:
                              - string
                              - 'null'
                            example: '10001'
                          country_code:
                            type:
                              - string
                              - 'null'
                            example: US
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                      shipping:
                        type: string
                        example: '0.0'
                      status:
                        type: string
                        example: awaiting_payment
                      fulfillment_status:
                        type: string
                        example: Unfulfilled
                      order_status:
                        type: string
                        example: Completed
                      financial_status:
                        type: string
                        example: Paid
                      tax:
                        type: string
                        example: '0.0'
                      token:
                        type: string
                        example: fo_5gczy7wuboaugpn0hemvec
                      currency_symbol:
                        type: string
                        example: $
                      items_count:
                        type: integer
                        example: 10
                      quantity_count:
                        type: integer
                        example: 10
                      updated_at:
                        type: string
                        example: '2025-04-25T08:54:27Z'
                      warehouse_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      order_on_behalf_of:
                        type: boolean
                        example: false
                      source:
                        type: string
                        example: web
                        enum:
                          - mobile
                          - web
                          - admin
                          - backoffice
                          - subscription
                      subscription:
                        type:
                          - object
                          - 'null'
                        properties:
                          subscription_token:
                            type: string
                            example: sb_1234567890
                          status:
                            type: string
                            example: active
                      subscriptions:
                        type:
                          - array
                        items:
                          type:
                            - object
                          properties:
                            subscription_token:
                              type: string
                              example: sb_1234567890
                            status:
                              type: string
                              example: active
                      cart_token:
                        type:
                          - string
                          - 'null'
                        example: ct_1doa7jhNm4rLXqmJ3dG1GV
                      subtotal:
                        type: string
                        example: '100.00'
                      sub_total_in_currency:
                        type: string
                        example: $100.00
                      tax_in_currency:
                        type: string
                        example: $10.00
                      discount:
                        type: string
                        example: '5.00'
                      discount_in_currency:
                        type: string
                        example: $5.00
                      transaction_fee:
                        type: string
                        example: '2.50'
                      enrollment_fee:
                        type: string
                        example: '0.00'
                      warehouse_name:
                        type:
                          - string
                          - 'null'
                        example: Main Warehouse
                      payment_status:
                        type: string
                        example: pending
                      payment_method:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                          spreedly_token:
                            type: string
                          full_name:
                            type: string
                          month:
                            type: integer
                          year:
                            type: integer
                          number:
                            type: string
                          last_four_digits:
                            type:
                              - string
                              - 'null'
                          first_six_digits:
                            type:
                              - string
                              - 'null'
                          card_type:
                            type:
                              - string
                              - 'null'
                          default:
                            type: boolean
                          email:
                            type:
                              - string
                              - 'null'
                          source:
                            type: string
                      metadata:
                        type:
                          - object
                          - 'null'
                      is_cancellable:
                        type: boolean
                        example: true
                      price_inclusive_of_tax:
                        type: boolean
                        example: false
                      price_inclusive_tax_name:
                        type:
                          - string
                          - 'null'
                        example: null
                      rep:
                        type:
                          - object
                          - 'null'
                        items:
                          title: UserCompany
                          type: object
                          properties:
                            id:
                              type: integer
                            external_id:
                              type:
                                - string
                                - 'null'
                            share_guid:
                              type: string
                              pattern: ^[a-z0-9\-_]+$
                              minLength: 2
                            email:
                              example: john.smith@company.com
                              type:
                                - string
                                - 'null'
                            image_url:
                              example: https://example.com/avatar/john-smith.jpg
                              type:
                                - string
                                - 'null'
                            full_name:
                              example: John Smith
                              type:
                                - string
                                - 'null'
                            rank:
                              description: Rep's rank information
                              example:
                                id: 1
                                name: Gold
                                external_id: GOLD
                              type:
                                - object
                                - 'null'
                          required:
                            - id
                            - share_guid
                      refunds:
                        type: array
                        items:
                          title: Refund
                          type: object
                          properties:
                            amount:
                              description: Amount refunded
                              example: 10.5
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                              minimum: 0
                            refund_type:
                              description: Type of refund
                              example: All
                              type: string
                              default: all
                            currency_code:
                              description: Currency code of the refunded order
                              example: USD
                              type: string
                            currency_symbol:
                              description: Currency symbol of the refunded order
                              example: $
                              type: string
                            amount_in_currency:
                              description: Formatted refund amount with currency
                              example: $10.50
                              type: string
                            cv:
                              description: CV refunded
                              example: 5
                              type:
                                - integer
                                - 'null'
                              default: 0
                              minimum: 0
                            qv:
                              description: QV refunded
                              example: 3
                              type:
                                - integer
                                - 'null'
                              default: 0
                              minimum: 0
                          required:
                            - refund_type
                            - currency_code
                            - currency_symbol
                            - amount_in_currency
                      metafields:
                        type: array
                        items:
                          title: LegacyMetafield
                          type: object
                          properties:
                            id:
                              type: integer
                            namespace:
                              description: >-
                                A container for related metafields. Commonly
                                used to group metafields by app or
                                functionality.
                              example: custom
                              type: string
                              maxLength: 20
                              pattern: ^[a-zA-Z0-9_]+$
                            key:
                              description: >-
                                The unique identifier for the metafield within
                                its namespace. Must be unique per namespace and
                                owner.
                              example: material
                              type: string
                              maxLength: 30
                              pattern: ^[a-zA-Z0-9_]+$
                            value:
                              description: >-
                                The actual data stored in the metafield. Type
                                depends on value_type.
                              example: cotton
                              type:
                                - string
                                - object
                            value_type:
                              description: >-
                                The data type that defines how the value should
                                be interpreted and validated.
                              example: single_line_text_field
                              type: string
                            description:
                              description: >-
                                Optional human-readable description explaining
                                the purpose of this metafield.
                              example: The primary material used in this product
                              type:
                                - string
                                - 'null'
                            owner_type:
                              description: >-
                                The type of resource that this metafield belongs
                                to (polymorphic association).
                              example: Product
                              type: string
                            owner_id:
                              description: >-
                                The ID of the specific resource that this
                                metafield belongs to.
                              example: 12345
                              type: integer
                            created_at:
                              description: Timestamp when the metafield was created.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            updated_at:
                              description: Timestamp when the metafield was last updated.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            metafield_definition:
                              title: MetafieldDefinition
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                company_id:
                                  description: >-
                                    The ID of the company that owns this
                                    metafield definition.
                                  example: 1
                                  type: integer
                                namespace:
                                  description: >-
                                    A container for related metafield
                                    definitions. Used to group definitions by
                                    app or functionality. Must be unique within
                                    company and owner_resource.
                                  example: product_details
                                  type: string
                                  maxLength: 20
                                  pattern: ^[a-zA-Z0-9_]+$
                                key:
                                  description: >-
                                    The unique identifier for the metafield
                                    definition within its namespace and
                                    owner_resource. Combined with namespace and
                                    owner_resource, this must be unique per
                                    company.
                                  example: material_type
                                  type: string
                                  maxLength: 30
                                  pattern: ^[a-zA-Z0-9_]+$
                                name:
                                  description: >-
                                    Human-readable display name for the
                                    metafield definition, shown in admin
                                    interfaces and forms.
                                  example: Material Type
                                  type: string
                                  maxLength: 100
                                description:
                                  description: >-
                                    Detailed explanation of what this metafield
                                    definition represents, how it should be
                                    used, and any special instructions for
                                    content creators.
                                  example: >-
                                    Specify the primary material composition of
                                    the product (e.g., cotton, polyester, silk).
                                    This will be displayed on the product detail
                                    page.
                                  type:
                                    - string
                                    - 'null'
                                value_type:
                                  description: >-
                                    The data type that defines how metafield
                                    values should be validated, stored, and
                                    displayed. Determines which validation rules
                                    are available.
                                  example: single_line_text_field
                                  type: string
                                validation_rules:
                                  description: >-
                                    JSON object containing validation
                                    constraints that will be applied to
                                    metafield values. Available rules depend on
                                    the value_type.
                                  example:
                                    choices:
                                      - cotton
                                      - polyester
                                      - silk
                                      - wool
                                      - linen
                                      - bamboo
                                    max: 50
                                    min: 2
                                  type:
                                    - object
                                    - 'null'
                                owner_resource:
                                  description: >-
                                    The type of resource (model class name) that
                                    metafields using this definition can be
                                    attached to. Must match the polymorphic
                                    owner_type.
                                  example: Product
                                  type: string
                                pinned:
                                  description: >-
                                    Whether this definition should be
                                    prominently displayed or prioritized in
                                    admin interfaces and forms.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                position:
                                  default: 0
                                  description: >-
                                    Sort order for displaying this definition
                                    relative to others in the same category and
                                    owner_resource. Lower numbers appear first.
                                  example: 1
                                  type:
                                    - integer
                                    - 'null'
                                locked:
                                  description: >-
                                    Whether this metafield definition is locked,
                                    preventing direct updates or deletions of
                                    metafields using this definition.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                created_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    created.
                                  example: '2024-01-15T10:30:00Z'
                                  type: string
                                  format: date-time
                                updated_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    last updated.
                                  example: '2024-02-20T14:45:00Z'
                                  type: string
                                  format: date-time
                                list_type:
                                  description: >-
                                    Whether this definition is for list-type
                                    metafields that store arrays of values.
                                  example: false
                                  type: boolean
                                reference_type:
                                  description: >-
                                    Whether this definition is for
                                    reference-type metafields that store
                                    references to other resources.
                                  example: false
                                  type: boolean
                                supported_validations:
                                  description: >-
                                    Array of validation rule names that are
                                    supported for this value_type.
                                  example:
                                    - min
                                    - max
                                    - choices
                                    - regex
                                  type: array
                                validation_description:
                                  description: >-
                                    Human-readable description of what the
                                    value_type represents and its constraints.
                                  example: Single line text up to 5000 characters
                                  type: string
                                category_ids:
                                  description: >-
                                    Array of category IDs that this metafield
                                    definition is associated with for
                                    organizational purposes.
                                  example:
                                    - 1
                                    - 2
                                    - 3
                                  items:
                                    type: integer
                                  type: array
                              required:
                                - id
                                - company_id
                                - namespace
                                - key
                                - name
                                - value_type
                                - owner_resource
                                - created_at
                                - updated_at
                                - list_type
                                - reference_type
                                - supported_validations
                                - validation_description
                                - category_ids
                          required:
                            - id
                            - namespace
                            - key
                            - value
                            - value_type
                            - owner_type
                            - owner_id
                            - created_at
                            - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                      shop_url:
                        type: string
                        example: https://example.com
                required:
                  - order
                  - meta
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    example:
                      order:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
  /api/orders:
    post:
      summary: Create Order
      description: Create an order from cart
      tags:
        - Orders
      operationId: createOrderFromCart
      security:
        - bearer_auth: []
      parameters:
        - name: cart_token
          in: query
          required: true
          description: Token of the cart to create order from
          schema:
            type: string
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  order:
                    type: object
                    properties:
                      id:
                        type: integer
                      amount_in_base:
                        type: string
                        example: '10.0'
                      base_to_currency_rate:
                        type:
                          - string
                          - 'null'
                        example: '1.35'
                      currency_symbol:
                        type: string
                      currency_code:
                        type: string
                      external_id:
                        type:
                          - string
                          - 'null'
                      order_number:
                        type: string
                      token:
                        type: string
                      note:
                        type:
                          - string
                          - 'null'
                      company_logo_url:
                        type:
                          - string
                          - 'null'
                      created_at:
                        type: string
                      customer:
                        type:
                          - string
                          - 'null'
                      email:
                        type:
                          - string
                          - 'null'
                      total:
                        type: string
                      total_in_currency:
                        type: string
                      subtotal:
                        type: string
                        example: '90.00'
                      subtotal_after_discounts:
                        type: string
                        example: '87.00'
                      sub_total:
                        type: string
                        example: '90.00'
                      sub_total_in_currency:
                        type: string
                        example: $90.00
                      tax:
                        type: string
                        example: '2.00'
                      tax_in_currency:
                        type: string
                        example: $2.00
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: '1.90'
                      transaction_fee_in_currency:
                        type: string
                        example: $1.00
                      discount:
                        type: string
                        example: '3.00'
                      discount_in_currency:
                        type: string
                        example: $3.00
                      warehouse_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      warehouse:
                        oneOf:
                          - title: Warehouse
                            type: object
                            properties:
                              id:
                                type: integer
                              name:
                                example: Central Distribution Center
                                type: string
                              active:
                                example: true
                                type: boolean
                              external_id:
                                example: WH-12345
                                type:
                                  - string
                                  - 'null'
                              metadata:
                                example:
                                  capacity:
                                    total_square_feet: 50000
                                  operations:
                                    staff_count: 15
                                    security_level: high
                                type: object
                            required:
                              - id
                              - name
                              - active
                              - metadata
                          - type: 'null'
                      shipping:
                        type: string
                        example: $11.00
                      shipping_in_currency:
                        type:
                          - object
                          - 'null'
                        properties:
                          amount_in_currency:
                            type: string
                            example: $11.00
                          surcharge_in_currency:
                            type: string
                            example: $11.00
                      refundable_amount:
                        type:
                          - number
                          - string
                        format: float
                        example: 10.5
                      payment_status:
                        type: string
                      enrollment_token:
                        type:
                          - string
                          - 'null'
                      enrollment_pack:
                        type:
                          - object
                          - 'null'
                        properties:
                          enrollment_pack_id:
                            type: integer
                            example: 1
                          additional_volume:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          slug:
                            type: string
                            example: test-enrollment-pack
                          description:
                            type:
                              - object
                              - 'null'
                              - string
                            properties:
                              id:
                                type: integer
                                example: 111
                              name:
                                type: string
                                example: description
                              body:
                                type: string
                                example: >-
                                  <div>Try the latest and greatest of our sugar
                                  zip packs. Guaranteed to make you skinner and
                                  cure cancer.</div>
                              record_type:
                                type: string
                                example: EnrollmentPack
                              record_id:
                                type: integer
                                example: 1
                              created_at:
                                type: string
                                format: date_time
                                example: '2025-01-16T04:22:43.809Z'
                              updated_at:
                                type: string
                                format: date_time
                                example: '2025-01-22T10:23:52.941Z'
                              locale:
                                type: string
                                example: en
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: 10
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.00
                          images:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2
                                relateable_type:
                                  type: string
                                  example: EnrollmentPack
                                relateable_id:
                                  type: integer
                                  example: 1
                                image_url:
                                  type: string
                                  example: >-
                                    https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                image_path:
                                  type: string
                                  example: jITWaU14QGe0y5AFgY7P_00179.svg
                                position:
                                  type: integer
                                  example: 1
                                shopify_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                                created_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                updated_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                external_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 625
                                allow_subscription:
                                  type: boolean
                                  example: true
                                cv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                cv_in_currency:
                                  type: string
                                  example: $0.00
                                cv_total:
                                  type: integer
                                  example: 0
                                enrollment:
                                  type: boolean
                                  example: true
                                enrollment_pack_id:
                                  type: integer
                                  example: 1
                                price:
                                  type: string
                                  example: '11.13'
                                price_in_currency:
                                  type: string
                                  example: $11.13
                                product_title:
                                  type: string
                                  example: Zip Pack Sample Pack (30)
                                quantity:
                                  type: integer
                                  example: 1
                                qv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                qv_in_currency:
                                  type: string
                                  example: $0.00
                                qv_total:
                                  type: integer
                                  example: 0
                                subscribe_and_save:
                                  type:
                                    - string
                                    - 'null'
                                  example: '-1988.87'
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $-1,988.87
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $-1,988.87
                                subscription:
                                  type: boolean
                                  example: false
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_only:
                                  type: boolean
                                  example: false
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_price:
                                  type: string
                                  example: '2000.0'
                                subscription_price_in_currency:
                                  type: string
                                  example: $2,000.00
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  format: date
                                  example: '2025-02-28'
                                tax:
                                  type: string
                                  example: '0.0'
                                tax_in_currency:
                                  type: string
                                  example: $0.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: null
                                display_to_customer:
                                  type: boolean
                                  example: false
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                          price:
                            type: string
                            example: '11.13'
                          price_in_currency:
                            type: string
                            example: $11.13
                          subscription_price:
                            type:
                              - string
                              - integer
                            example: 2000
                          subscription_price_in_currency:
                            type: string
                            example: $2,000.00
                          title:
                            type: string
                            example: enroll product
                          token:
                            type: string
                            example: NxL22AqLRRisfyF9LqxxWRak
                      fulfillment_status:
                        type: string
                      order_status:
                        type: string
                      financial_status:
                        type: string
                      delivery_status:
                        type: string
                      delivery_method:
                        type: string
                      delivery_date:
                        type:
                          - string
                          - 'null'
                        example: '2023-07-29'
                      channel:
                        type: string
                      tags:
                        type: string
                      items_count:
                        type: integer
                      quantity_count:
                        type: integer
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 101
                            price:
                              type:
                                - number
                                - string
                              example: 43.41
                            price_in_currency:
                              type: string
                              example: $43.41
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            cv:
                              type: integer
                              example: 5
                            cv_in_currency:
                              type: string
                              example: $5.00
                            qv:
                              type: integer
                              example: 7
                            qv_in_currency:
                              type: string
                              example: $7.00
                            product_title:
                              type: string
                              example: Sample Product
                            variant_title:
                              type:
                                - string
                                - 'null'
                              example: Sample Variant
                            variant_image:
                              type:
                                - string
                                - 'null'
                              example: https://example.com/image.png
                            variant_id:
                              type: integer
                              example: 202
                            quantity:
                              type: integer
                              example: 3
                            title:
                              type: string
                            total:
                              type:
                                - number
                                - string
                            image_url:
                              type:
                                - string
                                - 'null'
                            sku:
                              type:
                                - string
                                - 'null'
                            display_price:
                              type: string
                            display_total:
                              type: string
                            refundable_amount:
                              type:
                                - number
                                - string
                              format: float
                              example: 10.5
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            bundled_items:
                              type: array
                              items:
                                type: object
                                properties:
                                  variant_id:
                                    type: integer
                                  product_id:
                                    type: integer
                                  product_title:
                                    type: string
                                  variant_title:
                                    type: string
                                  option_titles:
                                    type: array
                                    items:
                                      type: string
                                  quantity:
                                    type: integer
                                  display_to_customer:
                                    type: boolean
                            ordered_variant:
                              type: array
                              items:
                                type: object
                                properties:
                                  option_type:
                                    type: string
                                  value:
                                    type: string
                            product:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1
                                title:
                                  type: string
                                  example: Sample Product
                                introduction:
                                  type:
                                    - string
                                    - 'null'
                                  example: Sample Short Description
                                cv:
                                  type: integer
                                  example: 10
                                cv_in_currency:
                                  type: string
                                  example: $10.00
                                external_id:
                                  type:
                                    - string
                                    - 'null'
                                  example: ext-prod-123
                                image_path:
                                  type:
                                    - string
                                    - 'null'
                                  example: /images/product.png
                                image_url:
                                  type:
                                    - string
                                    - 'null'
                                  example: https://example.com/images/product.png
                                price:
                                  type: string
                                  example: '29.99'
                                price_in_currency:
                                  type: string
                                  example: $29.99
                                sku:
                                  type:
                                    - string
                                    - 'null'
                                  example: SKU12345
                                tax:
                                  type: string
                                  example: '2.99'
                                tax_in_currency:
                                  type: string
                                  example: $2.99
                                metadata:
                                  type: object
                                  example:
                                    shopify_product_id: 9876054868270
                                metafields:
                                  type: array
                                  items:
                                    title: LegacyMetafield
                                    type: object
                                    properties:
                                      namespace:
                                        description: >-
                                          A container for related metafields.
                                          Commonly used to group metafields by app
                                          or functionality.
                                        example: custom
                                        type: string
                                        maxLength: 20
                                        pattern: ^[a-zA-Z0-9_]+$
                                      key:
                                        description: >-
                                          The unique identifier for the metafield
                                          within its namespace. Must be unique per
                                          namespace and owner.
                                        example: material
                                        type: string
                                        maxLength: 30
                                        pattern: ^[a-zA-Z0-9_]+$
                                      value:
                                        description: >-
                                          The actual data stored in the metafield.
                                          Type depends on value_type.
                                        example: cotton
                                        type:
                                          - string
                                          - integer
                                          - object
                                          - boolean
                                          - number
                                      value_type:
                                        description: >-
                                          The data type that defines how the value
                                          should be interpreted and validated.
                                        example: single_line_text_field
                                        type: string
                                      description:
                                        description: >-
                                          Optional human-readable description
                                          explaining the purpose of this
                                          metafield.
                                        example: >-
                                          The primary material used in this
                                          product
                                        type:
                                          - string
                                          - 'null'
                                      created_at:
                                        description: >-
                                          Timestamp when the metafield was
                                          created.
                                        example: '2021-01-01T00:00:00Z'
                                        type: string
                                        format: date-time
                                      updated_at:
                                        description: >-
                                          Timestamp when the metafield was last
                                          updated.
                                        example: '2021-01-01T00:00:00Z'
                                        type: string
                                        format: date-time
                                      locked:
                                        description: >-
                                          Whether this metafield is locked and
                                          cannot be updated or deleted directly.
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                          - 'null'
                                      metafield_definition:
                                        description: >-
                                          The definition that defines validation
                                          rules and structure for this metafield
                                        type:
                                          - 'null'
                                          - object
                                    required:
                                      - namespace
                                      - key
                                      - value
                                      - value_type
                                      - description
                                      - created_at
                                      - updated_at
                                      - metafield_definition
                            variant:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: Sample Variant
                                image_path:
                                  type:
                                    - string
                                    - 'null'
                                  example: /images/sample.png
                                image_url:
                                  type:
                                    - string
                                    - 'null'
                                  example: https://example.com/images/sample.png
                                primary_image:
                                  type:
                                    - string
                                    - 'null'
                                  example: https://example.com/images/primary.png
                                price:
                                  type:
                                    - string
                                    - 'null'
                                  example: '34.44'
                                price_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $34.44
                                sku:
                                  type:
                                    - string
                                    - 'null'
                                  example: SKU12345
                                options:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      title:
                                        type: string
                                        example: Size
                                      value:
                                        type: string
                                        example: XL
                      activities:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            user_id:
                              type: integer
                            relation_type:
                              type: string
                            relation_id:
                              type: integer
                            contact_id:
                              type:
                                - integer
                                - 'null'
                            title:
                              type: string
                              example: A new order has been placed
                            description:
                              type: string
                              example: Samantha Joseph placed an order on Vandelay Shop
                            formatted_description:
                              type: string
                              example: >-
                                Samantha Joseph placed an order on Vandelay Shop
                                recently
                            read_at:
                              type:
                                - string
                                - 'null'
                            slug:
                              type: string
                            company_id:
                              type: integer
                            created_at:
                              type: string
                      shipping_method:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: string
                              title:
                                type: string
                              delivery_time_estimate:
                                type:
                                  - string
                                  - 'null'
                                example: 3-5 business days
                          - type: object
                            properties: {}
                      payment_details:
                        type:
                          - object
                          - 'null'
                        properties:
                          payment_type:
                            type: string
                          details:
                            type: object
                            properties:
                              card_type:
                                type: string
                                example: visa
                              card_brand:
                                type: string
                                example: Visa
                              last_four:
                                type: string
                                example: '1234'
                              logo_url:
                                type: string
                                example: >-
                                  https://assets.fluid.app/images/payment_icons/visa.svg
                      primary_domain_hostname:
                        type:
                          - string
                          - 'null'
                        example: fluid.com
                      company_subdomain:
                        type:
                          - string
                          - 'null'
                        example: myco
                      shipping_total:
                        type: string
                        example: '0.0'
                      shipping_total_for_display:
                        type: string
                        example: Free
                      ship_to:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      bill_to:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      shipping_address:
                        type:
                          - object
                          - 'null'
                        properties:
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          address1:
                            type:
                              - string
                              - 'null'
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type:
                              - string
                              - 'null'
                            example: New York
                          state:
                            type:
                              - string
                              - 'null'
                            example: NY
                          postal_code:
                            type:
                              - string
                              - 'null'
                            example: '10001'
                          country_code:
                            type:
                              - string
                              - 'null'
                            example: US
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                      billing_address:
                        type:
                          - object
                          - 'null'
                        properties:
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          address1:
                            type:
                              - string
                              - 'null'
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type:
                              - string
                              - 'null'
                            example: New York
                          state:
                            type:
                              - string
                              - 'null'
                            example: NY
                          postal_code:
                            type:
                              - string
                              - 'null'
                            example: '10001'
                          country_code:
                            type:
                              - string
                              - 'null'
                            example: US
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      order_on_behalf_of:
                        type: boolean
                        example: true
                      volume_rep:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type:
                              - integer
                              - 'null'
                            example: 1
                          email:
                            type:
                              - string
                              - 'null'
                            example: volume_rep@example.com
                          full_name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          image_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/image.png
                      metadata:
                        type:
                          - object
                          - 'null'
                      metafields:
                        type: array
                        items:
                          title: LegacyMetafield
                          type: object
                          properties:
                            id:
                              type: integer
                            namespace:
                              description: >-
                                A container for related metafields. Commonly
                                used to group metafields by app or
                                functionality.
                              example: custom
                              type: string
                              maxLength: 20
                              pattern: ^[a-zA-Z0-9_]+$
                            key:
                              description: >-
                                The unique identifier for the metafield within
                                its namespace. Must be unique per namespace and
                                owner.
                              example: material
                              type: string
                              maxLength: 30
                              pattern: ^[a-zA-Z0-9_]+$
                            value:
                              description: >-
                                The actual data stored in the metafield. Type
                                depends on value_type.
                              example: cotton
                              type:
                                - string
                                - object
                            value_type:
                              description: >-
                                The data type that defines how the value should
                                be interpreted and validated.
                              example: single_line_text_field
                              type: string
                            description:
                              description: >-
                                Optional human-readable description explaining
                                the purpose of this metafield.
                              example: The primary material used in this product
                              type:
                                - string
                                - 'null'
                            owner_type:
                              description: >-
                                The type of resource that this metafield belongs
                                to (polymorphic association).
                              example: Product
                              type: string
                            owner_id:
                              description: >-
                                The ID of the specific resource that this
                                metafield belongs to.
                              example: 12345
                              type: integer
                            created_at:
                              description: Timestamp when the metafield was created.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            updated_at:
                              description: Timestamp when the metafield was last updated.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            metafield_definition:
                              title: MetafieldDefinition
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                company_id:
                                  description: >-
                                    The ID of the company that owns this
                                    metafield definition.
                                  example: 1
                                  type: integer
                                namespace:
                                  description: >-
                                    A container for related metafield
                                    definitions. Used to group definitions by
                                    app or functionality. Must be unique within
                                    company and owner_resource.
                                  example: product_details
                                  type: string
                                  maxLength: 20
                                  pattern: ^[a-zA-Z0-9_]+$
                                key:
                                  description: >-
                                    The unique identifier for the metafield
                                    definition within its namespace and
                                    owner_resource. Combined with namespace and
                                    owner_resource, this must be unique per
                                    company.
                                  example: material_type
                                  type: string
                                  maxLength: 30
                                  pattern: ^[a-zA-Z0-9_]+$
                                name:
                                  description: >-
                                    Human-readable display name for the
                                    metafield definition, shown in admin
                                    interfaces and forms.
                                  example: Material Type
                                  type: string
                                  maxLength: 100
                                description:
                                  description: >-
                                    Detailed explanation of what this metafield
                                    definition represents, how it should be
                                    used, and any special instructions for
                                    content creators.
                                  example: >-
                                    Specify the primary material composition of
                                    the product (e.g., cotton, polyester, silk).
                                    This will be displayed on the product detail
                                    page.
                                  type:
                                    - string
                                    - 'null'
                                value_type:
                                  description: >-
                                    The data type that defines how metafield
                                    values should be validated, stored, and
                                    displayed. Determines which validation rules
                                    are available.
                                  example: single_line_text_field
                                  type: string
                                validation_rules:
                                  description: >-
                                    JSON object containing validation
                                    constraints that will be applied to
                                    metafield values. Available rules depend on
                                    the value_type.
                                  example:
                                    choices:
                                      - cotton
                                      - polyester
                                      - silk
                                      - wool
                                      - linen
                                      - bamboo
                                    max: 50
                                    min: 2
                                  type:
                                    - object
                                    - 'null'
                                owner_resource:
                                  description: >-
                                    The type of resource (model class name) that
                                    metafields using this definition can be
                                    attached to. Must match the polymorphic
                                    owner_type.
                                  example: Product
                                  type: string
                                pinned:
                                  description: >-
                                    Whether this definition should be
                                    prominently displayed or prioritized in
                                    admin interfaces and forms.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                position:
                                  default: 0
                                  description: >-
                                    Sort order for displaying this definition
                                    relative to others in the same category and
                                    owner_resource. Lower numbers appear first.
                                  example: 1
                                  type:
                                    - integer
                                    - 'null'
                                locked:
                                  description: >-
                                    Whether this metafield definition is locked,
                                    preventing direct updates or deletions of
                                    metafields using this definition.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                created_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    created.
                                  example: '2024-01-15T10:30:00Z'
                                  type: string
                                  format: date-time
                                updated_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    last updated.
                                  example: '2024-02-20T14:45:00Z'
                                  type: string
                                  format: date-time
                                list_type:
                                  description: >-
                                    Whether this definition is for list-type
                                    metafields that store arrays of values.
                                  example: false
                                  type: boolean
                                reference_type:
                                  description: >-
                                    Whether this definition is for
                                    reference-type metafields that store
                                    references to other resources.
                                  example: false
                                  type: boolean
                                supported_validations:
                                  description: >-
                                    Array of validation rule names that are
                                    supported for this value_type.
                                  example:
                                    - min
                                    - max
                                    - choices
                                    - regex
                                  type: array
                                validation_description:
                                  description: >-
                                    Human-readable description of what the
                                    value_type represents and its constraints.
                                  example: Single line text up to 5000 characters
                                  type: string
                                category_ids:
                                  description: >-
                                    Array of category IDs that this metafield
                                    definition is associated with for
                                    organizational purposes.
                                  example:
                                    - 1
                                    - 2
                                    - 3
                                  items:
                                    type: integer
                                  type: array
                              required:
                                - id
                                - company_id
                                - namespace
                                - key
                                - name
                                - value_type
                                - owner_resource
                                - created_at
                                - updated_at
                                - list_type
                                - reference_type
                                - supported_validations
                                - validation_description
                                - category_ids
                          required:
                            - id
                            - namespace
                            - key
                            - value
                            - value_type
                            - owner_type
                            - owner_id
                            - created_at
                            - updated_at
                      free_shipping:
                        type: boolean
                        example: false
                        description: Whether the order has free shipping
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT1
                          - DISCOUNT2
                        description: Discount codes applied to the order
                      points_applied:
                        type: integer
                        example: 500
                        description: Total points used for this order
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Total points in currency amount used for this order
                      order_total_after_points_redemption:
                        type: number
                        example: 95
                        description: >-
                          The order total (actual card payment) after points
                          redemption
                      split_payment:
                        type:
                          - object
                          - 'null'
                        properties:
                          points_amount:
                            type: integer
                            example: 500
                          points_currency_value:
                            type: number
                            example: 5
                          card_amount:
                            type: number
                            example: 95
                          points_ledger_id:
                            type: integer
                            example: 123
                          card_payment_id:
                            type:
                              - integer
                              - 'null'
                            example: 456
                      source:
                        type: string
                        example: web
                        enum:
                          - mobile
                          - web
                          - admin
                          - backoffice
                          - subscription
                      price_inclusive_of_tax:
                        type: boolean
                        example: false
                      price_inclusive_tax_name:
                        type:
                          - string
                          - 'null'
                        example: null
                    required:
                      - id
                      - currency_symbol
                      - total
                      - payment_status
                      - fulfillment_status
                      - delivery_status
                      - delivery_method
                      - channel
                      - tags
                      - items_count
                      - items
                      - payment_details
                      - ship_to
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                      shop_url:
                        type: string
                required:
                  - order
                  - meta
        '404':
          description: cart not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Cart not found
                  errors:
                    type: object
                    properties:
                      cart:
                        type: array
                        items:
                          type: string
                        example:
                          - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '422':
          description: checkout error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Unable to create order
                  errors:
                    type: object
                    properties:
                      payment:
                        type: array
                        items:
                          type: string
                      cart:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                order:
                  type: object
                  properties:
                    email:
                      type: string
                      example: customer@example.com
                    status:
                      type: string
                      example: draft
                    payment_status:
                      type: string
                      example: marked_paid/free
                    order_type:
                      type: string
                      example: requested
                    financial_status:
                      type: string
                      example: free
                      enum:
                        - pending
                        - authorized
                        - partially_paid
                        - paid
                        - partially_refunded
                        - refunded
                        - voided
                        - marked_free
                        - marked_paid
                    order_status:
                      type: string
                      example: completed
                      enum:
                        - draft
                        - pending
                        - processing
                        - completed
                        - cancelled
                        - archived
                    fulfillment_status:
                      type: string
                      example: fulfilled
                      enum:
                        - unfulfilled
                        - in_progress
                        - on_hold
                        - partially_fulfilled
                        - scheduled
                        - fulfilled
                    note:
                      type: string
                      example: Customer requested expedited shipping
                    metafields:
                      type: array
                      description: Metafields for custom data storage
                      items:
                        type: object
                        properties:
                          namespace:
                            type: string
                            description: Namespace for the metafield
                          key:
                            type: string
                            description: Key for the metafield
                          value:
                            description: >-
                              Value for the metafield (type depends on
                              value_type)
                          value_type:
                            type: string
                            description: Type of the metafield value
                            enum:
                              - single_line_text_field
                              - multi_line_text_field
                              - rich_text_field
                              - number_integer
                              - number_decimal
                              - date
                              - date_time
                              - boolean
                              - json
                              - color
                              - url
                              - weight
                              - volume
                              - dimension
                              - rating
                              - money
                              - file_reference
                              - page_reference
                              - product_reference
                              - variant_reference
                              - collection_reference
                              - mixed_reference
                              - list.single_line_text_field
                              - list.number_integer
                              - list.number_decimal
                              - list.date
                              - list.date_time
                              - list.color
                              - list.url
                              - list.file_reference
                              - list.page_reference
                              - list.product_reference
                              - list.variant_reference
                              - list.collection_reference
                              - list.mixed_reference
                        required:
                          - namespace
                          - key
                          - value
                          - value_type
  /api/orders/{id}/transfer_customer:
    post:
      summary: Transfer an order to a different customer
      tags:
        - Orders
      description: >-
        Transfers an existing order to a different customer within the same
        company
      operationId: transferOrderToDifferentCustomer
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          description: Order ID
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: Order transferred with no address updates
          content:
            application/json:
              schema:
                type: object
                properties:
                  order:
                    type: object
                    properties:
                      id:
                        type: integer
                      email:
                        type:
                          - string
                          - 'null'
                      first_name:
                        type:
                          - string
                          - 'null'
                      last_name:
                        type:
                          - string
                          - 'null'
                      amount:
                        type:
                          - string
                          - 'null'
                      created_at:
                        type: string
                      updated_at:
                        type: string
                      currency_code:
                        type:
                          - string
                          - 'null'
                      order_number:
                        type:
                          - string
                          - 'null'
                      status:
                        type:
                          - string
                          - 'null'
                      note:
                        type:
                          - string
                          - 'null'
                      token:
                        type:
                          - string
                          - 'null'
                      tax:
                        type:
                          - string
                          - 'null'
                      shipping:
                        type:
                          - string
                          - 'null'
                      source:
                        type: string
                        enum:
                          - mobile
                          - web
                          - admin
                          - backoffice
                          - subscription
                      items:
                        type: array
                        items: {}
                      bill_to:
                        type:
                          - object
                          - 'null'
                      ship_to:
                        type:
                          - object
                          - 'null'
                      customer:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                          email:
                            type:
                              - string
                              - 'null'
                          first_name:
                            type:
                              - string
                              - 'null'
                          last_name:
                            type:
                              - string
                              - 'null'
                          phone:
                            type:
                              - string
                              - 'null'
                          full_name:
                            type:
                              - string
                              - 'null'
                          account_id:
                            type:
                              - string
                              - 'null'
                          created_at:
                            type: string
                          default_address:
                            type:
                              - object
                              - 'null'
                          external_id:
                            type:
                              - string
                              - 'null'
                          role:
                            type: string
                            example: customer
                            enum:
                              - customer
                              - preferred_customer
                              - rep
                        additionalProperties: true
                    additionalProperties: true
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                required:
                  - message
        '404':
          description: Customer not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      order:
                        type: array
                        items:
                          type: string
                      customer:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                required:
                  - error_message
                  - errors
                  - meta
        '422':
          description: Invalid transfer request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      customer:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                customer_id:
                  type: integer
                  description: ID of the customer to transfer the order to
              required:
                - customer_id
  /api/orders/{id}:
    patch:
      summary: Update an order
      description: Update an order
      tags:
        - Orders
      operationId: updateOrder
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Order ID
          schema:
            type: integer
      responses:
        '200':
          description: Order updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  order:
                    type: object
                    properties:
                      id:
                        type: integer
                      amount_in_base:
                        type: string
                        example: '10.0'
                      base_to_currency_rate:
                        type:
                          - string
                          - 'null'
                        example: '1.35'
                      currency_symbol:
                        type: string
                      currency_code:
                        type: string
                      external_id:
                        type:
                          - string
                          - 'null'
                      order_number:
                        type: string
                      token:
                        type: string
                      note:
                        type:
                          - string
                          - 'null'
                      company_logo_url:
                        type:
                          - string
                          - 'null'
                      created_at:
                        type: string
                      customer:
                        type:
                          - string
                          - 'null'
                      email:
                        type:
                          - string
                          - 'null'
                      total:
                        type: string
                      total_in_currency:
                        type: string
                      subtotal:
                        type: string
                        example: '90.00'
                      subtotal_after_discounts:
                        type: string
                        example: '87.00'
                      sub_total:
                        type: string
                        example: '90.00'
                      sub_total_in_currency:
                        type: string
                        example: $90.00
                      tax:
                        type: string
                        example: '2.00'
                      tax_in_currency:
                        type: string
                        example: $2.00
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: '1.90'
                      transaction_fee_in_currency:
                        type: string
                        example: $1.00
                      discount:
                        type: string
                        example: '3.00'
                      discount_in_currency:
                        type: string
                        example: $3.00
                      warehouse_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      warehouse:
                        oneOf:
                          - title: Warehouse
                            type: object
                            properties:
                              id:
                                type: integer
                              name:
                                example: Central Distribution Center
                                type: string
                              active:
                                example: true
                                type: boolean
                              external_id:
                                example: WH-12345
                                type:
                                  - string
                                  - 'null'
                              metadata:
                                example:
                                  capacity:
                                    total_square_feet: 50000
                                  operations:
                                    staff_count: 15
                                    security_level: high
                                type: object
                            required:
                              - id
                              - name
                              - active
                              - metadata
                          - type: 'null'
                      shipping:
                        type: string
                        example: $11.00
                      shipping_in_currency:
                        type:
                          - object
                          - 'null'
                        properties:
                          amount_in_currency:
                            type: string
                            example: $11.00
                          surcharge_in_currency:
                            type: string
                            example: $11.00
                      refundable_amount:
                        type:
                          - number
                          - string
                        format: float
                        example: 10.5
                      payment_status:
                        type: string
                      enrollment_token:
                        type:
                          - string
                          - 'null'
                      enrollment_pack:
                        type:
                          - object
                          - 'null'
                        properties:
                          enrollment_pack_id:
                            type: integer
                            example: 1
                          additional_volume:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          slug:
                            type: string
                            example: test-enrollment-pack
                          description:
                            type:
                              - object
                              - 'null'
                              - string
                            properties:
                              id:
                                type: integer
                                example: 111
                              name:
                                type: string
                                example: description
                              body:
                                type: string
                                example: >-
                                  <div>Try the latest and greatest of our sugar
                                  zip packs. Guaranteed to make you skinner and
                                  cure cancer.</div>
                              record_type:
                                type: string
                                example: EnrollmentPack
                              record_id:
                                type: integer
                                example: 1
                              created_at:
                                type: string
                                format: date_time
                                example: '2025-01-16T04:22:43.809Z'
                              updated_at:
                                type: string
                                format: date_time
                                example: '2025-01-22T10:23:52.941Z'
                              locale:
                                type: string
                                example: en
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: 10
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.00
                          images:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2
                                relateable_type:
                                  type: string
                                  example: EnrollmentPack
                                relateable_id:
                                  type: integer
                                  example: 1
                                image_url:
                                  type: string
                                  example: >-
                                    https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                image_path:
                                  type: string
                                  example: jITWaU14QGe0y5AFgY7P_00179.svg
                                position:
                                  type: integer
                                  example: 1
                                shopify_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                                created_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                updated_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                external_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 625
                                allow_subscription:
                                  type: boolean
                                  example: true
                                cv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                cv_in_currency:
                                  type: string
                                  example: $0.00
                                cv_total:
                                  type: integer
                                  example: 0
                                enrollment:
                                  type: boolean
                                  example: true
                                enrollment_pack_id:
                                  type: integer
                                  example: 1
                                price:
                                  type: string
                                  example: '11.13'
                                price_in_currency:
                                  type: string
                                  example: $11.13
                                product_title:
                                  type: string
                                  example: Zip Pack Sample Pack (30)
                                quantity:
                                  type: integer
                                  example: 1
                                qv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                qv_in_currency:
                                  type: string
                                  example: $0.00
                                qv_total:
                                  type: integer
                                  example: 0
                                subscribe_and_save:
                                  type:
                                    - string
                                    - 'null'
                                  example: '-1988.87'
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $-1,988.87
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $-1,988.87
                                subscription:
                                  type: boolean
                                  example: false
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_only:
                                  type: boolean
                                  example: false
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_price:
                                  type: string
                                  example: '2000.0'
                                subscription_price_in_currency:
                                  type: string
                                  example: $2,000.00
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  format: date
                                  example: '2025-02-28'
                                tax:
                                  type: string
                                  example: '0.0'
                                tax_in_currency:
                                  type: string
                                  example: $0.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: null
                                display_to_customer:
                                  type: boolean
                                  example: false
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                          price:
                            type: string
                            example: '11.13'
                          price_in_currency:
                            type: string
                            example: $11.13
                          subscription_price:
                            type:
                              - string
                              - integer
                            example: 2000
                          subscription_price_in_currency:
                            type: string
                            example: $2,000.00
                          title:
                            type: string
                            example: enroll product
                          token:
                            type: string
                            example: NxL22AqLRRisfyF9LqxxWRak
                      fulfillment_status:
                        type: string
                      order_status:
                        type: string
                      financial_status:
                        type: string
                      delivery_status:
                        type: string
                      delivery_method:
                        type: string
                      delivery_date:
                        type:
                          - string
                          - 'null'
                        example: '2023-07-29'
                      channel:
                        type: string
                      tags:
                        type: string
                      items_count:
                        type: integer
                      quantity_count:
                        type: integer
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 101
                            price:
                              type:
                                - number
                                - string
                              example: 43.41
                            price_in_currency:
                              type: string
                              example: $43.41
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            cv:
                              type: integer
                              example: 5
                            cv_in_currency:
                              type: string
                              example: $5.00
                            qv:
                              type: integer
                              example: 7
                            qv_in_currency:
                              type: string
                              example: $7.00
                            product_title:
                              type: string
                              example: Sample Product
                            variant_title:
                              type:
                                - string
                                - 'null'
                              example: Sample Variant
                            variant_image:
                              type:
                                - string
                                - 'null'
                              example: https://example.com/image.png
                            variant_id:
                              type: integer
                              example: 202
                            quantity:
                              type: integer
                              example: 3
                            title:
                              type: string
                            total:
                              type:
                                - number
                                - string
                            image_url:
                              type:
                                - string
                                - 'null'
                            sku:
                              type:
                                - string
                                - 'null'
                            display_price:
                              type: string
                            display_total:
                              type: string
                            refundable_amount:
                              type:
                                - number
                                - string
                              format: float
                              example: 10.5
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            bundled_items:
                              type: array
                              items:
                                type: object
                                properties:
                                  variant_id:
                                    type: integer
                                  product_id:
                                    type: integer
                                  product_title:
                                    type: string
                                  variant_title:
                                    type: string
                                  option_titles:
                                    type: array
                                    items:
                                      type: string
                                  quantity:
                                    type: integer
                                  display_to_customer:
                                    type: boolean
                            ordered_variant:
                              type: array
                              items:
                                type: object
                                properties:
                                  option_type:
                                    type: string
                                  value:
                                    type: string
                            product:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1
                                title:
                                  type: string
                                  example: Sample Product
                                introduction:
                                  type:
                                    - string
                                    - 'null'
                                  example: Sample Short Description
                                cv:
                                  type: integer
                                  example: 10
                                cv_in_currency:
                                  type: string
                                  example: $10.00
                                external_id:
                                  type:
                                    - string
                                    - 'null'
                                  example: ext-prod-123
                                image_path:
                                  type:
                                    - string
                                    - 'null'
                                  example: /images/product.png
                                image_url:
                                  type:
                                    - string
                                    - 'null'
                                  example: https://example.com/images/product.png
                                price:
                                  type: string
                                  example: '29.99'
                                price_in_currency:
                                  type: string
                                  example: $29.99
                                sku:
                                  type:
                                    - string
                                    - 'null'
                                  example: SKU12345
                                tax:
                                  type: string
                                  example: '2.99'
                                tax_in_currency:
                                  type: string
                                  example: $2.99
                                metadata:
                                  type: object
                                  example:
                                    shopify_product_id: 9876054868270
                                metafields:
                                  type: array
                                  items:
                                    title: LegacyMetafield
                                    type: object
                                    properties:
                                      namespace:
                                        description: >-
                                          A container for related metafields.
                                          Commonly used to group metafields by app
                                          or functionality.
                                        example: custom
                                        type: string
                                        maxLength: 20
                                        pattern: ^[a-zA-Z0-9_]+$
                                      key:
                                        description: >-
                                          The unique identifier for the metafield
                                          within its namespace. Must be unique per
                                          namespace and owner.
                                        example: material
                                        type: string
                                        maxLength: 30
                                        pattern: ^[a-zA-Z0-9_]+$
                                      value:
                                        description: >-
                                          The actual data stored in the metafield.
                                          Type depends on value_type.
                                        example: cotton
                                        type:
                                          - string
                                          - integer
                                          - object
                                          - boolean
                                          - number
                                      value_type:
                                        description: >-
                                          The data type that defines how the value
                                          should be interpreted and validated.
                                        example: single_line_text_field
                                        type: string
                                      description:
                                        description: >-
                                          Optional human-readable description
                                          explaining the purpose of this
                                          metafield.
                                        example: >-
                                          The primary material used in this
                                          product
                                        type:
                                          - string
                                          - 'null'
                                      created_at:
                                        description: >-
                                          Timestamp when the metafield was
                                          created.
                                        example: '2021-01-01T00:00:00Z'
                                        type: string
                                        format: date-time
                                      updated_at:
                                        description: >-
                                          Timestamp when the metafield was last
                                          updated.
                                        example: '2021-01-01T00:00:00Z'
                                        type: string
                                        format: date-time
                                      locked:
                                        description: >-
                                          Whether this metafield is locked and
                                          cannot be updated or deleted directly.
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                          - 'null'
                                      metafield_definition:
                                        description: >-
                                          The definition that defines validation
                                          rules and structure for this metafield
                                        type:
                                          - 'null'
                                          - object
                                    required:
                                      - namespace
                                      - key
                                      - value
                                      - value_type
                                      - description
                                      - created_at
                                      - updated_at
                                      - metafield_definition
                            variant:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: Sample Variant
                                image_path:
                                  type:
                                    - string
                                    - 'null'
                                  example: /images/sample.png
                                image_url:
                                  type:
                                    - string
                                    - 'null'
                                  example: https://example.com/images/sample.png
                                primary_image:
                                  type:
                                    - string
                                    - 'null'
                                  example: https://example.com/images/primary.png
                                price:
                                  type:
                                    - string
                                    - 'null'
                                  example: '34.44'
                                price_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $34.44
                                sku:
                                  type:
                                    - string
                                    - 'null'
                                  example: SKU12345
                                options:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      title:
                                        type: string
                                        example: Size
                                      value:
                                        type: string
                                        example: XL
                      activities:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            user_id:
                              type: integer
                            relation_type:
                              type: string
                            relation_id:
                              type: integer
                            contact_id:
                              type:
                                - integer
                                - 'null'
                            title:
                              type: string
                              example: A new order has been placed
                            description:
                              type: string
                              example: Samantha Joseph placed an order on Vandelay Shop
                            formatted_description:
                              type: string
                              example: >-
                                Samantha Joseph placed an order on Vandelay Shop
                                recently
                            read_at:
                              type:
                                - string
                                - 'null'
                            slug:
                              type: string
                            company_id:
                              type: integer
                            created_at:
                              type: string
                      shipping_method:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: string
                              title:
                                type: string
                              delivery_time_estimate:
                                type:
                                  - string
                                  - 'null'
                                example: 3-5 business days
                          - type: object
                            properties: {}
                      payment_details:
                        type:
                          - object
                          - 'null'
                        properties:
                          payment_type:
                            type: string
                          details:
                            type: object
                            properties:
                              card_type:
                                type: string
                                example: visa
                              card_brand:
                                type: string
                                example: Visa
                              last_four:
                                type: string
                                example: '1234'
                              logo_url:
                                type: string
                                example: >-
                                  https://assets.fluid.app/images/payment_icons/visa.svg
                      primary_domain_hostname:
                        type:
                          - string
                          - 'null'
                        example: fluid.com
                      company_subdomain:
                        type:
                          - string
                          - 'null'
                        example: myco
                      shipping_total:
                        type: string
                        example: '0.0'
                      shipping_total_for_display:
                        type: string
                        example: Free
                      ship_to:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      bill_to:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      shipping_address:
                        type:
                          - object
                          - 'null'
                        properties:
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          address1:
                            type:
                              - string
                              - 'null'
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type:
                              - string
                              - 'null'
                            example: New York
                          state:
                            type:
                              - string
                              - 'null'
                            example: NY
                          postal_code:
                            type:
                              - string
                              - 'null'
                            example: '10001'
                          country_code:
                            type:
                              - string
                              - 'null'
                            example: US
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                      billing_address:
                        type:
                          - object
                          - 'null'
                        properties:
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          address1:
                            type:
                              - string
                              - 'null'
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type:
                              - string
                              - 'null'
                            example: New York
                          state:
                            type:
                              - string
                              - 'null'
                            example: NY
                          postal_code:
                            type:
                              - string
                              - 'null'
                            example: '10001'
                          country_code:
                            type:
                              - string
                              - 'null'
                            example: US
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      order_on_behalf_of:
                        type: boolean
                        example: true
                      volume_rep:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type:
                              - integer
                              - 'null'
                            example: 1
                          email:
                            type:
                              - string
                              - 'null'
                            example: volume_rep@example.com
                          full_name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          image_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/image.png
                      metadata:
                        type:
                          - object
                          - 'null'
                      metafields:
                        type: array
                        items:
                          title: LegacyMetafield
                          type: object
                          properties:
                            id:
                              type: integer
                            namespace:
                              description: >-
                                A container for related metafields. Commonly
                                used to group metafields by app or
                                functionality.
                              example: custom
                              type: string
                              maxLength: 20
                              pattern: ^[a-zA-Z0-9_]+$
                            key:
                              description: >-
                                The unique identifier for the metafield within
                                its namespace. Must be unique per namespace and
                                owner.
                              example: material
                              type: string
                              maxLength: 30
                              pattern: ^[a-zA-Z0-9_]+$
                            value:
                              description: >-
                                The actual data stored in the metafield. Type
                                depends on value_type.
                              example: cotton
                              type:
                                - string
                                - object
                            value_type:
                              description: >-
                                The data type that defines how the value should
                                be interpreted and validated.
                              example: single_line_text_field
                              type: string
                            description:
                              description: >-
                                Optional human-readable description explaining
                                the purpose of this metafield.
                              example: The primary material used in this product
                              type:
                                - string
                                - 'null'
                            owner_type:
                              description: >-
                                The type of resource that this metafield belongs
                                to (polymorphic association).
                              example: Product
                              type: string
                            owner_id:
                              description: >-
                                The ID of the specific resource that this
                                metafield belongs to.
                              example: 12345
                              type: integer
                            created_at:
                              description: Timestamp when the metafield was created.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            updated_at:
                              description: Timestamp when the metafield was last updated.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            metafield_definition:
                              title: MetafieldDefinition
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                company_id:
                                  description: >-
                                    The ID of the company that owns this
                                    metafield definition.
                                  example: 1
                                  type: integer
                                namespace:
                                  description: >-
                                    A container for related metafield
                                    definitions. Used to group definitions by
                                    app or functionality. Must be unique within
                                    company and owner_resource.
                                  example: product_details
                                  type: string
                                  maxLength: 20
                                  pattern: ^[a-zA-Z0-9_]+$
                                key:
                                  description: >-
                                    The unique identifier for the metafield
                                    definition within its namespace and
                                    owner_resource. Combined with namespace and
                                    owner_resource, this must be unique per
                                    company.
                                  example: material_type
                                  type: string
                                  maxLength: 30
                                  pattern: ^[a-zA-Z0-9_]+$
                                name:
                                  description: >-
                                    Human-readable display name for the
                                    metafield definition, shown in admin
                                    interfaces and forms.
                                  example: Material Type
                                  type: string
                                  maxLength: 100
                                description:
                                  description: >-
                                    Detailed explanation of what this metafield
                                    definition represents, how it should be
                                    used, and any special instructions for
                                    content creators.
                                  example: >-
                                    Specify the primary material composition of
                                    the product (e.g., cotton, polyester, silk).
                                    This will be displayed on the product detail
                                    page.
                                  type:
                                    - string
                                    - 'null'
                                value_type:
                                  description: >-
                                    The data type that defines how metafield
                                    values should be validated, stored, and
                                    displayed. Determines which validation rules
                                    are available.
                                  example: single_line_text_field
                                  type: string
                                validation_rules:
                                  description: >-
                                    JSON object containing validation
                                    constraints that will be applied to
                                    metafield values. Available rules depend on
                                    the value_type.
                                  example:
                                    choices:
                                      - cotton
                                      - polyester
                                      - silk
                                      - wool
                                      - linen
                                      - bamboo
                                    max: 50
                                    min: 2
                                  type:
                                    - object
                                    - 'null'
                                owner_resource:
                                  description: >-
                                    The type of resource (model class name) that
                                    metafields using this definition can be
                                    attached to. Must match the polymorphic
                                    owner_type.
                                  example: Product
                                  type: string
                                pinned:
                                  description: >-
                                    Whether this definition should be
                                    prominently displayed or prioritized in
                                    admin interfaces and forms.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                position:
                                  default: 0
                                  description: >-
                                    Sort order for displaying this definition
                                    relative to others in the same category and
                                    owner_resource. Lower numbers appear first.
                                  example: 1
                                  type:
                                    - integer
                                    - 'null'
                                locked:
                                  description: >-
                                    Whether this metafield definition is locked,
                                    preventing direct updates or deletions of
                                    metafields using this definition.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                created_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    created.
                                  example: '2024-01-15T10:30:00Z'
                                  type: string
                                  format: date-time
                                updated_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    last updated.
                                  example: '2024-02-20T14:45:00Z'
                                  type: string
                                  format: date-time
                                list_type:
                                  description: >-
                                    Whether this definition is for list-type
                                    metafields that store arrays of values.
                                  example: false
                                  type: boolean
                                reference_type:
                                  description: >-
                                    Whether this definition is for
                                    reference-type metafields that store
                                    references to other resources.
                                  example: false
                                  type: boolean
                                supported_validations:
                                  description: >-
                                    Array of validation rule names that are
                                    supported for this value_type.
                                  example:
                                    - min
                                    - max
                                    - choices
                                    - regex
                                  type: array
                                validation_description:
                                  description: >-
                                    Human-readable description of what the
                                    value_type represents and its constraints.
                                  example: Single line text up to 5000 characters
                                  type: string
                                category_ids:
                                  description: >-
                                    Array of category IDs that this metafield
                                    definition is associated with for
                                    organizational purposes.
                                  example:
                                    - 1
                                    - 2
                                    - 3
                                  items:
                                    type: integer
                                  type: array
                              required:
                                - id
                                - company_id
                                - namespace
                                - key
                                - name
                                - value_type
                                - owner_resource
                                - created_at
                                - updated_at
                                - list_type
                                - reference_type
                                - supported_validations
                                - validation_description
                                - category_ids
                          required:
                            - id
                            - namespace
                            - key
                            - value
                            - value_type
                            - owner_type
                            - owner_id
                            - created_at
                            - updated_at
                      free_shipping:
                        type: boolean
                        example: false
                        description: Whether the order has free shipping
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT1
                          - DISCOUNT2
                        description: Discount codes applied to the order
                      points_applied:
                        type: integer
                        example: 500
                        description: Total points used for this order
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Total points in currency amount used for this order
                      order_total_after_points_redemption:
                        type: number
                        example: 95
                        description: >-
                          The order total (actual card payment) after points
                          redemption
                      split_payment:
                        type:
                          - object
                          - 'null'
                        properties:
                          points_amount:
                            type: integer
                            example: 500
                          points_currency_value:
                            type: number
                            example: 5
                          card_amount:
                            type: number
                            example: 95
                          points_ledger_id:
                            type: integer
                            example: 123
                          card_payment_id:
                            type:
                              - integer
                              - 'null'
                            example: 456
                      source:
                        type: string
                        example: web
                        enum:
                          - mobile
                          - web
                          - admin
                          - backoffice
                          - subscription
                      price_inclusive_of_tax:
                        type: boolean
                        example: false
                      price_inclusive_tax_name:
                        type:
                          - string
                          - 'null'
                        example: null
                    required:
                      - id
                      - currency_symbol
                      - total
                      - payment_status
                      - fulfillment_status
                      - delivery_status
                      - delivery_method
                      - channel
                      - tags
                      - items_count
                      - items
                      - payment_details
                      - ship_to
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                      shop_url:
                        type: string
                required:
                  - order
                  - meta
        '401':
          description: Unauthorized
        '404':
          description: Order not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    properties:
                      order:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                order:
                  type: object
                  properties:
                    note:
                      type: string
                      description: Order note
                      example: Customer requested expedited shipping
                    external_id:
                      type:
                        - string
                        - 'null'
                      description: External system identifier for the order (optional)
                      example: EXT-12345
                    metadata:
                      type: object
                      description: Additional order metadata
                      example:
                        source: mobile_app
                        campaign_id: summer2024
                    metafields:
                      type: array
                      description: Metafields for custom data storage
                      items:
                        type: object
                        properties:
                          id:
                            type: integer
                            description: Metafield ID (for updates)
                          namespace:
                            type: string
                            description: Namespace for the metafield
                          key:
                            type: string
                            description: Key for the metafield
                          value:
                            description: >-
                              Value for the metafield (type depends on
                              value_type)
                          value_type:
                            type: string
                            description: Type of the metafield value
                            enum:
                              - single_line_text_field
                              - multi_line_text_field
                              - rich_text_field
                              - number_integer
                              - number_decimal
                              - date
                              - date_time
                              - boolean
                              - json
                              - color
                              - url
                              - weight
                              - volume
                              - dimension
                              - rating
                              - money
                              - file_reference
                              - page_reference
                              - product_reference
                              - variant_reference
                              - collection_reference
                              - mixed_reference
                              - list.single_line_text_field
                              - list.number_integer
                              - list.number_decimal
                              - list.date
                              - list.date_time
                              - list.color
                              - list.url
                              - list.file_reference
                              - list.page_reference
                              - list.product_reference
                              - list.variant_reference
                              - list.collection_reference
                              - list.mixed_reference
                          _destroy:
                            type: boolean
                            description: Mark for deletion
        required: true
    put:
      summary: Update an order (PUT method)
      description: Update an order using PUT method
      tags:
        - Orders
      operationId: updateOrderPut
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Order ID
          schema:
            type: integer
      responses:
        '200':
          description: Order updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  order:
                    type: object
                    description: Updated order object with associations
                  meta:
                    type: object
                    properties:
                      shop_url:
                        type: string
                        description: Company base URL
                        example: https://test-company.fluid.com
                      request_id:
                        type: string
                        description: Request identifier
                      timestamp:
                        type: string
                        description: Response timestamp in ISO8601 format
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                order:
                  type: object
                  properties:
                    note:
                      type: string
                      description: Order note
                      example: Customer requested expedited shipping
                    external_id:
                      type:
                        - string
                        - 'null'
                      description: External system identifier for the order (optional)
                      example: EXT-12345
                    metadata:
                      type: object
                      description: Additional order metadata
                      example:
                        source: mobile_app
                        campaign_id: summer2024
        required: true
  /api/orders/{id}/update_warehouse:
    patch:
      summary: Update Order Warehouse
      description: Update the warehouse for an order
      tags:
        - Orders
      operationId: updateOrderWarehouse
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Order ID
          schema:
            type: integer
      responses:
        '200':
          description: Order warehouse updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  order:
                    type: object
                    properties:
                      id:
                        type: integer
                      amount_in_base:
                        type: string
                        example: '10.0'
                      base_to_currency_rate:
                        type:
                          - string
                          - 'null'
                        example: '1.35'
                      currency_symbol:
                        type: string
                      currency_code:
                        type: string
                      external_id:
                        type:
                          - string
                          - 'null'
                      order_number:
                        type: string
                      token:
                        type: string
                      note:
                        type:
                          - string
                          - 'null'
                      company_logo_url:
                        type:
                          - string
                          - 'null'
                      created_at:
                        type: string
                      customer:
                        type:
                          - string
                          - 'null'
                      email:
                        type:
                          - string
                          - 'null'
                      total:
                        type: string
                      total_in_currency:
                        type: string
                      subtotal:
                        type: string
                        example: '90.00'
                      subtotal_after_discounts:
                        type: string
                        example: '87.00'
                      sub_total:
                        type: string
                        example: '90.00'
                      sub_total_in_currency:
                        type: string
                        example: $90.00
                      tax:
                        type: string
                        example: '2.00'
                      tax_in_currency:
                        type: string
                        example: $2.00
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: '1.90'
                      transaction_fee_in_currency:
                        type: string
                        example: $1.00
                      discount:
                        type: string
                        example: '3.00'
                      discount_in_currency:
                        type: string
                        example: $3.00
                      warehouse_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      warehouse:
                        oneOf:
                          - title: Warehouse
                            type: object
                            properties:
                              id:
                                type: integer
                              name:
                                example: Central Distribution Center
                                type: string
                              active:
                                example: true
                                type: boolean
                              external_id:
                                example: WH-12345
                                type:
                                  - string
                                  - 'null'
                              metadata:
                                example:
                                  capacity:
                                    total_square_feet: 50000
                                  operations:
                                    staff_count: 15
                                    security_level: high
                                type: object
                            required:
                              - id
                              - name
                              - active
                              - metadata
                          - type: 'null'
                      shipping:
                        type: string
                        example: $11.00
                      shipping_in_currency:
                        type:
                          - object
                          - 'null'
                        properties:
                          amount_in_currency:
                            type: string
                            example: $11.00
                          surcharge_in_currency:
                            type: string
                            example: $11.00
                      refundable_amount:
                        type:
                          - number
                          - string
                        format: float
                        example: 10.5
                      payment_status:
                        type: string
                      enrollment_token:
                        type:
                          - string
                          - 'null'
                      enrollment_pack:
                        type:
                          - object
                          - 'null'
                        properties:
                          enrollment_pack_id:
                            type: integer
                            example: 1
                          additional_volume:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          slug:
                            type: string
                            example: test-enrollment-pack
                          description:
                            type:
                              - object
                              - 'null'
                              - string
                            properties:
                              id:
                                type: integer
                                example: 111
                              name:
                                type: string
                                example: description
                              body:
                                type: string
                                example: >-
                                  <div>Try the latest and greatest of our sugar
                                  zip packs. Guaranteed to make you skinner and
                                  cure cancer.</div>
                              record_type:
                                type: string
                                example: EnrollmentPack
                              record_id:
                                type: integer
                                example: 1
                              created_at:
                                type: string
                                format: date_time
                                example: '2025-01-16T04:22:43.809Z'
                              updated_at:
                                type: string
                                format: date_time
                                example: '2025-01-22T10:23:52.941Z'
                              locale:
                                type: string
                                example: en
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: 10
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.00
                          images:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2
                                relateable_type:
                                  type: string
                                  example: EnrollmentPack
                                relateable_id:
                                  type: integer
                                  example: 1
                                image_url:
                                  type: string
                                  example: >-
                                    https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                image_path:
                                  type: string
                                  example: jITWaU14QGe0y5AFgY7P_00179.svg
                                position:
                                  type: integer
                                  example: 1
                                shopify_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                                created_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                updated_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                external_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 625
                                allow_subscription:
                                  type: boolean
                                  example: true
                                cv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                cv_in_currency:
                                  type: string
                                  example: $0.00
                                cv_total:
                                  type: integer
                                  example: 0
                                enrollment:
                                  type: boolean
                                  example: true
                                enrollment_pack_id:
                                  type: integer
                                  example: 1
                                price:
                                  type: string
                                  example: '11.13'
                                price_in_currency:
                                  type: string
                                  example: $11.13
                                product_title:
                                  type: string
                                  example: Zip Pack Sample Pack (30)
                                quantity:
                                  type: integer
                                  example: 1
                                qv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                qv_in_currency:
                                  type: string
                                  example: $0.00
                                qv_total:
                                  type: integer
                                  example: 0
                                subscribe_and_save:
                                  type:
                                    - string
                                    - 'null'
                                  example: '-1988.87'
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $-1,988.87
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $-1,988.87
                                subscription:
                                  type: boolean
                                  example: false
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_only:
                                  type: boolean
                                  example: false
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_price:
                                  type: string
                                  example: '2000.0'
                                subscription_price_in_currency:
                                  type: string
                                  example: $2,000.00
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  format: date
                                  example: '2025-02-28'
                                tax:
                                  type: string
                                  example: '0.0'
                                tax_in_currency:
                                  type: string
                                  example: $0.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: null
                                display_to_customer:
                                  type: boolean
                                  example: false
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                          price:
                            type: string
                            example: '11.13'
                          price_in_currency:
                            type: string
                            example: $11.13
                          subscription_price:
                            type:
                              - string
                              - integer
                            example: 2000
                          subscription_price_in_currency:
                            type: string
                            example: $2,000.00
                          title:
                            type: string
                            example: enroll product
                          token:
                            type: string
                            example: NxL22AqLRRisfyF9LqxxWRak
                      fulfillment_status:
                        type: string
                      order_status:
                        type: string
                      financial_status:
                        type: string
                      delivery_status:
                        type: string
                      delivery_method:
                        type: string
                      delivery_date:
                        type:
                          - string
                          - 'null'
                        example: '2023-07-29'
                      channel:
                        type: string
                      tags:
                        type: string
                      items_count:
                        type: integer
                      quantity_count:
                        type: integer
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 101
                            price:
                              type:
                                - number
                                - string
                              example: 43.41
                            price_in_currency:
                              type: string
                              example: $43.41
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            cv:
                              type: integer
                              example: 5
                            cv_in_currency:
                              type: string
                              example: $5.00
                            qv:
                              type: integer
                              example: 7
                            qv_in_currency:
                              type: string
                              example: $7.00
                            product_title:
                              type: string
                              example: Sample Product
                            variant_title:
                              type:
                                - string
                                - 'null'
                              example: Sample Variant
                            variant_image:
                              type:
                                - string
                                - 'null'
                              example: https://example.com/image.png
                            variant_id:
                              type: integer
                              example: 202
                            quantity:
                              type: integer
                              example: 3
                            title:
                              type: string
                            total:
                              type:
                                - number
                                - string
                            image_url:
                              type:
                                - string
                                - 'null'
                            sku:
                              type:
                                - string
                                - 'null'
                            display_price:
                              type: string
                            display_total:
                              type: string
                            refundable_amount:
                              type:
                                - number
                                - string
                              format: float
                              example: 10.5
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            bundled_items:
                              type: array
                              items:
                                type: object
                                properties:
                                  variant_id:
                                    type: integer
                                  product_id:
                                    type: integer
                                  product_title:
                                    type: string
                                  variant_title:
                                    type: string
                                  option_titles:
                                    type: array
                                    items:
                                      type: string
                                  quantity:
                                    type: integer
                                  display_to_customer:
                                    type: boolean
                            ordered_variant:
                              type: array
                              items:
                                type: object
                                properties:
                                  option_type:
                                    type: string
                                  value:
                                    type: string
                            product:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1
                                title:
                                  type: string
                                  example: Sample Product
                                introduction:
                                  type:
                                    - string
                                    - 'null'
                                  example: Sample Short Description
                                cv:
                                  type: integer
                                  example: 10
                                cv_in_currency:
                                  type: string
                                  example: $10.00
                                external_id:
                                  type:
                                    - string
                                    - 'null'
                                  example: ext-prod-123
                                image_path:
                                  type:
                                    - string
                                    - 'null'
                                  example: /images/product.png
                                image_url:
                                  type:
                                    - string
                                    - 'null'
                                  example: https://example.com/images/product.png
                                price:
                                  type: string
                                  example: '29.99'
                                price_in_currency:
                                  type: string
                                  example: $29.99
                                sku:
                                  type:
                                    - string
                                    - 'null'
                                  example: SKU12345
                                tax:
                                  type: string
                                  example: '2.99'
                                tax_in_currency:
                                  type: string
                                  example: $2.99
                                metadata:
                                  type: object
                                  example:
                                    shopify_product_id: 9876054868270
                                metafields:
                                  type: array
                                  items:
                                    title: LegacyMetafield
                                    type: object
                                    properties:
                                      namespace:
                                        description: >-
                                          A container for related metafields.
                                          Commonly used to group metafields by app
                                          or functionality.
                                        example: custom
                                        type: string
                                        maxLength: 20
                                        pattern: ^[a-zA-Z0-9_]+$
                                      key:
                                        description: >-
                                          The unique identifier for the metafield
                                          within its namespace. Must be unique per
                                          namespace and owner.
                                        example: material
                                        type: string
                                        maxLength: 30
                                        pattern: ^[a-zA-Z0-9_]+$
                                      value:
                                        description: >-
                                          The actual data stored in the metafield.
                                          Type depends on value_type.
                                        example: cotton
                                        type:
                                          - string
                                          - integer
                                          - object
                                          - boolean
                                          - number
                                      value_type:
                                        description: >-
                                          The data type that defines how the value
                                          should be interpreted and validated.
                                        example: single_line_text_field
                                        type: string
                                      description:
                                        description: >-
                                          Optional human-readable description
                                          explaining the purpose of this
                                          metafield.
                                        example: >-
                                          The primary material used in this
                                          product
                                        type:
                                          - string
                                          - 'null'
                                      created_at:
                                        description: >-
                                          Timestamp when the metafield was
                                          created.
                                        example: '2021-01-01T00:00:00Z'
                                        type: string
                                        format: date-time
                                      updated_at:
                                        description: >-
                                          Timestamp when the metafield was last
                                          updated.
                                        example: '2021-01-01T00:00:00Z'
                                        type: string
                                        format: date-time
                                      locked:
                                        description: >-
                                          Whether this metafield is locked and
                                          cannot be updated or deleted directly.
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                          - 'null'
                                      metafield_definition:
                                        description: >-
                                          The definition that defines validation
                                          rules and structure for this metafield
                                        type:
                                          - 'null'
                                          - object
                                    required:
                                      - namespace
                                      - key
                                      - value
                                      - value_type
                                      - description
                                      - created_at
                                      - updated_at
                                      - metafield_definition
                            variant:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: Sample Variant
                                image_path:
                                  type:
                                    - string
                                    - 'null'
                                  example: /images/sample.png
                                image_url:
                                  type:
                                    - string
                                    - 'null'
                                  example: https://example.com/images/sample.png
                                primary_image:
                                  type:
                                    - string
                                    - 'null'
                                  example: https://example.com/images/primary.png
                                price:
                                  type:
                                    - string
                                    - 'null'
                                  example: '34.44'
                                price_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $34.44
                                sku:
                                  type:
                                    - string
                                    - 'null'
                                  example: SKU12345
                                options:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      title:
                                        type: string
                                        example: Size
                                      value:
                                        type: string
                                        example: XL
                      activities:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            user_id:
                              type: integer
                            relation_type:
                              type: string
                            relation_id:
                              type: integer
                            contact_id:
                              type:
                                - integer
                                - 'null'
                            title:
                              type: string
                              example: A new order has been placed
                            description:
                              type: string
                              example: Samantha Joseph placed an order on Vandelay Shop
                            formatted_description:
                              type: string
                              example: >-
                                Samantha Joseph placed an order on Vandelay Shop
                                recently
                            read_at:
                              type:
                                - string
                                - 'null'
                            slug:
                              type: string
                            company_id:
                              type: integer
                            created_at:
                              type: string
                      shipping_method:
                        oneOf:
                          - type: object
                            properties:
                              id:
                                type: string
                              title:
                                type: string
                              delivery_time_estimate:
                                type:
                                  - string
                                  - 'null'
                                example: 3-5 business days
                          - type: object
                            properties: {}
                      payment_details:
                        type:
                          - object
                          - 'null'
                        properties:
                          payment_type:
                            type: string
                          details:
                            type: object
                            properties:
                              card_type:
                                type: string
                                example: visa
                              card_brand:
                                type: string
                                example: Visa
                              last_four:
                                type: string
                                example: '1234'
                              logo_url:
                                type: string
                                example: >-
                                  https://assets.fluid.app/images/payment_icons/visa.svg
                      primary_domain_hostname:
                        type:
                          - string
                          - 'null'
                        example: fluid.com
                      company_subdomain:
                        type:
                          - string
                          - 'null'
                        example: myco
                      shipping_total:
                        type: string
                        example: '0.0'
                      shipping_total_for_display:
                        type: string
                        example: Free
                      ship_to:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      bill_to:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      shipping_address:
                        type:
                          - object
                          - 'null'
                        properties:
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          address1:
                            type:
                              - string
                              - 'null'
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type:
                              - string
                              - 'null'
                            example: New York
                          state:
                            type:
                              - string
                              - 'null'
                            example: NY
                          postal_code:
                            type:
                              - string
                              - 'null'
                            example: '10001'
                          country_code:
                            type:
                              - string
                              - 'null'
                            example: US
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                      billing_address:
                        type:
                          - object
                          - 'null'
                        properties:
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          address1:
                            type:
                              - string
                              - 'null'
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type:
                              - string
                              - 'null'
                            example: New York
                          state:
                            type:
                              - string
                              - 'null'
                            example: NY
                          postal_code:
                            type:
                              - string
                              - 'null'
                            example: '10001'
                          country_code:
                            type:
                              - string
                              - 'null'
                            example: US
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      order_on_behalf_of:
                        type: boolean
                        example: true
                      volume_rep:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type:
                              - integer
                              - 'null'
                            example: 1
                          email:
                            type:
                              - string
                              - 'null'
                            example: volume_rep@example.com
                          full_name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          image_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/image.png
                      metadata:
                        type:
                          - object
                          - 'null'
                      metafields:
                        type: array
                        items:
                          title: LegacyMetafield
                          type: object
                          properties:
                            id:
                              type: integer
                            namespace:
                              description: >-
                                A container for related metafields. Commonly
                                used to group metafields by app or
                                functionality.
                              example: custom
                              type: string
                              maxLength: 20
                              pattern: ^[a-zA-Z0-9_]+$
                            key:
                              description: >-
                                The unique identifier for the metafield within
                                its namespace. Must be unique per namespace and
                                owner.
                              example: material
                              type: string
                              maxLength: 30
                              pattern: ^[a-zA-Z0-9_]+$
                            value:
                              description: >-
                                The actual data stored in the metafield. Type
                                depends on value_type.
                              example: cotton
                              type:
                                - string
                                - object
                            value_type:
                              description: >-
                                The data type that defines how the value should
                                be interpreted and validated.
                              example: single_line_text_field
                              type: string
                            description:
                              description: >-
                                Optional human-readable description explaining
                                the purpose of this metafield.
                              example: The primary material used in this product
                              type:
                                - string
                                - 'null'
                            owner_type:
                              description: >-
                                The type of resource that this metafield belongs
                                to (polymorphic association).
                              example: Product
                              type: string
                            owner_id:
                              description: >-
                                The ID of the specific resource that this
                                metafield belongs to.
                              example: 12345
                              type: integer
                            created_at:
                              description: Timestamp when the metafield was created.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            updated_at:
                              description: Timestamp when the metafield was last updated.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            metafield_definition:
                              title: MetafieldDefinition
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                company_id:
                                  description: >-
                                    The ID of the company that owns this
                                    metafield definition.
                                  example: 1
                                  type: integer
                                namespace:
                                  description: >-
                                    A container for related metafield
                                    definitions. Used to group definitions by
                                    app or functionality. Must be unique within
                                    company and owner_resource.
                                  example: product_details
                                  type: string
                                  maxLength: 20
                                  pattern: ^[a-zA-Z0-9_]+$
                                key:
                                  description: >-
                                    The unique identifier for the metafield
                                    definition within its namespace and
                                    owner_resource. Combined with namespace and
                                    owner_resource, this must be unique per
                                    company.
                                  example: material_type
                                  type: string
                                  maxLength: 30
                                  pattern: ^[a-zA-Z0-9_]+$
                                name:
                                  description: >-
                                    Human-readable display name for the
                                    metafield definition, shown in admin
                                    interfaces and forms.
                                  example: Material Type
                                  type: string
                                  maxLength: 100
                                description:
                                  description: >-
                                    Detailed explanation of what this metafield
                                    definition represents, how it should be
                                    used, and any special instructions for
                                    content creators.
                                  example: >-
                                    Specify the primary material composition of
                                    the product (e.g., cotton, polyester, silk).
                                    This will be displayed on the product detail
                                    page.
                                  type:
                                    - string
                                    - 'null'
                                value_type:
                                  description: >-
                                    The data type that defines how metafield
                                    values should be validated, stored, and
                                    displayed. Determines which validation rules
                                    are available.
                                  example: single_line_text_field
                                  type: string
                                validation_rules:
                                  description: >-
                                    JSON object containing validation
                                    constraints that will be applied to
                                    metafield values. Available rules depend on
                                    the value_type.
                                  example:
                                    choices:
                                      - cotton
                                      - polyester
                                      - silk
                                      - wool
                                      - linen
                                      - bamboo
                                    max: 50
                                    min: 2
                                  type:
                                    - object
                                    - 'null'
                                owner_resource:
                                  description: >-
                                    The type of resource (model class name) that
                                    metafields using this definition can be
                                    attached to. Must match the polymorphic
                                    owner_type.
                                  example: Product
                                  type: string
                                pinned:
                                  description: >-
                                    Whether this definition should be
                                    prominently displayed or prioritized in
                                    admin interfaces and forms.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                position:
                                  default: 0
                                  description: >-
                                    Sort order for displaying this definition
                                    relative to others in the same category and
                                    owner_resource. Lower numbers appear first.
                                  example: 1
                                  type:
                                    - integer
                                    - 'null'
                                locked:
                                  description: >-
                                    Whether this metafield definition is locked,
                                    preventing direct updates or deletions of
                                    metafields using this definition.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                created_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    created.
                                  example: '2024-01-15T10:30:00Z'
                                  type: string
                                  format: date-time
                                updated_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    last updated.
                                  example: '2024-02-20T14:45:00Z'
                                  type: string
                                  format: date-time
                                list_type:
                                  description: >-
                                    Whether this definition is for list-type
                                    metafields that store arrays of values.
                                  example: false
                                  type: boolean
                                reference_type:
                                  description: >-
                                    Whether this definition is for
                                    reference-type metafields that store
                                    references to other resources.
                                  example: false
                                  type: boolean
                                supported_validations:
                                  description: >-
                                    Array of validation rule names that are
                                    supported for this value_type.
                                  example:
                                    - min
                                    - max
                                    - choices
                                    - regex
                                  type: array
                                validation_description:
                                  description: >-
                                    Human-readable description of what the
                                    value_type represents and its constraints.
                                  example: Single line text up to 5000 characters
                                  type: string
                                category_ids:
                                  description: >-
                                    Array of category IDs that this metafield
                                    definition is associated with for
                                    organizational purposes.
                                  example:
                                    - 1
                                    - 2
                                    - 3
                                  items:
                                    type: integer
                                  type: array
                              required:
                                - id
                                - company_id
                                - namespace
                                - key
                                - name
                                - value_type
                                - owner_resource
                                - created_at
                                - updated_at
                                - list_type
                                - reference_type
                                - supported_validations
                                - validation_description
                                - category_ids
                          required:
                            - id
                            - namespace
                            - key
                            - value
                            - value_type
                            - owner_type
                            - owner_id
                            - created_at
                            - updated_at
                      free_shipping:
                        type: boolean
                        example: false
                        description: Whether the order has free shipping
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT1
                          - DISCOUNT2
                        description: Discount codes applied to the order
                      points_applied:
                        type: integer
                        example: 500
                        description: Total points used for this order
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Total points in currency amount used for this order
                      order_total_after_points_redemption:
                        type: number
                        example: 95
                        description: >-
                          The order total (actual card payment) after points
                          redemption
                      split_payment:
                        type:
                          - object
                          - 'null'
                        properties:
                          points_amount:
                            type: integer
                            example: 500
                          points_currency_value:
                            type: number
                            example: 5
                          card_amount:
                            type: number
                            example: 95
                          points_ledger_id:
                            type: integer
                            example: 123
                          card_payment_id:
                            type:
                              - integer
                              - 'null'
                            example: 456
                      source:
                        type: string
                        example: web
                        enum:
                          - mobile
                          - web
                          - admin
                          - backoffice
                          - subscription
                      price_inclusive_of_tax:
                        type: boolean
                        example: false
                      price_inclusive_tax_name:
                        type:
                          - string
                          - 'null'
                        example: null
                    required:
                      - id
                      - currency_symbol
                      - total
                      - payment_status
                      - fulfillment_status
                      - delivery_status
                      - delivery_method
                      - channel
                      - tags
                      - items_count
                      - items
                      - payment_details
                      - ship_to
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                      shop_url:
                        type: string
                required:
                  - order
                  - meta
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '404':
          description: Order not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    properties:
                      order:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '422':
          description: Warehouse does not belong to the same company country
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Warehouse does not belong to the same company country
                  errors:
                    type: object
                    properties:
                      warehouse_id:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                warehouse_id:
                  type: integer
                  description: ID of the warehouse to assign to the order
                  example: 123
              required:
                - warehouse_id
        required: true
  /api/v202506/orders/export_csv:
    get:
      summary: Export Commerce Orders to CSV
      description: Export orders to CSV file (async or sync)
      tags:
        - Orders
      operationId: exportCommerceOrdersToCSV
      security:
        - bearer_auth: []
      parameters:
        - name: within_days
          in: query
          required: false
          description: Limit results to within the last N days
          example: 30
          schema:
            type: integer
        - name: report_type
          in: query
          required: false
          description: Type of report to generate
          schema:
            type: string
            enum:
              - orders
              - shipping
              - subscription
          example: orders
        - name: send_email
          in: query
          required: false
          description: Send export result via email
          example: false
          schema:
            type: boolean
        - name: async
          in: query
          required: false
          description: Process export asynchronously
          example: true
          schema:
            type: boolean
        - name: start_date
          in: query
          required: false
          description: Start date for filtering orders (MM/DD/YYYY)
          example: 01/01/2025
          schema:
            type: string
        - name: end_date
          in: query
          required: false
          description: End date for filtering orders (MM/DD/YYYY)
          example: 01/31/2025
          schema:
            type: string
        - name: status
          in: query
          required: false
          description: Filter by order status
          example: processing
          schema:
            type: string
        - name: countries
          in: query
          required: false
          description: Filter by country codes (comma-separated)
          example: US,CA
          schema:
            type: string
      responses:
        '200':
          description: sync export completed
          content:
            application/json:
              schema:
                type: object
                properties:
                  job_id:
                    type: string
                    example: 12345abcde
                  status:
                    type: string
                    example: processing
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 5d72c7cd-54c5-449d-93f5-6da4631cd267
                      timestamp:
                        type: string
                        example: '2025-04-25T09:13:38Z'
                    required:
                      - request_id
                      - timestamp
                  url:
                    type: string
                    example: https://cdn.example.com/exports/orders_2025-01-15.csv
                required:
                  - url
                  - meta
        '401':
          description: unauthorized
        '422':
          description: no orders found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      export:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                required:
                  - error_message
                  - errors
                  - meta
  /api/company/orders/find_by_email:
    get:
      summary: Find orders by email
      tags:
        - Orders
      operationId: findByEmail
      security:
        - bearer_auth: []
      parameters:
        - name: email
          in: query
          required: true
          description: Email to find orders by
          schema:
            type: string
      responses:
        '200':
          description: orders found by customer email
        '400':
          description: email is required
        '404':
          description: orders not found
  /api/v2/orders:
    get:
      summary: List Orders
      description: Get all orders with optional filters
      tags:
        - Orders
      operationId: listOrder
      security:
        - bearer_auth: []
      parameters:
        - name: customer_id
          in: query
          required: false
          description: Filter orders by customer
          schema:
            type: integer
        - name: user_company_id
          in: query
          required: false
          description: Filter orders by user company
          schema:
            type: integer
        - name: unfulfilled
          in: query
          required: false
          description: Filter unfulfilled orders
          schema:
            type: boolean
        - name: unpaid
          in: query
          required: false
          description: Filter unpaid orders
          schema:
            type: boolean
        - name: search_query
          in: query
          required: false
          description: >-
            Search by order id, number, email, phone, first name, last name,
            order number, external id, product title, product sku, contact first
            name,
                            contact last name, customer id, customer first name, customer last name
          schema:
            type: string
        - name: within_days
          in: query
          required: false
          description: Filter orders created within the last number of days
          schema:
            type: integer
        - name: date
          in: query
          required: false
          description: 'Filter orders by date range (format: MM/DD/YYYY-MM/DD/YYYY)'
          schema:
            type: string
        - name: page
          in: query
          schema:
            type: integer
            default: 1
          required: false
          description: Page number for pagination
        - name: per_page
          in: query
          schema:
            type: integer
            default: 10
          required: false
          description: Number of records per page
        - name: by_metadata
          in: query
          schema:
            type: string
            default: '{}'
            format: json
          required: false
          description: Search JSON meta data
        - name: sorted_by
          in: query
          required: false
          description: >
            Sort orders by specified field and direction. Available sort fields:

            `id`, `created_at`, `order_number`, `amount`, `country`, `buyer`,
            `product_title`.


            Sort field should be followed by '_{direction}'; eg. `id_asc`,
            `amount_desc`, etc.
          example: created_at_desc
          schema:
            type: string
      responses:
        '200':
          description: Stats remain consistent across pagination
          content:
            application/json:
              schema:
                type: object
                properties:
                  orders:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 1
                        order_number:
                          type: string
                          example: F1248177316463
                        currency_code:
                          type: string
                          example: USD
                        currency_symbol:
                          type: string
                          example: $
                        customer_id:
                          type: integer
                          example: 1
                        customer:
                          type: string
                          example: John Doe
                        channel:
                          type: string
                          example: Channel 2
                        payment_status:
                          type: string
                          example: Paid
                        is_cancellable:
                          type: boolean
                          example: true
                        status:
                          type: string
                          example: awaiting_payment
                        fulfillment_status:
                          type: string
                          example: Fulfilled
                        financial_status:
                          type: string
                          example: Paid
                        order_status:
                          type: string
                          example: Completed
                        total:
                          type: string
                          example: '100.00'
                        total_in_currency:
                          type: string
                          example: $100.00 USD
                        subtotal:
                          type: string
                          example: '90.00'
                        sub_total:
                          type: string
                          example: '90.00'
                        sub_total_in_currency:
                          type: string
                          example: '90.00'
                        tax:
                          type: string
                          example: '2.00'
                        tax_in_currency:
                          type: string
                          example: $2.00 USD
                        discount:
                          type: string
                          example: '3.00'
                        discount_in_currency:
                          type: string
                          example: $3.00 USD
                        shipping:
                          type: string
                          example: '11.00'
                        shipping_discount:
                          type: number
                          example: 10.45
                        note:
                          type:
                            - string
                            - 'null'
                          example: Order note
                        cv:
                          type: integer
                          example: 100
                        qv:
                          type: integer
                          example: 100
                        external_id:
                          type:
                            - string
                            - 'null'
                          example: '1234567890'
                        cart_id:
                          type:
                            - string
                            - 'null'
                          example: 1
                        cart_token:
                          type:
                            - string
                            - 'null'
                          example: CART_TOKEN
                        metadata:
                          type: object
                          example:
                            level: gold
                            tags:
                              - Tag1
                              - Tag2
                            camapaign:
                              id: 1
                              name: Winter 2025
                        shipping_in_currency:
                          type:
                            - object
                            - 'null'
                          properties:
                            amount_in_currency:
                              type: string
                              example: $11.00 USD
                            surcharge_in_currency:
                              type: string
                              example: $2.00 USD
                        buyer:
                          type:
                            - object
                            - 'null'
                          example:
                            share_guid: f6b4c9
                        delivery_method:
                          type: string
                          example: Courier
                        delivery_status:
                          type: string
                          example: In Transit
                        delivery_date:
                          type:
                            - string
                            - 'null'
                          example: '2023-07-29'
                        tags:
                          type: string
                          example: Tag 1
                        created_at:
                          type: string
                          example: '2023-07-24T10:00:00.000Z'
                        items_count:
                          type: integer
                          example: 2
                        enrollment_token:
                          type:
                            - string
                            - 'null'
                          example: et_12ad8jjhuxhtv4qlmn6poz
                        enrollment_pack_id:
                          type:
                            - integer
                            - 'null'
                          example: 1
                        rep:
                          type:
                            - object
                            - 'null'
                          example:
                            email:
                              type: string
                              example: john.doe@example.com
                            name:
                              type: string
                              example: John Doe
                            id:
                              type: integer
                              example: 1
                            image_url:
                              type: string
                              example: https://example.com/image.png
                            external_id:
                              type: string
                              example: '1234567890'
                        ship_to:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            name:
                              type:
                                - string
                                - 'null'
                              example: John Doe
                            first_name:
                              type:
                                - string
                                - 'null'
                              example: John
                            last_name:
                              type:
                                - string
                                - 'null'
                              example: Doe
                            address1:
                              type: string
                              example: 123 Main St
                            address2:
                              type:
                                - string
                                - 'null'
                              example: Apt 4B
                            address3:
                              type:
                                - string
                                - 'null'
                              example: Building 5
                            city:
                              type: string
                              example: New York
                            state:
                              type: string
                              example: NY
                            postal_code:
                              type: string
                              example: '10001'
                            country_code:
                              type: string
                              example: US
                              description: >-
                                country_id takes precedence if both country_id
                                and country_code provided.
                            subdivision_code:
                              type:
                                - string
                                - 'null'
                              example: NY
                            default:
                              type: boolean
                              example: true
                        bill_to:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            name:
                              type:
                                - string
                                - 'null'
                              example: John Doe
                            first_name:
                              type:
                                - string
                                - 'null'
                              example: John
                            last_name:
                              type:
                                - string
                                - 'null'
                              example: Doe
                            address1:
                              type: string
                              example: 123 Main St
                            address2:
                              type:
                                - string
                                - 'null'
                              example: Apt 4B
                            address3:
                              type:
                                - string
                                - 'null'
                              example: Building 5
                            city:
                              type: string
                              example: New York
                            state:
                              type: string
                              example: NY
                            postal_code:
                              type: string
                              example: '10001'
                            country_code:
                              type: string
                              example: US
                              description: >-
                                country_id takes precedence if both country_id
                                and country_code provided.
                            subdivision_code:
                              type:
                                - string
                                - 'null'
                              example: NY
                            default:
                              type: boolean
                              example: true
                        activities:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                              user_id:
                                type: integer
                              relation_type:
                                type: string
                              relation_id:
                                type: integer
                              contact_id:
                                type:
                                  - integer
                                  - 'null'
                              title:
                                type: string
                                example: A new order has been placed
                              description:
                                type: string
                                example: >-
                                  Samantha Joseph placed an order on Vandelay
                                  Shop
                              formatted_description:
                                type: string
                                example: >-
                                  Samantha Joseph placed an order on Vandelay
                                  Shop recently
                              read_at:
                                type:
                                  - string
                                  - 'null'
                              slug:
                                type: string
                              company_id:
                                type: integer
                              created_at:
                                type: string
                        items:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              title:
                                type: string
                                example: Hula Hoop
                              quantity:
                                type: integer
                                example: 3
                              price:
                                type:
                                  - number
                                  - string
                                example: 5.5
                              display_price:
                                type: string
                                example: $5.5 USD
                              total:
                                type:
                                  - number
                                  - string
                                example: 16.5
                              display_total:
                                type: string
                                example: $16.5 USD
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/test_image.jpg
                              sku:
                                type:
                                  - string
                                  - 'null'
                                example: ABC-12345-S-BL
                              cv:
                                type: integer
                                example: 100
                              qv:
                                type: integer
                                example: 100
                              display_to_customer:
                                type:
                                  - boolean
                                  - 'null'
                                example: true
                              ordered_variant:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    option_type:
                                      type: string
                                      example: Size
                                    value:
                                      type: string
                                      example: XXL
                        metafields_collection:
                          type: array
                          items:
                            type: object
                            properties:
                              key:
                                type: string
                                example: order_source
                              value:
                                type: string
                                example: wholesale_portal
                              namespace:
                                type: string
                                example: global
                              value_type:
                                type: string
                                example: string
                        company:
                          type: object
                          properties:
                            id:
                              type: integer
                            name:
                              type: string
                            primary_domain_hostname:
                              type:
                                - string
                                - 'null'
                              example: fluid.com
                            subdomain:
                              type:
                                - string
                                - 'null'
                              example: myco
                            logo_url:
                              type:
                                - string
                                - 'null'
                              example: https://example.com/logo.png
                            fluid_shop:
                              type:
                                - string
                                - 'null'
                              example: https://fluid-sample-shop.fluid.com
                            collect_phone:
                              type: boolean
                              example: true
                            require_phone:
                              type: boolean
                              example: false
                            require_billing_zip:
                              type: boolean
                              example: false
                            checkout_primary_button_color:
                              type:
                                - string
                                - 'null'
                              example: '#000000'
                            checkout_primary_text_color:
                              type:
                                - string
                                - 'null'
                              example: '#FFFFFF'
                            checkout_secondary_button_color:
                              type:
                                - string
                                - 'null'
                              example: '#FFFFFF'
                            checkout_secondary_text_color:
                              type:
                                - string
                                - 'null'
                              example: '#000000'
                            favicon_url:
                              type:
                                - string
                                - 'null'
                              example: https://example.com/favicon.ico
                            order_on_behalf:
                              type: boolean
                              example: false
                            use_juspay_gateway:
                              type: boolean
                              example: false
                            reward_points_enabled:
                              type: boolean
                              example: false
                        source:
                          type: string
                          example: web
                          enum:
                            - mobile
                            - web
                            - admin
                            - backoffice
                            - subscription
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 84eadc2f-4e51-4e3f-9f96-e8d7ba35cea4
                      timestamp:
                        type: string
                        example: '2025-05-07T08:25:35Z'
                      current_page:
                        type: integer
                      next_page:
                        type:
                          - integer
                          - 'null'
                      prev_page:
                        type:
                          - integer
                          - 'null'
                      total_pages:
                        type: integer
                      total_count:
                        type: integer
                      average_cv:
                        type:
                          - integer
                          - number
                        example: 20
                      total_cv:
                        type:
                          - integer
                          - number
                        example: 60
                      average_amount_base:
                        type:
                          - integer
                          - number
                        example: 200
                      total_amount_base:
                        type:
                          - integer
                          - number
                        example: 600
                      fulfilled_orders_count:
                        type: integer
                        example: 2
                      stats_calculated:
                        type: boolean
                        example: false
                      message:
                        type: string
                        example: Stats calculation skipped for large dataset
                    required:
                      - request_id
                      - timestamp
                      - total_count
                required:
                  - orders
                  - meta
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  data:
                    type: object
                    properties:
                      error:
                        type: string
                        example: >-
                          The value `{referred_by: {user: 'John},}` in parameter
                          `by_metadata` is not a valid JSON
  /api/v2/orders/stats:
    get:
      summary: Orders' stats
      description: Get statistics for orders
      tags:
        - Orders
      security:
        - bearer_auth: []
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_orders:
                    type: integer
                    example: 10
                  total_cancelled_orders:
                    type: integer
                    example: 2
                  total_shipped_orders:
                    type: integer
                    example: 8
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - total_orders
                  - total_cancelled_orders
                  - total_shipped_orders
                  - meta
  /api/v2/orders/{id}:
    get:
      summary: Show Order
      parameters:
        - name: id
          in: path
          description: Order ID
          required: true
          schema:
            type: integer
      description: Show Order Information
      tags:
        - Orders
      security:
        - bearer_auth: []
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  order:
                    type: object
                    properties:
                      id:
                        type: integer
                      order_number:
                        type: string
                        example: F1248177316463
                      currency_code:
                        type: string
                        example: USD
                      currency_symbol:
                        type: string
                        example: $
                      created_at:
                        type: string
                        example: '2023-07-24T10:00:00.000Z'
                      customer:
                        anyOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                              account_id:
                                type: string
                              first_name:
                                type: string
                              last_name:
                                type: string
                              full_name:
                                type: string
                              email:
                                type: string
                              verified_email:
                                type: boolean
                              phone:
                                type: string
                              orders_count:
                                type: integer
                              total_spent:
                                type:
                                  - number
                                  - string
                              display_total_spent:
                                type: string
                              last_order_id:
                                type:
                                  - integer
                                  - 'null'
                              notes:
                                type:
                                  - string
                                  - 'null'
                              user_company_id:
                                type:
                                  - integer
                                  - 'null'
                              created_at:
                                type: string
                              active:
                                type: boolean
                              is_rep:
                                type: boolean
                              is_discarded:
                                type: boolean
                              external_id:
                                type:
                                  - string
                                  - 'null'
                              role:
                                type: string
                                example: customer
                                enum:
                                  - customer
                                  - preferred_customer
                                  - rep
                              metadata:
                                type: object
                                description: >-
                                  A JSON object that can store any custom data
                                  structure.
                              default_address:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  name:
                                    type:
                                      - string
                                      - 'null'
                                    example: John Doe
                                  first_name:
                                    type:
                                      - string
                                      - 'null'
                                    example: John
                                  last_name:
                                    type:
                                      - string
                                      - 'null'
                                    example: Doe
                                  address1:
                                    type: string
                                    example: 123 Main St
                                  address2:
                                    type:
                                      - string
                                      - 'null'
                                    example: Apt 4B
                                  address3:
                                    type:
                                      - string
                                      - 'null'
                                    example: Building 5
                                  city:
                                    type: string
                                    example: New York
                                  state:
                                    type: string
                                    example: NY
                                  postal_code:
                                    type: string
                                    example: '10001'
                                  country_code:
                                    type: string
                                    example: US
                                    description: >-
                                      country_id takes precedence if both
                                      country_id and country_code provided.
                                  subdivision_code:
                                    type:
                                      - string
                                      - 'null'
                                    example: NY
                                  default:
                                    type: boolean
                                    example: true
                              addresses:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    name:
                                      type:
                                        - string
                                        - 'null'
                                      example: John Doe
                                    first_name:
                                      type:
                                        - string
                                        - 'null'
                                      example: John
                                    last_name:
                                      type:
                                        - string
                                        - 'null'
                                      example: Doe
                                    address1:
                                      type: string
                                      example: 123 Main St
                                    address2:
                                      type:
                                        - string
                                        - 'null'
                                      example: Apt 4B
                                    address3:
                                      type:
                                        - string
                                        - 'null'
                                      example: Building 5
                                    city:
                                      type: string
                                      example: New York
                                    state:
                                      type: string
                                      example: NY
                                    postal_code:
                                      type: string
                                      example: '10001'
                                    country_code:
                                      type: string
                                      example: US
                                      description: >-
                                        country_id takes precedence if both
                                        country_id and country_code provided.
                                    subdivision_code:
                                      type:
                                        - string
                                        - 'null'
                                      example: NY
                                    default:
                                      type: boolean
                                      example: true
                              payment_methods:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 967023914
                                    company_id:
                                      type: integer
                                      example: 96778814
                                    created_at:
                                      type: string
                                      example: '2025-11-11T04:59:05Z'
                                    logo_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: >-
                                        https://assets.fluid.app/images/payment_icons/visa.svg
                                    payload:
                                      type: object
                                      example:
                                        exp_year: '2030'
                                        card_type: visa
                                        exp_month: '01'
                                        card_last_four: '1234'
                                        token_provider: spreedly
                                    source:
                                      type: string
                                      example: card
                                    updated_at:
                                      type: string
                                      example: '2025-11-11T04:59:05Z'
                                    user_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: null
                              customer_notes:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                    customer_id:
                                      type: integer
                                    user_company_id:
                                      type:
                                        - integer
                                        - 'null'
                                    note:
                                      type: string
                                    resource_type:
                                      type:
                                        - string
                                        - 'null'
                                    resource_id:
                                      type:
                                        - integer
                                        - 'null'
                                    created_at:
                                      type: string
                              active_subscriptions_count:
                                type: integer
                              inactive_subscriptions_count:
                                type: integer
                              total_orders:
                                type: integer
                                example: 12
                              user_id:
                                type:
                                  - integer
                                  - 'null'
                      fulfillment_status:
                        type: string
                        example: Fulfilled
                      financial_status:
                        type: string
                        example: Paid
                      order_status:
                        type: string
                        example: Completed
                      payment_status:
                        type: string
                        example: Paid
                      is_cancellable:
                        type: boolean
                        example: true
                      note:
                        type:
                          - string
                          - 'null'
                        example: Order notes
                      notes:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              description: Id of the customer note
                            user_company_id:
                              type:
                                - integer
                                - 'null'
                              description: Id of UserCompany who created the customer note
                            customer_id:
                              type: integer
                              description: Id of Customer associated with the customer note
                            note:
                              type: string
                              description: Note of the customer note
                            resource_type:
                              type:
                                - string
                                - 'null'
                              description: Type of Resource attached with the customer note
                            resource_id:
                              type:
                                - integer
                                - 'null'
                              description: >-
                                Id of Resource specified in the `resource_type`
                                field
                            created_at:
                              type: string
                              description: Time the customer note was created
                      rep:
                        type:
                          - object
                          - 'null'
                        example:
                          email:
                            type: string
                            example: john.doe@example.com
                          name:
                            type: string
                            example: John Doe
                          id:
                            type: integer
                            example: 1
                          image_url:
                            type: string
                            example: https://example.com/image.png
                          external_id:
                            type: string
                            example: '1234567890'
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      refunds:
                        type:
                          - array
                          - 'null'
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            amount:
                              type: string
                              example: '10.00'
                            reason:
                              type: string
                              example: Refund reason
                            cv:
                              type: integer
                              example: 1
                            qv:
                              type: integer
                              example: 1
                            refund_type:
                              type: string
                              example: Refund type
                      activities:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            user_id:
                              type: integer
                            relation_type:
                              type: string
                            relation_id:
                              type: integer
                            contact_id:
                              type:
                                - integer
                                - 'null'
                            title:
                              type: string
                              example: A new order has been placed
                            description:
                              type: string
                              example: Samantha Joseph placed an order on Vandelay Shop
                            formatted_description:
                              type: string
                              example: >-
                                Samantha Joseph placed an order on Vandelay Shop
                                recently
                            read_at:
                              type:
                                - string
                                - 'null'
                            slug:
                              type: string
                            company_id:
                              type: integer
                            created_at:
                              type: string
                      payment_method:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                          spreedly_token:
                            type: string
                          full_name:
                            type: string
                          month:
                            type: integer
                          year:
                            type: integer
                          number:
                            type: string
                          last_four_digits:
                            type:
                              - string
                              - 'null'
                          first_six_digits:
                            type:
                              - string
                              - 'null'
                          card_type:
                            type:
                              - string
                              - 'null'
                          default:
                            type: boolean
                          email:
                            type:
                              - string
                              - 'null'
                          source:
                            type: string
                      total:
                        type: string
                        example: '100.00'
                      total_in_currency:
                        type: string
                        example: $100.00 USD
                      sub_total:
                        type: string
                        example: '90.00'
                      subtotal:
                        type: string
                        example: '90.00'
                      sub_total_in_currency:
                        type: string
                        example: $90.00 USD
                      shipping:
                        type: object
                        properties:
                          amount:
                            type: string
                            example: '5.00'
                          surcharge:
                            type: string
                            example: '2.00'
                          amount_in_currency:
                            type: string
                            example: $5.00 USD
                          surcharge_in_currency:
                            type: string
                            example: $2.00 USD
                      shipping_discount:
                        type: number
                        example: 10.45
                      items_count:
                        type: integer
                        example: 10
                      metadata:
                        type: object
                        example:
                          level: gold
                          tags:
                            - Tag1
                            - Tag2
                          camapaign:
                            id: 1
                            name: Winter 2025
                      metafields_collection:
                        type: array
                        items:
                          type: object
                          properties:
                            key:
                              type: string
                              example: order_source
                            value:
                              type: string
                              example: wholesale_portal
                            namespace:
                              type: string
                              example: global
                            value_type:
                              type: string
                              example: string
                      metafields:
                        type: array
                        items:
                          title: LegacyMetafield
                          type: object
                          properties:
                            id:
                              type: integer
                            namespace:
                              description: >-
                                A container for related metafields. Commonly
                                used to group metafields by app or
                                functionality.
                              example: custom
                              type: string
                              maxLength: 20
                              pattern: ^[a-zA-Z0-9_]+$
                            key:
                              description: >-
                                The unique identifier for the metafield within
                                its namespace. Must be unique per namespace and
                                owner.
                              example: material
                              type: string
                              maxLength: 30
                              pattern: ^[a-zA-Z0-9_]+$
                            value:
                              description: >-
                                The actual data stored in the metafield. Type
                                depends on value_type.
                              example: cotton
                              type:
                                - string
                                - object
                            value_type:
                              description: >-
                                The data type that defines how the value should
                                be interpreted and validated.
                              example: single_line_text_field
                              type: string
                            description:
                              description: >-
                                Optional human-readable description explaining
                                the purpose of this metafield.
                              example: The primary material used in this product
                              type:
                                - string
                                - 'null'
                            owner_type:
                              description: >-
                                The type of resource that this metafield belongs
                                to (polymorphic association).
                              example: Product
                              type: string
                            owner_id:
                              description: >-
                                The ID of the specific resource that this
                                metafield belongs to.
                              example: 12345
                              type: integer
                            created_at:
                              description: Timestamp when the metafield was created.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            updated_at:
                              description: Timestamp when the metafield was last updated.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            metafield_definition:
                              title: MetafieldDefinition
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                company_id:
                                  description: >-
                                    The ID of the company that owns this
                                    metafield definition.
                                  example: 1
                                  type: integer
                                namespace:
                                  description: >-
                                    A container for related metafield
                                    definitions. Used to group definitions by
                                    app or functionality. Must be unique within
                                    company and owner_resource.
                                  example: product_details
                                  type: string
                                  maxLength: 20
                                  pattern: ^[a-zA-Z0-9_]+$
                                key:
                                  description: >-
                                    The unique identifier for the metafield
                                    definition within its namespace and
                                    owner_resource. Combined with namespace and
                                    owner_resource, this must be unique per
                                    company.
                                  example: material_type
                                  type: string
                                  maxLength: 30
                                  pattern: ^[a-zA-Z0-9_]+$
                                name:
                                  description: >-
                                    Human-readable display name for the
                                    metafield definition, shown in admin
                                    interfaces and forms.
                                  example: Material Type
                                  type: string
                                  maxLength: 100
                                description:
                                  description: >-
                                    Detailed explanation of what this metafield
                                    definition represents, how it should be
                                    used, and any special instructions for
                                    content creators.
                                  example: >-
                                    Specify the primary material composition of
                                    the product (e.g., cotton, polyester, silk).
                                    This will be displayed on the product detail
                                    page.
                                  type:
                                    - string
                                    - 'null'
                                value_type:
                                  description: >-
                                    The data type that defines how metafield
                                    values should be validated, stored, and
                                    displayed. Determines which validation rules
                                    are available.
                                  example: single_line_text_field
                                  type: string
                                validation_rules:
                                  description: >-
                                    JSON object containing validation
                                    constraints that will be applied to
                                    metafield values. Available rules depend on
                                    the value_type.
                                  example:
                                    choices:
                                      - cotton
                                      - polyester
                                      - silk
                                      - wool
                                      - linen
                                      - bamboo
                                    max: 50
                                    min: 2
                                  type:
                                    - object
                                    - 'null'
                                owner_resource:
                                  description: >-
                                    The type of resource (model class name) that
                                    metafields using this definition can be
                                    attached to. Must match the polymorphic
                                    owner_type.
                                  example: Product
                                  type: string
                                pinned:
                                  description: >-
                                    Whether this definition should be
                                    prominently displayed or prioritized in
                                    admin interfaces and forms.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                position:
                                  default: 0
                                  description: >-
                                    Sort order for displaying this definition
                                    relative to others in the same category and
                                    owner_resource. Lower numbers appear first.
                                  example: 1
                                  type:
                                    - integer
                                    - 'null'
                                locked:
                                  description: >-
                                    Whether this metafield definition is locked,
                                    preventing direct updates or deletions of
                                    metafields using this definition.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                created_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    created.
                                  example: '2024-01-15T10:30:00Z'
                                  type: string
                                  format: date-time
                                updated_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    last updated.
                                  example: '2024-02-20T14:45:00Z'
                                  type: string
                                  format: date-time
                                list_type:
                                  description: >-
                                    Whether this definition is for list-type
                                    metafields that store arrays of values.
                                  example: false
                                  type: boolean
                                reference_type:
                                  description: >-
                                    Whether this definition is for
                                    reference-type metafields that store
                                    references to other resources.
                                  example: false
                                  type: boolean
                                supported_validations:
                                  description: >-
                                    Array of validation rule names that are
                                    supported for this value_type.
                                  example:
                                    - min
                                    - max
                                    - choices
                                    - regex
                                  type: array
                                validation_description:
                                  description: >-
                                    Human-readable description of what the
                                    value_type represents and its constraints.
                                  example: Single line text up to 5000 characters
                                  type: string
                                category_ids:
                                  description: >-
                                    Array of category IDs that this metafield
                                    definition is associated with for
                                    organizational purposes.
                                  example:
                                    - 1
                                    - 2
                                    - 3
                                  items:
                                    type: integer
                                  type: array
                              required:
                                - id
                                - company_id
                                - namespace
                                - key
                                - name
                                - value_type
                                - owner_resource
                                - created_at
                                - updated_at
                                - list_type
                                - reference_type
                                - supported_validations
                                - validation_description
                                - category_ids
                          required:
                            - id
                            - namespace
                            - key
                            - value
                            - value_type
                            - owner_type
                            - owner_id
                            - created_at
                            - updated_at
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: 3
                      transaction_fee_in_currency:
                        type: string
                        example: $3.00 USD
                      enrollment_fee:
                        type:
                          - number
                          - string
                        example: 3
                      enrollment_fee_in_currency:
                        type: string
                        example: $3.00 USD
                      discount:
                        type: string
                        example: '10.00'
                      tax:
                        type: string
                        example: '8.00'
                      dynamic_charges:
                        type: object
                        example:
                          handling: 2
                      dynamic_charges_in_currency:
                        type: object
                        example:
                          handling: $2.00 USD
                      buyer:
                        type:
                          - object
                          - 'null'
                        example:
                          share_guid: f6b4c9
                      shipping_address:
                        type:
                          - object
                          - 'null'
                        properties:
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          address1:
                            type:
                              - string
                              - 'null'
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type:
                              - string
                              - 'null'
                            example: New York
                          state:
                            type:
                              - string
                              - 'null'
                            example: NY
                          postal_code:
                            type:
                              - string
                              - 'null'
                            example: '10001'
                          country_code:
                            type:
                              - string
                              - 'null'
                            example: US
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                      billing_address:
                        type:
                          - object
                          - 'null'
                        properties:
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          address1:
                            type:
                              - string
                              - 'null'
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type:
                              - string
                              - 'null'
                            example: New York
                          state:
                            type:
                              - string
                              - 'null'
                            example: NY
                          postal_code:
                            type:
                              - string
                              - 'null'
                            example: '10001'
                          country_code:
                            type:
                              - string
                              - 'null'
                            example: US
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            title:
                              type: string
                              example: Hula Hoop
                            quantity:
                              type: integer
                              example: 3
                            price:
                              type:
                                - number
                                - string
                              example: 5.5
                            display_price:
                              type: string
                              example: $5.5 USD
                            total:
                              type:
                                - number
                                - string
                              example: 16.5
                            display_total:
                              type: string
                              example: $16.5 USD
                            image_url:
                              type:
                                - string
                                - 'null'
                              example: https://example.com/test_image.jpg
                            sku:
                              type:
                                - string
                                - 'null'
                              example: ABC-12345-S-BL
                            cv:
                              type: integer
                              example: 100
                            qv:
                              type: integer
                              example: 100
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            ordered_variant:
                              type: array
                              items:
                                type: object
                                properties:
                                  option_type:
                                    type: string
                                    example: Size
                                  value:
                                    type: string
                                    example: XXL
                            hs_code:
                              type:
                                - string
                                - 'null'
                              example: HS123
                            total_in_currency:
                              type: string
                              example: $11.0 USD
                            price_in_currency:
                              type: string
                              example: $29.99
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            thumbnail:
                              type: string
                              example: https://example.com/test_image.jpg
                            variant:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: Sample Variant
                                image_path:
                                  type:
                                    - string
                                    - 'null'
                                  example: /images/sample.png
                                image_url:
                                  type:
                                    - string
                                    - 'null'
                                  example: https://example.com/images/sample.png
                                primary_image:
                                  type:
                                    - string
                                    - 'null'
                                  example: https://example.com/images/primary.png
                                price:
                                  type:
                                    - string
                                    - 'null'
                                  example: '34.44'
                                price_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $34.44
                                sku:
                                  type:
                                    - string
                                    - 'null'
                                  example: SKU12345
                                options:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      title:
                                        type: string
                                        example: Size
                                      value:
                                        type: string
                                        example: XL
                      discount_in_currency:
                        type: string
                        example: $10.00 USD
                      tax_in_currency:
                        type: string
                        example: $8.00 USD
                      cv:
                        type: integer
                        example: 100
                      qv:
                        type: integer
                        example: 100
                      status:
                        type: string
                        example: awaiting_payment
                      external_id:
                        type:
                          - string
                          - 'null'
                        example: '1234567890'
                      cart_id:
                        type:
                          - string
                          - 'null'
                        example: 1
                      cart_token:
                        type:
                          - string
                          - 'null'
                        example: CART_TOKEN
                      source:
                        type: string
                        example: web
                        enum:
                          - mobile
                          - web
                          - admin
                          - backoffice
                          - subscription
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: order belongs to a different company
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: fail
                  data:
                    type: object
                    properties:
                      error:
                        type: string
                        example: Order not found.
  /api/v2/orders/{id}/cancel:
    patch:
      summary: Cancel an Order
      description: Cancel an order
      tags:
        - Orders
      security:
        - bearer_auth: []
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: success
                  data:
                    type: object
                    properties:
                      message:
                        type: string
                        example: Order cancelled successfully
        '422':
          description: refund service exception
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: error
                  data:
                    type: object
                    properties:
                      error:
                        type: string
                        example: 'Refund failed: Network timeout'
    parameters:
      - name: id
        in: path
        description: Order ID
        required: true
        schema:
          type: string
  /api/v2/orders/{id}/charge:
    post:
      summary: Charge an Order
      description: Charge an order. Order must be in `awaiting_payment` status
      tags:
        - Orders
      security:
        - bearer_auth: []
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: success
                  data:
                    type: object
                    properties:
                      message:
                        type: string
                        example: Order charged successfully
        '422':
          description: payment failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: fail
                  data:
                    type: object
                    properties:
                      error:
                        type: string
                        example: Payment failed
    parameters:
      - name: id
        in: path
        description: Order ID
        required: true
        schema:
          type: string
  /api/v2/orders/{id}/append_metadata:
    patch:
      summary: Append metadata field
      tags:
        - Orders
      operationId: orderAppendMetadataField
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Orders's Id
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  order:
                    type: object
                    properties:
                      id:
                        type: integer
                      order_number:
                        type: string
                        example: F1248177316463
                      currency_code:
                        type: string
                        example: USD
                      currency_symbol:
                        type: string
                        example: $
                      created_at:
                        type: string
                        example: '2023-07-24T10:00:00.000Z'
                      customer:
                        anyOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                              account_id:
                                type: string
                              first_name:
                                type: string
                              last_name:
                                type: string
                              full_name:
                                type: string
                              email:
                                type: string
                              verified_email:
                                type: boolean
                              phone:
                                type: string
                              orders_count:
                                type: integer
                              total_spent:
                                type:
                                  - number
                                  - string
                              display_total_spent:
                                type: string
                              last_order_id:
                                type:
                                  - integer
                                  - 'null'
                              notes:
                                type:
                                  - string
                                  - 'null'
                              user_company_id:
                                type:
                                  - integer
                                  - 'null'
                              created_at:
                                type: string
                              active:
                                type: boolean
                              is_rep:
                                type: boolean
                              is_discarded:
                                type: boolean
                              external_id:
                                type:
                                  - string
                                  - 'null'
                              role:
                                type: string
                                example: customer
                                enum:
                                  - customer
                                  - preferred_customer
                                  - rep
                              metadata:
                                type: object
                                description: >-
                                  A JSON object that can store any custom data
                                  structure.
                              default_address:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  name:
                                    type:
                                      - string
                                      - 'null'
                                    example: John Doe
                                  first_name:
                                    type:
                                      - string
                                      - 'null'
                                    example: John
                                  last_name:
                                    type:
                                      - string
                                      - 'null'
                                    example: Doe
                                  address1:
                                    type: string
                                    example: 123 Main St
                                  address2:
                                    type:
                                      - string
                                      - 'null'
                                    example: Apt 4B
                                  address3:
                                    type:
                                      - string
                                      - 'null'
                                    example: Building 5
                                  city:
                                    type: string
                                    example: New York
                                  state:
                                    type: string
                                    example: NY
                                  postal_code:
                                    type: string
                                    example: '10001'
                                  country_code:
                                    type: string
                                    example: US
                                    description: >-
                                      country_id takes precedence if both
                                      country_id and country_code provided.
                                  subdivision_code:
                                    type:
                                      - string
                                      - 'null'
                                    example: NY
                                  default:
                                    type: boolean
                                    example: true
                              addresses:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    name:
                                      type:
                                        - string
                                        - 'null'
                                      example: John Doe
                                    first_name:
                                      type:
                                        - string
                                        - 'null'
                                      example: John
                                    last_name:
                                      type:
                                        - string
                                        - 'null'
                                      example: Doe
                                    address1:
                                      type: string
                                      example: 123 Main St
                                    address2:
                                      type:
                                        - string
                                        - 'null'
                                      example: Apt 4B
                                    address3:
                                      type:
                                        - string
                                        - 'null'
                                      example: Building 5
                                    city:
                                      type: string
                                      example: New York
                                    state:
                                      type: string
                                      example: NY
                                    postal_code:
                                      type: string
                                      example: '10001'
                                    country_code:
                                      type: string
                                      example: US
                                      description: >-
                                        country_id takes precedence if both
                                        country_id and country_code provided.
                                    subdivision_code:
                                      type:
                                        - string
                                        - 'null'
                                      example: NY
                                    default:
                                      type: boolean
                                      example: true
                              payment_methods:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 967023914
                                    company_id:
                                      type: integer
                                      example: 96778814
                                    created_at:
                                      type: string
                                      example: '2025-11-11T04:59:05Z'
                                    logo_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: >-
                                        https://assets.fluid.app/images/payment_icons/visa.svg
                                    payload:
                                      type: object
                                      example:
                                        exp_year: '2030'
                                        card_type: visa
                                        exp_month: '01'
                                        card_last_four: '1234'
                                        token_provider: spreedly
                                    source:
                                      type: string
                                      example: card
                                    updated_at:
                                      type: string
                                      example: '2025-11-11T04:59:05Z'
                                    user_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: null
                              customer_notes:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                    customer_id:
                                      type: integer
                                    user_company_id:
                                      type:
                                        - integer
                                        - 'null'
                                    note:
                                      type: string
                                    resource_type:
                                      type:
                                        - string
                                        - 'null'
                                    resource_id:
                                      type:
                                        - integer
                                        - 'null'
                                    created_at:
                                      type: string
                              active_subscriptions_count:
                                type: integer
                              inactive_subscriptions_count:
                                type: integer
                              total_orders:
                                type: integer
                                example: 12
                              user_id:
                                type:
                                  - integer
                                  - 'null'
                      fulfillment_status:
                        type: string
                        example: Fulfilled
                      financial_status:
                        type: string
                        example: Paid
                      order_status:
                        type: string
                        example: Completed
                      payment_status:
                        type: string
                        example: Paid
                      is_cancellable:
                        type: boolean
                        example: true
                      note:
                        type:
                          - string
                          - 'null'
                        example: Order notes
                      notes:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              description: Id of the customer note
                            user_company_id:
                              type:
                                - integer
                                - 'null'
                              description: Id of UserCompany who created the customer note
                            customer_id:
                              type: integer
                              description: Id of Customer associated with the customer note
                            note:
                              type: string
                              description: Note of the customer note
                            resource_type:
                              type:
                                - string
                                - 'null'
                              description: Type of Resource attached with the customer note
                            resource_id:
                              type:
                                - integer
                                - 'null'
                              description: >-
                                Id of Resource specified in the `resource_type`
                                field
                            created_at:
                              type: string
                              description: Time the customer note was created
                      rep:
                        type:
                          - object
                          - 'null'
                        example:
                          email:
                            type: string
                            example: john.doe@example.com
                          name:
                            type: string
                            example: John Doe
                          id:
                            type: integer
                            example: 1
                          image_url:
                            type: string
                            example: https://example.com/image.png
                          external_id:
                            type: string
                            example: '1234567890'
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      refunds:
                        type:
                          - array
                          - 'null'
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            amount:
                              type: string
                              example: '10.00'
                            reason:
                              type: string
                              example: Refund reason
                            cv:
                              type: integer
                              example: 1
                            qv:
                              type: integer
                              example: 1
                            refund_type:
                              type: string
                              example: Refund type
                      activities:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            user_id:
                              type: integer
                            relation_type:
                              type: string
                            relation_id:
                              type: integer
                            contact_id:
                              type:
                                - integer
                                - 'null'
                            title:
                              type: string
                              example: A new order has been placed
                            description:
                              type: string
                              example: Samantha Joseph placed an order on Vandelay Shop
                            formatted_description:
                              type: string
                              example: >-
                                Samantha Joseph placed an order on Vandelay Shop
                                recently
                            read_at:
                              type:
                                - string
                                - 'null'
                            slug:
                              type: string
                            company_id:
                              type: integer
                            created_at:
                              type: string
                      payment_method:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                          spreedly_token:
                            type: string
                          full_name:
                            type: string
                          month:
                            type: integer
                          year:
                            type: integer
                          number:
                            type: string
                          last_four_digits:
                            type:
                              - string
                              - 'null'
                          first_six_digits:
                            type:
                              - string
                              - 'null'
                          card_type:
                            type:
                              - string
                              - 'null'
                          default:
                            type: boolean
                          email:
                            type:
                              - string
                              - 'null'
                          source:
                            type: string
                      total:
                        type: string
                        example: '100.00'
                      total_in_currency:
                        type: string
                        example: $100.00 USD
                      sub_total:
                        type: string
                        example: '90.00'
                      subtotal:
                        type: string
                        example: '90.00'
                      sub_total_in_currency:
                        type: string
                        example: $90.00 USD
                      shipping:
                        type: object
                        properties:
                          amount:
                            type: string
                            example: '5.00'
                          surcharge:
                            type: string
                            example: '2.00'
                          amount_in_currency:
                            type: string
                            example: $5.00 USD
                          surcharge_in_currency:
                            type: string
                            example: $2.00 USD
                      shipping_discount:
                        type: number
                        example: 10.45
                      items_count:
                        type: integer
                        example: 10
                      metadata:
                        type: object
                        example:
                          level: gold
                          tags:
                            - Tag1
                            - Tag2
                          camapaign:
                            id: 1
                            name: Winter 2025
                      metafields_collection:
                        type: array
                        items:
                          type: object
                          properties:
                            key:
                              type: string
                              example: order_source
                            value:
                              type: string
                              example: wholesale_portal
                            namespace:
                              type: string
                              example: global
                            value_type:
                              type: string
                              example: string
                      metafields:
                        type: array
                        items:
                          title: LegacyMetafield
                          type: object
                          properties:
                            id:
                              type: integer
                            namespace:
                              description: >-
                                A container for related metafields. Commonly
                                used to group metafields by app or
                                functionality.
                              example: custom
                              type: string
                              maxLength: 20
                              pattern: ^[a-zA-Z0-9_]+$
                            key:
                              description: >-
                                The unique identifier for the metafield within
                                its namespace. Must be unique per namespace and
                                owner.
                              example: material
                              type: string
                              maxLength: 30
                              pattern: ^[a-zA-Z0-9_]+$
                            value:
                              description: >-
                                The actual data stored in the metafield. Type
                                depends on value_type.
                              example: cotton
                              type:
                                - string
                                - object
                            value_type:
                              description: >-
                                The data type that defines how the value should
                                be interpreted and validated.
                              example: single_line_text_field
                              type: string
                            description:
                              description: >-
                                Optional human-readable description explaining
                                the purpose of this metafield.
                              example: The primary material used in this product
                              type:
                                - string
                                - 'null'
                            owner_type:
                              description: >-
                                The type of resource that this metafield belongs
                                to (polymorphic association).
                              example: Product
                              type: string
                            owner_id:
                              description: >-
                                The ID of the specific resource that this
                                metafield belongs to.
                              example: 12345
                              type: integer
                            created_at:
                              description: Timestamp when the metafield was created.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            updated_at:
                              description: Timestamp when the metafield was last updated.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            metafield_definition:
                              title: MetafieldDefinition
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                company_id:
                                  description: >-
                                    The ID of the company that owns this
                                    metafield definition.
                                  example: 1
                                  type: integer
                                namespace:
                                  description: >-
                                    A container for related metafield
                                    definitions. Used to group definitions by
                                    app or functionality. Must be unique within
                                    company and owner_resource.
                                  example: product_details
                                  type: string
                                  maxLength: 20
                                  pattern: ^[a-zA-Z0-9_]+$
                                key:
                                  description: >-
                                    The unique identifier for the metafield
                                    definition within its namespace and
                                    owner_resource. Combined with namespace and
                                    owner_resource, this must be unique per
                                    company.
                                  example: material_type
                                  type: string
                                  maxLength: 30
                                  pattern: ^[a-zA-Z0-9_]+$
                                name:
                                  description: >-
                                    Human-readable display name for the
                                    metafield definition, shown in admin
                                    interfaces and forms.
                                  example: Material Type
                                  type: string
                                  maxLength: 100
                                description:
                                  description: >-
                                    Detailed explanation of what this metafield
                                    definition represents, how it should be
                                    used, and any special instructions for
                                    content creators.
                                  example: >-
                                    Specify the primary material composition of
                                    the product (e.g., cotton, polyester, silk).
                                    This will be displayed on the product detail
                                    page.
                                  type:
                                    - string
                                    - 'null'
                                value_type:
                                  description: >-
                                    The data type that defines how metafield
                                    values should be validated, stored, and
                                    displayed. Determines which validation rules
                                    are available.
                                  example: single_line_text_field
                                  type: string
                                validation_rules:
                                  description: >-
                                    JSON object containing validation
                                    constraints that will be applied to
                                    metafield values. Available rules depend on
                                    the value_type.
                                  example:
                                    choices:
                                      - cotton
                                      - polyester
                                      - silk
                                      - wool
                                      - linen
                                      - bamboo
                                    max: 50
                                    min: 2
                                  type:
                                    - object
                                    - 'null'
                                owner_resource:
                                  description: >-
                                    The type of resource (model class name) that
                                    metafields using this definition can be
                                    attached to. Must match the polymorphic
                                    owner_type.
                                  example: Product
                                  type: string
                                pinned:
                                  description: >-
                                    Whether this definition should be
                                    prominently displayed or prioritized in
                                    admin interfaces and forms.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                position:
                                  default: 0
                                  description: >-
                                    Sort order for displaying this definition
                                    relative to others in the same category and
                                    owner_resource. Lower numbers appear first.
                                  example: 1
                                  type:
                                    - integer
                                    - 'null'
                                locked:
                                  description: >-
                                    Whether this metafield definition is locked,
                                    preventing direct updates or deletions of
                                    metafields using this definition.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                created_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    created.
                                  example: '2024-01-15T10:30:00Z'
                                  type: string
                                  format: date-time
                                updated_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    last updated.
                                  example: '2024-02-20T14:45:00Z'
                                  type: string
                                  format: date-time
                                list_type:
                                  description: >-
                                    Whether this definition is for list-type
                                    metafields that store arrays of values.
                                  example: false
                                  type: boolean
                                reference_type:
                                  description: >-
                                    Whether this definition is for
                                    reference-type metafields that store
                                    references to other resources.
                                  example: false
                                  type: boolean
                                supported_validations:
                                  description: >-
                                    Array of validation rule names that are
                                    supported for this value_type.
                                  example:
                                    - min
                                    - max
                                    - choices
                                    - regex
                                  type: array
                                validation_description:
                                  description: >-
                                    Human-readable description of what the
                                    value_type represents and its constraints.
                                  example: Single line text up to 5000 characters
                                  type: string
                                category_ids:
                                  description: >-
                                    Array of category IDs that this metafield
                                    definition is associated with for
                                    organizational purposes.
                                  example:
                                    - 1
                                    - 2
                                    - 3
                                  items:
                                    type: integer
                                  type: array
                              required:
                                - id
                                - company_id
                                - namespace
                                - key
                                - name
                                - value_type
                                - owner_resource
                                - created_at
                                - updated_at
                                - list_type
                                - reference_type
                                - supported_validations
                                - validation_description
                                - category_ids
                          required:
                            - id
                            - namespace
                            - key
                            - value
                            - value_type
                            - owner_type
                            - owner_id
                            - created_at
                            - updated_at
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: 3
                      transaction_fee_in_currency:
                        type: string
                        example: $3.00 USD
                      enrollment_fee:
                        type:
                          - number
                          - string
                        example: 3
                      enrollment_fee_in_currency:
                        type: string
                        example: $3.00 USD
                      discount:
                        type: string
                        example: '10.00'
                      tax:
                        type: string
                        example: '8.00'
                      dynamic_charges:
                        type: object
                        example:
                          handling: 2
                      dynamic_charges_in_currency:
                        type: object
                        example:
                          handling: $2.00 USD
                      buyer:
                        type:
                          - object
                          - 'null'
                        example:
                          share_guid: f6b4c9
                      shipping_address:
                        type:
                          - object
                          - 'null'
                        properties:
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          address1:
                            type:
                              - string
                              - 'null'
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type:
                              - string
                              - 'null'
                            example: New York
                          state:
                            type:
                              - string
                              - 'null'
                            example: NY
                          postal_code:
                            type:
                              - string
                              - 'null'
                            example: '10001'
                          country_code:
                            type:
                              - string
                              - 'null'
                            example: US
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                      billing_address:
                        type:
                          - object
                          - 'null'
                        properties:
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          address1:
                            type:
                              - string
                              - 'null'
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type:
                              - string
                              - 'null'
                            example: New York
                          state:
                            type:
                              - string
                              - 'null'
                            example: NY
                          postal_code:
                            type:
                              - string
                              - 'null'
                            example: '10001'
                          country_code:
                            type:
                              - string
                              - 'null'
                            example: US
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            title:
                              type: string
                              example: Hula Hoop
                            quantity:
                              type: integer
                              example: 3
                            price:
                              type:
                                - number
                                - string
                              example: 5.5
                            display_price:
                              type: string
                              example: $5.5 USD
                            total:
                              type:
                                - number
                                - string
                              example: 16.5
                            display_total:
                              type: string
                              example: $16.5 USD
                            image_url:
                              type:
                                - string
                                - 'null'
                              example: https://example.com/test_image.jpg
                            sku:
                              type:
                                - string
                                - 'null'
                              example: ABC-12345-S-BL
                            cv:
                              type: integer
                              example: 100
                            qv:
                              type: integer
                              example: 100
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            ordered_variant:
                              type: array
                              items:
                                type: object
                                properties:
                                  option_type:
                                    type: string
                                    example: Size
                                  value:
                                    type: string
                                    example: XXL
                            hs_code:
                              type:
                                - string
                                - 'null'
                              example: HS123
                            total_in_currency:
                              type: string
                              example: $11.0 USD
                            price_in_currency:
                              type: string
                              example: $29.99
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            thumbnail:
                              type: string
                              example: https://example.com/test_image.jpg
                            variant:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: Sample Variant
                                image_path:
                                  type:
                                    - string
                                    - 'null'
                                  example: /images/sample.png
                                image_url:
                                  type:
                                    - string
                                    - 'null'
                                  example: https://example.com/images/sample.png
                                primary_image:
                                  type:
                                    - string
                                    - 'null'
                                  example: https://example.com/images/primary.png
                                price:
                                  type:
                                    - string
                                    - 'null'
                                  example: '34.44'
                                price_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $34.44
                                sku:
                                  type:
                                    - string
                                    - 'null'
                                  example: SKU12345
                                options:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      title:
                                        type: string
                                        example: Size
                                      value:
                                        type: string
                                        example: XL
                      discount_in_currency:
                        type: string
                        example: $10.00 USD
                      tax_in_currency:
                        type: string
                        example: $8.00 USD
                      cv:
                        type: integer
                        example: 100
                      qv:
                        type: integer
                        example: 100
                      status:
                        type: string
                        example: awaiting_payment
                      external_id:
                        type:
                          - string
                          - 'null'
                        example: '1234567890'
                      cart_id:
                        type:
                          - string
                          - 'null'
                        example: 1
                      cart_token:
                        type:
                          - string
                          - 'null'
                        example: CART_TOKEN
                      source:
                        type: string
                        example: web
                        enum:
                          - mobile
                          - web
                          - admin
                          - backoffice
                          - subscription
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                        example:
                          - Order not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                metadata:
                  type: object
                  description: >-
                    A JSON object that can store any custom data structure. When
                    provided, merges with existing metadata data.
              required:
                - metadata
  /api/v2/orders/{id}/remove_metadata:
    patch:
      summary: Remove metadata field(s)
      tags:
        - Orders
      operationId: orderRemoveMetadataField
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Order ID
          schema:
            type: integer
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  order:
                    type: object
                    properties:
                      id:
                        type: integer
                      order_number:
                        type: string
                        example: F1248177316463
                      currency_code:
                        type: string
                        example: USD
                      currency_symbol:
                        type: string
                        example: $
                      created_at:
                        type: string
                        example: '2023-07-24T10:00:00.000Z'
                      customer:
                        anyOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                              account_id:
                                type: string
                              first_name:
                                type: string
                              last_name:
                                type: string
                              full_name:
                                type: string
                              email:
                                type: string
                              verified_email:
                                type: boolean
                              phone:
                                type: string
                              orders_count:
                                type: integer
                              total_spent:
                                type:
                                  - number
                                  - string
                              display_total_spent:
                                type: string
                              last_order_id:
                                type:
                                  - integer
                                  - 'null'
                              notes:
                                type:
                                  - string
                                  - 'null'
                              user_company_id:
                                type:
                                  - integer
                                  - 'null'
                              created_at:
                                type: string
                              active:
                                type: boolean
                              is_rep:
                                type: boolean
                              is_discarded:
                                type: boolean
                              external_id:
                                type:
                                  - string
                                  - 'null'
                              role:
                                type: string
                                example: customer
                                enum:
                                  - customer
                                  - preferred_customer
                                  - rep
                              metadata:
                                type: object
                                description: >-
                                  A JSON object that can store any custom data
                                  structure.
                              default_address:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  name:
                                    type:
                                      - string
                                      - 'null'
                                    example: John Doe
                                  first_name:
                                    type:
                                      - string
                                      - 'null'
                                    example: John
                                  last_name:
                                    type:
                                      - string
                                      - 'null'
                                    example: Doe
                                  address1:
                                    type: string
                                    example: 123 Main St
                                  address2:
                                    type:
                                      - string
                                      - 'null'
                                    example: Apt 4B
                                  address3:
                                    type:
                                      - string
                                      - 'null'
                                    example: Building 5
                                  city:
                                    type: string
                                    example: New York
                                  state:
                                    type: string
                                    example: NY
                                  postal_code:
                                    type: string
                                    example: '10001'
                                  country_code:
                                    type: string
                                    example: US
                                    description: >-
                                      country_id takes precedence if both
                                      country_id and country_code provided.
                                  subdivision_code:
                                    type:
                                      - string
                                      - 'null'
                                    example: NY
                                  default:
                                    type: boolean
                                    example: true
                              addresses:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    name:
                                      type:
                                        - string
                                        - 'null'
                                      example: John Doe
                                    first_name:
                                      type:
                                        - string
                                        - 'null'
                                      example: John
                                    last_name:
                                      type:
                                        - string
                                        - 'null'
                                      example: Doe
                                    address1:
                                      type: string
                                      example: 123 Main St
                                    address2:
                                      type:
                                        - string
                                        - 'null'
                                      example: Apt 4B
                                    address3:
                                      type:
                                        - string
                                        - 'null'
                                      example: Building 5
                                    city:
                                      type: string
                                      example: New York
                                    state:
                                      type: string
                                      example: NY
                                    postal_code:
                                      type: string
                                      example: '10001'
                                    country_code:
                                      type: string
                                      example: US
                                      description: >-
                                        country_id takes precedence if both
                                        country_id and country_code provided.
                                    subdivision_code:
                                      type:
                                        - string
                                        - 'null'
                                      example: NY
                                    default:
                                      type: boolean
                                      example: true
                              payment_methods:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 967023914
                                    company_id:
                                      type: integer
                                      example: 96778814
                                    created_at:
                                      type: string
                                      example: '2025-11-11T04:59:05Z'
                                    logo_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: >-
                                        https://assets.fluid.app/images/payment_icons/visa.svg
                                    payload:
                                      type: object
                                      example:
                                        exp_year: '2030'
                                        card_type: visa
                                        exp_month: '01'
                                        card_last_four: '1234'
                                        token_provider: spreedly
                                    source:
                                      type: string
                                      example: card
                                    updated_at:
                                      type: string
                                      example: '2025-11-11T04:59:05Z'
                                    user_id:
                                      type:
                                        - integer
                                        - 'null'
                                      example: null
                              customer_notes:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                    customer_id:
                                      type: integer
                                    user_company_id:
                                      type:
                                        - integer
                                        - 'null'
                                    note:
                                      type: string
                                    resource_type:
                                      type:
                                        - string
                                        - 'null'
                                    resource_id:
                                      type:
                                        - integer
                                        - 'null'
                                    created_at:
                                      type: string
                              active_subscriptions_count:
                                type: integer
                              inactive_subscriptions_count:
                                type: integer
                              total_orders:
                                type: integer
                                example: 12
                              user_id:
                                type:
                                  - integer
                                  - 'null'
                      fulfillment_status:
                        type: string
                        example: Fulfilled
                      financial_status:
                        type: string
                        example: Paid
                      order_status:
                        type: string
                        example: Completed
                      payment_status:
                        type: string
                        example: Paid
                      is_cancellable:
                        type: boolean
                        example: true
                      note:
                        type:
                          - string
                          - 'null'
                        example: Order notes
                      notes:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              description: Id of the customer note
                            user_company_id:
                              type:
                                - integer
                                - 'null'
                              description: Id of UserCompany who created the customer note
                            customer_id:
                              type: integer
                              description: Id of Customer associated with the customer note
                            note:
                              type: string
                              description: Note of the customer note
                            resource_type:
                              type:
                                - string
                                - 'null'
                              description: Type of Resource attached with the customer note
                            resource_id:
                              type:
                                - integer
                                - 'null'
                              description: >-
                                Id of Resource specified in the `resource_type`
                                field
                            created_at:
                              type: string
                              description: Time the customer note was created
                      rep:
                        type:
                          - object
                          - 'null'
                        example:
                          email:
                            type: string
                            example: john.doe@example.com
                          name:
                            type: string
                            example: John Doe
                          id:
                            type: integer
                            example: 1
                          image_url:
                            type: string
                            example: https://example.com/image.png
                          external_id:
                            type: string
                            example: '1234567890'
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      refunds:
                        type:
                          - array
                          - 'null'
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            amount:
                              type: string
                              example: '10.00'
                            reason:
                              type: string
                              example: Refund reason
                            cv:
                              type: integer
                              example: 1
                            qv:
                              type: integer
                              example: 1
                            refund_type:
                              type: string
                              example: Refund type
                      activities:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            user_id:
                              type: integer
                            relation_type:
                              type: string
                            relation_id:
                              type: integer
                            contact_id:
                              type:
                                - integer
                                - 'null'
                            title:
                              type: string
                              example: A new order has been placed
                            description:
                              type: string
                              example: Samantha Joseph placed an order on Vandelay Shop
                            formatted_description:
                              type: string
                              example: >-
                                Samantha Joseph placed an order on Vandelay Shop
                                recently
                            read_at:
                              type:
                                - string
                                - 'null'
                            slug:
                              type: string
                            company_id:
                              type: integer
                            created_at:
                              type: string
                      payment_method:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                          spreedly_token:
                            type: string
                          full_name:
                            type: string
                          month:
                            type: integer
                          year:
                            type: integer
                          number:
                            type: string
                          last_four_digits:
                            type:
                              - string
                              - 'null'
                          first_six_digits:
                            type:
                              - string
                              - 'null'
                          card_type:
                            type:
                              - string
                              - 'null'
                          default:
                            type: boolean
                          email:
                            type:
                              - string
                              - 'null'
                          source:
                            type: string
                      total:
                        type: string
                        example: '100.00'
                      total_in_currency:
                        type: string
                        example: $100.00 USD
                      sub_total:
                        type: string
                        example: '90.00'
                      subtotal:
                        type: string
                        example: '90.00'
                      sub_total_in_currency:
                        type: string
                        example: $90.00 USD
                      shipping:
                        type: object
                        properties:
                          amount:
                            type: string
                            example: '5.00'
                          surcharge:
                            type: string
                            example: '2.00'
                          amount_in_currency:
                            type: string
                            example: $5.00 USD
                          surcharge_in_currency:
                            type: string
                            example: $2.00 USD
                      shipping_discount:
                        type: number
                        example: 10.45
                      items_count:
                        type: integer
                        example: 10
                      metadata:
                        type: object
                        example:
                          level: gold
                          tags:
                            - Tag1
                            - Tag2
                          camapaign:
                            id: 1
                            name: Winter 2025
                      metafields_collection:
                        type: array
                        items:
                          type: object
                          properties:
                            key:
                              type: string
                              example: order_source
                            value:
                              type: string
                              example: wholesale_portal
                            namespace:
                              type: string
                              example: global
                            value_type:
                              type: string
                              example: string
                      metafields:
                        type: array
                        items:
                          title: LegacyMetafield
                          type: object
                          properties:
                            id:
                              type: integer
                            namespace:
                              description: >-
                                A container for related metafields. Commonly
                                used to group metafields by app or
                                functionality.
                              example: custom
                              type: string
                              maxLength: 20
                              pattern: ^[a-zA-Z0-9_]+$
                            key:
                              description: >-
                                The unique identifier for the metafield within
                                its namespace. Must be unique per namespace and
                                owner.
                              example: material
                              type: string
                              maxLength: 30
                              pattern: ^[a-zA-Z0-9_]+$
                            value:
                              description: >-
                                The actual data stored in the metafield. Type
                                depends on value_type.
                              example: cotton
                              type:
                                - string
                                - object
                            value_type:
                              description: >-
                                The data type that defines how the value should
                                be interpreted and validated.
                              example: single_line_text_field
                              type: string
                            description:
                              description: >-
                                Optional human-readable description explaining
                                the purpose of this metafield.
                              example: The primary material used in this product
                              type:
                                - string
                                - 'null'
                            owner_type:
                              description: >-
                                The type of resource that this metafield belongs
                                to (polymorphic association).
                              example: Product
                              type: string
                            owner_id:
                              description: >-
                                The ID of the specific resource that this
                                metafield belongs to.
                              example: 12345
                              type: integer
                            created_at:
                              description: Timestamp when the metafield was created.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            updated_at:
                              description: Timestamp when the metafield was last updated.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            metafield_definition:
                              title: MetafieldDefinition
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                company_id:
                                  description: >-
                                    The ID of the company that owns this
                                    metafield definition.
                                  example: 1
                                  type: integer
                                namespace:
                                  description: >-
                                    A container for related metafield
                                    definitions. Used to group definitions by
                                    app or functionality. Must be unique within
                                    company and owner_resource.
                                  example: product_details
                                  type: string
                                  maxLength: 20
                                  pattern: ^[a-zA-Z0-9_]+$
                                key:
                                  description: >-
                                    The unique identifier for the metafield
                                    definition within its namespace and
                                    owner_resource. Combined with namespace and
                                    owner_resource, this must be unique per
                                    company.
                                  example: material_type
                                  type: string
                                  maxLength: 30
                                  pattern: ^[a-zA-Z0-9_]+$
                                name:
                                  description: >-
                                    Human-readable display name for the
                                    metafield definition, shown in admin
                                    interfaces and forms.
                                  example: Material Type
                                  type: string
                                  maxLength: 100
                                description:
                                  description: >-
                                    Detailed explanation of what this metafield
                                    definition represents, how it should be
                                    used, and any special instructions for
                                    content creators.
                                  example: >-
                                    Specify the primary material composition of
                                    the product (e.g., cotton, polyester, silk).
                                    This will be displayed on the product detail
                                    page.
                                  type:
                                    - string
                                    - 'null'
                                value_type:
                                  description: >-
                                    The data type that defines how metafield
                                    values should be validated, stored, and
                                    displayed. Determines which validation rules
                                    are available.
                                  example: single_line_text_field
                                  type: string
                                validation_rules:
                                  description: >-
                                    JSON object containing validation
                                    constraints that will be applied to
                                    metafield values. Available rules depend on
                                    the value_type.
                                  example:
                                    choices:
                                      - cotton
                                      - polyester
                                      - silk
                                      - wool
                                      - linen
                                      - bamboo
                                    max: 50
                                    min: 2
                                  type:
                                    - object
                                    - 'null'
                                owner_resource:
                                  description: >-
                                    The type of resource (model class name) that
                                    metafields using this definition can be
                                    attached to. Must match the polymorphic
                                    owner_type.
                                  example: Product
                                  type: string
                                pinned:
                                  description: >-
                                    Whether this definition should be
                                    prominently displayed or prioritized in
                                    admin interfaces and forms.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                position:
                                  default: 0
                                  description: >-
                                    Sort order for displaying this definition
                                    relative to others in the same category and
                                    owner_resource. Lower numbers appear first.
                                  example: 1
                                  type:
                                    - integer
                                    - 'null'
                                locked:
                                  description: >-
                                    Whether this metafield definition is locked,
                                    preventing direct updates or deletions of
                                    metafields using this definition.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                created_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    created.
                                  example: '2024-01-15T10:30:00Z'
                                  type: string
                                  format: date-time
                                updated_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    last updated.
                                  example: '2024-02-20T14:45:00Z'
                                  type: string
                                  format: date-time
                                list_type:
                                  description: >-
                                    Whether this definition is for list-type
                                    metafields that store arrays of values.
                                  example: false
                                  type: boolean
                                reference_type:
                                  description: >-
                                    Whether this definition is for
                                    reference-type metafields that store
                                    references to other resources.
                                  example: false
                                  type: boolean
                                supported_validations:
                                  description: >-
                                    Array of validation rule names that are
                                    supported for this value_type.
                                  example:
                                    - min
                                    - max
                                    - choices
                                    - regex
                                  type: array
                                validation_description:
                                  description: >-
                                    Human-readable description of what the
                                    value_type represents and its constraints.
                                  example: Single line text up to 5000 characters
                                  type: string
                                category_ids:
                                  description: >-
                                    Array of category IDs that this metafield
                                    definition is associated with for
                                    organizational purposes.
                                  example:
                                    - 1
                                    - 2
                                    - 3
                                  items:
                                    type: integer
                                  type: array
                              required:
                                - id
                                - company_id
                                - namespace
                                - key
                                - name
                                - value_type
                                - owner_resource
                                - created_at
                                - updated_at
                                - list_type
                                - reference_type
                                - supported_validations
                                - validation_description
                                - category_ids
                          required:
                            - id
                            - namespace
                            - key
                            - value
                            - value_type
                            - owner_type
                            - owner_id
                            - created_at
                            - updated_at
                      transaction_fee:
                        type:
                          - number
                          - string
                        example: 3
                      transaction_fee_in_currency:
                        type: string
                        example: $3.00 USD
                      enrollment_fee:
                        type:
                          - number
                          - string
                        example: 3
                      enrollment_fee_in_currency:
                        type: string
                        example: $3.00 USD
                      discount:
                        type: string
                        example: '10.00'
                      tax:
                        type: string
                        example: '8.00'
                      dynamic_charges:
                        type: object
                        example:
                          handling: 2
                      dynamic_charges_in_currency:
                        type: object
                        example:
                          handling: $2.00 USD
                      buyer:
                        type:
                          - object
                          - 'null'
                        example:
                          share_guid: f6b4c9
                      shipping_address:
                        type:
                          - object
                          - 'null'
                        properties:
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          address1:
                            type:
                              - string
                              - 'null'
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type:
                              - string
                              - 'null'
                            example: New York
                          state:
                            type:
                              - string
                              - 'null'
                            example: NY
                          postal_code:
                            type:
                              - string
                              - 'null'
                            example: '10001'
                          country_code:
                            type:
                              - string
                              - 'null'
                            example: US
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                      billing_address:
                        type:
                          - object
                          - 'null'
                        properties:
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          address1:
                            type:
                              - string
                              - 'null'
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type:
                              - string
                              - 'null'
                            example: New York
                          state:
                            type:
                              - string
                              - 'null'
                            example: NY
                          postal_code:
                            type:
                              - string
                              - 'null'
                            example: '10001'
                          country_code:
                            type:
                              - string
                              - 'null'
                            example: US
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            title:
                              type: string
                              example: Hula Hoop
                            quantity:
                              type: integer
                              example: 3
                            price:
                              type:
                                - number
                                - string
                              example: 5.5
                            display_price:
                              type: string
                              example: $5.5 USD
                            total:
                              type:
                                - number
                                - string
                              example: 16.5
                            display_total:
                              type: string
                              example: $16.5 USD
                            image_url:
                              type:
                                - string
                                - 'null'
                              example: https://example.com/test_image.jpg
                            sku:
                              type:
                                - string
                                - 'null'
                              example: ABC-12345-S-BL
                            cv:
                              type: integer
                              example: 100
                            qv:
                              type: integer
                              example: 100
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            ordered_variant:
                              type: array
                              items:
                                type: object
                                properties:
                                  option_type:
                                    type: string
                                    example: Size
                                  value:
                                    type: string
                                    example: XXL
                            hs_code:
                              type:
                                - string
                                - 'null'
                              example: HS123
                            total_in_currency:
                              type: string
                              example: $11.0 USD
                            price_in_currency:
                              type: string
                              example: $29.99
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            thumbnail:
                              type: string
                              example: https://example.com/test_image.jpg
                            variant:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: Sample Variant
                                image_path:
                                  type:
                                    - string
                                    - 'null'
                                  example: /images/sample.png
                                image_url:
                                  type:
                                    - string
                                    - 'null'
                                  example: https://example.com/images/sample.png
                                primary_image:
                                  type:
                                    - string
                                    - 'null'
                                  example: https://example.com/images/primary.png
                                price:
                                  type:
                                    - string
                                    - 'null'
                                  example: '34.44'
                                price_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $34.44
                                sku:
                                  type:
                                    - string
                                    - 'null'
                                  example: SKU12345
                                options:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      title:
                                        type: string
                                        example: Size
                                      value:
                                        type: string
                                        example: XL
                      discount_in_currency:
                        type: string
                        example: $10.00 USD
                      tax_in_currency:
                        type: string
                        example: $8.00 USD
                      cv:
                        type: integer
                        example: 100
                      qv:
                        type: integer
                        example: 100
                      status:
                        type: string
                        example: awaiting_payment
                      external_id:
                        type:
                          - string
                          - 'null'
                        example: '1234567890'
                      cart_id:
                        type:
                          - string
                          - 'null'
                        example: 1
                      cart_token:
                        type:
                          - string
                          - 'null'
                        example: CART_TOKEN
                      source:
                        type: string
                        example: web
                        enum:
                          - mobile
                          - web
                          - admin
                          - backoffice
                          - subscription
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                metadata:
                  type: array
                  items:
                    type: string
                  description: >-
                    Array of metadata keys to remove. Supports dot notation for
                    nested keys.
                  example:
                    - level
                    - referred_by.user.id
                    - location_ids
              required:
                - metadata
  /api/v2/orders/{id}/update_sponsor:
    patch:
      summary: Update Order Sponsor
      description: Update the sponsor (user_company) of an order
      tags:
        - Orders
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Order ID
          schema:
            type: integer
      responses:
        '200':
          description: successful
        '422':
          description: sponsor not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: fail
                  data:
                    type: object
                    properties:
                      error:
                        type: string
                        example: Sponsor not found
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                order:
                  type: object
                  properties:
                    user_company_id:
                      type: integer
                      description: ID of the UserCompany (sponsor)
                  required:
                    - user_company_id
              required:
                - order
        required: true
    parameters:
      - name: id
        in: path
        description: Order ID
        required: true
        schema:
          type: string
  /api/v2/orders/{id}/archive:
    patch:
      summary: Archive an Order
      description: Archive an order
      tags:
        - Orders
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Order ID
          schema:
            type: integer
      responses:
        '200':
          description: successful - order archived
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: success
                  data:
                    type: object
                    properties:
                      message:
                        type: string
                        example: Order archived successfully
        '422':
          description: validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: fail
                  data:
                    type: object
                    properties:
                      error:
                        type: string
                        example: Status cannot be archived for cancelled order
    parameters:
      - name: id
        in: path
        description: Order ID
        required: true
        schema:
          type: string
  /api/v2/orders/{id}/unarchive:
    patch:
      summary: Unarchive an Order
      description: Unarchive an order
      tags:
        - Orders
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Order ID
          schema:
            type: integer
      responses:
        '200':
          description: successful - order unarchived
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: success
                  data:
                    type: object
                    properties:
                      message:
                        type: string
                        example: Order unarchived successfully
        '422':
          description: validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: fail
                  data:
                    type: object
                    properties:
                      error:
                        type: string
                        example: Order is not archived
    parameters:
      - name: id
        in: path
        description: Order ID
        required: true
        schema:
          type: string
  /api/v2/orders/{id}/update_external_id:
    patch:
      summary: Update Order External ID
      description: Update the external_id of an order
      tags:
        - Orders
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Order ID
          schema:
            type: integer
      responses:
        '200':
          description: successful
        '404':
          description: order not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: fail
                  data:
                    type: object
                    properties:
                      error:
                        type: string
                        example: Order not found.
        '422':
          description: external_id not provided
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameters
                  errors:
                    type: object
                    properties:
                      order:
                        type: object
                        properties:
                          external_id:
                            type: array
                            items:
                              type: string
                            example:
                              - is missing
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                order:
                  type: object
                  properties:
                    external_id:
                      type: string
                      description: External ID for the order
                  required:
                    - external_id
              required:
                - order
        required: true
    parameters:
      - name: id
        in: path
        description: Order ID
        required: true
        schema:
          type: string
  /api/v2/orders/send_invoice_email:
    post:
      summary: Send order invoice email
      description: Send an order invoice email
      tags:
        - Orders
      operationId: sendOrderInvoiceEmail
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart_token:
                    type: string
                    example: ct_ABC123
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - cart_token
        '404':
          description: cart not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                cart_token:
                  type: string
              required:
                - cart_token
        description: Invoice email parameters
  /api/company/orders.json:
    get:
      tags:
        - Orders
      summary: Retrieve Company Orders
      description: >-
        Retrieves a list of all company orders with their associated details
        including order information, customer data, and tracking details.
      operationId: getCompanyOrders
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
          description: Page number for paginated results
        - name: limit
          in: query
          required: false
          schema:
            type: integer
          description: Number of orders to return per page
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/index7'
                description: ''
      deprecated: false
      security:
        - bearer: []
    post:
      tags:
        - Orders
      summary: Create Company Order
      description: >-
        Creates a new order for a company with the specified order details
        including customer information, shipping address, items, and payment
        information.
      operationId: createCompanyOrder
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/createrequest5'
                - example:
                    order:
                      order_number: K5124124
                      customer_email: gavin@hooli.com
                      customer_firstname: Gavin
                      customer_lastname: Belson
                      affiliate:
                        email: tingeym2@gmail.com
                      ship_to:
                        address1: 506 W 1060 N
                        city: American Fork
                        state: UT
                        postal_code: '84003'
                      items:
                        - sku: ABC1234
                          name: SRQ
                          image_url: >-
                            https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png
                          quantity: 2
                          unit_price: 99.99
                      amount_paid: 218.73
            example:
              order:
                order_number: K5124124
                customer_email: gavin@hooli.com
                customer_firstname: Gavin
                customer_lastname: Belson
                affiliate:
                  email: tingeym2@gmail.com
                ship_to:
                  address1: 506 W 1060 N
                  city: American Fork
                  state: UT
                  postal_code: '84003'
                items:
                  - sku: ABC1234
                    name: SRQ
                    image_url: >-
                      https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png
                    quantity: 2
                    unit_price: 99.99
                amount_paid: 218.73
        required: true
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/create5'
                  - example:
                      id: 10276
                      order_number: K5124124
                      amount: '218.73'
                      shipping: '0.0'
                      tax: '0.0'
                      subtotal: '0.0'
                      first_name: Gavin
                      last_name: Belson
                      email: gavin@hooli.com
                      phone: null
                      tracking: null
                      cv: 0
                      qv: 0
                      status: awaiting_shipment
                      order_type: imported
                      rating: 1
                      review: null
                      referrer: Mike Tingey
                      friendly_status: paid
                      type: null
                      created_at: '2023-12-19T11:52:57.474Z'
                      currency_code: AFN
                      currency_symbol: ؋
                      display_amount: ؋218.73 (AFN)
                      display_subtotal: ؋0.00 (AFN)
                      display_tax: ؋0.00 (AFN)
                      display_shipping: ؋0.00 (AFN)
                      display_refunds: (0 CV, 0 QV) -؋0.00 (AFN)
                      display_discount: ؋0.00 (AFN)
                      order_thumbnail: >-
                        https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png
                      sale_date: '2023-12-19T11:52:57.474Z'
                      recognized_ship_date: null
                      refundable: false
                      max_refundable_amount: '218.73'
                      max_refundable_tax: '0.0'
                      max_refundable_shipping: '0.0'
                      max_refundable_product_price: '0.0'
                      ship_to:
                        id: 980200545
                        name: null
                        address1: 506 W 1060 N
                        address2: null
                        address3: null
                        city: American Fork
                        state: UT
                        postal_code: '84003'
                        country_code: null
                        country: null
                        default: false
                      bill_to: null
                      contact:
                        id: 18105
                        token: H8HneojRWb3qhs6mkNsCmAv3
                        first_name: Gavin
                        last_name: Belson
                        avatar_url: null
                        status: new
                        email: gavin@hooli.com
                        email2: null
                        phone: null
                        phone2: null
                        phone_id: null
                        address: null
                        address2: null
                        city: null
                        state: null
                        postal_code: null
                        language_id: null
                        country_id: null
                        lead_type: null
                        ip: null
                        requested_at: null
                        best_time: null
                        time_zone: null
                        reason: null
                        income: null
                        hours: null
                        invest: null
                        interest: null
                        full_name: Gavin Belson
                      items:
                        - id: 10622
                          quantity: 2
                          price: 99.99
                          ordered_variant: ''
                          sku: null
                          product:
                            id: 6684
                            active: false
                            title: SRQ
                            description:
                              id: null
                              name: description
                              body: null
                              record_type: Product
                              record_id: 6684
                              created_at: null
                              updated_at: null
                            stripped: ''
                            price: '99.99'
                            display_price: ؋99.99 (AFN)
                            subscription_price: '99.99'
                            display_subscription_price: ؋99.99 (AFN)
                            wholesale_price: '0.0'
                            display_wholesale_price: ؋0.00 (AFN)
                            wholesale_subscription_price: '0.0'
                            display_wholesale_subscription_price: ؋0.00 (AFN)
                            shipping: '0.0'
                            image:
                              mini: >-
                                https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png
                              detail: >-
                                https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png
                              full: >-
                                https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png
                            image_url: >-
                              https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png
                            sku: ABC1234
                            country_code: us
                            country_id: 1
                            views: 0
                            leads: 0
                            share_link: null
                            commission: '10.0'
                            public: true
                            shopify_id: null
                            shopify_handle: null
                            in_stock: true
                            vendor: null
                            price_range:
                              - $99.99
                              - $99.99
                            price_range_formatted: $99.99
                            unlimited_inventory: false
                            default_variant:
                              id: 27306
                              product_id: 6684
                              shopify_id: null
                              title: null
                              sku: ABC1234
                              position: 15756
                              inventory_policy: none
                              taxable: true
                              inventory_quantity: 1
                              created_at: '2023-12-19T11:52:57.058Z'
                              updated_at: '2023-12-19T11:52:57.058Z'
                              external_id: null
                              variant_country_id: null
                              image_url: null
                              image_path: null
                              is_master: true
                              discarded_at: null
                              price: null
                              weight: null
                              size: null
                              physical: true
                              unit_of_weight: null
                              height: null
                              width: null
                              length: null
                              unit_of_size: null
                              hs_code: null
                              country_of_origin: null
                              customs_information_shipping: true
                              active: true
                              bar_code: null
                              track_quantity: true
                              keep_selling: false
                              option_attrs: []
                              allow_subscription: true
                            currency_symbol: ؋
                            currency_code: AFN
                            average_rating: 0
                            option_values: {}
                            publish_to_retail_store: true
                            publish_to_rep_store: true
                            publish_to_share_tab: true
                            images: []
                            countries:
                              - id: 24
                                iso_name: BHUTAN
                                iso: BT
                                iso3: BTN
                                name: Bhutan
                                numcode: 64
                                active: true
                                currency_code: BTN
                                currency_symbol: Nu.
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 39
                                iso_name: CHAD
                                iso: TD
                                iso3: TCD
                                name: Chad
                                numcode: 148
                                active: true
                                currency_code: XAF
                                currency_symbol: CFA
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 92
                                iso_name: INDIA
                                iso: IN
                                iso3: IND
                                name: India
                                numcode: 356
                                active: true
                                currency_code: INR
                                currency_symbol: ₹
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 131
                                iso_name: MICRONESIA, FEDERATED STATES OF
                                iso: FM
                                iso3: FSM
                                name: Micronesia, Federated States of
                                numcode: 583
                                active: true
                                currency_code: USD
                                currency_symbol: $
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 148
                                iso_name: NIGERIA
                                iso: NG
                                iso3: NGA
                                name: Nigeria
                                numcode: 566
                                active: true
                                currency_code: NGN
                                currency_symbol: ₦
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 179
                                iso_name: SENEGAL
                                iso: SN
                                iso3: SEN
                                name: Senegal
                                numcode: 686
                                active: true
                                currency_code: XOF
                                currency_symbol: Fr
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 214
                                iso_name: UNITED STATES
                                iso: US
                                iso3: USA
                                name: United States
                                numcode: 840
                                active: true
                                currency_code: USD
                                currency_symbol: $
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 12
                                iso_name: AUSTRALIA
                                iso: AU
                                iso3: AUS
                                name: Australia
                                numcode: 36
                                active: true
                                currency_code: AUD
                                currency_symbol: $
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 13
                                iso_name: AUSTRIA
                                iso: AT
                                iso3: AUT
                                name: Austria
                                numcode: 40
                                active: true
                                currency_code: EUR
                                currency_symbol: €
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 14
                                iso_name: AZERBAIJAN
                                iso: AZ
                                iso3: AZE
                                name: Azerbaijan
                                numcode: 31
                                active: true
                                currency_code: AZN
                                currency_symbol: ₼
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 15
                                iso_name: BAHAMAS
                                iso: BS
                                iso3: BHS
                                name: Bahamas
                                numcode: 44
                                active: true
                                currency_code: BSD
                                currency_symbol: $
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 16
                                iso_name: BAHRAIN
                                iso: BH
                                iso3: BHR
                                name: Bahrain
                                numcode: 48
                                active: true
                                currency_code: BHD
                                currency_symbol: د.ب
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 205
                                iso_name: TUNISIA
                                iso: TN
                                iso3: TUN
                                name: Tunisia
                                numcode: 788
                                active: true
                                currency_code: TND
                                currency_symbol: د.ت
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 2
                                iso_name: ALBANIA
                                iso: AL
                                iso3: ALB
                                name: Albania
                                numcode: 8
                                active: true
                                currency_code: ALL
                                currency_symbol: L
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 3
                                iso_name: ALGERIA
                                iso: DZ
                                iso3: DZA
                                name: Algeria
                                numcode: 12
                                active: true
                                currency_code: DZD
                                currency_symbol: د.ج
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 5
                                iso_name: ANDORRA
                                iso: AD
                                iso3: AND
                                name: Andorra
                                numcode: 20
                                active: true
                                currency_code: EUR
                                currency_symbol: €
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 6
                                iso_name: ANGOLA
                                iso: AO
                                iso3: AGO
                                name: Angola
                                numcode: 24
                                active: true
                                currency_code: AOA
                                currency_symbol: Kz
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 7
                                iso_name: ANGUILLA
                                iso: AI
                                iso3: AIA
                                name: Anguilla
                                numcode: 660
                                active: true
                                currency_code: XCD
                                currency_symbol: $
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 8
                                iso_name: ANTIGUA AND BARBUDA
                                iso: AG
                                iso3: ATG
                                name: Antigua and Barbuda
                                numcode: 28
                                active: true
                                currency_code: XCD
                                currency_symbol: $
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 74
                                iso_name: GERMANY
                                iso: DE
                                iso3: DEU
                                name: Germany
                                numcode: 276
                                active: true
                                currency_code: EUR
                                currency_symbol: €
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 78
                                iso_name: GREENLAND
                                iso: GL
                                iso3: GRL
                                name: Greenland
                                numcode: 304
                                active: true
                                currency_code: DKK
                                currency_symbol: kr.
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 141
                                iso_name: NEPAL
                                iso: NP
                                iso3: NPL
                                name: Nepal
                                numcode: 524
                                active: true
                                currency_code: NPR
                                currency_symbol: Rs.
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 1
                                iso_name: AFGHANISTAN
                                iso: AF
                                iso3: AFG
                                name: Afghanistan
                                numcode: 4
                                active: true
                                currency_code: AFN
                                currency_symbol: ؋
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 9
                                iso_name: ARGENTINA
                                iso: AR
                                iso3: ARG
                                name: Argentina
                                numcode: 32
                                active: true
                                currency_code: ARS
                                currency_symbol: $
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 35
                                iso_name: CANADA
                                iso: CA
                                iso3: CAN
                                name: Canada
                                numcode: 124
                                active: true
                                currency_code: CAD
                                currency_symbol: $
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 142
                                iso_name: NETHERLANDS
                                iso: NL
                                iso3: NLD
                                name: Netherlands
                                numcode: 528
                                active: true
                                currency_code: EUR
                                currency_symbol: €
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 144
                                iso_name: NEW CALEDONIA
                                iso: NC
                                iso3: NCL
                                name: New Caledonia
                                numcode: 540
                                active: true
                                currency_code: XPF
                                currency_symbol: Fr
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 192
                                iso_name: SVALBARD AND JAN MAYEN
                                iso: SJ
                                iso3: SJM
                                name: Svalbard and Jan Mayen
                                numcode: 744
                                active: true
                                currency_code: NOK
                                currency_symbol: kr
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 224
                                iso_name: YEMEN
                                iso: YE
                                iso3: YEM
                                name: Yemen
                                numcode: 887
                                active: true
                                currency_code: YER
                                currency_symbol: ﷼
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                            variants:
                              - id: 27306
                                title: null
                                image_url: null
                                buyable: true
                                option_value_ids: []
                                allow_subscription: true
                                variant_countries:
                                  - id: 3147116
                                    price: '99.99'
                                    shipping: '0.0'
                                    tax: '0.0'
                                    currency_code: AFN
                                    currency_symbol: ؋
                                    display_price: ؋99.99 (AFN)
                                    country_iso: AF
                                    subscription_price: '99.99'
                                    display_wholesale_price: ؋0.00 (AFN)
                                    display_wholesale_subscription_price: ؋0.00 (AFN)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 1
                                      iso: AF
                                      iso_name: AFGHANISTAN
                                      iso3: AFG
                                      name: Afghanistan
                                      tax_rate: 0
                                  - id: 3147117
                                    price: '99.99'
                                    shipping: '0.0'
                                    tax: '0.0'
                                    currency_code: ALL
                                    currency_symbol: L
                                    display_price: L99.99 (ALL)
                                    country_iso: AL
                                    subscription_price: '99.99'
                                    display_wholesale_price: L0.00 (ALL)
                                    display_wholesale_subscription_price: L0.00 (ALL)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 2
                                      iso: AL
                                      iso_name: ALBANIA
                                      iso3: ALB
                                      name: Albania
                                      tax_rate: 0
                                  - id: 3147118
                                    price: '99.99'
                                    shipping: '0.0'
                                    tax: '0.0'
                                    currency_code: DZD
                                    currency_symbol: د.ج
                                    display_price: د.ج99.99 (DZD)
                                    country_iso: DZ
                                    subscription_price: '99.99'
                                    display_wholesale_price: د.ج0.00 (DZD)
                                    display_wholesale_subscription_price: د.ج0.00 (DZD)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 3
                                      iso: DZ
                                      iso_name: ALGERIA
                                      iso3: DZA
                                      name: Algeria
                                      tax_rate: 0
                                  - id: 3147119
                                    price: '99.99'
                                    shipping: '0.0'
                                    tax: '0.0'
                                    currency_code: EUR
                                    currency_symbol: €
                                    display_price: €99.99 (EUR)
                                    country_iso: AD
                                    subscription_price: '99.99'
                                    display_wholesale_price: €0.00 (EUR)
                                    display_wholesale_subscription_price: €0.00 (EUR)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 5
                                      iso: AD
                                      iso_name: ANDORRA
                                      iso3: AND
                                      name: Andorra
                                      tax_rate: 0
                                  - id: 3147120
                                    price: '99.99'
                                    shipping: '0.0'
                                    tax: '0.0'
                                    currency_code: AOA
                                    currency_symbol: Kz
                                    display_price: Kz99.99 (AOA)
                                    country_iso: AO
                                    subscription_price: '99.99'
                                    display_wholesale_price: Kz0.00 (AOA)
                                    display_wholesale_subscription_price: Kz0.00 (AOA)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 6
                                      iso: AO
                                      iso_name: ANGOLA
                                      iso3: AGO
                                      name: Angola
                                      tax_rate: 0
                                  - id: 3147121
                                    price: '99.99'
                                    shipping: '0.0'
                                    tax: '0.0'
                                    currency_code: XCD
                                    currency_symbol: $
                                    display_price: $99.99 (XCD)
                                    country_iso: AI
                                    subscription_price: '99.99'
                                    display_wholesale_price: $0.00 (XCD)
                                    display_wholesale_subscription_price: $0.00 (XCD)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 7
                                      iso: AI
                                      iso_name: ANGUILLA
                                      iso3: AIA
                                      name: Anguilla
                                      tax_rate: 0
                                  - id: 3147122
                                    price: '99.99'
                                    shipping: '0.0'
                                    tax: '0.0'
                                    currency_code: XCD
                                    currency_symbol: $
                                    display_price: $99.99 (XCD)
                                    country_iso: AG
                                    subscription_price: '99.99'
                                    display_wholesale_price: $0.00 (XCD)
                                    display_wholesale_subscription_price: $0.00 (XCD)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 8
                                      iso: AG
                                      iso_name: ANTIGUA AND BARBUDA
                                      iso3: ATG
                                      name: Antigua and Barbuda
                                      tax_rate: 0
                                  - id: 3147123
                                    price: '99.99'
                                    shipping: '0.0'
                                    tax: '0.0'
                                    currency_code: ARS
                                    currency_symbol: $
                                    display_price: $99.99 (ARS)
                                    country_iso: AR
                                    subscription_price: '99.99'
                                    display_wholesale_price: $0.00 (ARS)
                                    display_wholesale_subscription_price: $0.00 (ARS)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 9
                                      iso: AR
                                      iso_name: ARGENTINA
                                      iso3: ARG
                                      name: Argentina
                                      tax_rate: 0
                                  - id: 3147124
                                    price: '99.99'
                                    shipping: '0.0'
                                    tax: '0.0'
                                    currency_code: AUD
                                    currency_symbol: $
                                    display_price: $99.99 (AUD)
                                    country_iso: AU
                                    subscription_price: '99.99'
                                    display_wholesale_price: $0.00 (AUD)
                                    display_wholesale_subscription_price: $0.00 (AUD)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 12
                                      iso: AU
                                      iso_name: AUSTRALIA
                                      iso3: AUS
                                      name: Australia
                                      tax_rate: 0
                                  - id: 3147125
                                    price: '99.99'
                                    shipping: '0.0'
                                    tax: '0.0'
                                    currency_code: EUR
                                    currency_symbol: €
                                    display_price: €99.99 (EUR)
                                    country_iso: AT
                                    subscription_price: '99.99'
                                    display_wholesale_price: €0.00 (EUR)
                                    display_wholesale_subscription_price: €0.00 (EUR)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 13
                                      iso: AT
                                      iso_name: AUSTRIA
                                      iso3: AUT
                                      name: Austria
                                      tax_rate: 0
                                  - id: 3147126
                                    price: '99.99'
                                    shipping: '0.0'
                                    tax: '0.0'
                                    currency_code: AZN
                                    currency_symbol: ₼
                                    display_price: ₼99.99 (AZN)
                                    country_iso: AZ
                                    subscription_price: '99.99'
                                    display_wholesale_price: ₼0.00 (AZN)
                                    display_wholesale_subscription_price: ₼0.00 (AZN)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 14
                                      iso: AZ
                                      iso_name: AZERBAIJAN
                                      iso3: AZE
                                      name: Azerbaijan
                                      tax_rate: 0
                                  - id: 3147127
                                    price: '99.99'
                                    shipping: '0.0'
                                    tax: '0.0'
                                    currency_code: BSD
                                    currency_symbol: $
                                    display_price: $99.99 (BSD)
                                    country_iso: BS
                                    subscription_price: '99.99'
                                    display_wholesale_price: $0.00 (BSD)
                                    display_wholesale_subscription_price: $0.00 (BSD)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 15
                                      iso: BS
                                      iso_name: BAHAMAS
                                      iso3: BHS
                                      name: Bahamas
                                      tax_rate: 0
                                  - id: 3147128
                                    price: '99.99'
                                    shipping: '0.0'
                                    tax: '0.0'
                                    currency_code: BHD
                                    currency_symbol: د.ب
                                    display_price: د.ب99.990 (BHD)
                                    country_iso: BH
                                    subscription_price: '99.99'
                                    display_wholesale_price: د.ب0.000 (BHD)
                                    display_wholesale_subscription_price: د.ب0.000 (BHD)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 16
                                      iso: BH
                                      iso_name: BAHRAIN
                                      iso3: BHR
                                      name: Bahrain
                                      tax_rate: 0
                                  - id: 3147129
                                    price: '99.99'
                                    shipping: '0.0'
                                    tax: '0.0'
                                    currency_code: BTN
                                    currency_symbol: Nu.
                                    display_price: Nu.99.99 (BTN)
                                    country_iso: BT
                                    subscription_price: '99.99'
                                    display_wholesale_price: Nu.0.00 (BTN)
                                    display_wholesale_subscription_price: Nu.0.00 (BTN)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 24
                                      iso: BT
                                      iso_name: BHUTAN
                                      iso3: BTN
                                      name: Bhutan
                                      tax_rate: 0
                                  - id: 3147130
                                    price: '99.99'
                                    shipping: '0.0'
                                    tax: '0.0'
                                    currency_code: CAD
                                    currency_symbol: $
                                    display_price: $99.99 (CAD)
                                    country_iso: CA
                                    subscription_price: '99.99'
                                    display_wholesale_price: $0.00 (CAD)
                                    display_wholesale_subscription_price: $0.00 (CAD)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 35
                                      iso: CA
                                      iso_name: CANADA
                                      iso3: CAN
                                      name: Canada
                                      tax_rate: 0
                                  - id: 3147131
                                    price: '99.99'
                                    shipping: '0.0'
                                    tax: '0.0'
                                    currency_code: XAF
                                    currency_symbol: CFA
                                    display_price: CFA100 (XAF)
                                    country_iso: TD
                                    subscription_price: '99.99'
                                    display_wholesale_price: CFA0 (XAF)
                                    display_wholesale_subscription_price: CFA0 (XAF)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 39
                                      iso: TD
                                      iso_name: CHAD
                                      iso3: TCD
                                      name: Chad
                                      tax_rate: 0
                                  - id: 3147132
                                    price: '99.99'
                                    shipping: '0.0'
                                    tax: '0.0'
                                    currency_code: EUR
                                    currency_symbol: €
                                    display_price: €99.99 (EUR)
                                    country_iso: DE
                                    subscription_price: '99.99'
                                    display_wholesale_price: €0.00 (EUR)
                                    display_wholesale_subscription_price: €0.00 (EUR)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 74
                                      iso: DE
                                      iso_name: GERMANY
                                      iso3: DEU
                                      name: Germany
                                      tax_rate: 0
                                  - id: 3147133
                                    price: '99.99'
                                    shipping: '0.0'
                                    tax: '0.0'
                                    currency_code: DKK
                                    currency_symbol: kr.
                                    display_price: kr.99.99 (DKK)
                                    country_iso: GL
                                    subscription_price: '99.99'
                                    display_wholesale_price: kr.0.00 (DKK)
                                    display_wholesale_subscription_price: kr.0.00 (DKK)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 78
                                      iso: GL
                                      iso_name: GREENLAND
                                      iso3: GRL
                                      name: Greenland
                                      tax_rate: 0
                                  - id: 3147134
                                    price: '99.99'
                                    shipping: '0.0'
                                    tax: '0.0'
                                    currency_code: INR
                                    currency_symbol: ₹
                                    display_price: ₹99.99 (INR)
                                    country_iso: IN
                                    subscription_price: '99.99'
                                    display_wholesale_price: ₹0.00 (INR)
                                    display_wholesale_subscription_price: ₹0.00 (INR)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 92
                                      iso: IN
                                      iso_name: INDIA
                                      iso3: IND
                                      name: India
                                      tax_rate: 0
                                  - id: 3147135
                                    price: '99.99'
                                    shipping: '0.0'
                                    tax: '0.0'
                                    currency_code: USD
                                    currency_symbol: $
                                    display_price: $99.99 (USD)
                                    country_iso: FM
                                    subscription_price: '99.99'
                                    display_wholesale_price: $0.00 (USD)
                                    display_wholesale_subscription_price: $0.00 (USD)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 131
                                      iso: FM
                                      iso_name: MICRONESIA, FEDERATED STATES OF
                                      iso3: FSM
                                      name: Micronesia, Federated States of
                                      tax_rate: 0
                                  - id: 3147136
                                    price: '99.99'
                                    shipping: '0.0'
                                    tax: '0.0'
                                    currency_code: NPR
                                    currency_symbol: Rs.
                                    display_price: Rs.99.99 (NPR)
                                    country_iso: NP
                                    subscription_price: '99.99'
                                    display_wholesale_price: Rs.0.00 (NPR)
                                    display_wholesale_subscription_price: Rs.0.00 (NPR)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 141
                                      iso: NP
                                      iso_name: NEPAL
                                      iso3: NPL
                                      name: Nepal
                                      tax_rate: 0
                                  - id: 3147137
                                    price: '99.99'
                                    shipping: '0.0'
                                    tax: '0.0'
                                    currency_code: EUR
                                    currency_symbol: €
                                    display_price: €99.99 (EUR)
                                    country_iso: NL
                                    subscription_price: '99.99'
                                    display_wholesale_price: €0.00 (EUR)
                                    display_wholesale_subscription_price: €0.00 (EUR)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 142
                                      iso: NL
                                      iso_name: NETHERLANDS
                                      iso3: NLD
                                      name: Netherlands
                                      tax_rate: 0
                                  - id: 3147138
                                    price: '99.99'
                                    shipping: '0.0'
                                    tax: '0.0'
                                    currency_code: XPF
                                    currency_symbol: Fr
                                    display_price: Fr100 (XPF)
                                    country_iso: NC
                                    subscription_price: '99.99'
                                    display_wholesale_price: Fr0 (XPF)
                                    display_wholesale_subscription_price: Fr0 (XPF)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 144
                                      iso: NC
                                      iso_name: NEW CALEDONIA
                                      iso3: NCL
                                      name: New Caledonia
                                      tax_rate: 0
                                  - id: 3147139
                                    price: '99.99'
                                    shipping: '0.0'
                                    tax: '0.0'
                                    currency_code: NGN
                                    currency_symbol: ₦
                                    display_price: ₦99.99 (NGN)
                                    country_iso: NG
                                    subscription_price: '99.99'
                                    display_wholesale_price: ₦0.00 (NGN)
                                    display_wholesale_subscription_price: ₦0.00 (NGN)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 148
                                      iso: NG
                                      iso_name: NIGERIA
                                      iso3: NGA
                                      name: Nigeria
                                      tax_rate: 0
                                  - id: 3147140
                                    price: '99.99'
                                    shipping: '0.0'
                                    tax: '0.0'
                                    currency_code: XOF
                                    currency_symbol: Fr
                                    display_price: Fr100 (XOF)
                                    country_iso: SN
                                    subscription_price: '99.99'
                                    display_wholesale_price: Fr0 (XOF)
                                    display_wholesale_subscription_price: Fr0 (XOF)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 179
                                      iso: SN
                                      iso_name: SENEGAL
                                      iso3: SEN
                                      name: Senegal
                                      tax_rate: 0
                                  - id: 3147141
                                    price: '99.99'
                                    shipping: '0.0'
                                    tax: '0.0'
                                    currency_code: NOK
                                    currency_symbol: kr
                                    display_price: kr99.99 (NOK)
                                    country_iso: SJ
                                    subscription_price: '99.99'
                                    display_wholesale_price: kr0.00 (NOK)
                                    display_wholesale_subscription_price: kr0.00 (NOK)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 192
                                      iso: SJ
                                      iso_name: SVALBARD AND JAN MAYEN
                                      iso3: SJM
                                      name: Svalbard and Jan Mayen
                                      tax_rate: 0
                                  - id: 3147142
                                    price: '99.99'
                                    shipping: '0.0'
                                    tax: '0.0'
                                    currency_code: TND
                                    currency_symbol: د.ت
                                    display_price: د.ت99.990 (TND)
                                    country_iso: TN
                                    subscription_price: '99.99'
                                    display_wholesale_price: د.ت0.000 (TND)
                                    display_wholesale_subscription_price: د.ت0.000 (TND)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 205
                                      iso: TN
                                      iso_name: TUNISIA
                                      iso3: TUN
                                      name: Tunisia
                                      tax_rate: 0
                                  - id: 3147143
                                    price: '99.99'
                                    shipping: '0.0'
                                    tax: '0.0'
                                    currency_code: USD
                                    currency_symbol: $
                                    display_price: $99.99 (USD)
                                    country_iso: US
                                    subscription_price: '99.99'
                                    display_wholesale_price: $0.00 (USD)
                                    display_wholesale_subscription_price: $0.00 (USD)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 214
                                      iso: US
                                      iso_name: UNITED STATES
                                      iso3: USA
                                      name: United States
                                      tax_rate: 0
                                  - id: 3147144
                                    price: '99.99'
                                    shipping: '0.0'
                                    tax: '0.0'
                                    currency_code: YER
                                    currency_symbol: ﷼
                                    display_price: ﷼99.99 (YER)
                                    country_iso: YE
                                    subscription_price: '99.99'
                                    display_wholesale_price: ﷼0.00 (YER)
                                    display_wholesale_subscription_price: ﷼0.00 (YER)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 224
                                      iso: YE
                                      iso_name: YEMEN
                                      iso3: YEM
                                      name: Yemen
                                      tax_rate: 0
                            options: []
                            prompts: []
                            enroll_products: []
                            enrolls: []
                      tracking_informations: []
              example:
                id: 10276
                order_number: K5124124
                amount: '218.73'
                shipping: '0.0'
                tax: '0.0'
                subtotal: '0.0'
                first_name: Gavin
                last_name: Belson
                email: gavin@hooli.com
                phone: null
                tracking: null
                cv: 0
                qv: 0
                status: awaiting_shipment
                order_type: imported
                rating: 1
                review: null
                referrer: Mike Tingey
                friendly_status: paid
                type: null
                created_at: '2023-12-19T11:52:57.474Z'
                currency_code: AFN
                currency_symbol: ؋
                display_amount: ؋218.73 (AFN)
                display_subtotal: ؋0.00 (AFN)
                display_tax: ؋0.00 (AFN)
                display_shipping: ؋0.00 (AFN)
                display_refunds: (0 CV, 0 QV) -؋0.00 (AFN)
                display_discount: ؋0.00 (AFN)
                order_thumbnail: >-
                  https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png
                sale_date: '2023-12-19T11:52:57.474Z'
                recognized_ship_date: null
                refundable: false
                max_refundable_amount: '218.73'
                max_refundable_tax: '0.0'
                max_refundable_shipping: '0.0'
                max_refundable_product_price: '0.0'
                ship_to:
                  id: 980200545
                  name: null
                  address1: 506 W 1060 N
                  address2: null
                  address3: null
                  city: American Fork
                  state: UT
                  postal_code: '84003'
                  country_code: null
                  country: null
                  default: false
                bill_to: null
                contact:
                  id: 18105
                  token: H8HneojRWb3qhs6mkNsCmAv3
                  first_name: Gavin
                  last_name: Belson
                  avatar_url: null
                  status: new
                  email: gavin@hooli.com
                  email2: null
                  phone: null
                  phone2: null
                  phone_id: null
                  address: null
                  address2: null
                  city: null
                  state: null
                  postal_code: null
                  language_id: null
                  country_id: null
                  lead_type: null
                  ip: null
                  requested_at: null
                  best_time: null
                  time_zone: null
                  reason: null
                  income: null
                  hours: null
                  invest: null
                  interest: null
                  full_name: Gavin Belson
                items:
                  - id: 10622
                    quantity: 2
                    price: 99.99
                    ordered_variant: ''
                    sku: null
                    product:
                      id: 6684
                      active: false
                      title: SRQ
                      description:
                        id: null
                        name: description
                        body: null
                        record_type: Product
                        record_id: 6684
                        created_at: null
                        updated_at: null
                      stripped: ''
                      price: '99.99'
                      display_price: ؋99.99 (AFN)
                      subscription_price: '99.99'
                      display_subscription_price: ؋99.99 (AFN)
                      wholesale_price: '0.0'
                      display_wholesale_price: ؋0.00 (AFN)
                      wholesale_subscription_price: '0.0'
                      display_wholesale_subscription_price: ؋0.00 (AFN)
                      shipping: '0.0'
                      image:
                        mini: >-
                          https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png
                        detail: >-
                          https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png
                        full: >-
                          https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png
                      image_url: >-
                        https://dh52nxpb2rr5f.cloudfront.net/uploads/product_image/image/39/SRQ512new.png
                      sku: ABC1234
                      country_code: us
                      country_id: 1
                      views: 0
                      leads: 0
                      share_link: null
                      commission: '10.0'
                      public: true
                      shopify_id: null
                      shopify_handle: null
                      in_stock: true
                      vendor: null
                      price_range:
                        - $99.99
                        - $99.99
                      price_range_formatted: $99.99
                      unlimited_inventory: false
                      default_variant:
                        id: 27306
                        product_id: 6684
                        shopify_id: null
                        title: null
                        sku: ABC1234
                        position: 15756
                        inventory_policy: none
                        taxable: true
                        inventory_quantity: 1
                        created_at: '2023-12-19T11:52:57.058Z'
                        updated_at: '2023-12-19T11:52:57.058Z'
                        external_id: null
                        variant_country_id: null
                        image_url: null
                        image_path: null
                        is_master: true
                        discarded_at: null
                        price: null
                        weight: null
                        size: null
                        physical: true
                        unit_of_weight: null
                        height: null
                        width: null
                        length: null
                        unit_of_size: null
                        hs_code: null
                        country_of_origin: null
                        customs_information_shipping: true
                        active: true
                        bar_code: null
                        track_quantity: true
                        keep_selling: false
                        option_attrs: []
                        allow_subscription: true
                      currency_symbol: ؋
                      currency_code: AFN
                      average_rating: 0
                      option_values: {}
                      publish_to_retail_store: true
                      publish_to_rep_store: true
                      publish_to_share_tab: true
                      images: []
                      countries:
                        - id: 24
                          iso_name: BHUTAN
                          iso: BT
                          iso3: BTN
                          name: Bhutan
                          numcode: 64
                          active: true
                          currency_code: BTN
                          currency_symbol: Nu.
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 39
                          iso_name: CHAD
                          iso: TD
                          iso3: TCD
                          name: Chad
                          numcode: 148
                          active: true
                          currency_code: XAF
                          currency_symbol: CFA
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 92
                          iso_name: INDIA
                          iso: IN
                          iso3: IND
                          name: India
                          numcode: 356
                          active: true
                          currency_code: INR
                          currency_symbol: ₹
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 131
                          iso_name: MICRONESIA, FEDERATED STATES OF
                          iso: FM
                          iso3: FSM
                          name: Micronesia, Federated States of
                          numcode: 583
                          active: true
                          currency_code: USD
                          currency_symbol: $
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 148
                          iso_name: NIGERIA
                          iso: NG
                          iso3: NGA
                          name: Nigeria
                          numcode: 566
                          active: true
                          currency_code: NGN
                          currency_symbol: ₦
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 179
                          iso_name: SENEGAL
                          iso: SN
                          iso3: SEN
                          name: Senegal
                          numcode: 686
                          active: true
                          currency_code: XOF
                          currency_symbol: Fr
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 214
                          iso_name: UNITED STATES
                          iso: US
                          iso3: USA
                          name: United States
                          numcode: 840
                          active: true
                          currency_code: USD
                          currency_symbol: $
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 12
                          iso_name: AUSTRALIA
                          iso: AU
                          iso3: AUS
                          name: Australia
                          numcode: 36
                          active: true
                          currency_code: AUD
                          currency_symbol: $
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 13
                          iso_name: AUSTRIA
                          iso: AT
                          iso3: AUT
                          name: Austria
                          numcode: 40
                          active: true
                          currency_code: EUR
                          currency_symbol: €
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 14
                          iso_name: AZERBAIJAN
                          iso: AZ
                          iso3: AZE
                          name: Azerbaijan
                          numcode: 31
                          active: true
                          currency_code: AZN
                          currency_symbol: ₼
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 15
                          iso_name: BAHAMAS
                          iso: BS
                          iso3: BHS
                          name: Bahamas
                          numcode: 44
                          active: true
                          currency_code: BSD
                          currency_symbol: $
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 16
                          iso_name: BAHRAIN
                          iso: BH
                          iso3: BHR
                          name: Bahrain
                          numcode: 48
                          active: true
                          currency_code: BHD
                          currency_symbol: د.ب
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 205
                          iso_name: TUNISIA
                          iso: TN
                          iso3: TUN
                          name: Tunisia
                          numcode: 788
                          active: true
                          currency_code: TND
                          currency_symbol: د.ت
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 2
                          iso_name: ALBANIA
                          iso: AL
                          iso3: ALB
                          name: Albania
                          numcode: 8
                          active: true
                          currency_code: ALL
                          currency_symbol: L
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 3
                          iso_name: ALGERIA
                          iso: DZ
                          iso3: DZA
                          name: Algeria
                          numcode: 12
                          active: true
                          currency_code: DZD
                          currency_symbol: د.ج
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 5
                          iso_name: ANDORRA
                          iso: AD
                          iso3: AND
                          name: Andorra
                          numcode: 20
                          active: true
                          currency_code: EUR
                          currency_symbol: €
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 6
                          iso_name: ANGOLA
                          iso: AO
                          iso3: AGO
                          name: Angola
                          numcode: 24
                          active: true
                          currency_code: AOA
                          currency_symbol: Kz
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 7
                          iso_name: ANGUILLA
                          iso: AI
                          iso3: AIA
                          name: Anguilla
                          numcode: 660
                          active: true
                          currency_code: XCD
                          currency_symbol: $
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 8
                          iso_name: ANTIGUA AND BARBUDA
                          iso: AG
                          iso3: ATG
                          name: Antigua and Barbuda
                          numcode: 28
                          active: true
                          currency_code: XCD
                          currency_symbol: $
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 74
                          iso_name: GERMANY
                          iso: DE
                          iso3: DEU
                          name: Germany
                          numcode: 276
                          active: true
                          currency_code: EUR
                          currency_symbol: €
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 78
                          iso_name: GREENLAND
                          iso: GL
                          iso3: GRL
                          name: Greenland
                          numcode: 304
                          active: true
                          currency_code: DKK
                          currency_symbol: kr.
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 141
                          iso_name: NEPAL
                          iso: NP
                          iso3: NPL
                          name: Nepal
                          numcode: 524
                          active: true
                          currency_code: NPR
                          currency_symbol: Rs.
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 1
                          iso_name: AFGHANISTAN
                          iso: AF
                          iso3: AFG
                          name: Afghanistan
                          numcode: 4
                          active: true
                          currency_code: AFN
                          currency_symbol: ؋
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 9
                          iso_name: ARGENTINA
                          iso: AR
                          iso3: ARG
                          name: Argentina
                          numcode: 32
                          active: true
                          currency_code: ARS
                          currency_symbol: $
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 35
                          iso_name: CANADA
                          iso: CA
                          iso3: CAN
                          name: Canada
                          numcode: 124
                          active: true
                          currency_code: CAD
                          currency_symbol: $
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 142
                          iso_name: NETHERLANDS
                          iso: NL
                          iso3: NLD
                          name: Netherlands
                          numcode: 528
                          active: true
                          currency_code: EUR
                          currency_symbol: €
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 144
                          iso_name: NEW CALEDONIA
                          iso: NC
                          iso3: NCL
                          name: New Caledonia
                          numcode: 540
                          active: true
                          currency_code: XPF
                          currency_symbol: Fr
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 192
                          iso_name: SVALBARD AND JAN MAYEN
                          iso: SJ
                          iso3: SJM
                          name: Svalbard and Jan Mayen
                          numcode: 744
                          active: true
                          currency_code: NOK
                          currency_symbol: kr
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 224
                          iso_name: YEMEN
                          iso: YE
                          iso3: YEM
                          name: Yemen
                          numcode: 887
                          active: true
                          currency_code: YER
                          currency_symbol: ﷼
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                      variants:
                        - id: 27306
                          title: null
                          image_url: null
                          buyable: true
                          option_value_ids: []
                          allow_subscription: true
                          variant_countries:
                            - id: 3147116
                              price: '99.99'
                              shipping: '0.0'
                              tax: '0.0'
                              currency_code: AFN
                              currency_symbol: ؋
                              display_price: ؋99.99 (AFN)
                              country_iso: AF
                              subscription_price: '99.99'
                              display_wholesale_price: ؋0.00 (AFN)
                              display_wholesale_subscription_price: ؋0.00 (AFN)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 1
                                iso: AF
                                iso_name: AFGHANISTAN
                                iso3: AFG
                                name: Afghanistan
                                tax_rate: 0
                            - id: 3147117
                              price: '99.99'
                              shipping: '0.0'
                              tax: '0.0'
                              currency_code: ALL
                              currency_symbol: L
                              display_price: L99.99 (ALL)
                              country_iso: AL
                              subscription_price: '99.99'
                              display_wholesale_price: L0.00 (ALL)
                              display_wholesale_subscription_price: L0.00 (ALL)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 2
                                iso: AL
                                iso_name: ALBANIA
                                iso3: ALB
                                name: Albania
                                tax_rate: 0
                            - id: 3147118
                              price: '99.99'
                              shipping: '0.0'
                              tax: '0.0'
                              currency_code: DZD
                              currency_symbol: د.ج
                              display_price: د.ج99.99 (DZD)
                              country_iso: DZ
                              subscription_price: '99.99'
                              display_wholesale_price: د.ج0.00 (DZD)
                              display_wholesale_subscription_price: د.ج0.00 (DZD)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 3
                                iso: DZ
                                iso_name: ALGERIA
                                iso3: DZA
                                name: Algeria
                                tax_rate: 0
                            - id: 3147119
                              price: '99.99'
                              shipping: '0.0'
                              tax: '0.0'
                              currency_code: EUR
                              currency_symbol: €
                              display_price: €99.99 (EUR)
                              country_iso: AD
                              subscription_price: '99.99'
                              display_wholesale_price: €0.00 (EUR)
                              display_wholesale_subscription_price: €0.00 (EUR)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 5
                                iso: AD
                                iso_name: ANDORRA
                                iso3: AND
                                name: Andorra
                                tax_rate: 0
                            - id: 3147120
                              price: '99.99'
                              shipping: '0.0'
                              tax: '0.0'
                              currency_code: AOA
                              currency_symbol: Kz
                              display_price: Kz99.99 (AOA)
                              country_iso: AO
                              subscription_price: '99.99'
                              display_wholesale_price: Kz0.00 (AOA)
                              display_wholesale_subscription_price: Kz0.00 (AOA)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 6
                                iso: AO
                                iso_name: ANGOLA
                                iso3: AGO
                                name: Angola
                                tax_rate: 0
                            - id: 3147121
                              price: '99.99'
                              shipping: '0.0'
                              tax: '0.0'
                              currency_code: XCD
                              currency_symbol: $
                              display_price: $99.99 (XCD)
                              country_iso: AI
                              subscription_price: '99.99'
                              display_wholesale_price: $0.00 (XCD)
                              display_wholesale_subscription_price: $0.00 (XCD)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 7
                                iso: AI
                                iso_name: ANGUILLA
                                iso3: AIA
                                name: Anguilla
                                tax_rate: 0
                            - id: 3147122
                              price: '99.99'
                              shipping: '0.0'
                              tax: '0.0'
                              currency_code: XCD
                              currency_symbol: $
                              display_price: $99.99 (XCD)
                              country_iso: AG
                              subscription_price: '99.99'
                              display_wholesale_price: $0.00 (XCD)
                              display_wholesale_subscription_price: $0.00 (XCD)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 8
                                iso: AG
                                iso_name: ANTIGUA AND BARBUDA
                                iso3: ATG
                                name: Antigua and Barbuda
                                tax_rate: 0
                            - id: 3147123
                              price: '99.99'
                              shipping: '0.0'
                              tax: '0.0'
                              currency_code: ARS
                              currency_symbol: $
                              display_price: $99.99 (ARS)
                              country_iso: AR
                              subscription_price: '99.99'
                              display_wholesale_price: $0.00 (ARS)
                              display_wholesale_subscription_price: $0.00 (ARS)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 9
                                iso: AR
                                iso_name: ARGENTINA
                                iso3: ARG
                                name: Argentina
                                tax_rate: 0
                            - id: 3147124
                              price: '99.99'
                              shipping: '0.0'
                              tax: '0.0'
                              currency_code: AUD
                              currency_symbol: $
                              display_price: $99.99 (AUD)
                              country_iso: AU
                              subscription_price: '99.99'
                              display_wholesale_price: $0.00 (AUD)
                              display_wholesale_subscription_price: $0.00 (AUD)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 12
                                iso: AU
                                iso_name: AUSTRALIA
                                iso3: AUS
                                name: Australia
                                tax_rate: 0
                            - id: 3147125
                              price: '99.99'
                              shipping: '0.0'
                              tax: '0.0'
                              currency_code: EUR
                              currency_symbol: €
                              display_price: €99.99 (EUR)
                              country_iso: AT
                              subscription_price: '99.99'
                              display_wholesale_price: €0.00 (EUR)
                              display_wholesale_subscription_price: €0.00 (EUR)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 13
                                iso: AT
                                iso_name: AUSTRIA
                                iso3: AUT
                                name: Austria
                                tax_rate: 0
                            - id: 3147126
                              price: '99.99'
                              shipping: '0.0'
                              tax: '0.0'
                              currency_code: AZN
                              currency_symbol: ₼
                              display_price: ₼99.99 (AZN)
                              country_iso: AZ
                              subscription_price: '99.99'
                              display_wholesale_price: ₼0.00 (AZN)
                              display_wholesale_subscription_price: ₼0.00 (AZN)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 14
                                iso: AZ
                                iso_name: AZERBAIJAN
                                iso3: AZE
                                name: Azerbaijan
                                tax_rate: 0
                            - id: 3147127
                              price: '99.99'
                              shipping: '0.0'
                              tax: '0.0'
                              currency_code: BSD
                              currency_symbol: $
                              display_price: $99.99 (BSD)
                              country_iso: BS
                              subscription_price: '99.99'
                              display_wholesale_price: $0.00 (BSD)
                              display_wholesale_subscription_price: $0.00 (BSD)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 15
                                iso: BS
                                iso_name: BAHAMAS
                                iso3: BHS
                                name: Bahamas
                                tax_rate: 0
                            - id: 3147128
                              price: '99.99'
                              shipping: '0.0'
                              tax: '0.0'
                              currency_code: BHD
                              currency_symbol: د.ب
                              display_price: د.ب99.990 (BHD)
                              country_iso: BH
                              subscription_price: '99.99'
                              display_wholesale_price: د.ب0.000 (BHD)
                              display_wholesale_subscription_price: د.ب0.000 (BHD)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 16
                                iso: BH
                                iso_name: BAHRAIN
                                iso3: BHR
                                name: Bahrain
                                tax_rate: 0
                            - id: 3147129
                              price: '99.99'
                              shipping: '0.0'
                              tax: '0.0'
                              currency_code: BTN
                              currency_symbol: Nu.
                              display_price: Nu.99.99 (BTN)
                              country_iso: BT
                              subscription_price: '99.99'
                              display_wholesale_price: Nu.0.00 (BTN)
                              display_wholesale_subscription_price: Nu.0.00 (BTN)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 24
                                iso: BT
                                iso_name: BHUTAN
                                iso3: BTN
                                name: Bhutan
                                tax_rate: 0
                            - id: 3147130
                              price: '99.99'
                              shipping: '0.0'
                              tax: '0.0'
                              currency_code: CAD
                              currency_symbol: $
                              display_price: $99.99 (CAD)
                              country_iso: CA
                              subscription_price: '99.99'
                              display_wholesale_price: $0.00 (CAD)
                              display_wholesale_subscription_price: $0.00 (CAD)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 35
                                iso: CA
                                iso_name: CANADA
                                iso3: CAN
                                name: Canada
                                tax_rate: 0
                            - id: 3147131
                              price: '99.99'
                              shipping: '0.0'
                              tax: '0.0'
                              currency_code: XAF
                              currency_symbol: CFA
                              display_price: CFA100 (XAF)
                              country_iso: TD
                              subscription_price: '99.99'
                              display_wholesale_price: CFA0 (XAF)
                              display_wholesale_subscription_price: CFA0 (XAF)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 39
                                iso: TD
                                iso_name: CHAD
                                iso3: TCD
                                name: Chad
                                tax_rate: 0
                            - id: 3147132
                              price: '99.99'
                              shipping: '0.0'
                              tax: '0.0'
                              currency_code: EUR
                              currency_symbol: €
                              display_price: €99.99 (EUR)
                              country_iso: DE
                              subscription_price: '99.99'
                              display_wholesale_price: €0.00 (EUR)
                              display_wholesale_subscription_price: €0.00 (EUR)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 74
                                iso: DE
                                iso_name: GERMANY
                                iso3: DEU
                                name: Germany
                                tax_rate: 0
                            - id: 3147133
                              price: '99.99'
                              shipping: '0.0'
                              tax: '0.0'
                              currency_code: DKK
                              currency_symbol: kr.
                              display_price: kr.99.99 (DKK)
                              country_iso: GL
                              subscription_price: '99.99'
                              display_wholesale_price: kr.0.00 (DKK)
                              display_wholesale_subscription_price: kr.0.00 (DKK)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 78
                                iso: GL
                                iso_name: GREENLAND
                                iso3: GRL
                                name: Greenland
                                tax_rate: 0
                            - id: 3147134
                              price: '99.99'
                              shipping: '0.0'
                              tax: '0.0'
                              currency_code: INR
                              currency_symbol: ₹
                              display_price: ₹99.99 (INR)
                              country_iso: IN
                              subscription_price: '99.99'
                              display_wholesale_price: ₹0.00 (INR)
                              display_wholesale_subscription_price: ₹0.00 (INR)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 92
                                iso: IN
                                iso_name: INDIA
                                iso3: IND
                                name: India
                                tax_rate: 0
                            - id: 3147135
                              price: '99.99'
                              shipping: '0.0'
                              tax: '0.0'
                              currency_code: USD
                              currency_symbol: $
                              display_price: $99.99 (USD)
                              country_iso: FM
                              subscription_price: '99.99'
                              display_wholesale_price: $0.00 (USD)
                              display_wholesale_subscription_price: $0.00 (USD)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 131
                                iso: FM
                                iso_name: MICRONESIA, FEDERATED STATES OF
                                iso3: FSM
                                name: Micronesia, Federated States of
                                tax_rate: 0
                            - id: 3147136
                              price: '99.99'
                              shipping: '0.0'
                              tax: '0.0'
                              currency_code: NPR
                              currency_symbol: Rs.
                              display_price: Rs.99.99 (NPR)
                              country_iso: NP
                              subscription_price: '99.99'
                              display_wholesale_price: Rs.0.00 (NPR)
                              display_wholesale_subscription_price: Rs.0.00 (NPR)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 141
                                iso: NP
                                iso_name: NEPAL
                                iso3: NPL
                                name: Nepal
                                tax_rate: 0
                            - id: 3147137
                              price: '99.99'
                              shipping: '0.0'
                              tax: '0.0'
                              currency_code: EUR
                              currency_symbol: €
                              display_price: €99.99 (EUR)
                              country_iso: NL
                              subscription_price: '99.99'
                              display_wholesale_price: €0.00 (EUR)
                              display_wholesale_subscription_price: €0.00 (EUR)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 142
                                iso: NL
                                iso_name: NETHERLANDS
                                iso3: NLD
                                name: Netherlands
                                tax_rate: 0
                            - id: 3147138
                              price: '99.99'
                              shipping: '0.0'
                              tax: '0.0'
                              currency_code: XPF
                              currency_symbol: Fr
                              display_price: Fr100 (XPF)
                              country_iso: NC
                              subscription_price: '99.99'
                              display_wholesale_price: Fr0 (XPF)
                              display_wholesale_subscription_price: Fr0 (XPF)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 144
                                iso: NC
                                iso_name: NEW CALEDONIA
                                iso3: NCL
                                name: New Caledonia
                                tax_rate: 0
                            - id: 3147139
                              price: '99.99'
                              shipping: '0.0'
                              tax: '0.0'
                              currency_code: NGN
                              currency_symbol: ₦
                              display_price: ₦99.99 (NGN)
                              country_iso: NG
                              subscription_price: '99.99'
                              display_wholesale_price: ₦0.00 (NGN)
                              display_wholesale_subscription_price: ₦0.00 (NGN)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 148
                                iso: NG
                                iso_name: NIGERIA
                                iso3: NGA
                                name: Nigeria
                                tax_rate: 0
                            - id: 3147140
                              price: '99.99'
                              shipping: '0.0'
                              tax: '0.0'
                              currency_code: XOF
                              currency_symbol: Fr
                              display_price: Fr100 (XOF)
                              country_iso: SN
                              subscription_price: '99.99'
                              display_wholesale_price: Fr0 (XOF)
                              display_wholesale_subscription_price: Fr0 (XOF)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 179
                                iso: SN
                                iso_name: SENEGAL
                                iso3: SEN
                                name: Senegal
                                tax_rate: 0
                            - id: 3147141
                              price: '99.99'
                              shipping: '0.0'
                              tax: '0.0'
                              currency_code: NOK
                              currency_symbol: kr
                              display_price: kr99.99 (NOK)
                              country_iso: SJ
                              subscription_price: '99.99'
                              display_wholesale_price: kr0.00 (NOK)
                              display_wholesale_subscription_price: kr0.00 (NOK)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 192
                                iso: SJ
                                iso_name: SVALBARD AND JAN MAYEN
                                iso3: SJM
                                name: Svalbard and Jan Mayen
                                tax_rate: 0
                            - id: 3147142
                              price: '99.99'
                              shipping: '0.0'
                              tax: '0.0'
                              currency_code: TND
                              currency_symbol: د.ت
                              display_price: د.ت99.990 (TND)
                              country_iso: TN
                              subscription_price: '99.99'
                              display_wholesale_price: د.ت0.000 (TND)
                              display_wholesale_subscription_price: د.ت0.000 (TND)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 205
                                iso: TN
                                iso_name: TUNISIA
                                iso3: TUN
                                name: Tunisia
                                tax_rate: 0
                            - id: 3147143
                              price: '99.99'
                              shipping: '0.0'
                              tax: '0.0'
                              currency_code: USD
                              currency_symbol: $
                              display_price: $99.99 (USD)
                              country_iso: US
                              subscription_price: '99.99'
                              display_wholesale_price: $0.00 (USD)
                              display_wholesale_subscription_price: $0.00 (USD)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 214
                                iso: US
                                iso_name: UNITED STATES
                                iso3: USA
                                name: United States
                                tax_rate: 0
                            - id: 3147144
                              price: '99.99'
                              shipping: '0.0'
                              tax: '0.0'
                              currency_code: YER
                              currency_symbol: ﷼
                              display_price: ﷼99.99 (YER)
                              country_iso: YE
                              subscription_price: '99.99'
                              display_wholesale_price: ﷼0.00 (YER)
                              display_wholesale_subscription_price: ﷼0.00 (YER)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 224
                                iso: YE
                                iso_name: YEMEN
                                iso3: YEM
                                name: Yemen
                                tax_rate: 0
                      options: []
                      prompts: []
                      enroll_products: []
                      enrolls: []
                tracking_informations: []
      deprecated: false
      security:
        - bearer: []
  /api/company/orders/{orderId}.json:
    get:
      tags:
        - Orders
      summary: Get Company Order Details
      description: Retrieves detailed information about a specific company order.
      operationId: getCompanyOrder
      parameters:
        - name: orderId
          in: path
          required: true
          schema:
            type: string
          description: The unique identifier of the order to retrieve
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/show6'
                  - example:
                      id: 8768
                      order_number: F32799720937756
                      amount: '16900.0'
                      shipping: '650.0'
                      tax: '260.0'
                      subtotal: '12740.0'
                      first_name: Bishal
                      last_name: Nepal
                      email: bnepal05579887@gmail.com
                      phone: null
                      tracking: null
                      cv: 5
                      qv: 0
                      status: awaiting_shipment
                      order_type: purchased
                      rating: 0
                      review: ''
                      referrer: Bishal Nepal
                      friendly_status: paid
                      type: null
                      created_at: '2023-03-15T11:10:53.263Z'
                      currency_code: NPR
                      currency_symbol: Rs.
                      display_amount: Rs.16,900.00 (NPR)
                      display_subtotal: Rs.12,740.00 (NPR)
                      display_tax: Rs.260.00 (NPR)
                      display_shipping: Rs.650.00 (NPR)
                      display_refunds: (0 CV, 0 QV) -Rs.0.00 (NPR)
                      display_discount: Rs.0.00 (NPR)
                      order_thumbnail: >-
                        https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                      sale_date: null
                      recognized_ship_date: null
                      refundable: true
                      max_refundable_amount: '16900.0'
                      max_refundable_tax: '260.0'
                      max_refundable_shipping: '650.0'
                      max_refundable_product_price: '12740.0'
                      display_enrollment_fee: Rs.3,250.00 (NPR)
                      ship_to:
                        id: 980199006
                        name: Bishal Nepal
                        address1: jhapa
                        address2: null
                        address3: null
                        city: damak
                        state: Province 1
                        postal_code: mechi
                        country_code: null
                        country:
                          id: 141
                          iso_name: NEPAL
                          iso: NP
                          iso3: NPL
                          name: Nepal
                          numcode: 524
                          active: true
                          currency_code: NPR
                          currency_symbol: Rs.
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                          default: false
                          created_at: '2022-05-09T05:12:21.806Z'
                          updated_at: '2022-05-09T05:12:21.806Z'
                          geo_entity_id: 28
                        default: false
                      contact:
                        id: 6557
                        token: h59g4H8EExXpmNYmhq4woiMh
                        first_name: Bishal
                        last_name: Nepal
                        avatar_url: null
                        status: null
                        email: bnepal05579887@gmail.com
                        email2: null
                        phone: null
                        phone2: null
                        phone_id: null
                        address: null
                        address2: null
                        city: null
                        state: null
                        postal_code: null
                        language_id: null
                        country_id: null
                        lead_type: null
                        ip: null
                        requested_at: null
                        best_time: null
                        time_zone: null
                        reason: null
                        income: null
                        hours: null
                        invest: null
                        interest: null
                        full_name: Bishal Nepal
                      items:
                        - id: 8803
                          quantity: 1
                          price: 12740
                          ordered_variant: ''
                          sku: sketch12
                          product:
                            id: 2240
                            active: true
                            title: sketch
                            description:
                              id: 4836
                              name: description
                              body: <div>best selling sketch</div>
                              record_type: Product
                              record_id: 2240
                              created_at: '2023-02-02T03:48:16.810Z'
                              updated_at: '2023-02-02T03:48:16.810Z'
                            stripped: best selling sketch
                            price: '12740.0'
                            display_price: Rs.12,740.00 (NPR)
                            subscription_price: '12740.0'
                            display_subscription_price: Rs.12,740.00 (NPR)
                            wholesale_price: '0.0'
                            display_wholesale_price: Rs.0.00 (NPR)
                            wholesale_subscription_price: '0.0'
                            display_wholesale_subscription_price: Rs.0.00 (NPR)
                            shipping: '5.0'
                            image:
                              mini: >-
                                https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                              detail: >-
                                https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                              full: >-
                                https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                            image_url: >-
                              https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                            sku: sketch
                            country_code: ar
                            country_id: null
                            views: 0
                            leads: 0
                            share_link: null
                            commission: '10.0'
                            public: true
                            shopify_id: null
                            shopify_handle: null
                            in_stock: true
                            vendor: null
                            price_range:
                              - Rs.0.00
                              - Rs.12,740.00
                            price_range_formatted: Rs.0.00 - Rs.12,740.00
                            unlimited_inventory: false
                            default_variant:
                              id: 19630
                              product_id: 2240
                              shopify_id: null
                              title: ''
                              sku: sketch12
                              position: 12698
                              inventory_policy: none
                              taxable: true
                              inventory_quantity: -84
                              created_at: '2023-02-02T03:48:18.009Z'
                              updated_at: '2023-09-29T04:59:12.098Z'
                              external_id: null
                              variant_country_id: null
                              image_url: null
                              image_path: null
                              is_master: true
                              discarded_at: null
                              price: null
                              weight: ''
                              size: ''
                              physical: true
                              unit_of_weight: lb
                              height: 0
                              width: 0
                              length: 0
                              unit_of_size: ft
                              hs_code: ''
                              country_of_origin: ''
                              customs_information_shipping: false
                              active: true
                              bar_code: ''
                              track_quantity: false
                              keep_selling: true
                              option_attrs: []
                              allow_subscription: true
                            currency_symbol: Rs.
                            currency_code: NPR
                            average_rating: 0
                            option_values: {}
                            publish_to_retail_store: true
                            publish_to_rep_store: true
                            publish_to_share_tab: true
                            images:
                              - id: 2089
                                image:
                                  mini: >-
                                    https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                                  detail: >-
                                    https://ik.imagekit.io/fluid/s3/tr:n-video_poster/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                                  full: >-
                                    https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                                image_url: >-
                                  https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                                position: null
                                shopify_id: null
                            countries:
                              - id: 27
                                iso_name: BOTSWANA
                                iso: BW
                                iso3: BWA
                                name: Botswana
                                numcode: 72
                                active: true
                                currency_code: BWP
                                currency_symbol: P
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 68
                                iso_name: FRANCE
                                iso: FR
                                iso3: FRA
                                name: France
                                numcode: 250
                                active: true
                                currency_code: EUR
                                currency_symbol: €
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 214
                                iso_name: UNITED STATES
                                iso: US
                                iso3: USA
                                name: United States
                                numcode: 840
                                active: true
                                currency_code: USD
                                currency_symbol: $
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 12
                                iso_name: AUSTRALIA
                                iso: AU
                                iso3: AUS
                                name: Australia
                                numcode: 36
                                active: true
                                currency_code: AUD
                                currency_symbol: $
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 13
                                iso_name: AUSTRIA
                                iso: AT
                                iso3: AUT
                                name: Austria
                                numcode: 40
                                active: true
                                currency_code: EUR
                                currency_symbol: €
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 14
                                iso_name: AZERBAIJAN
                                iso: AZ
                                iso3: AZE
                                name: Azerbaijan
                                numcode: 31
                                active: true
                                currency_code: AZN
                                currency_symbol: ₼
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 15
                                iso_name: BAHAMAS
                                iso: BS
                                iso3: BHS
                                name: Bahamas
                                numcode: 44
                                active: true
                                currency_code: BSD
                                currency_symbol: $
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 16
                                iso_name: BAHRAIN
                                iso: BH
                                iso3: BHR
                                name: Bahrain
                                numcode: 48
                                active: true
                                currency_code: BHD
                                currency_symbol: د.ب
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 17
                                iso_name: BANGLADESH
                                iso: BD
                                iso3: BGD
                                name: Bangladesh
                                numcode: 50
                                active: true
                                currency_code: BDT
                                currency_symbol: ৳
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 41
                                iso_name: CHINA
                                iso: CN
                                iso3: CHN
                                name: China
                                numcode: 156
                                active: true
                                currency_code: CNY
                                currency_symbol: ¥
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 162
                                iso_name: POLAND
                                iso: PL
                                iso3: POL
                                name: Poland
                                numcode: 616
                                active: true
                                currency_code: PLN
                                currency_symbol: zł
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 163
                                iso_name: PORTUGAL
                                iso: PT
                                iso3: PRT
                                name: Portugal
                                numcode: 620
                                active: true
                                currency_code: EUR
                                currency_symbol: €
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 168
                                iso_name: RUSSIAN FEDERATION
                                iso: RU
                                iso3: RUS
                                name: Russia
                                numcode: 643
                                active: true
                                currency_code: RUB
                                currency_symbol: ₽
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 197
                                iso_name: TAIWAN, PROVINCE OF CHINA
                                iso: TW
                                iso3: TWN
                                name: Taiwan
                                numcode: 158
                                active: true
                                currency_code: TWD
                                currency_symbol: $
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 2
                                iso_name: ALBANIA
                                iso: AL
                                iso3: ALB
                                name: Albania
                                numcode: 8
                                active: true
                                currency_code: ALL
                                currency_symbol: L
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 3
                                iso_name: ALGERIA
                                iso: DZ
                                iso3: DZA
                                name: Algeria
                                numcode: 12
                                active: true
                                currency_code: DZD
                                currency_symbol: د.ج
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 74
                                iso_name: GERMANY
                                iso: DE
                                iso3: DEU
                                name: Germany
                                numcode: 276
                                active: true
                                currency_code: EUR
                                currency_symbol: €
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 141
                                iso_name: NEPAL
                                iso: NP
                                iso3: NPL
                                name: Nepal
                                numcode: 524
                                active: true
                                currency_code: NPR
                                currency_symbol: Rs.
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 188
                                iso_name: SPAIN
                                iso: ES
                                iso3: ESP
                                name: Spain
                                numcode: 724
                                active: true
                                currency_code: EUR
                                currency_symbol: €
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 1
                                iso_name: AFGHANISTAN
                                iso: AF
                                iso3: AFG
                                name: Afghanistan
                                numcode: 4
                                active: true
                                currency_code: AFN
                                currency_symbol: ؋
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 4
                                iso_name: AMERICAN SAMOA
                                iso: AS
                                iso3: ASM
                                name: American Samoa
                                numcode: 16
                                active: true
                                currency_code: USD
                                currency_symbol: $
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 9
                                iso_name: ARGENTINA
                                iso: AR
                                iso3: ARG
                                name: Argentina
                                numcode: 32
                                active: true
                                currency_code: ARS
                                currency_symbol: $
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 23
                                iso_name: BERMUDA
                                iso: BM
                                iso3: BMU
                                name: Bermuda
                                numcode: 60
                                active: true
                                currency_code: BMD
                                currency_symbol: $
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                            variants:
                              - id: 19630
                                title: ''
                                image_url: null
                                buyable: true
                                option_value_ids: []
                                allow_subscription: true
                                variant_countries:
                                  - id: 130789
                                    price: '9800.0'
                                    shipping: '500.0'
                                    tax: '200.0'
                                    currency_code: ARS
                                    currency_symbol: $
                                    display_price: $9,800.00 (ARS)
                                    country_iso: AR
                                    subscription_price: '9800.0'
                                    display_wholesale_price: $0.00 (ARS)
                                    display_wholesale_subscription_price: $0.00 (ARS)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 9
                                      iso: AR
                                      iso_name: ARGENTINA
                                      iso3: ARG
                                      name: Argentina
                                      tax_rate: 0
                                  - id: 130790
                                    price: '98.0'
                                    shipping: '5.0'
                                    tax: '2.0'
                                    currency_code: AUD
                                    currency_symbol: $
                                    display_price: $98.00 (AUD)
                                    country_iso: AU
                                    subscription_price: '98.0'
                                    display_wholesale_price: $0.00 (AUD)
                                    display_wholesale_subscription_price: $0.00 (AUD)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 12
                                      iso: AU
                                      iso_name: AUSTRALIA
                                      iso3: AUS
                                      name: Australia
                                      tax_rate: 0
                                  - id: 130791
                                    price: '4900.0'
                                    shipping: '250.0'
                                    tax: '100.0'
                                    currency_code: EUR
                                    currency_symbol: €
                                    display_price: €4,900.00 (EUR)
                                    country_iso: AT
                                    subscription_price: '4900.0'
                                    display_wholesale_price: €0.00 (EUR)
                                    display_wholesale_subscription_price: €0.00 (EUR)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 13
                                      iso: AT
                                      iso_name: AUSTRIA
                                      iso3: AUT
                                      name: Austria
                                      tax_rate: 0
                                  - id: 130792
                                    price: '9604.0'
                                    shipping: '490.0'
                                    tax: '196.0'
                                    currency_code: AZN
                                    currency_symbol: ₼
                                    display_price: ₼9,604.00 (AZN)
                                    country_iso: AZ
                                    subscription_price: '9604.0'
                                    display_wholesale_price: ₼0.00 (AZN)
                                    display_wholesale_subscription_price: ₼0.00 (AZN)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 14
                                      iso: AZ
                                      iso_name: AZERBAIJAN
                                      iso3: AZE
                                      name: Azerbaijan
                                      tax_rate: 0
                                  - id: 130793
                                    price: '98.0'
                                    shipping: '5.0'
                                    tax: '2.0'
                                    currency_code: BSD
                                    currency_symbol: $
                                    display_price: $98.00 (BSD)
                                    country_iso: BS
                                    subscription_price: '98.0'
                                    display_wholesale_price: $0.00 (BSD)
                                    display_wholesale_subscription_price: $0.00 (BSD)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 15
                                      iso: BS
                                      iso_name: BAHAMAS
                                      iso3: BHS
                                      name: Bahamas
                                      tax_rate: 0
                                  - id: 130794
                                    price: '98.0'
                                    shipping: '5.0'
                                    tax: '2.0'
                                    currency_code: BHD
                                    currency_symbol: د.ب
                                    display_price: د.ب98.000 (BHD)
                                    country_iso: BH
                                    subscription_price: '98.0'
                                    display_wholesale_price: د.ب0.000 (BHD)
                                    display_wholesale_subscription_price: د.ب0.000 (BHD)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 16
                                      iso: BH
                                      iso_name: BAHRAIN
                                      iso3: BHR
                                      name: Bahrain
                                      tax_rate: 0
                                  - id: 130795
                                    price: '98.0'
                                    shipping: '5.0'
                                    tax: '2.0'
                                    currency_code: BDT
                                    currency_symbol: ৳
                                    display_price: ৳98.00 (BDT)
                                    country_iso: BD
                                    subscription_price: '98.0'
                                    display_wholesale_price: ৳0.00 (BDT)
                                    display_wholesale_subscription_price: ৳0.00 (BDT)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 17
                                      iso: BD
                                      iso_name: BANGLADESH
                                      iso3: BGD
                                      name: Bangladesh
                                      tax_rate: 0
                                  - id: 130798
                                    price: '98.0'
                                    shipping: '5.0'
                                    tax: '2.0'
                                    currency_code: BMD
                                    currency_symbol: $
                                    display_price: $98.00 (BMD)
                                    country_iso: BM
                                    subscription_price: '98.0'
                                    display_wholesale_price: $0.00 (BMD)
                                    display_wholesale_subscription_price: $0.00 (BMD)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 23
                                      iso: BM
                                      iso_name: BERMUDA
                                      iso3: BMU
                                      name: Bermuda
                                      tax_rate: 0
                                  - id: 130801
                                    price: '98.0'
                                    shipping: '5.0'
                                    tax: '2.0'
                                    currency_code: BWP
                                    currency_symbol: P
                                    display_price: P98.00 (BWP)
                                    country_iso: BW
                                    subscription_price: '98.0'
                                    display_wholesale_price: P0.00 (BWP)
                                    display_wholesale_subscription_price: P0.00 (BWP)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 27
                                      iso: BW
                                      iso_name: BOTSWANA
                                      iso3: BWA
                                      name: Botswana
                                      tax_rate: 0
                                  - id: 130881
                                    price: '12740.0'
                                    shipping: '650.0'
                                    tax: '260.0'
                                    currency_code: NPR
                                    currency_symbol: Rs.
                                    display_price: Rs.12,740.00 (NPR)
                                    country_iso: NP
                                    subscription_price: '12740.0'
                                    display_wholesale_price: Rs.0.00 (NPR)
                                    display_wholesale_subscription_price: Rs.0.00 (NPR)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 141
                                      iso: NP
                                      iso_name: NEPAL
                                      iso3: NPL
                                      name: Nepal
                                      tax_rate: 0
                                  - id: 130897
                                    price: '98.0'
                                    shipping: '5.0'
                                    tax: '2.0'
                                    currency_code: EUR
                                    currency_symbol: €
                                    display_price: €98.00 (EUR)
                                    country_iso: PT
                                    subscription_price: '98.0'
                                    display_wholesale_price: €0.00 (EUR)
                                    display_wholesale_subscription_price: €0.00 (EUR)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 163
                                      iso: PT
                                      iso_name: PORTUGAL
                                      iso3: PRT
                                      name: Portugal
                                      tax_rate: 0
                                  - id: 130921
                                    price: '98.0'
                                    shipping: '5.0'
                                    tax: '2.0'
                                    currency_code: TWD
                                    currency_symbol: $
                                    display_price: $98.00 (TWD)
                                    country_iso: TW
                                    subscription_price: '98.0'
                                    display_wholesale_price: $0.00 (TWD)
                                    display_wholesale_subscription_price: $0.00 (TWD)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 197
                                      iso: TW
                                      iso_name: TAIWAN, PROVINCE OF CHINA
                                      iso3: TWN
                                      name: Taiwan
                                      tax_rate: 0
                                  - id: 130933
                                    price: '98.0'
                                    shipping: '5.0'
                                    tax: '2.0'
                                    currency_code: USD
                                    currency_symbol: $
                                    display_price: $98.00 (USD)
                                    country_iso: US
                                    subscription_price: '98.0'
                                    display_wholesale_price: $0.00 (USD)
                                    display_wholesale_subscription_price: $0.00 (USD)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 214
                                      iso: US
                                      iso_name: UNITED STATES
                                      iso3: USA
                                      name: United States
                                      tax_rate: 0
                            options: []
                            prompts: []
                            enroll_products:
                              - id: 19
                                product_id: 2240
                                enroll_id: 2
                                active: true
                                type: membership_product
                                created_at: '2023-02-15T06:40:53.303Z'
                                updated_at: '2023-02-15T06:40:53.303Z'
                            enrolls:
                              - id: 2
                                integration_id: null
                                fields:
                                  dob: Birthdate
                                  full_name: Name
                                  government_id: Government ID
                                member_fee: 25
                                member_fee_enabled: true
                                company_id: 980191019
                                created_at: '2023-02-01T07:49:12.347Z'
                                updated_at: '2023-02-01T07:54:36.961Z'
                                terms_and_conditions_url: https://www.google.com/
                      tracking_informations: []
              example:
                id: 8768
                order_number: F32799720937756
                amount: '16900.0'
                shipping: '650.0'
                tax: '260.0'
                subtotal: '12740.0'
                first_name: Bishal
                last_name: Nepal
                email: bnepal05579887@gmail.com
                phone: null
                tracking: null
                cv: 5
                qv: 0
                status: awaiting_shipment
                order_type: purchased
                rating: 0
                review: ''
                referrer: Bishal Nepal
                friendly_status: paid
                type: null
                created_at: '2023-03-15T11:10:53.263Z'
                currency_code: NPR
                currency_symbol: Rs.
                display_amount: Rs.16,900.00 (NPR)
                display_subtotal: Rs.12,740.00 (NPR)
                display_tax: Rs.260.00 (NPR)
                display_shipping: Rs.650.00 (NPR)
                display_refunds: (0 CV, 0 QV) -Rs.0.00 (NPR)
                display_discount: Rs.0.00 (NPR)
                order_thumbnail: >-
                  https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                sale_date: null
                recognized_ship_date: null
                refundable: true
                max_refundable_amount: '16900.0'
                max_refundable_tax: '260.0'
                max_refundable_shipping: '650.0'
                max_refundable_product_price: '12740.0'
                display_enrollment_fee: Rs.3,250.00 (NPR)
                ship_to:
                  id: 980199006
                  name: Bishal Nepal
                  address1: jhapa
                  address2: null
                  address3: null
                  city: damak
                  state: Province 1
                  postal_code: mechi
                  country_code: null
                  country:
                    id: 141
                    iso_name: NEPAL
                    iso: NP
                    iso3: NPL
                    name: Nepal
                    numcode: 524
                    active: true
                    currency_code: NPR
                    currency_symbol: Rs.
                    separator: .
                    delimiter: ','
                    address3: false
                    state: true
                    passport: false
                    itn: false
                    tax_rate: 0
                    default: false
                    created_at: '2022-05-09T05:12:21.806Z'
                    updated_at: '2022-05-09T05:12:21.806Z'
                    geo_entity_id: 28
                  default: false
                contact:
                  id: 6557
                  token: h59g4H8EExXpmNYmhq4woiMh
                  first_name: Bishal
                  last_name: Nepal
                  avatar_url: null
                  status: null
                  email: bnepal05579887@gmail.com
                  email2: null
                  phone: null
                  phone2: null
                  phone_id: null
                  address: null
                  address2: null
                  city: null
                  state: null
                  postal_code: null
                  language_id: null
                  country_id: null
                  lead_type: null
                  ip: null
                  requested_at: null
                  best_time: null
                  time_zone: null
                  reason: null
                  income: null
                  hours: null
                  invest: null
                  interest: null
                  full_name: Bishal Nepal
                items:
                  - id: 8803
                    quantity: 1
                    price: 12740
                    ordered_variant: ''
                    sku: sketch12
                    product:
                      id: 2240
                      active: true
                      title: sketch
                      description:
                        id: 4836
                        name: description
                        body: <div>best selling sketch</div>
                        record_type: Product
                        record_id: 2240
                        created_at: '2023-02-02T03:48:16.810Z'
                        updated_at: '2023-02-02T03:48:16.810Z'
                      stripped: best selling sketch
                      price: '12740.0'
                      display_price: Rs.12,740.00 (NPR)
                      subscription_price: '12740.0'
                      display_subscription_price: Rs.12,740.00 (NPR)
                      wholesale_price: '0.0'
                      display_wholesale_price: Rs.0.00 (NPR)
                      wholesale_subscription_price: '0.0'
                      display_wholesale_subscription_price: Rs.0.00 (NPR)
                      shipping: '5.0'
                      image:
                        mini: >-
                          https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                        detail: >-
                          https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                        full: >-
                          https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                      image_url: >-
                        https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                      sku: sketch
                      country_code: ar
                      country_id: null
                      views: 0
                      leads: 0
                      share_link: null
                      commission: '10.0'
                      public: true
                      shopify_id: null
                      shopify_handle: null
                      in_stock: true
                      vendor: null
                      price_range:
                        - Rs.0.00
                        - Rs.12,740.00
                      price_range_formatted: Rs.0.00 - Rs.12,740.00
                      unlimited_inventory: false
                      default_variant:
                        id: 19630
                        product_id: 2240
                        shopify_id: null
                        title: ''
                        sku: sketch12
                        position: 12698
                        inventory_policy: none
                        taxable: true
                        inventory_quantity: -84
                        created_at: '2023-02-02T03:48:18.009Z'
                        updated_at: '2023-09-29T04:59:12.098Z'
                        external_id: null
                        variant_country_id: null
                        image_url: null
                        image_path: null
                        is_master: true
                        discarded_at: null
                        price: null
                        weight: ''
                        size: ''
                        physical: true
                        unit_of_weight: lb
                        height: 0
                        width: 0
                        length: 0
                        unit_of_size: ft
                        hs_code: ''
                        country_of_origin: ''
                        customs_information_shipping: false
                        active: true
                        bar_code: ''
                        track_quantity: false
                        keep_selling: true
                        option_attrs: []
                        allow_subscription: true
                      currency_symbol: Rs.
                      currency_code: NPR
                      average_rating: 0
                      option_values: {}
                      publish_to_retail_store: true
                      publish_to_rep_store: true
                      publish_to_share_tab: true
                      images:
                        - id: 2089
                          image:
                            mini: >-
                              https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                            detail: >-
                              https://ik.imagekit.io/fluid/s3/tr:n-video_poster/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                            full: >-
                              https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                          image_url: >-
                            https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                          position: null
                          shopify_id: null
                      countries:
                        - id: 27
                          iso_name: BOTSWANA
                          iso: BW
                          iso3: BWA
                          name: Botswana
                          numcode: 72
                          active: true
                          currency_code: BWP
                          currency_symbol: P
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 68
                          iso_name: FRANCE
                          iso: FR
                          iso3: FRA
                          name: France
                          numcode: 250
                          active: true
                          currency_code: EUR
                          currency_symbol: €
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 214
                          iso_name: UNITED STATES
                          iso: US
                          iso3: USA
                          name: United States
                          numcode: 840
                          active: true
                          currency_code: USD
                          currency_symbol: $
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 12
                          iso_name: AUSTRALIA
                          iso: AU
                          iso3: AUS
                          name: Australia
                          numcode: 36
                          active: true
                          currency_code: AUD
                          currency_symbol: $
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 13
                          iso_name: AUSTRIA
                          iso: AT
                          iso3: AUT
                          name: Austria
                          numcode: 40
                          active: true
                          currency_code: EUR
                          currency_symbol: €
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 14
                          iso_name: AZERBAIJAN
                          iso: AZ
                          iso3: AZE
                          name: Azerbaijan
                          numcode: 31
                          active: true
                          currency_code: AZN
                          currency_symbol: ₼
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 15
                          iso_name: BAHAMAS
                          iso: BS
                          iso3: BHS
                          name: Bahamas
                          numcode: 44
                          active: true
                          currency_code: BSD
                          currency_symbol: $
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 16
                          iso_name: BAHRAIN
                          iso: BH
                          iso3: BHR
                          name: Bahrain
                          numcode: 48
                          active: true
                          currency_code: BHD
                          currency_symbol: د.ب
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 17
                          iso_name: BANGLADESH
                          iso: BD
                          iso3: BGD
                          name: Bangladesh
                          numcode: 50
                          active: true
                          currency_code: BDT
                          currency_symbol: ৳
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 41
                          iso_name: CHINA
                          iso: CN
                          iso3: CHN
                          name: China
                          numcode: 156
                          active: true
                          currency_code: CNY
                          currency_symbol: ¥
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 162
                          iso_name: POLAND
                          iso: PL
                          iso3: POL
                          name: Poland
                          numcode: 616
                          active: true
                          currency_code: PLN
                          currency_symbol: zł
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 163
                          iso_name: PORTUGAL
                          iso: PT
                          iso3: PRT
                          name: Portugal
                          numcode: 620
                          active: true
                          currency_code: EUR
                          currency_symbol: €
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 168
                          iso_name: RUSSIAN FEDERATION
                          iso: RU
                          iso3: RUS
                          name: Russia
                          numcode: 643
                          active: true
                          currency_code: RUB
                          currency_symbol: ₽
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 197
                          iso_name: TAIWAN, PROVINCE OF CHINA
                          iso: TW
                          iso3: TWN
                          name: Taiwan
                          numcode: 158
                          active: true
                          currency_code: TWD
                          currency_symbol: $
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 2
                          iso_name: ALBANIA
                          iso: AL
                          iso3: ALB
                          name: Albania
                          numcode: 8
                          active: true
                          currency_code: ALL
                          currency_symbol: L
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 3
                          iso_name: ALGERIA
                          iso: DZ
                          iso3: DZA
                          name: Algeria
                          numcode: 12
                          active: true
                          currency_code: DZD
                          currency_symbol: د.ج
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 74
                          iso_name: GERMANY
                          iso: DE
                          iso3: DEU
                          name: Germany
                          numcode: 276
                          active: true
                          currency_code: EUR
                          currency_symbol: €
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 141
                          iso_name: NEPAL
                          iso: NP
                          iso3: NPL
                          name: Nepal
                          numcode: 524
                          active: true
                          currency_code: NPR
                          currency_symbol: Rs.
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 188
                          iso_name: SPAIN
                          iso: ES
                          iso3: ESP
                          name: Spain
                          numcode: 724
                          active: true
                          currency_code: EUR
                          currency_symbol: €
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 1
                          iso_name: AFGHANISTAN
                          iso: AF
                          iso3: AFG
                          name: Afghanistan
                          numcode: 4
                          active: true
                          currency_code: AFN
                          currency_symbol: ؋
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 4
                          iso_name: AMERICAN SAMOA
                          iso: AS
                          iso3: ASM
                          name: American Samoa
                          numcode: 16
                          active: true
                          currency_code: USD
                          currency_symbol: $
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 9
                          iso_name: ARGENTINA
                          iso: AR
                          iso3: ARG
                          name: Argentina
                          numcode: 32
                          active: true
                          currency_code: ARS
                          currency_symbol: $
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 23
                          iso_name: BERMUDA
                          iso: BM
                          iso3: BMU
                          name: Bermuda
                          numcode: 60
                          active: true
                          currency_code: BMD
                          currency_symbol: $
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                      variants:
                        - id: 19630
                          title: ''
                          image_url: null
                          buyable: true
                          option_value_ids: []
                          allow_subscription: true
                          variant_countries:
                            - id: 130789
                              price: '9800.0'
                              shipping: '500.0'
                              tax: '200.0'
                              currency_code: ARS
                              currency_symbol: $
                              display_price: $9,800.00 (ARS)
                              country_iso: AR
                              subscription_price: '9800.0'
                              display_wholesale_price: $0.00 (ARS)
                              display_wholesale_subscription_price: $0.00 (ARS)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 9
                                iso: AR
                                iso_name: ARGENTINA
                                iso3: ARG
                                name: Argentina
                                tax_rate: 0
                            - id: 130790
                              price: '98.0'
                              shipping: '5.0'
                              tax: '2.0'
                              currency_code: AUD
                              currency_symbol: $
                              display_price: $98.00 (AUD)
                              country_iso: AU
                              subscription_price: '98.0'
                              display_wholesale_price: $0.00 (AUD)
                              display_wholesale_subscription_price: $0.00 (AUD)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 12
                                iso: AU
                                iso_name: AUSTRALIA
                                iso3: AUS
                                name: Australia
                                tax_rate: 0
                            - id: 130791
                              price: '4900.0'
                              shipping: '250.0'
                              tax: '100.0'
                              currency_code: EUR
                              currency_symbol: €
                              display_price: €4,900.00 (EUR)
                              country_iso: AT
                              subscription_price: '4900.0'
                              display_wholesale_price: €0.00 (EUR)
                              display_wholesale_subscription_price: €0.00 (EUR)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 13
                                iso: AT
                                iso_name: AUSTRIA
                                iso3: AUT
                                name: Austria
                                tax_rate: 0
                            - id: 130792
                              price: '9604.0'
                              shipping: '490.0'
                              tax: '196.0'
                              currency_code: AZN
                              currency_symbol: ₼
                              display_price: ₼9,604.00 (AZN)
                              country_iso: AZ
                              subscription_price: '9604.0'
                              display_wholesale_price: ₼0.00 (AZN)
                              display_wholesale_subscription_price: ₼0.00 (AZN)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 14
                                iso: AZ
                                iso_name: AZERBAIJAN
                                iso3: AZE
                                name: Azerbaijan
                                tax_rate: 0
                            - id: 130793
                              price: '98.0'
                              shipping: '5.0'
                              tax: '2.0'
                              currency_code: BSD
                              currency_symbol: $
                              display_price: $98.00 (BSD)
                              country_iso: BS
                              subscription_price: '98.0'
                              display_wholesale_price: $0.00 (BSD)
                              display_wholesale_subscription_price: $0.00 (BSD)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 15
                                iso: BS
                                iso_name: BAHAMAS
                                iso3: BHS
                                name: Bahamas
                                tax_rate: 0
                            - id: 130794
                              price: '98.0'
                              shipping: '5.0'
                              tax: '2.0'
                              currency_code: BHD
                              currency_symbol: د.ب
                              display_price: د.ب98.000 (BHD)
                              country_iso: BH
                              subscription_price: '98.0'
                              display_wholesale_price: د.ب0.000 (BHD)
                              display_wholesale_subscription_price: د.ب0.000 (BHD)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 16
                                iso: BH
                                iso_name: BAHRAIN
                                iso3: BHR
                                name: Bahrain
                                tax_rate: 0
                            - id: 130795
                              price: '98.0'
                              shipping: '5.0'
                              tax: '2.0'
                              currency_code: BDT
                              currency_symbol: ৳
                              display_price: ৳98.00 (BDT)
                              country_iso: BD
                              subscription_price: '98.0'
                              display_wholesale_price: ৳0.00 (BDT)
                              display_wholesale_subscription_price: ৳0.00 (BDT)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 17
                                iso: BD
                                iso_name: BANGLADESH
                                iso3: BGD
                                name: Bangladesh
                                tax_rate: 0
                            - id: 130798
                              price: '98.0'
                              shipping: '5.0'
                              tax: '2.0'
                              currency_code: BMD
                              currency_symbol: $
                              display_price: $98.00 (BMD)
                              country_iso: BM
                              subscription_price: '98.0'
                              display_wholesale_price: $0.00 (BMD)
                              display_wholesale_subscription_price: $0.00 (BMD)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 23
                                iso: BM
                                iso_name: BERMUDA
                                iso3: BMU
                                name: Bermuda
                                tax_rate: 0
                            - id: 130801
                              price: '98.0'
                              shipping: '5.0'
                              tax: '2.0'
                              currency_code: BWP
                              currency_symbol: P
                              display_price: P98.00 (BWP)
                              country_iso: BW
                              subscription_price: '98.0'
                              display_wholesale_price: P0.00 (BWP)
                              display_wholesale_subscription_price: P0.00 (BWP)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 27
                                iso: BW
                                iso_name: BOTSWANA
                                iso3: BWA
                                name: Botswana
                                tax_rate: 0
                            - id: 130881
                              price: '12740.0'
                              shipping: '650.0'
                              tax: '260.0'
                              currency_code: NPR
                              currency_symbol: Rs.
                              display_price: Rs.12,740.00 (NPR)
                              country_iso: NP
                              subscription_price: '12740.0'
                              display_wholesale_price: Rs.0.00 (NPR)
                              display_wholesale_subscription_price: Rs.0.00 (NPR)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 141
                                iso: NP
                                iso_name: NEPAL
                                iso3: NPL
                                name: Nepal
                                tax_rate: 0
                            - id: 130897
                              price: '98.0'
                              shipping: '5.0'
                              tax: '2.0'
                              currency_code: EUR
                              currency_symbol: €
                              display_price: €98.00 (EUR)
                              country_iso: PT
                              subscription_price: '98.0'
                              display_wholesale_price: €0.00 (EUR)
                              display_wholesale_subscription_price: €0.00 (EUR)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 163
                                iso: PT
                                iso_name: PORTUGAL
                                iso3: PRT
                                name: Portugal
                                tax_rate: 0
                            - id: 130921
                              price: '98.0'
                              shipping: '5.0'
                              tax: '2.0'
                              currency_code: TWD
                              currency_symbol: $
                              display_price: $98.00 (TWD)
                              country_iso: TW
                              subscription_price: '98.0'
                              display_wholesale_price: $0.00 (TWD)
                              display_wholesale_subscription_price: $0.00 (TWD)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 197
                                iso: TW
                                iso_name: TAIWAN, PROVINCE OF CHINA
                                iso3: TWN
                                name: Taiwan
                                tax_rate: 0
                            - id: 130933
                              price: '98.0'
                              shipping: '5.0'
                              tax: '2.0'
                              currency_code: USD
                              currency_symbol: $
                              display_price: $98.00 (USD)
                              country_iso: US
                              subscription_price: '98.0'
                              display_wholesale_price: $0.00 (USD)
                              display_wholesale_subscription_price: $0.00 (USD)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 214
                                iso: US
                                iso_name: UNITED STATES
                                iso3: USA
                                name: United States
                                tax_rate: 0
                      options: []
                      prompts: []
                      enroll_products:
                        - id: 19
                          product_id: 2240
                          enroll_id: 2
                          active: true
                          type: membership_product
                          created_at: '2023-02-15T06:40:53.303Z'
                          updated_at: '2023-02-15T06:40:53.303Z'
                      enrolls:
                        - id: 2
                          integration_id: null
                          fields:
                            dob: Birthdate
                            full_name: Name
                            government_id: Government ID
                          member_fee: 25
                          member_fee_enabled: true
                          company_id: 980191019
                          created_at: '2023-02-01T07:49:12.347Z'
                          updated_at: '2023-02-01T07:54:36.961Z'
                          terms_and_conditions_url: https://www.google.com/
                tracking_informations: []
      deprecated: false
      security:
        - bearer: []
    put:
      tags:
        - Orders
      summary: Update Company Order
      description: >-
        Updates information for a specific company order using the provided
        order ID and order details.
      operationId: updateCompanyOrder
      parameters:
        - name: orderId
          in: path
          required: true
          schema:
            type: string
          description: The unique identifier of the order to update
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/updaterequest6'
                - example:
                    order:
                      shipped_on: '2021-01-02'
                      delivered_on: '2021-04-02'
            example:
              order:
                shipped_on: '2021-01-02'
                delivered_on: '2021-04-02'
        required: true
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/update6'
                  - example:
                      id: 8770
                      order_number: F32835649011346
                      amount: '16900.0'
                      shipping: '650.0'
                      tax: '260.0'
                      subtotal: '12740.0'
                      first_name: Bishal
                      last_name: Nepal
                      email: bnepal05362914@gmail.com
                      phone: null
                      tracking: null
                      cv: 5
                      qv: 0
                      status: awaiting_shipment
                      order_type: purchased
                      rating: 0
                      review: >-
                        Lorem Ipsum is simply dummy text of the printing and
                        typesetting industry. Lorem Ipsum has been the
                        industry's standard dummy text ever since the 1500s,
                        when an unknown printer took a galley of type and
                        scrambled it to make a type specimen book. It has
                        survived not only five centuries, but also the leap into
                        electronic typesetting, remaining essentially unchanged.
                      referrer: Bishal Nepal
                      friendly_status: paid
                      type: null
                      created_at: '2023-03-15T11:17:58.289Z'
                      currency_code: NPR
                      currency_symbol: Rs.
                      display_amount: Rs.16,900.00 (NPR)
                      display_subtotal: Rs.12,740.00 (NPR)
                      display_tax: Rs.260.00 (NPR)
                      display_shipping: Rs.650.00 (NPR)
                      display_refunds: (0 CV, 0 QV) -Rs.0.00 (NPR)
                      display_discount: Rs.0.00 (NPR)
                      order_thumbnail: >-
                        https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                      sale_date: null
                      recognized_ship_date: '2021-01-02T00:00:00.000Z'
                      refundable: true
                      max_refundable_amount: '16900.0'
                      max_refundable_tax: '260.0'
                      max_refundable_shipping: '650.0'
                      max_refundable_product_price: '12740.0'
                      display_enrollment_fee: Rs.3,250.00 (NPR)
                      ship_to:
                        id: 980199006
                        name: Bishal Nepal
                        address1: jhapa
                        address2: null
                        address3: null
                        city: damak
                        state: Province 1
                        postal_code: mechi
                        country_code: null
                        country:
                          id: 141
                          iso_name: NEPAL
                          iso: NP
                          iso3: NPL
                          name: Nepal
                          numcode: 524
                          active: true
                          currency_code: NPR
                          currency_symbol: Rs.
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                          default: false
                          created_at: '2022-05-09T05:12:21.806Z'
                          updated_at: '2022-05-09T05:12:21.806Z'
                          geo_entity_id: 28
                        default: false
                      contact:
                        id: 6559
                        token: SGJ8gug1WYDBB4vhNW5DqoMM
                        first_name: Bishal
                        last_name: Nepal
                        avatar_url: null
                        status: null
                        email: bnepal05362914@gmail.com
                        email2: null
                        phone: null
                        phone2: null
                        phone_id: null
                        address: null
                        address2: null
                        city: null
                        state: null
                        postal_code: null
                        language_id: null
                        country_id: null
                        lead_type: null
                        ip: null
                        requested_at: null
                        best_time: null
                        time_zone: null
                        reason: null
                        income: null
                        hours: null
                        invest: null
                        interest: null
                        full_name: Bishal Nepal
                      items:
                        - id: 8805
                          quantity: 1
                          price: 12740
                          ordered_variant: ''
                          sku: sketch12
                          product:
                            id: 2240
                            active: true
                            title: sketch
                            description:
                              id: 4836
                              name: description
                              body: <div>best selling sketch</div>
                              record_type: Product
                              record_id: 2240
                              created_at: '2023-02-02T03:48:16.810Z'
                              updated_at: '2023-02-02T03:48:16.810Z'
                            stripped: best selling sketch
                            price: '12740.0'
                            display_price: Rs.12,740.00 (NPR)
                            subscription_price: '12740.0'
                            display_subscription_price: Rs.12,740.00 (NPR)
                            wholesale_price: '0.0'
                            display_wholesale_price: Rs.0.00 (NPR)
                            wholesale_subscription_price: '0.0'
                            display_wholesale_subscription_price: Rs.0.00 (NPR)
                            shipping: '5.0'
                            image:
                              mini: >-
                                https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                              detail: >-
                                https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                              full: >-
                                https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                            image_url: >-
                              https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                            sku: sketch
                            country_code: ar
                            country_id: null
                            views: 0
                            leads: 0
                            share_link: null
                            commission: '10.0'
                            public: true
                            shopify_id: null
                            shopify_handle: null
                            in_stock: true
                            vendor: null
                            price_range:
                              - Rs.0.00
                              - Rs.12,740.00
                            price_range_formatted: Rs.0.00 - Rs.12,740.00
                            unlimited_inventory: false
                            default_variant:
                              id: 19630
                              product_id: 2240
                              shopify_id: null
                              title: ''
                              sku: sketch12
                              position: 12698
                              inventory_policy: none
                              taxable: true
                              inventory_quantity: -84
                              created_at: '2023-02-02T03:48:18.009Z'
                              updated_at: '2023-09-29T04:59:12.098Z'
                              external_id: null
                              variant_country_id: null
                              image_url: null
                              image_path: null
                              is_master: true
                              discarded_at: null
                              price: null
                              weight: ''
                              size: ''
                              physical: true
                              unit_of_weight: lb
                              height: 0
                              width: 0
                              length: 0
                              unit_of_size: ft
                              hs_code: ''
                              country_of_origin: ''
                              customs_information_shipping: false
                              active: true
                              bar_code: ''
                              track_quantity: false
                              keep_selling: true
                              option_attrs: []
                              allow_subscription: true
                            currency_symbol: Rs.
                            currency_code: NPR
                            average_rating: 0
                            option_values: {}
                            publish_to_retail_store: true
                            publish_to_rep_store: true
                            publish_to_share_tab: true
                            images:
                              - id: 2089
                                image:
                                  mini: >-
                                    https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                                  detail: >-
                                    https://ik.imagekit.io/fluid/s3/tr:n-video_poster/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                                  full: >-
                                    https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                                image_url: >-
                                  https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                                position: null
                                shopify_id: null
                            countries:
                              - id: 27
                                iso_name: BOTSWANA
                                iso: BW
                                iso3: BWA
                                name: Botswana
                                numcode: 72
                                active: true
                                currency_code: BWP
                                currency_symbol: P
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 68
                                iso_name: FRANCE
                                iso: FR
                                iso3: FRA
                                name: France
                                numcode: 250
                                active: true
                                currency_code: EUR
                                currency_symbol: €
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 214
                                iso_name: UNITED STATES
                                iso: US
                                iso3: USA
                                name: United States
                                numcode: 840
                                active: true
                                currency_code: USD
                                currency_symbol: $
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 12
                                iso_name: AUSTRALIA
                                iso: AU
                                iso3: AUS
                                name: Australia
                                numcode: 36
                                active: true
                                currency_code: AUD
                                currency_symbol: $
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 13
                                iso_name: AUSTRIA
                                iso: AT
                                iso3: AUT
                                name: Austria
                                numcode: 40
                                active: true
                                currency_code: EUR
                                currency_symbol: €
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 14
                                iso_name: AZERBAIJAN
                                iso: AZ
                                iso3: AZE
                                name: Azerbaijan
                                numcode: 31
                                active: true
                                currency_code: AZN
                                currency_symbol: ₼
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 15
                                iso_name: BAHAMAS
                                iso: BS
                                iso3: BHS
                                name: Bahamas
                                numcode: 44
                                active: true
                                currency_code: BSD
                                currency_symbol: $
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 16
                                iso_name: BAHRAIN
                                iso: BH
                                iso3: BHR
                                name: Bahrain
                                numcode: 48
                                active: true
                                currency_code: BHD
                                currency_symbol: د.ب
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 17
                                iso_name: BANGLADESH
                                iso: BD
                                iso3: BGD
                                name: Bangladesh
                                numcode: 50
                                active: true
                                currency_code: BDT
                                currency_symbol: ৳
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 41
                                iso_name: CHINA
                                iso: CN
                                iso3: CHN
                                name: China
                                numcode: 156
                                active: true
                                currency_code: CNY
                                currency_symbol: ¥
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 162
                                iso_name: POLAND
                                iso: PL
                                iso3: POL
                                name: Poland
                                numcode: 616
                                active: true
                                currency_code: PLN
                                currency_symbol: zł
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 163
                                iso_name: PORTUGAL
                                iso: PT
                                iso3: PRT
                                name: Portugal
                                numcode: 620
                                active: true
                                currency_code: EUR
                                currency_symbol: €
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 168
                                iso_name: RUSSIAN FEDERATION
                                iso: RU
                                iso3: RUS
                                name: Russia
                                numcode: 643
                                active: true
                                currency_code: RUB
                                currency_symbol: ₽
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 197
                                iso_name: TAIWAN, PROVINCE OF CHINA
                                iso: TW
                                iso3: TWN
                                name: Taiwan
                                numcode: 158
                                active: true
                                currency_code: TWD
                                currency_symbol: $
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 2
                                iso_name: ALBANIA
                                iso: AL
                                iso3: ALB
                                name: Albania
                                numcode: 8
                                active: true
                                currency_code: ALL
                                currency_symbol: L
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 3
                                iso_name: ALGERIA
                                iso: DZ
                                iso3: DZA
                                name: Algeria
                                numcode: 12
                                active: true
                                currency_code: DZD
                                currency_symbol: د.ج
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 74
                                iso_name: GERMANY
                                iso: DE
                                iso3: DEU
                                name: Germany
                                numcode: 276
                                active: true
                                currency_code: EUR
                                currency_symbol: €
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 141
                                iso_name: NEPAL
                                iso: NP
                                iso3: NPL
                                name: Nepal
                                numcode: 524
                                active: true
                                currency_code: NPR
                                currency_symbol: Rs.
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 188
                                iso_name: SPAIN
                                iso: ES
                                iso3: ESP
                                name: Spain
                                numcode: 724
                                active: true
                                currency_code: EUR
                                currency_symbol: €
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 1
                                iso_name: AFGHANISTAN
                                iso: AF
                                iso3: AFG
                                name: Afghanistan
                                numcode: 4
                                active: true
                                currency_code: AFN
                                currency_symbol: ؋
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 4
                                iso_name: AMERICAN SAMOA
                                iso: AS
                                iso3: ASM
                                name: American Samoa
                                numcode: 16
                                active: true
                                currency_code: USD
                                currency_symbol: $
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 9
                                iso_name: ARGENTINA
                                iso: AR
                                iso3: ARG
                                name: Argentina
                                numcode: 32
                                active: true
                                currency_code: ARS
                                currency_symbol: $
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                              - id: 23
                                iso_name: BERMUDA
                                iso: BM
                                iso3: BMU
                                name: Bermuda
                                numcode: 60
                                active: true
                                currency_code: BMD
                                currency_symbol: $
                                separator: .
                                delimiter: ','
                                address3: false
                                state: true
                                passport: false
                                itn: false
                                tax_rate: 0
                            variants:
                              - id: 19630
                                title: ''
                                image_url: null
                                buyable: true
                                option_value_ids: []
                                allow_subscription: true
                                variant_countries:
                                  - id: 130789
                                    price: '9800.0'
                                    shipping: '500.0'
                                    tax: '200.0'
                                    currency_code: ARS
                                    currency_symbol: $
                                    display_price: $9,800.00 (ARS)
                                    country_iso: AR
                                    subscription_price: '9800.0'
                                    display_wholesale_price: $0.00 (ARS)
                                    display_wholesale_subscription_price: $0.00 (ARS)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 9
                                      iso: AR
                                      iso_name: ARGENTINA
                                      iso3: ARG
                                      name: Argentina
                                      tax_rate: 0
                                  - id: 130790
                                    price: '98.0'
                                    shipping: '5.0'
                                    tax: '2.0'
                                    currency_code: AUD
                                    currency_symbol: $
                                    display_price: $98.00 (AUD)
                                    country_iso: AU
                                    subscription_price: '98.0'
                                    display_wholesale_price: $0.00 (AUD)
                                    display_wholesale_subscription_price: $0.00 (AUD)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 12
                                      iso: AU
                                      iso_name: AUSTRALIA
                                      iso3: AUS
                                      name: Australia
                                      tax_rate: 0
                                  - id: 130791
                                    price: '4900.0'
                                    shipping: '250.0'
                                    tax: '100.0'
                                    currency_code: EUR
                                    currency_symbol: €
                                    display_price: €4,900.00 (EUR)
                                    country_iso: AT
                                    subscription_price: '4900.0'
                                    display_wholesale_price: €0.00 (EUR)
                                    display_wholesale_subscription_price: €0.00 (EUR)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 13
                                      iso: AT
                                      iso_name: AUSTRIA
                                      iso3: AUT
                                      name: Austria
                                      tax_rate: 0
                                  - id: 130792
                                    price: '9604.0'
                                    shipping: '490.0'
                                    tax: '196.0'
                                    currency_code: AZN
                                    currency_symbol: ₼
                                    display_price: ₼9,604.00 (AZN)
                                    country_iso: AZ
                                    subscription_price: '9604.0'
                                    display_wholesale_price: ₼0.00 (AZN)
                                    display_wholesale_subscription_price: ₼0.00 (AZN)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 14
                                      iso: AZ
                                      iso_name: AZERBAIJAN
                                      iso3: AZE
                                      name: Azerbaijan
                                      tax_rate: 0
                                  - id: 130793
                                    price: '98.0'
                                    shipping: '5.0'
                                    tax: '2.0'
                                    currency_code: BSD
                                    currency_symbol: $
                                    display_price: $98.00 (BSD)
                                    country_iso: BS
                                    subscription_price: '98.0'
                                    display_wholesale_price: $0.00 (BSD)
                                    display_wholesale_subscription_price: $0.00 (BSD)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 15
                                      iso: BS
                                      iso_name: BAHAMAS
                                      iso3: BHS
                                      name: Bahamas
                                      tax_rate: 0
                                  - id: 130794
                                    price: '98.0'
                                    shipping: '5.0'
                                    tax: '2.0'
                                    currency_code: BHD
                                    currency_symbol: د.ب
                                    display_price: د.ب98.000 (BHD)
                                    country_iso: BH
                                    subscription_price: '98.0'
                                    display_wholesale_price: د.ب0.000 (BHD)
                                    display_wholesale_subscription_price: د.ب0.000 (BHD)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 16
                                      iso: BH
                                      iso_name: BAHRAIN
                                      iso3: BHR
                                      name: Bahrain
                                      tax_rate: 0
                                  - id: 130795
                                    price: '98.0'
                                    shipping: '5.0'
                                    tax: '2.0'
                                    currency_code: BDT
                                    currency_symbol: ৳
                                    display_price: ৳98.00 (BDT)
                                    country_iso: BD
                                    subscription_price: '98.0'
                                    display_wholesale_price: ৳0.00 (BDT)
                                    display_wholesale_subscription_price: ৳0.00 (BDT)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 17
                                      iso: BD
                                      iso_name: BANGLADESH
                                      iso3: BGD
                                      name: Bangladesh
                                      tax_rate: 0
                                  - id: 130798
                                    price: '98.0'
                                    shipping: '5.0'
                                    tax: '2.0'
                                    currency_code: BMD
                                    currency_symbol: $
                                    display_price: $98.00 (BMD)
                                    country_iso: BM
                                    subscription_price: '98.0'
                                    display_wholesale_price: $0.00 (BMD)
                                    display_wholesale_subscription_price: $0.00 (BMD)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 23
                                      iso: BM
                                      iso_name: BERMUDA
                                      iso3: BMU
                                      name: Bermuda
                                      tax_rate: 0
                                  - id: 130801
                                    price: '98.0'
                                    shipping: '5.0'
                                    tax: '2.0'
                                    currency_code: BWP
                                    currency_symbol: P
                                    display_price: P98.00 (BWP)
                                    country_iso: BW
                                    subscription_price: '98.0'
                                    display_wholesale_price: P0.00 (BWP)
                                    display_wholesale_subscription_price: P0.00 (BWP)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 27
                                      iso: BW
                                      iso_name: BOTSWANA
                                      iso3: BWA
                                      name: Botswana
                                      tax_rate: 0
                                  - id: 130881
                                    price: '12740.0'
                                    shipping: '650.0'
                                    tax: '260.0'
                                    currency_code: NPR
                                    currency_symbol: Rs.
                                    display_price: Rs.12,740.00 (NPR)
                                    country_iso: NP
                                    subscription_price: '12740.0'
                                    display_wholesale_price: Rs.0.00 (NPR)
                                    display_wholesale_subscription_price: Rs.0.00 (NPR)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 141
                                      iso: NP
                                      iso_name: NEPAL
                                      iso3: NPL
                                      name: Nepal
                                      tax_rate: 0
                                  - id: 130897
                                    price: '98.0'
                                    shipping: '5.0'
                                    tax: '2.0'
                                    currency_code: EUR
                                    currency_symbol: €
                                    display_price: €98.00 (EUR)
                                    country_iso: PT
                                    subscription_price: '98.0'
                                    display_wholesale_price: €0.00 (EUR)
                                    display_wholesale_subscription_price: €0.00 (EUR)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 163
                                      iso: PT
                                      iso_name: PORTUGAL
                                      iso3: PRT
                                      name: Portugal
                                      tax_rate: 0
                                  - id: 130921
                                    price: '98.0'
                                    shipping: '5.0'
                                    tax: '2.0'
                                    currency_code: TWD
                                    currency_symbol: $
                                    display_price: $98.00 (TWD)
                                    country_iso: TW
                                    subscription_price: '98.0'
                                    display_wholesale_price: $0.00 (TWD)
                                    display_wholesale_subscription_price: $0.00 (TWD)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 197
                                      iso: TW
                                      iso_name: TAIWAN, PROVINCE OF CHINA
                                      iso3: TWN
                                      name: Taiwan
                                      tax_rate: 0
                                  - id: 130933
                                    price: '98.0'
                                    shipping: '5.0'
                                    tax: '2.0'
                                    currency_code: USD
                                    currency_symbol: $
                                    display_price: $98.00 (USD)
                                    country_iso: US
                                    subscription_price: '98.0'
                                    display_wholesale_price: $0.00 (USD)
                                    display_wholesale_subscription_price: $0.00 (USD)
                                    wholesale_price: '0.0'
                                    wholesale_subscription_price: '0.0'
                                    country:
                                      id: 214
                                      iso: US
                                      iso_name: UNITED STATES
                                      iso3: USA
                                      name: United States
                                      tax_rate: 0
                            options: []
                            prompts: []
                            enroll_products:
                              - id: 19
                                product_id: 2240
                                enroll_id: 2
                                active: true
                                type: membership_product
                                created_at: '2023-02-15T06:40:53.303Z'
                                updated_at: '2023-02-15T06:40:53.303Z'
                            enrolls:
                              - id: 2
                                integration_id: null
                                fields:
                                  dob: Birthdate
                                  full_name: Name
                                  government_id: Government ID
                                member_fee: 25
                                member_fee_enabled: true
                                company_id: 980191019
                                created_at: '2023-02-01T07:49:12.347Z'
                                updated_at: '2023-02-01T07:54:36.961Z'
                                terms_and_conditions_url: https://www.google.com/
                      tracking_informations: []
              example:
                id: 8770
                order_number: F32835649011346
                amount: '16900.0'
                shipping: '650.0'
                tax: '260.0'
                subtotal: '12740.0'
                first_name: Bishal
                last_name: Nepal
                email: bnepal05362914@gmail.com
                phone: null
                tracking: null
                cv: 5
                qv: 0
                status: awaiting_shipment
                order_type: purchased
                rating: 0
                review: >-
                  Lorem Ipsum is simply dummy text of the printing and
                  typesetting industry. Lorem Ipsum has been the industry's
                  standard dummy text ever since the 1500s, when an unknown
                  printer took a galley of type and scrambled it to make a type
                  specimen book. It has survived not only five centuries, but
                  also the leap into electronic typesetting, remaining
                  essentially unchanged.
                referrer: Bishal Nepal
                friendly_status: paid
                type: null
                created_at: '2023-03-15T11:17:58.289Z'
                currency_code: NPR
                currency_symbol: Rs.
                display_amount: Rs.16,900.00 (NPR)
                display_subtotal: Rs.12,740.00 (NPR)
                display_tax: Rs.260.00 (NPR)
                display_shipping: Rs.650.00 (NPR)
                display_refunds: (0 CV, 0 QV) -Rs.0.00 (NPR)
                display_discount: Rs.0.00 (NPR)
                order_thumbnail: >-
                  https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                sale_date: null
                recognized_ship_date: '2021-01-02T00:00:00.000Z'
                refundable: true
                max_refundable_amount: '16900.0'
                max_refundable_tax: '260.0'
                max_refundable_shipping: '650.0'
                max_refundable_product_price: '12740.0'
                display_enrollment_fee: Rs.3,250.00 (NPR)
                ship_to:
                  id: 980199006
                  name: Bishal Nepal
                  address1: jhapa
                  address2: null
                  address3: null
                  city: damak
                  state: Province 1
                  postal_code: mechi
                  country_code: null
                  country:
                    id: 141
                    iso_name: NEPAL
                    iso: NP
                    iso3: NPL
                    name: Nepal
                    numcode: 524
                    active: true
                    currency_code: NPR
                    currency_symbol: Rs.
                    separator: .
                    delimiter: ','
                    address3: false
                    state: true
                    passport: false
                    itn: false
                    tax_rate: 0
                    default: false
                    created_at: '2022-05-09T05:12:21.806Z'
                    updated_at: '2022-05-09T05:12:21.806Z'
                    geo_entity_id: 28
                  default: false
                contact:
                  id: 6559
                  token: SGJ8gug1WYDBB4vhNW5DqoMM
                  first_name: Bishal
                  last_name: Nepal
                  avatar_url: null
                  status: null
                  email: bnepal05362914@gmail.com
                  email2: null
                  phone: null
                  phone2: null
                  phone_id: null
                  address: null
                  address2: null
                  city: null
                  state: null
                  postal_code: null
                  language_id: null
                  country_id: null
                  lead_type: null
                  ip: null
                  requested_at: null
                  best_time: null
                  time_zone: null
                  reason: null
                  income: null
                  hours: null
                  invest: null
                  interest: null
                  full_name: Bishal Nepal
                items:
                  - id: 8805
                    quantity: 1
                    price: 12740
                    ordered_variant: ''
                    sku: sketch12
                    product:
                      id: 2240
                      active: true
                      title: sketch
                      description:
                        id: 4836
                        name: description
                        body: <div>best selling sketch</div>
                        record_type: Product
                        record_id: 2240
                        created_at: '2023-02-02T03:48:16.810Z'
                        updated_at: '2023-02-02T03:48:16.810Z'
                      stripped: best selling sketch
                      price: '12740.0'
                      display_price: Rs.12,740.00 (NPR)
                      subscription_price: '12740.0'
                      display_subscription_price: Rs.12,740.00 (NPR)
                      wholesale_price: '0.0'
                      display_wholesale_price: Rs.0.00 (NPR)
                      wholesale_subscription_price: '0.0'
                      display_wholesale_subscription_price: Rs.0.00 (NPR)
                      shipping: '5.0'
                      image:
                        mini: >-
                          https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                        detail: >-
                          https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                        full: >-
                          https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                      image_url: >-
                        https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                      sku: sketch
                      country_code: ar
                      country_id: null
                      views: 0
                      leads: 0
                      share_link: null
                      commission: '10.0'
                      public: true
                      shopify_id: null
                      shopify_handle: null
                      in_stock: true
                      vendor: null
                      price_range:
                        - Rs.0.00
                        - Rs.12,740.00
                      price_range_formatted: Rs.0.00 - Rs.12,740.00
                      unlimited_inventory: false
                      default_variant:
                        id: 19630
                        product_id: 2240
                        shopify_id: null
                        title: ''
                        sku: sketch12
                        position: 12698
                        inventory_policy: none
                        taxable: true
                        inventory_quantity: -84
                        created_at: '2023-02-02T03:48:18.009Z'
                        updated_at: '2023-09-29T04:59:12.098Z'
                        external_id: null
                        variant_country_id: null
                        image_url: null
                        image_path: null
                        is_master: true
                        discarded_at: null
                        price: null
                        weight: ''
                        size: ''
                        physical: true
                        unit_of_weight: lb
                        height: 0
                        width: 0
                        length: 0
                        unit_of_size: ft
                        hs_code: ''
                        country_of_origin: ''
                        customs_information_shipping: false
                        active: true
                        bar_code: ''
                        track_quantity: false
                        keep_selling: true
                        option_attrs: []
                        allow_subscription: true
                      currency_symbol: Rs.
                      currency_code: NPR
                      average_rating: 0
                      option_values: {}
                      publish_to_retail_store: true
                      publish_to_rep_store: true
                      publish_to_share_tab: true
                      images:
                        - id: 2089
                          image:
                            mini: >-
                              https://ik.imagekit.io/fluid/s3/tr:n-split_mobile/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                            detail: >-
                              https://ik.imagekit.io/fluid/s3/tr:n-video_poster/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                            full: >-
                              https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                          image_url: >-
                            https://ik.imagekit.io/fluid/s3/9lNWB9YzTkG197DSm9Q0_best_selling_product.jpg
                          position: null
                          shopify_id: null
                      countries:
                        - id: 27
                          iso_name: BOTSWANA
                          iso: BW
                          iso3: BWA
                          name: Botswana
                          numcode: 72
                          active: true
                          currency_code: BWP
                          currency_symbol: P
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 68
                          iso_name: FRANCE
                          iso: FR
                          iso3: FRA
                          name: France
                          numcode: 250
                          active: true
                          currency_code: EUR
                          currency_symbol: €
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 214
                          iso_name: UNITED STATES
                          iso: US
                          iso3: USA
                          name: United States
                          numcode: 840
                          active: true
                          currency_code: USD
                          currency_symbol: $
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 12
                          iso_name: AUSTRALIA
                          iso: AU
                          iso3: AUS
                          name: Australia
                          numcode: 36
                          active: true
                          currency_code: AUD
                          currency_symbol: $
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 13
                          iso_name: AUSTRIA
                          iso: AT
                          iso3: AUT
                          name: Austria
                          numcode: 40
                          active: true
                          currency_code: EUR
                          currency_symbol: €
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 14
                          iso_name: AZERBAIJAN
                          iso: AZ
                          iso3: AZE
                          name: Azerbaijan
                          numcode: 31
                          active: true
                          currency_code: AZN
                          currency_symbol: ₼
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 15
                          iso_name: BAHAMAS
                          iso: BS
                          iso3: BHS
                          name: Bahamas
                          numcode: 44
                          active: true
                          currency_code: BSD
                          currency_symbol: $
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 16
                          iso_name: BAHRAIN
                          iso: BH
                          iso3: BHR
                          name: Bahrain
                          numcode: 48
                          active: true
                          currency_code: BHD
                          currency_symbol: د.ب
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 17
                          iso_name: BANGLADESH
                          iso: BD
                          iso3: BGD
                          name: Bangladesh
                          numcode: 50
                          active: true
                          currency_code: BDT
                          currency_symbol: ৳
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 41
                          iso_name: CHINA
                          iso: CN
                          iso3: CHN
                          name: China
                          numcode: 156
                          active: true
                          currency_code: CNY
                          currency_symbol: ¥
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 162
                          iso_name: POLAND
                          iso: PL
                          iso3: POL
                          name: Poland
                          numcode: 616
                          active: true
                          currency_code: PLN
                          currency_symbol: zł
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 163
                          iso_name: PORTUGAL
                          iso: PT
                          iso3: PRT
                          name: Portugal
                          numcode: 620
                          active: true
                          currency_code: EUR
                          currency_symbol: €
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 168
                          iso_name: RUSSIAN FEDERATION
                          iso: RU
                          iso3: RUS
                          name: Russia
                          numcode: 643
                          active: true
                          currency_code: RUB
                          currency_symbol: ₽
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 197
                          iso_name: TAIWAN, PROVINCE OF CHINA
                          iso: TW
                          iso3: TWN
                          name: Taiwan
                          numcode: 158
                          active: true
                          currency_code: TWD
                          currency_symbol: $
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 2
                          iso_name: ALBANIA
                          iso: AL
                          iso3: ALB
                          name: Albania
                          numcode: 8
                          active: true
                          currency_code: ALL
                          currency_symbol: L
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 3
                          iso_name: ALGERIA
                          iso: DZ
                          iso3: DZA
                          name: Algeria
                          numcode: 12
                          active: true
                          currency_code: DZD
                          currency_symbol: د.ج
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 74
                          iso_name: GERMANY
                          iso: DE
                          iso3: DEU
                          name: Germany
                          numcode: 276
                          active: true
                          currency_code: EUR
                          currency_symbol: €
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 141
                          iso_name: NEPAL
                          iso: NP
                          iso3: NPL
                          name: Nepal
                          numcode: 524
                          active: true
                          currency_code: NPR
                          currency_symbol: Rs.
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 188
                          iso_name: SPAIN
                          iso: ES
                          iso3: ESP
                          name: Spain
                          numcode: 724
                          active: true
                          currency_code: EUR
                          currency_symbol: €
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 1
                          iso_name: AFGHANISTAN
                          iso: AF
                          iso3: AFG
                          name: Afghanistan
                          numcode: 4
                          active: true
                          currency_code: AFN
                          currency_symbol: ؋
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 4
                          iso_name: AMERICAN SAMOA
                          iso: AS
                          iso3: ASM
                          name: American Samoa
                          numcode: 16
                          active: true
                          currency_code: USD
                          currency_symbol: $
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 9
                          iso_name: ARGENTINA
                          iso: AR
                          iso3: ARG
                          name: Argentina
                          numcode: 32
                          active: true
                          currency_code: ARS
                          currency_symbol: $
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                        - id: 23
                          iso_name: BERMUDA
                          iso: BM
                          iso3: BMU
                          name: Bermuda
                          numcode: 60
                          active: true
                          currency_code: BMD
                          currency_symbol: $
                          separator: .
                          delimiter: ','
                          address3: false
                          state: true
                          passport: false
                          itn: false
                          tax_rate: 0
                      variants:
                        - id: 19630
                          title: ''
                          image_url: null
                          buyable: true
                          option_value_ids: []
                          allow_subscription: true
                          variant_countries:
                            - id: 130789
                              price: '9800.0'
                              shipping: '500.0'
                              tax: '200.0'
                              currency_code: ARS
                              currency_symbol: $
                              display_price: $9,800.00 (ARS)
                              country_iso: AR
                              subscription_price: '9800.0'
                              display_wholesale_price: $0.00 (ARS)
                              display_wholesale_subscription_price: $0.00 (ARS)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 9
                                iso: AR
                                iso_name: ARGENTINA
                                iso3: ARG
                                name: Argentina
                                tax_rate: 0
                            - id: 130790
                              price: '98.0'
                              shipping: '5.0'
                              tax: '2.0'
                              currency_code: AUD
                              currency_symbol: $
                              display_price: $98.00 (AUD)
                              country_iso: AU
                              subscription_price: '98.0'
                              display_wholesale_price: $0.00 (AUD)
                              display_wholesale_subscription_price: $0.00 (AUD)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 12
                                iso: AU
                                iso_name: AUSTRALIA
                                iso3: AUS
                                name: Australia
                                tax_rate: 0
                            - id: 130791
                              price: '4900.0'
                              shipping: '250.0'
                              tax: '100.0'
                              currency_code: EUR
                              currency_symbol: €
                              display_price: €4,900.00 (EUR)
                              country_iso: AT
                              subscription_price: '4900.0'
                              display_wholesale_price: €0.00 (EUR)
                              display_wholesale_subscription_price: €0.00 (EUR)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 13
                                iso: AT
                                iso_name: AUSTRIA
                                iso3: AUT
                                name: Austria
                                tax_rate: 0
                            - id: 130792
                              price: '9604.0'
                              shipping: '490.0'
                              tax: '196.0'
                              currency_code: AZN
                              currency_symbol: ₼
                              display_price: ₼9,604.00 (AZN)
                              country_iso: AZ
                              subscription_price: '9604.0'
                              display_wholesale_price: ₼0.00 (AZN)
                              display_wholesale_subscription_price: ₼0.00 (AZN)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 14
                                iso: AZ
                                iso_name: AZERBAIJAN
                                iso3: AZE
                                name: Azerbaijan
                                tax_rate: 0
                            - id: 130793
                              price: '98.0'
                              shipping: '5.0'
                              tax: '2.0'
                              currency_code: BSD
                              currency_symbol: $
                              display_price: $98.00 (BSD)
                              country_iso: BS
                              subscription_price: '98.0'
                              display_wholesale_price: $0.00 (BSD)
                              display_wholesale_subscription_price: $0.00 (BSD)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 15
                                iso: BS
                                iso_name: BAHAMAS
                                iso3: BHS
                                name: Bahamas
                                tax_rate: 0
                            - id: 130794
                              price: '98.0'
                              shipping: '5.0'
                              tax: '2.0'
                              currency_code: BHD
                              currency_symbol: د.ب
                              display_price: د.ب98.000 (BHD)
                              country_iso: BH
                              subscription_price: '98.0'
                              display_wholesale_price: د.ب0.000 (BHD)
                              display_wholesale_subscription_price: د.ب0.000 (BHD)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 16
                                iso: BH
                                iso_name: BAHRAIN
                                iso3: BHR
                                name: Bahrain
                                tax_rate: 0
                            - id: 130795
                              price: '98.0'
                              shipping: '5.0'
                              tax: '2.0'
                              currency_code: BDT
                              currency_symbol: ৳
                              display_price: ৳98.00 (BDT)
                              country_iso: BD
                              subscription_price: '98.0'
                              display_wholesale_price: ৳0.00 (BDT)
                              display_wholesale_subscription_price: ৳0.00 (BDT)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 17
                                iso: BD
                                iso_name: BANGLADESH
                                iso3: BGD
                                name: Bangladesh
                                tax_rate: 0
                            - id: 130798
                              price: '98.0'
                              shipping: '5.0'
                              tax: '2.0'
                              currency_code: BMD
                              currency_symbol: $
                              display_price: $98.00 (BMD)
                              country_iso: BM
                              subscription_price: '98.0'
                              display_wholesale_price: $0.00 (BMD)
                              display_wholesale_subscription_price: $0.00 (BMD)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 23
                                iso: BM
                                iso_name: BERMUDA
                                iso3: BMU
                                name: Bermuda
                                tax_rate: 0
                            - id: 130801
                              price: '98.0'
                              shipping: '5.0'
                              tax: '2.0'
                              currency_code: BWP
                              currency_symbol: P
                              display_price: P98.00 (BWP)
                              country_iso: BW
                              subscription_price: '98.0'
                              display_wholesale_price: P0.00 (BWP)
                              display_wholesale_subscription_price: P0.00 (BWP)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 27
                                iso: BW
                                iso_name: BOTSWANA
                                iso3: BWA
                                name: Botswana
                                tax_rate: 0
                            - id: 130881
                              price: '12740.0'
                              shipping: '650.0'
                              tax: '260.0'
                              currency_code: NPR
                              currency_symbol: Rs.
                              display_price: Rs.12,740.00 (NPR)
                              country_iso: NP
                              subscription_price: '12740.0'
                              display_wholesale_price: Rs.0.00 (NPR)
                              display_wholesale_subscription_price: Rs.0.00 (NPR)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 141
                                iso: NP
                                iso_name: NEPAL
                                iso3: NPL
                                name: Nepal
                                tax_rate: 0
                            - id: 130897
                              price: '98.0'
                              shipping: '5.0'
                              tax: '2.0'
                              currency_code: EUR
                              currency_symbol: €
                              display_price: €98.00 (EUR)
                              country_iso: PT
                              subscription_price: '98.0'
                              display_wholesale_price: €0.00 (EUR)
                              display_wholesale_subscription_price: €0.00 (EUR)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 163
                                iso: PT
                                iso_name: PORTUGAL
                                iso3: PRT
                                name: Portugal
                                tax_rate: 0
                            - id: 130921
                              price: '98.0'
                              shipping: '5.0'
                              tax: '2.0'
                              currency_code: TWD
                              currency_symbol: $
                              display_price: $98.00 (TWD)
                              country_iso: TW
                              subscription_price: '98.0'
                              display_wholesale_price: $0.00 (TWD)
                              display_wholesale_subscription_price: $0.00 (TWD)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 197
                                iso: TW
                                iso_name: TAIWAN, PROVINCE OF CHINA
                                iso3: TWN
                                name: Taiwan
                                tax_rate: 0
                            - id: 130933
                              price: '98.0'
                              shipping: '5.0'
                              tax: '2.0'
                              currency_code: USD
                              currency_symbol: $
                              display_price: $98.00 (USD)
                              country_iso: US
                              subscription_price: '98.0'
                              display_wholesale_price: $0.00 (USD)
                              display_wholesale_subscription_price: $0.00 (USD)
                              wholesale_price: '0.0'
                              wholesale_subscription_price: '0.0'
                              country:
                                id: 214
                                iso: US
                                iso_name: UNITED STATES
                                iso3: USA
                                name: United States
                                tax_rate: 0
                      options: []
                      prompts: []
                      enroll_products:
                        - id: 19
                          product_id: 2240
                          enroll_id: 2
                          active: true
                          type: membership_product
                          created_at: '2023-02-15T06:40:53.303Z'
                          updated_at: '2023-02-15T06:40:53.303Z'
                      enrolls:
                        - id: 2
                          integration_id: null
                          fields:
                            dob: Birthdate
                            full_name: Name
                            government_id: Government ID
                          member_fee: 25
                          member_fee_enabled: true
                          company_id: 980191019
                          created_at: '2023-02-01T07:49:12.347Z'
                          updated_at: '2023-02-01T07:54:36.961Z'
                          terms_and_conditions_url: https://www.google.com/
                tracking_informations: []
      deprecated: false
      security:
        - bearer: []
    delete:
      tags:
        - Orders
      summary: Delete Company Order
      description: Deletes a specific order belonging to a company.
      operationId: deleteCompanyOrder
      parameters:
        - name: orderId
          in: path
          required: true
          schema:
            type: integer
          description: The unique identifier of the order to delete
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                type: string
                example: Order deleted successfully.
              example: Order deleted successfully.
      deprecated: false
      security:
        - bearer: []
  /api/public/v2025-06/orders/{token}:
    get:
      summary: Retrieves an order with points redemption
      tags:
        - Orders
      operationId: getOrderWithPoints
      parameters:
        - name: token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: order with points found
          content:
            application/json:
              schema:
                type: object
                properties:
                  order:
                    type: object
                    properties:
                      id:
                        type: integer
                      amount_in_base:
                        type: string
                        example: '10.0'
                      base_to_currency_rate:
                        type:
                          - string
                          - 'null'
                        example: '1.35'
                      currency_symbol:
                        type: string
                      currency_code:
                        type: string
                      external_id:
                        type:
                          - string
                          - 'null'
                      order_number:
                        type: string
                      note:
                        type:
                          - string
                          - 'null'
                      company_logo_url:
                        type:
                          - string
                          - 'null'
                      created_at:
                        type: string
                      customer:
                        type:
                          - string
                          - 'null'
                      email:
                        type:
                          - string
                          - 'null'
                      total:
                        type: string
                      total_in_currency:
                        type: string
                      subtotal:
                        type: string
                        example: '90.00'
                      sub_total:
                        type: string
                        example: '90.00'
                      sub_total_in_currency:
                        type: string
                        example: $90.00
                      subtotal_after_discounts:
                        type: string
                        example: '90.00'
                      tax:
                        type: string
                        example: '2.00'
                      tax_in_currency:
                        type: string
                        example: $2.00
                      token:
                        type: string
                        example: fo_abcdefgh1234
                      transaction_fee:
                        type: string
                        example: '1.00'
                      transaction_fee_in_currency:
                        type: string
                        example: $1.00
                      discount:
                        type: string
                        example: '3.00'
                      discount_in_currency:
                        type: string
                        example: $3.00
                      refundable_amount:
                        type:
                          - number
                          - string
                        format: float
                        example: 10.5
                      shipping:
                        type: string
                        example: $11.00
                      shipping_in_currency:
                        type:
                          - object
                          - 'null'
                        properties:
                          amount_in_currency:
                            type: string
                            example: $11.00
                          surcharge_in_currency:
                            type: string
                            example: $11.00
                      payment_status:
                        type: string
                      enrollment_token:
                        type:
                          - string
                          - 'null'
                      enrollment_pack:
                        type:
                          - object
                          - 'null'
                        properties:
                          enrollment_pack_id:
                            type: integer
                            example: 1
                          additional_volume:
                            type:
                              - integer
                              - 'null'
                            example: 10
                          slug:
                            type: string
                            example: test-enrollment-pack
                          description:
                            type:
                              - object
                              - 'null'
                              - string
                            properties:
                              id:
                                type: integer
                                example: 111
                              name:
                                type: string
                                example: description
                              body:
                                type: string
                                example: >-
                                  <div>Try the latest and greatest of our sugar
                                  zip packs. Guaranteed to make you skinner and
                                  cure cancer.</div>
                              record_type:
                                type: string
                                example: EnrollmentPack
                              record_id:
                                type: integer
                                example: 1
                              created_at:
                                type: string
                                format: date_time
                                example: '2025-01-16T04:22:43.809Z'
                              updated_at:
                                type: string
                                format: date_time
                                example: '2025-01-22T10:23:52.941Z'
                              locale:
                                type: string
                                example: en
                          enrollment_fee:
                            type:
                              - number
                              - string
                            example: 10
                          enrollment_fee_in_currency:
                            type: string
                            example: $10.00
                          images:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 2
                                relateable_type:
                                  type: string
                                  example: EnrollmentPack
                                relateable_id:
                                  type: integer
                                  example: 1
                                image_url:
                                  type: string
                                  example: >-
                                    https://ik.imagekit.io/fluid/s3/jITWaU14QGe0y5AFgY7P_00179.svg
                                image_path:
                                  type: string
                                  example: jITWaU14QGe0y5AFgY7P_00179.svg
                                position:
                                  type: integer
                                  example: 1
                                shopify_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                                created_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                updated_at:
                                  type: string
                                  format: date_time
                                  example: '2025-01-16T04:22:44.870Z'
                                external_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: null
                          items:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 625
                                allow_subscription:
                                  type: boolean
                                  example: true
                                cv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                cv_in_currency:
                                  type: string
                                  example: $0.00
                                cv_total:
                                  type: integer
                                  example: 0
                                enrollment:
                                  type: boolean
                                  example: true
                                enrollment_pack_id:
                                  type: integer
                                  example: 1
                                price:
                                  type: string
                                  example: '11.13'
                                price_in_currency:
                                  type: string
                                  example: $11.13
                                product_title:
                                  type: string
                                  example: Zip Pack Sample Pack (30)
                                quantity:
                                  type: integer
                                  example: 1
                                qv:
                                  type:
                                    - number
                                    - string
                                  example: 0
                                qv_in_currency:
                                  type: string
                                  example: $0.00
                                qv_total:
                                  type: integer
                                  example: 0
                                subscribe_and_save:
                                  type:
                                    - string
                                    - 'null'
                                  example: '-1988.87'
                                subscribe_and_save_for_display:
                                  type:
                                    - string
                                    - 'null'
                                  example: Subscribe and save $-1,988.87
                                subscribe_and_save_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $-1,988.87
                                subscription:
                                  type: boolean
                                  example: false
                                subscription_interval:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_interval_unit:
                                  type:
                                    - string
                                    - 'null'
                                  example: month
                                subscription_only:
                                  type: boolean
                                  example: false
                                subscription_plan_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 1
                                subscription_plans:
                                  oneOf:
                                    - type: array
                                      items:
                                        title: Commerce::SubscriptionPlan
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          name:
                                            example: Test Subscription Plan
                                            type: string
                                          billing_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          billing_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          billing_frequency_in_words:
                                            example: 2 Months
                                            type: string
                                          shipping_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          shipping_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          volume_interval:
                                            example: 1
                                            type: integer
                                            default: 1
                                            minimum: 1
                                            maximum: 29
                                          volume_interval_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type: string
                                            default: month
                                          trial_period:
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                            minimum: 1
                                          trial_period_unit:
                                            description: >-
                                              Possible values: `day`, `week`, `month`,
                                              `year`
                                            example: day
                                            type:
                                              - string
                                              - 'null'
                                          split_volume:
                                            example: true
                                            type: boolean
                                            default: false
                                          allow_max_billing_cycles:
                                            example: true
                                            type: boolean
                                            default: false
                                          max_billing_cycles:
                                            example: 3
                                            type:
                                              - integer
                                              - 'null'
                                          company_default:
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          products_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          subscribers_count:
                                            example: 10
                                            type:
                                              - integer
                                              - 'null'
                                          price:
                                            type: string
                                          price_in_currency:
                                            type: string
                                          subscription_start:
                                            type: string
                                          subscribe_and_save:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_in_currency:
                                            type:
                                              - string
                                              - 'null'
                                          subscribe_and_save_for_display:
                                            type:
                                              - string
                                              - 'null'
                                        required:
                                          - id
                                          - name
                                          - billing_interval
                                          - billing_interval_unit
                                          - billing_frequency_in_words
                                          - shipping_interval
                                          - shipping_interval_unit
                                          - volume_interval
                                          - volume_interval_unit
                                          - split_volume
                                          - allow_max_billing_cycles
                                          - price
                                          - price_in_currency
                                          - subscription_start
                                          - subscribe_and_save
                                          - subscribe_and_save_in_currency
                                          - subscribe_and_save_for_display
                                    - type: 'null'
                                subscription_price:
                                  type: string
                                  example: '2000.0'
                                subscription_price_in_currency:
                                  type: string
                                  example: $2,000.00
                                subscription_start:
                                  type:
                                    - string
                                    - 'null'
                                  format: date
                                  example: '2025-02-28'
                                tax:
                                  type: string
                                  example: '0.0'
                                tax_in_currency:
                                  type: string
                                  example: $0.00
                                total_after_discounts:
                                  type: string
                                  example: '90.00'
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: null
                                display_to_customer:
                                  type: boolean
                                  example: false
                                metadata:
                                  type: object
                                  description: >-
                                    A JSON object that can store any custom data
                                    structure
                                  example: {}
                                errors:
                                  oneOf:
                                    - type: 'null'
                                    - type: array
                                      items:
                                        type: object
                                      example:
                                        - country:
                                            - >-
                                              This product is not available for this
                                              country. Please change your country
                          price:
                            type: string
                            example: '11.13'
                          price_in_currency:
                            type: string
                            example: $11.13
                          subscription_price:
                            type:
                              - string
                              - integer
                            example: 2000
                          subscription_price_in_currency:
                            type: string
                            example: $2,000.00
                          title:
                            type: string
                            example: enroll product
                          token:
                            type: string
                            example: NxL22AqLRRisfyF9LqxxWRak
                      fulfillment_status:
                        type: string
                      order_status:
                        type: string
                      financial_status:
                        type: string
                      delivery_status:
                        type: string
                      delivery_method:
                        type: string
                      delivery_date:
                        type:
                          - string
                          - 'null'
                        example: '2023-07-29'
                      channel:
                        type: string
                      tags:
                        type: string
                      items_count:
                        type: integer
                      quantity_count:
                        type: integer
                      items:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 101
                            price:
                              type:
                                - number
                                - string
                              example: 43.41
                            price_in_currency:
                              type: string
                              example: $43.41
                            tax:
                              type: string
                              example: '2.99'
                            tax_in_currency:
                              type: string
                              example: $2.99
                            cv:
                              type: integer
                              example: 5
                            cv_in_currency:
                              type: string
                              example: $5.00
                            qv:
                              type: integer
                              example: 7
                            qv_in_currency:
                              type: string
                              example: $7.00
                            product_title:
                              type: string
                              example: Sample Product
                            variant_title:
                              type:
                                - string
                                - 'null'
                              example: Sample Variant
                            variant_image:
                              type:
                                - string
                                - 'null'
                              example: https://example.com/image.png
                            variant_id:
                              type: integer
                              example: 202
                            quantity:
                              type: integer
                              example: 3
                            title:
                              type: string
                            total:
                              type:
                                - number
                                - string
                            image_url:
                              type:
                                - string
                                - 'null'
                            sku:
                              type:
                                - string
                                - 'null'
                            display_price:
                              type: string
                            display_total:
                              type: string
                            refundable_amount:
                              type:
                                - number
                                - string
                              format: float
                              example: 10.5
                            enrollment_pack_id:
                              type:
                                - integer
                                - 'null'
                            display_to_customer:
                              type:
                                - boolean
                                - 'null'
                              example: true
                            bundled_items:
                              type: array
                              items:
                                type: object
                                properties:
                                  variant_id:
                                    type: integer
                                  product_id:
                                    type: integer
                                  product_title:
                                    type: string
                                  variant_title:
                                    type: string
                                  option_titles:
                                    type: array
                                    items:
                                      type: string
                                  quantity:
                                    type: integer
                                  display_to_customer:
                                    type: boolean
                            ordered_variant:
                              type: array
                              items:
                                type: object
                                properties:
                                  option_type:
                                    type: string
                                  value:
                                    type: string
                            product:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1
                                title:
                                  type: string
                                  example: Sample Product
                                introduction:
                                  type:
                                    - string
                                    - 'null'
                                  example: Sample Short Description
                                cv:
                                  type: integer
                                  example: 10
                                cv_in_currency:
                                  type: string
                                  example: $10.00
                                external_id:
                                  type:
                                    - string
                                    - 'null'
                                  example: ext-prod-123
                                image_path:
                                  type:
                                    - string
                                    - 'null'
                                  example: /images/product.png
                                image_url:
                                  type:
                                    - string
                                    - 'null'
                                  example: https://example.com/images/product.png
                                price:
                                  type: string
                                  example: '29.99'
                                price_in_currency:
                                  type: string
                                  example: $29.99
                                sku:
                                  type:
                                    - string
                                    - 'null'
                                  example: SKU12345
                                tax:
                                  type: string
                                  example: '2.99'
                                tax_in_currency:
                                  type: string
                                  example: $2.99
                                metadata:
                                  type: object
                                  example:
                                    shopify_product_id: 9876054868270
                                metafields:
                                  type: array
                                  items:
                                    title: LegacyMetafield
                                    type: object
                                    properties:
                                      namespace:
                                        description: >-
                                          A container for related metafields.
                                          Commonly used to group metafields by app
                                          or functionality.
                                        example: custom
                                        type: string
                                        maxLength: 20
                                        pattern: ^[a-zA-Z0-9_]+$
                                      key:
                                        description: >-
                                          The unique identifier for the metafield
                                          within its namespace. Must be unique per
                                          namespace and owner.
                                        example: material
                                        type: string
                                        maxLength: 30
                                        pattern: ^[a-zA-Z0-9_]+$
                                      value:
                                        description: >-
                                          The actual data stored in the metafield.
                                          Type depends on value_type.
                                        example: cotton
                                        type:
                                          - string
                                          - integer
                                          - object
                                          - boolean
                                          - number
                                      value_type:
                                        description: >-
                                          The data type that defines how the value
                                          should be interpreted and validated.
                                        example: single_line_text_field
                                        type: string
                                      description:
                                        description: >-
                                          Optional human-readable description
                                          explaining the purpose of this
                                          metafield.
                                        example: >-
                                          The primary material used in this
                                          product
                                        type:
                                          - string
                                          - 'null'
                                      created_at:
                                        description: >-
                                          Timestamp when the metafield was
                                          created.
                                        example: '2021-01-01T00:00:00Z'
                                        type: string
                                        format: date-time
                                      updated_at:
                                        description: >-
                                          Timestamp when the metafield was last
                                          updated.
                                        example: '2021-01-01T00:00:00Z'
                                        type: string
                                        format: date-time
                                      locked:
                                        description: >-
                                          Whether this metafield is locked and
                                          cannot be updated or deleted directly.
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                          - 'null'
                                      metafield_definition:
                                        description: >-
                                          The definition that defines validation
                                          rules and structure for this metafield
                                        type:
                                          - 'null'
                                          - object
                                    required:
                                      - namespace
                                      - key
                                      - value
                                      - value_type
                                      - description
                                      - created_at
                                      - updated_at
                                      - metafield_definition
                            variant:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: Sample Variant
                                image_path:
                                  type:
                                    - string
                                    - 'null'
                                  example: /images/sample.png
                                image_url:
                                  type:
                                    - string
                                    - 'null'
                                  example: https://example.com/images/sample.png
                                primary_image:
                                  type:
                                    - string
                                    - 'null'
                                  example: https://example.com/images/primary.png
                                price:
                                  type:
                                    - string
                                    - 'null'
                                  example: '34.44'
                                price_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $34.44
                                sku:
                                  type:
                                    - string
                                    - 'null'
                                  example: SKU12345
                                options:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      title:
                                        type: string
                                        example: Size
                                      value:
                                        type: string
                                        example: XL
                      activities:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            user_id:
                              type: integer
                            relation_type:
                              type: string
                            relation_id:
                              type: integer
                            contact_id:
                              type:
                                - integer
                                - 'null'
                            title:
                              type: string
                              example: A new order has been placed
                            description:
                              type: string
                              example: Samantha Joseph placed an order on Vandelay Shop
                            formatted_description:
                              type: string
                              example: >-
                                Samantha Joseph placed an order on Vandelay Shop
                                recently
                            read_at:
                              type:
                                - string
                                - 'null'
                            slug:
                              type: string
                            company_id:
                              type: integer
                            created_at:
                              type: string
                      shipping_method:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: string
                            example: standard-shipping
                          title:
                            type: string
                            example: Standard Shipping
                          delivery_time_estimate:
                            type:
                              - string
                              - 'null'
                            example: 3-5 business days
                      payment_details:
                        type:
                          - object
                          - 'null'
                        properties:
                          source:
                            type: string
                            example: card
                          payment_type:
                            type: string
                          payment_title:
                            type: string
                          details:
                            type: object
                            properties:
                              card_type:
                                type: string
                                example: visa
                              card_brand:
                                type: string
                                example: Visa
                              last_four:
                                type: string
                                example: '1234'
                              logo_url:
                                type: string
                                example: >-
                                  https://assets.fluid.app/images/payment_icons/visa.svg
                      primary_domain_hostname:
                        type:
                          - string
                          - 'null'
                        example: fluid.com
                      company_subdomain:
                        type:
                          - string
                          - 'null'
                        example: myco
                      shipping_total:
                        type: string
                        example: '0.0'
                      shipping_total_for_display:
                        type: string
                        example: Free
                      ship_to:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      bill_to:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          first_name:
                            type:
                              - string
                              - 'null'
                            example: John
                          last_name:
                            type:
                              - string
                              - 'null'
                            example: Doe
                          address1:
                            type: string
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type: string
                            example: New York
                          state:
                            type: string
                            example: NY
                          postal_code:
                            type: string
                            example: '10001'
                          country_code:
                            type: string
                            example: US
                            description: >-
                              country_id takes precedence if both country_id and
                              country_code provided.
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                          default:
                            type: boolean
                            example: true
                      shipping_address:
                        type:
                          - object
                          - 'null'
                        properties:
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          address1:
                            type:
                              - string
                              - 'null'
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type:
                              - string
                              - 'null'
                            example: New York
                          state:
                            type:
                              - string
                              - 'null'
                            example: NY
                          postal_code:
                            type:
                              - string
                              - 'null'
                            example: '10001'
                          country_code:
                            type:
                              - string
                              - 'null'
                            example: US
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                      billing_address:
                        type:
                          - object
                          - 'null'
                        properties:
                          name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          address1:
                            type:
                              - string
                              - 'null'
                            example: 123 Main St
                          address2:
                            type:
                              - string
                              - 'null'
                            example: Apt 4B
                          address3:
                            type:
                              - string
                              - 'null'
                            example: Building 5
                          city:
                            type:
                              - string
                              - 'null'
                            example: New York
                          state:
                            type:
                              - string
                              - 'null'
                            example: NY
                          postal_code:
                            type:
                              - string
                              - 'null'
                            example: '10001'
                          country_code:
                            type:
                              - string
                              - 'null'
                            example: US
                          subdivision_code:
                            type:
                              - string
                              - 'null'
                            example: NY
                      warehouse_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      warehouse:
                        oneOf:
                          - title: Warehouse
                            type: object
                            properties:
                              id:
                                type: integer
                              name:
                                example: Central Distribution Center
                                type: string
                              active:
                                example: true
                                type: boolean
                              external_id:
                                example: WH-12345
                                type:
                                  - string
                                  - 'null'
                              metadata:
                                example:
                                  capacity:
                                    total_square_feet: 50000
                                  operations:
                                    staff_count: 15
                                    security_level: high
                                type: object
                            required:
                              - id
                              - name
                              - active
                              - metadata
                          - type: 'null'
                      company:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          primary_domain_hostname:
                            type:
                              - string
                              - 'null'
                            example: fluid.com
                          subdomain:
                            type:
                              - string
                              - 'null'
                            example: myco
                          logo_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/logo.png
                          fluid_shop:
                            type:
                              - string
                              - 'null'
                            example: https://fluid-sample-shop.fluid.com
                          collect_phone:
                            type: boolean
                            example: true
                          require_phone:
                            type: boolean
                            example: false
                          require_billing_zip:
                            type: boolean
                            example: false
                          checkout_primary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          checkout_primary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_button_color:
                            type:
                              - string
                              - 'null'
                            example: '#FFFFFF'
                          checkout_secondary_text_color:
                            type:
                              - string
                              - 'null'
                            example: '#000000'
                          favicon_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/favicon.ico
                          order_on_behalf:
                            type: boolean
                            example: false
                          use_juspay_gateway:
                            type: boolean
                            example: false
                          reward_points_enabled:
                            type: boolean
                            example: false
                      order_on_behalf_of:
                        type: boolean
                        example: true
                      volume_rep:
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type:
                              - integer
                              - 'null'
                            example: 1
                          email:
                            type:
                              - string
                              - 'null'
                            example: volume_rep@example.com
                          full_name:
                            type:
                              - string
                              - 'null'
                            example: John Doe
                          image_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/image.png
                      metadata:
                        type:
                          - object
                          - 'null'
                      metafields:
                        type: array
                        items:
                          title: LegacyMetafield
                          type: object
                          properties:
                            id:
                              type: integer
                            namespace:
                              description: >-
                                A container for related metafields. Commonly
                                used to group metafields by app or
                                functionality.
                              example: custom
                              type: string
                              maxLength: 20
                              pattern: ^[a-zA-Z0-9_]+$
                            key:
                              description: >-
                                The unique identifier for the metafield within
                                its namespace. Must be unique per namespace and
                                owner.
                              example: material
                              type: string
                              maxLength: 30
                              pattern: ^[a-zA-Z0-9_]+$
                            value:
                              description: >-
                                The actual data stored in the metafield. Type
                                depends on value_type.
                              example: cotton
                              type:
                                - string
                                - object
                            value_type:
                              description: >-
                                The data type that defines how the value should
                                be interpreted and validated.
                              example: single_line_text_field
                              type: string
                            description:
                              description: >-
                                Optional human-readable description explaining
                                the purpose of this metafield.
                              example: The primary material used in this product
                              type:
                                - string
                                - 'null'
                            owner_type:
                              description: >-
                                The type of resource that this metafield belongs
                                to (polymorphic association).
                              example: Product
                              type: string
                            owner_id:
                              description: >-
                                The ID of the specific resource that this
                                metafield belongs to.
                              example: 12345
                              type: integer
                            created_at:
                              description: Timestamp when the metafield was created.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            updated_at:
                              description: Timestamp when the metafield was last updated.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            metafield_definition:
                              title: MetafieldDefinition
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                company_id:
                                  description: >-
                                    The ID of the company that owns this
                                    metafield definition.
                                  example: 1
                                  type: integer
                                namespace:
                                  description: >-
                                    A container for related metafield
                                    definitions. Used to group definitions by
                                    app or functionality. Must be unique within
                                    company and owner_resource.
                                  example: product_details
                                  type: string
                                  maxLength: 20
                                  pattern: ^[a-zA-Z0-9_]+$
                                key:
                                  description: >-
                                    The unique identifier for the metafield
                                    definition within its namespace and
                                    owner_resource. Combined with namespace and
                                    owner_resource, this must be unique per
                                    company.
                                  example: material_type
                                  type: string
                                  maxLength: 30
                                  pattern: ^[a-zA-Z0-9_]+$
                                name:
                                  description: >-
                                    Human-readable display name for the
                                    metafield definition, shown in admin
                                    interfaces and forms.
                                  example: Material Type
                                  type: string
                                  maxLength: 100
                                description:
                                  description: >-
                                    Detailed explanation of what this metafield
                                    definition represents, how it should be
                                    used, and any special instructions for
                                    content creators.
                                  example: >-
                                    Specify the primary material composition of
                                    the product (e.g., cotton, polyester, silk).
                                    This will be displayed on the product detail
                                    page.
                                  type:
                                    - string
                                    - 'null'
                                value_type:
                                  description: >-
                                    The data type that defines how metafield
                                    values should be validated, stored, and
                                    displayed. Determines which validation rules
                                    are available.
                                  example: single_line_text_field
                                  type: string
                                validation_rules:
                                  description: >-
                                    JSON object containing validation
                                    constraints that will be applied to
                                    metafield values. Available rules depend on
                                    the value_type.
                                  example:
                                    choices:
                                      - cotton
                                      - polyester
                                      - silk
                                      - wool
                                      - linen
                                      - bamboo
                                    max: 50
                                    min: 2
                                  type:
                                    - object
                                    - 'null'
                                owner_resource:
                                  description: >-
                                    The type of resource (model class name) that
                                    metafields using this definition can be
                                    attached to. Must match the polymorphic
                                    owner_type.
                                  example: Product
                                  type: string
                                pinned:
                                  description: >-
                                    Whether this definition should be
                                    prominently displayed or prioritized in
                                    admin interfaces and forms.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                position:
                                  default: 0
                                  description: >-
                                    Sort order for displaying this definition
                                    relative to others in the same category and
                                    owner_resource. Lower numbers appear first.
                                  example: 1
                                  type:
                                    - integer
                                    - 'null'
                                locked:
                                  description: >-
                                    Whether this metafield definition is locked,
                                    preventing direct updates or deletions of
                                    metafields using this definition.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                created_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    created.
                                  example: '2024-01-15T10:30:00Z'
                                  type: string
                                  format: date-time
                                updated_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    last updated.
                                  example: '2024-02-20T14:45:00Z'
                                  type: string
                                  format: date-time
                                list_type:
                                  description: >-
                                    Whether this definition is for list-type
                                    metafields that store arrays of values.
                                  example: false
                                  type: boolean
                                reference_type:
                                  description: >-
                                    Whether this definition is for
                                    reference-type metafields that store
                                    references to other resources.
                                  example: false
                                  type: boolean
                                supported_validations:
                                  description: >-
                                    Array of validation rule names that are
                                    supported for this value_type.
                                  example:
                                    - min
                                    - max
                                    - choices
                                    - regex
                                  type: array
                                validation_description:
                                  description: >-
                                    Human-readable description of what the
                                    value_type represents and its constraints.
                                  example: Single line text up to 5000 characters
                                  type: string
                                category_ids:
                                  description: >-
                                    Array of category IDs that this metafield
                                    definition is associated with for
                                    organizational purposes.
                                  example:
                                    - 1
                                    - 2
                                    - 3
                                  items:
                                    type: integer
                                  type: array
                              required:
                                - id
                                - company_id
                                - namespace
                                - key
                                - name
                                - value_type
                                - owner_resource
                                - created_at
                                - updated_at
                                - list_type
                                - reference_type
                                - supported_validations
                                - validation_description
                                - category_ids
                          required:
                            - id
                            - namespace
                            - key
                            - value
                            - value_type
                            - owner_type
                            - owner_id
                            - created_at
                            - updated_at
                      source:
                        type: string
                        example: web
                        enum:
                          - mobile
                          - web
                          - admin
                          - backoffice
                          - subscription
                      split_payment:
                        type:
                          - object
                          - 'null'
                        description: Details about split payment if points were used
                      points_applied:
                        type: integer
                        example: 500
                        description: Total points used for this order
                      points_applied_amount_in_currency:
                        type: number
                        example: 5
                        description: Total points in currency amount used for this order
                      order_total_after_points_redemption:
                        type: number
                        example: 95
                        description: >-
                          The order total (actual card payment) after points
                          redemption
                      price_inclusive_of_tax:
                        type: boolean
                        example: true
                        description: Whether the price includes tax
                      price_inclusive_tax_name:
                        type:
                          - string
                          - 'null'
                        example: GST
                        description: Name of the tax if price is inclusive, e.g. VAT, GST
                      free_shipping:
                        type: boolean
                        example: false
                        description: Whether the order has free shipping
                      discount_codes:
                        type: array
                        items:
                          type: string
                        example:
                          - DISCOUNT1
                          - DISCOUNT2
                        description: Discount codes applied to the order
                    required:
                      - id
                      - currency_symbol
                      - total
                      - payment_status
                      - fulfillment_status
                      - delivery_status
                      - delivery_method
                      - channel
                      - tags
                      - items_count
                      - items
                      - payment_details
                      - ship_to
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                      shop_url:
                        type: string
                required:
                  - order
                  - meta
        '404':
          description: order not found
  /api/companies/{company_id}/owners:
    get:
      summary: List company owners
      tags:
        - Owners
      operationId: listCompanyOwners
      security:
        - bearer_auth: []
      parameters:
        - name: company_id
          in: path
          required: true
          example: 1
          schema:
            type: integer
      responses:
        '200':
          description: owners retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  owners:
                    type: array
                    items:
                      title: Company::Owner
                      type: object
                      properties:
                        id:
                          type: integer
                        entity_id:
                          example: 1
                          type: integer
                        full_name:
                          example: John Doe
                          type: string
                        native_name:
                          example: John Doe
                          type:
                            - string
                            - 'null'
                        position:
                          example: Chief Financial Officer
                          type:
                            - string
                            - 'null'
                        work_email:
                          example: john.doe@company.com
                          type: string
                        phone:
                          example: +1-555-123-4567
                          type:
                            - string
                            - 'null'
                        date_of_birth:
                          example: '1980-01-15'
                          type:
                            - string
                            - 'null'
                        place_of_birth:
                          example: New York
                          type:
                            - string
                            - 'null'
                        nationality:
                          example: US
                          type:
                            - string
                            - 'null'
                        country_iso:
                          example: US
                          type:
                            - string
                            - 'null'
                        street_address:
                          example: 123 Main St
                          type:
                            - string
                            - 'null'
                        city:
                          example: New York
                          type:
                            - string
                            - 'null'
                        state:
                          example: NY
                          type:
                            - string
                            - 'null'
                        postcode:
                          example: '10001'
                          type:
                            - string
                            - 'null'
                        identification_number:
                          example: 123-45-6789
                          type:
                            - string
                            - 'null'
                        is_managing_director:
                          example: false
                          type:
                            - boolean
                            - 'null'
                        is_beneficial_owner:
                          example: true
                          type:
                            - boolean
                            - 'null'
                        percent_ownership:
                          example: '25.5'
                          type:
                            - string
                            - 'null'
                        is_authorized_signatory:
                          example: false
                          type:
                            - boolean
                            - 'null'
                        government_issued_ids:
                          example:
                            - file_url: https://example.com/passport.pdf
                              file_name: passport.pdf
                              file_type: passport
                          type:
                            - array
                            - 'null'
                        proof_of_residence_file_url:
                          example: https://example.com/utility-bill.pdf
                          type:
                            - string
                            - 'null'
                        proof_of_residence_file_name:
                          example: utility-bill.pdf
                          type:
                            - string
                            - 'null'
                        created_at:
                          example: '2025-01-15T10:30:00Z'
                          type: string
                        updated_at:
                          example: '2025-01-15T10:30:00Z'
                          type: string
                      required:
                        - id
                        - entity_id
                        - full_name
                        - work_email
                        - created_at
                        - updated_at
                  meta:
                    type: object
                required:
                  - owners
                  - meta
        '401':
          description: unauthorized - company access denied
    post:
      summary: Create company owner
      tags:
        - Owners
      operationId: createCompanyOwner
      security:
        - bearer_auth: []
      parameters:
        - name: company_id
          in: path
          required: true
          example: 1
          schema:
            type: integer
      responses:
        '201':
          description: owner created
          content:
            application/json:
              schema:
                type: object
                properties:
                  owner:
                    title: Company::Owner
                    type: object
                    properties:
                      id:
                        type: integer
                      entity_id:
                        example: 1
                        type: integer
                      full_name:
                        example: John Doe
                        type: string
                      native_name:
                        example: John Doe
                        type:
                          - string
                          - 'null'
                      position:
                        example: Chief Financial Officer
                        type:
                          - string
                          - 'null'
                      work_email:
                        example: john.doe@company.com
                        type: string
                      phone:
                        example: +1-555-123-4567
                        type:
                          - string
                          - 'null'
                      date_of_birth:
                        example: '1980-01-15'
                        type:
                          - string
                          - 'null'
                      place_of_birth:
                        example: New York
                        type:
                          - string
                          - 'null'
                      nationality:
                        example: US
                        type:
                          - string
                          - 'null'
                      country_iso:
                        example: US
                        type:
                          - string
                          - 'null'
                      street_address:
                        example: 123 Main St
                        type:
                          - string
                          - 'null'
                      city:
                        example: New York
                        type:
                          - string
                          - 'null'
                      state:
                        example: NY
                        type:
                          - string
                          - 'null'
                      postcode:
                        example: '10001'
                        type:
                          - string
                          - 'null'
                      identification_number:
                        example: 123-45-6789
                        type:
                          - string
                          - 'null'
                      is_managing_director:
                        example: false
                        type:
                          - boolean
                          - 'null'
                      is_beneficial_owner:
                        example: true
                        type:
                          - boolean
                          - 'null'
                      percent_ownership:
                        example: '25.5'
                        type:
                          - string
                          - 'null'
                      is_authorized_signatory:
                        example: false
                        type:
                          - boolean
                          - 'null'
                      government_issued_ids:
                        example:
                          - file_url: https://example.com/passport.pdf
                            file_name: passport.pdf
                            file_type: passport
                        type:
                          - array
                          - 'null'
                      proof_of_residence_file_url:
                        example: https://example.com/utility-bill.pdf
                        type:
                          - string
                          - 'null'
                      proof_of_residence_file_name:
                        example: utility-bill.pdf
                        type:
                          - string
                          - 'null'
                      created_at:
                        example: '2025-01-15T10:30:00Z'
                        type: string
                      updated_at:
                        example: '2025-01-15T10:30:00Z'
                        type: string
                    required:
                      - id
                      - entity_id
                      - full_name
                      - work_email
                      - created_at
                      - updated_at
                  meta:
                    type: object
                required:
                  - owner
                  - meta
        '401':
          description: unauthorized - company access denied
        '422':
          description: validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Owner could not be created
                  errors:
                    type: object
                    example:
                      owner:
                        full_name:
                          - can't be blank
                  meta:
                    type: object
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                owner:
                  type: object
                  properties:
                    entity_id:
                      type: integer
                    full_name:
                      type: string
                    work_email:
                      type: string
                    phone:
                      type: string
                    native_name:
                      type: string
                    position:
                      type: string
                    date_of_birth:
                      type: string
                    place_of_birth:
                      type: string
                    nationality:
                      type: string
                    country_iso:
                      type: string
                    street_address:
                      type: string
                    city:
                      type: string
                    state:
                      type: string
                    postcode:
                      type: string
                    identification_number:
                      type: string
                    is_managing_director:
                      type: boolean
                    is_beneficial_owner:
                      type: boolean
                    percent_ownership:
                      type: number
                    is_authorized_signatory:
                      type: boolean
                    government_issued_ids:
                      type: array
                      items:
                        type: object
                        properties:
                          file_url:
                            type: string
                          file_name:
                            type: string
                          file_type:
                            type: string
                        required:
                          - file_url
                          - file_name
                    proof_of_residence_file_url:
                      type: string
                    proof_of_residence_file_name:
                      type: string
                  required:
                    - entity_id
                    - full_name
                    - work_email
                company_id:
                  type: integer
              required:
                - owner
                - company_id
  /api/companies/{company_id}/owners/{id}:
    get:
      summary: Get company owner
      tags:
        - Owners
      operationId: getCompanyOwner
      security:
        - bearer_auth: []
      parameters:
        - name: company_id
          in: path
          required: true
          example: 1
          schema:
            type: integer
        - name: id
          in: path
          required: true
          example: 1
          schema:
            type: integer
      responses:
        '200':
          description: owner retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  owner:
                    title: Company::Owner
                    type: object
                    properties:
                      id:
                        type: integer
                      entity_id:
                        example: 1
                        type: integer
                      full_name:
                        example: John Doe
                        type: string
                      native_name:
                        example: John Doe
                        type:
                          - string
                          - 'null'
                      position:
                        example: Chief Financial Officer
                        type:
                          - string
                          - 'null'
                      work_email:
                        example: john.doe@company.com
                        type: string
                      phone:
                        example: +1-555-123-4567
                        type:
                          - string
                          - 'null'
                      date_of_birth:
                        example: '1980-01-15'
                        type:
                          - string
                          - 'null'
                      place_of_birth:
                        example: New York
                        type:
                          - string
                          - 'null'
                      nationality:
                        example: US
                        type:
                          - string
                          - 'null'
                      country_iso:
                        example: US
                        type:
                          - string
                          - 'null'
                      street_address:
                        example: 123 Main St
                        type:
                          - string
                          - 'null'
                      city:
                        example: New York
                        type:
                          - string
                          - 'null'
                      state:
                        example: NY
                        type:
                          - string
                          - 'null'
                      postcode:
                        example: '10001'
                        type:
                          - string
                          - 'null'
                      identification_number:
                        example: 123-45-6789
                        type:
                          - string
                          - 'null'
                      is_managing_director:
                        example: false
                        type:
                          - boolean
                          - 'null'
                      is_beneficial_owner:
                        example: true
                        type:
                          - boolean
                          - 'null'
                      percent_ownership:
                        example: '25.5'
                        type:
                          - string
                          - 'null'
                      is_authorized_signatory:
                        example: false
                        type:
                          - boolean
                          - 'null'
                      government_issued_ids:
                        example:
                          - file_url: https://example.com/passport.pdf
                            file_name: passport.pdf
                            file_type: passport
                        type:
                          - array
                          - 'null'
                      proof_of_residence_file_url:
                        example: https://example.com/utility-bill.pdf
                        type:
                          - string
                          - 'null'
                      proof_of_residence_file_name:
                        example: utility-bill.pdf
                        type:
                          - string
                          - 'null'
                      created_at:
                        example: '2025-01-15T10:30:00Z'
                        type: string
                      updated_at:
                        example: '2025-01-15T10:30:00Z'
                        type: string
                    required:
                      - id
                      - entity_id
                      - full_name
                      - work_email
                      - created_at
                      - updated_at
                  meta:
                    type: object
                required:
                  - owner
                  - meta
        '401':
          description: unauthorized - company access denied
        '404':
          description: owner not found
    put:
      summary: Update company owner
      tags:
        - Owners
      operationId: updateCompanyOwner
      security:
        - bearer_auth: []
      parameters:
        - name: company_id
          in: path
          required: true
          example: 1
          schema:
            type: integer
        - name: id
          in: path
          required: true
          example: 1
          schema:
            type: integer
      responses:
        '200':
          description: owner updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  owner:
                    title: Company::Owner
                    type: object
                    properties:
                      id:
                        type: integer
                      entity_id:
                        example: 1
                        type: integer
                      full_name:
                        example: John Doe
                        type: string
                      native_name:
                        example: John Doe
                        type:
                          - string
                          - 'null'
                      position:
                        example: Chief Financial Officer
                        type:
                          - string
                          - 'null'
                      work_email:
                        example: john.doe@company.com
                        type: string
                      phone:
                        example: +1-555-123-4567
                        type:
                          - string
                          - 'null'
                      date_of_birth:
                        example: '1980-01-15'
                        type:
                          - string
                          - 'null'
                      place_of_birth:
                        example: New York
                        type:
                          - string
                          - 'null'
                      nationality:
                        example: US
                        type:
                          - string
                          - 'null'
                      country_iso:
                        example: US
                        type:
                          - string
                          - 'null'
                      street_address:
                        example: 123 Main St
                        type:
                          - string
                          - 'null'
                      city:
                        example: New York
                        type:
                          - string
                          - 'null'
                      state:
                        example: NY
                        type:
                          - string
                          - 'null'
                      postcode:
                        example: '10001'
                        type:
                          - string
                          - 'null'
                      identification_number:
                        example: 123-45-6789
                        type:
                          - string
                          - 'null'
                      is_managing_director:
                        example: false
                        type:
                          - boolean
                          - 'null'
                      is_beneficial_owner:
                        example: true
                        type:
                          - boolean
                          - 'null'
                      percent_ownership:
                        example: '25.5'
                        type:
                          - string
                          - 'null'
                      is_authorized_signatory:
                        example: false
                        type:
                          - boolean
                          - 'null'
                      government_issued_ids:
                        example:
                          - file_url: https://example.com/passport.pdf
                            file_name: passport.pdf
                            file_type: passport
                        type:
                          - array
                          - 'null'
                      proof_of_residence_file_url:
                        example: https://example.com/utility-bill.pdf
                        type:
                          - string
                          - 'null'
                      proof_of_residence_file_name:
                        example: utility-bill.pdf
                        type:
                          - string
                          - 'null'
                      created_at:
                        example: '2025-01-15T10:30:00Z'
                        type: string
                      updated_at:
                        example: '2025-01-15T10:30:00Z'
                        type: string
                    required:
                      - id
                      - entity_id
                      - full_name
                      - work_email
                      - created_at
                      - updated_at
                  meta:
                    type: object
                required:
                  - owner
                  - meta
        '401':
          description: unauthorized - company access denied
        '404':
          description: owner not found
        '422':
          description: validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Owner could not be created
                  errors:
                    type: object
                    example:
                      owner:
                        full_name:
                          - can't be blank
                  meta:
                    type: object
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                owner:
                  type: object
                  properties:
                    entity_id:
                      type: integer
                    full_name:
                      type: string
                    native_name:
                      type: string
                    position:
                      type: string
                    work_email:
                      type: string
                    phone:
                      type: string
                    date_of_birth:
                      type: string
                    place_of_birth:
                      type: string
                    nationality:
                      type: string
                    country_iso:
                      type: string
                    street_address:
                      type: string
                    city:
                      type: string
                    state:
                      type: string
                    postcode:
                      type: string
                    identification_number:
                      type: string
                    is_managing_director:
                      type: boolean
                    is_beneficial_owner:
                      type: boolean
                    percent_ownership:
                      type: number
                    is_authorized_signatory:
                      type: boolean
                    government_issued_ids:
                      type: array
                      items:
                        type: object
                        properties:
                          file_url:
                            type: string
                          file_name:
                            type: string
                          file_type:
                            type: string
                        required:
                          - file_url
                          - file_name
                    proof_of_residence_file_url:
                      type: string
                    proof_of_residence_file_name:
                      type: string
                  required: []
                company_id:
                  type: integer
                id:
                  type: integer
              required:
                - owner
                - company_id
                - id
    delete:
      summary: Delete company owner
      tags:
        - Owners
      operationId: deleteCompanyOwner
      security:
        - bearer_auth: []
      parameters:
        - name: company_id
          in: path
          required: true
          example: 1
          schema:
            type: integer
        - name: id
          in: path
          required: true
          example: 1
          schema:
            type: integer
      responses:
        '204':
          description: owner deleted
        '401':
          description: unauthorized - company access denied
        '404':
          description: owner not found
  /api/company/pages:
    get:
      summary: Retrieve a list of company pages
      description: >-
        Get all company pages for the current company, filtered by the current
        language.
      tags:
        - Pages
      operationId: listPages
      security:
        - bearer_auth: []
      parameters:
        - name: page_number
          in: query
          schema:
            type: integer
            default: 1
          required: false
          description: Page number for pagination
        - name: per_page
          in: query
          schema:
            type: integer
            default: 10
          required: false
          description: Number of records per page
        - name: by_metadata
          in: query
          schema:
            type: string
            default: '{}'
            format: json
          required: false
          description: Search JSON meta data
      responses:
        '200':
          description: pages retrieved
          content:
            application/json:
              schema:
                type: array
                items:
                  oneOf:
                    - type: object
                      properties:
                        pagination:
                          type: object
                          properties:
                            current:
                              type: integer
                            previous:
                              oneOf:
                                - type: integer
                                - type: 'null'
                            next:
                              oneOf:
                                - type: integer
                                - type: 'null'
                            per_page:
                              type: integer
                            pages:
                              type: integer
                            count:
                              type: integer
                    - type: object
                      properties:
                        items:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              title:
                                type: string
                                example: Page Title
                              slug:
                                type: string
                                example: page-title
                              label:
                                type:
                                  - string
                                  - 'null'
                                example: Trending
                              display_tag:
                                type:
                                  - string
                                  - 'null'
                                example: Display tag
                              share_link:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/page-title
                              active:
                                type: boolean
                                example: true
                              metadata:
                                type: object
                                description: >-
                                  A JSON object that can store any custom data
                                  structure.
                              preview_url:
                                type: string
                                example: https://example.com/page-title?preview=true
                              countries:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                    iso_name:
                                      type: string
                                    iso:
                                      type: string
                                    iso3:
                                      type: string
                                    name:
                                      type: string
                                    numcode:
                                      type: integer
                                    active:
                                      type: boolean
                                    currency_code:
                                      type: string
                                    currency_symbol:
                                      type: string
                                    separator:
                                      type: string
                                    delimiter:
                                      type: string
                                    address3:
                                      type: boolean
                                    default:
                                      type: boolean
                                    created_at:
                                      type: string
                                    updated_at:
                                      type: string
                                    geo_entity_id:
                                      type:
                                        - integer
                                        - 'null'
                                    settings:
                                      type:
                                        - object
                                        - 'null'
                                    tax_enabled:
                                      type:
                                        - boolean
                                        - 'null'
                                    tax_inclusive:
                                      type:
                                        - boolean
                                        - 'null'
                                    tax_standard_rate:
                                      type:
                                        - number
                                        - 'null'
                                    tax_name:
                                      type:
                                        - string
                                        - 'null'
                                    tax_local_name:
                                      type:
                                        - string
                                        - 'null'
                                    tax_local_abbreviation:
                                      type:
                                        - string
                                        - 'null'
                                    tax_provinces:
                                      type:
                                        - array
                                        - 'null'
                                    tax_rates:
                                      type:
                                        - array
                                        - 'null'
                                    tax_invoice_required:
                                      type:
                                        - boolean
                                        - 'null'
                                    checkout_requires_terms:
                                      type:
                                        - boolean
                                        - 'null'
                                    address_requires_province:
                                      type:
                                        - boolean
                                        - 'null'
                                    eu:
                                      type:
                                        - boolean
                                        - 'null'
                                    requires_3ds:
                                      type:
                                        - boolean
                                        - 'null'
                              stripped_description:
                                type:
                                  - string
                                  - 'null'
                                example: Page description
                              views:
                                type: integer
                                example: 100
                              leads:
                                type: integer
                                example: 10
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/image.jpg
                              source:
                                type:
                                  - string
                                  - 'null'
                                example: builder
                              publish:
                                type: boolean
                                example: true
                              prompts:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                    title:
                                      type: string
                                    content:
                                      type: string
                              html_code:
                                type: string
                              prompts_enabled:
                                type: boolean
                              json:
                                type:
                                  - string
                                  - 'null'
                              application_theme_template:
                                type:
                                  - object
                                  - 'null'
                                properties:
                                  id:
                                    type: integer
                                  name:
                                    type: string
                                  themeable_type:
                                    type: string
                                  content:
                                    type: string
                                  stylesheet:
                                    type:
                                      - string
                                      - 'null'
                                  status:
                                    type: string
                                  created_at:
                                    type: string
                                  updated_at:
                                    type: string
                                  script:
                                    type: object
                                  schema:
                                    type: object
                                  content_without_schema:
                                    type: string
                                  images:
                                    type: array
                                  metadata:
                                    type: object
                                  category:
                                    type:
                                      - string
                                      - 'null'
                              search_engine_optimizer:
                                type:
                                  - object
                                  - 'null'
                                properties:
                                  id:
                                    type: integer
                                  title:
                                    type: string
                                  description:
                                    type: string
                                  image_url:
                                    type: string
                              use_search_engine:
                                type: boolean
                              show_on_site_search:
                                type: boolean
                              email:
                                type:
                                  - string
                                  - 'null'
                              open_graph:
                                type:
                                  - object
                                  - 'null'
                                properties:
                                  id:
                                    type: integer
                                  title:
                                    type: string
                                  description:
                                    type: string
                                  image_url:
                                    type: string
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  data:
                    type: object
                    properties:
                      error:
                        type: string
                        example: >-
                          The value `{referred_by: {user: 'John},}` in parameter
                          `by_metadata` is not a valid JSON
    post:
      summary: Create a new page
      description: Create a new page
      tags:
        - Pages
      operationId: createPages
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: page created
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                    example: 1
                  title:
                    type: string
                    example: Page Title
                  slug:
                    type: string
                    example: page-title
                  label:
                    type:
                      - string
                      - 'null'
                    example: Trending
                  display_tag:
                    type:
                      - string
                      - 'null'
                    example: Display tag
                  share_link:
                    type:
                      - string
                      - 'null'
                    example: https://example.com/page-title
                  active:
                    type: boolean
                    example: true
                  metadata:
                    type: object
                    description: A JSON object that can store any custom data structure.
                  preview_url:
                    type: string
                    example: https://example.com/page-title?preview=true
                  countries:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        iso_name:
                          type: string
                        iso:
                          type: string
                        iso3:
                          type: string
                        name:
                          type: string
                        numcode:
                          type: integer
                        active:
                          type: boolean
                        currency_code:
                          type: string
                        currency_symbol:
                          type: string
                        separator:
                          type: string
                        delimiter:
                          type: string
                        address3:
                          type: boolean
                        default:
                          type: boolean
                        created_at:
                          type: string
                        updated_at:
                          type: string
                        geo_entity_id:
                          type:
                            - integer
                            - 'null'
                        settings:
                          type:
                            - object
                            - 'null'
                        tax_enabled:
                          type:
                            - boolean
                            - 'null'
                        tax_inclusive:
                          type:
                            - boolean
                            - 'null'
                        tax_standard_rate:
                          type:
                            - number
                            - 'null'
                        tax_name:
                          type:
                            - string
                            - 'null'
                        tax_local_name:
                          type:
                            - string
                            - 'null'
                        tax_local_abbreviation:
                          type:
                            - string
                            - 'null'
                        tax_provinces:
                          type:
                            - array
                            - 'null'
                        tax_rates:
                          type:
                            - array
                            - 'null'
                        tax_invoice_required:
                          type:
                            - boolean
                            - 'null'
                        checkout_requires_terms:
                          type:
                            - boolean
                            - 'null'
                        address_requires_province:
                          type:
                            - boolean
                            - 'null'
                        eu:
                          type:
                            - boolean
                            - 'null'
                        requires_3ds:
                          type:
                            - boolean
                            - 'null'
                  stripped_description:
                    type:
                      - string
                      - 'null'
                    example: Page description
                  views:
                    type: integer
                    example: 100
                  leads:
                    type: integer
                    example: 10
                  image_url:
                    type:
                      - string
                      - 'null'
                    example: https://example.com/image.jpg
                  source:
                    type:
                      - string
                      - 'null'
                    example: builder
                  publish:
                    type: boolean
                    example: true
                  prompts:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        title:
                          type: string
                        content:
                          type: string
                  html_code:
                    type: string
                  prompts_enabled:
                    type: boolean
                  json:
                    type:
                      - string
                      - 'null'
                  application_theme_template:
                    type:
                      - object
                      - 'null'
                    properties:
                      id:
                        type: integer
                      name:
                        type: string
                      themeable_type:
                        type: string
                      content:
                        type: string
                      stylesheet:
                        type:
                          - string
                          - 'null'
                      status:
                        type: string
                      created_at:
                        type: string
                      updated_at:
                        type: string
                      script:
                        type: object
                      schema:
                        type: object
                      content_without_schema:
                        type: string
                      images:
                        type: array
                      metadata:
                        type: object
                      category:
                        type:
                          - string
                          - 'null'
                  search_engine_optimizer:
                    type:
                      - object
                      - 'null'
                    properties:
                      id:
                        type: integer
                      title:
                        type: string
                      description:
                        type: string
                      image_url:
                        type: string
                  use_search_engine:
                    type: boolean
                  show_on_site_search:
                    type: boolean
                  email:
                    type:
                      - string
                      - 'null'
                  open_graph:
                    type:
                      - object
                      - 'null'
                    properties:
                      id:
                        type: integer
                      title:
                        type: string
                      description:
                        type: string
                      image_url:
                        type: string
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: object
                    properties:
                      title:
                        type: array
                        items:
                          type: string
                          example: can't be blank
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                page:
                  type: object
                  properties:
                    title:
                      type: string
                      example: Page Title
                    html_code:
                      type: string
                      example: <p>Page content</p>
                    publish:
                      type: boolean
                      example: true
                    image_url:
                      type:
                        - string
                        - 'null'
                      example: https://example.com/image.jpg
                    available_countries:
                      type: array
                      items:
                        type: string
                      example:
                        - US
                    metadata:
                      type: object
                      description: Can hold JSON object of arbitrary structure
                  required:
                    - title
                    - html_code
  /api/company/pages/{id}:
    get:
      summary: Retrieve a single company page
      description: Fetch a specific page by its ID for the current company.
      tags:
        - Pages
      operationId: showPage
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          description: Page's Id
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: page retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                    example: 1
                  title:
                    type: string
                    example: Page Title
                  slug:
                    type: string
                    example: page-title
                  label:
                    type:
                      - string
                      - 'null'
                    example: Trending
                  display_tag:
                    type:
                      - string
                      - 'null'
                    example: Display tag
                  share_link:
                    type:
                      - string
                      - 'null'
                    example: https://example.com/page-title
                  active:
                    type: boolean
                    example: true
                  metadata:
                    type: object
                    description: A JSON object that can store any custom data structure.
                  preview_url:
                    type: string
                    example: https://example.com/page-title?preview=true
                  countries:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        iso_name:
                          type: string
                        iso:
                          type: string
                        iso3:
                          type: string
                        name:
                          type: string
                        numcode:
                          type: integer
                        active:
                          type: boolean
                        currency_code:
                          type: string
                        currency_symbol:
                          type: string
                        separator:
                          type: string
                        delimiter:
                          type: string
                        address3:
                          type: boolean
                        default:
                          type: boolean
                        created_at:
                          type: string
                        updated_at:
                          type: string
                        geo_entity_id:
                          type:
                            - integer
                            - 'null'
                        settings:
                          type:
                            - object
                            - 'null'
                        tax_enabled:
                          type:
                            - boolean
                            - 'null'
                        tax_inclusive:
                          type:
                            - boolean
                            - 'null'
                        tax_standard_rate:
                          type:
                            - number
                            - 'null'
                        tax_name:
                          type:
                            - string
                            - 'null'
                        tax_local_name:
                          type:
                            - string
                            - 'null'
                        tax_local_abbreviation:
                          type:
                            - string
                            - 'null'
                        tax_provinces:
                          type:
                            - array
                            - 'null'
                        tax_rates:
                          type:
                            - array
                            - 'null'
                        tax_invoice_required:
                          type:
                            - boolean
                            - 'null'
                        checkout_requires_terms:
                          type:
                            - boolean
                            - 'null'
                        address_requires_province:
                          type:
                            - boolean
                            - 'null'
                        eu:
                          type:
                            - boolean
                            - 'null'
                        requires_3ds:
                          type:
                            - boolean
                            - 'null'
                  stripped_description:
                    type:
                      - string
                      - 'null'
                    example: Page description
                  views:
                    type: integer
                    example: 100
                  leads:
                    type: integer
                    example: 10
                  image_url:
                    type:
                      - string
                      - 'null'
                    example: https://example.com/image.jpg
                  source:
                    type:
                      - string
                      - 'null'
                    example: builder
                  publish:
                    type: boolean
                    example: true
                  prompts:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        title:
                          type: string
                        content:
                          type: string
                  html_code:
                    type: string
                  prompts_enabled:
                    type: boolean
                  json:
                    type:
                      - string
                      - 'null'
                  application_theme_template:
                    type:
                      - object
                      - 'null'
                    properties:
                      id:
                        type: integer
                      name:
                        type: string
                      themeable_type:
                        type: string
                      content:
                        type: string
                      stylesheet:
                        type:
                          - string
                          - 'null'
                      status:
                        type: string
                      created_at:
                        type: string
                      updated_at:
                        type: string
                      script:
                        type: object
                      schema:
                        type: object
                      content_without_schema:
                        type: string
                      images:
                        type: array
                      metadata:
                        type: object
                      category:
                        type:
                          - string
                          - 'null'
                  search_engine_optimizer:
                    type:
                      - object
                      - 'null'
                    properties:
                      id:
                        type: integer
                      title:
                        type: string
                      description:
                        type: string
                      image_url:
                        type: string
                  use_search_engine:
                    type: boolean
                  show_on_site_search:
                    type: boolean
                  email:
                    type:
                      - string
                      - 'null'
                  open_graph:
                    type:
                      - object
                      - 'null'
                    properties:
                      id:
                        type: integer
                      title:
                        type: string
                      description:
                        type: string
                      image_url:
                        type: string
        '404':
          description: page not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: string
    put:
      summary: Update a company page
      description: Update the details of a specific company page.
      tags:
        - Pages
      operationId: updatePage
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          description: Page's Id
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: page updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                    example: 1
                  title:
                    type: string
                    example: Page Title
                  slug:
                    type: string
                    example: page-title
                  label:
                    type:
                      - string
                      - 'null'
                    example: Trending
                  display_tag:
                    type:
                      - string
                      - 'null'
                    example: Display tag
                  share_link:
                    type:
                      - string
                      - 'null'
                    example: https://example.com/page-title
                  active:
                    type: boolean
                    example: true
                  metadata:
                    type: object
                    description: A JSON object that can store any custom data structure.
                  preview_url:
                    type: string
                    example: https://example.com/page-title?preview=true
                  countries:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        iso_name:
                          type: string
                        iso:
                          type: string
                        iso3:
                          type: string
                        name:
                          type: string
                        numcode:
                          type: integer
                        active:
                          type: boolean
                        currency_code:
                          type: string
                        currency_symbol:
                          type: string
                        separator:
                          type: string
                        delimiter:
                          type: string
                        address3:
                          type: boolean
                        default:
                          type: boolean
                        created_at:
                          type: string
                        updated_at:
                          type: string
                        geo_entity_id:
                          type:
                            - integer
                            - 'null'
                        settings:
                          type:
                            - object
                            - 'null'
                        tax_enabled:
                          type:
                            - boolean
                            - 'null'
                        tax_inclusive:
                          type:
                            - boolean
                            - 'null'
                        tax_standard_rate:
                          type:
                            - number
                            - 'null'
                        tax_name:
                          type:
                            - string
                            - 'null'
                        tax_local_name:
                          type:
                            - string
                            - 'null'
                        tax_local_abbreviation:
                          type:
                            - string
                            - 'null'
                        tax_provinces:
                          type:
                            - array
                            - 'null'
                        tax_rates:
                          type:
                            - array
                            - 'null'
                        tax_invoice_required:
                          type:
                            - boolean
                            - 'null'
                        checkout_requires_terms:
                          type:
                            - boolean
                            - 'null'
                        address_requires_province:
                          type:
                            - boolean
                            - 'null'
                        eu:
                          type:
                            - boolean
                            - 'null'
                        requires_3ds:
                          type:
                            - boolean
                            - 'null'
                  stripped_description:
                    type:
                      - string
                      - 'null'
                    example: Page description
                  views:
                    type: integer
                    example: 100
                  leads:
                    type: integer
                    example: 10
                  image_url:
                    type:
                      - string
                      - 'null'
                    example: https://example.com/image.jpg
                  source:
                    type:
                      - string
                      - 'null'
                    example: builder
                  publish:
                    type: boolean
                    example: true
                  prompts:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        title:
                          type: string
                        content:
                          type: string
                  html_code:
                    type: string
                  prompts_enabled:
                    type: boolean
                  json:
                    type:
                      - string
                      - 'null'
                  application_theme_template:
                    type:
                      - object
                      - 'null'
                    properties:
                      id:
                        type: integer
                      name:
                        type: string
                      themeable_type:
                        type: string
                      content:
                        type: string
                      stylesheet:
                        type:
                          - string
                          - 'null'
                      status:
                        type: string
                      created_at:
                        type: string
                      updated_at:
                        type: string
                      script:
                        type: object
                      schema:
                        type: object
                      content_without_schema:
                        type: string
                      images:
                        type: array
                      metadata:
                        type: object
                      category:
                        type:
                          - string
                          - 'null'
                  search_engine_optimizer:
                    type:
                      - object
                      - 'null'
                    properties:
                      id:
                        type: integer
                      title:
                        type: string
                      description:
                        type: string
                      image_url:
                        type: string
                  use_search_engine:
                    type: boolean
                  show_on_site_search:
                    type: boolean
                  email:
                    type:
                      - string
                      - 'null'
                  open_graph:
                    type:
                      - object
                      - 'null'
                    properties:
                      id:
                        type: integer
                      title:
                        type: string
                      description:
                        type: string
                      image_url:
                        type: string
        '400':
          description: invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: object
                    example:
                      title:
                        - can't be blank
                      html_code:
                        - can't be blank
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                page:
                  type: object
                  properties:
                    title:
                      type: string
                      example: Updated Title
                    html_code:
                      type: string
                      example: <p>Updated content</p>
                    publish:
                      type: boolean
                      example: true
                    metadata:
                      type: object
                      description: Can hold JSON object of arbitrary structure
                  required:
                    - title
    delete:
      summary: Delete a company page
      description: Delete a specific page for the current company.
      tags:
        - Pages
      operationId: deletePage
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          description: Page's Id
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: page deleted
        '404':
          description: page not found
  /api/company/pages/{id}/send_to_top:
    get:
      summary: Send a page to the top
      description: >-
        Mark a specific company page as prioritized and send it to the top of
        the list.
      tags:
        - Pages
      operationId: sendToTopPage
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          description: Page's Id
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: page sent to top
        '500':
          description: server error
  /api/company/pages/{id}/duplicate:
    get:
      summary: Duplicate a page
      description: Create a duplicate of an existing company page.
      tags:
        - Pages
      operationId: duplicatePage
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          description: Page's Id
          required: true
          schema:
            type: integer
        - name: lang
          in: query
          description: Language code for the duplicated page
          schema:
            type: string
      responses:
        '200':
          description: page duplicated
        '400':
          description: missing language parameter
  /api/company/pages/{id}/append_metadata:
    patch:
      summary: Append metadata field
      tags:
        - Pages
      operationId: pageAppendMetadataField
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Page's Id
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  data:
                    type: object
                    properties:
                      page:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          title:
                            type: string
                            example: Page Title
                          slug:
                            type: string
                            example: page-title
                          label:
                            type:
                              - string
                              - 'null'
                            example: Trending
                          display_tag:
                            type:
                              - string
                              - 'null'
                            example: Display tag
                          share_link:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/page-title
                          active:
                            type: boolean
                            example: true
                          metadata:
                            type: object
                            description: >-
                              A JSON object that can store any custom data
                              structure.
                          preview_url:
                            type: string
                            example: https://example.com/page-title?preview=true
                          countries:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                iso_name:
                                  type: string
                                iso:
                                  type: string
                                iso3:
                                  type: string
                                name:
                                  type: string
                                numcode:
                                  type: integer
                                active:
                                  type: boolean
                                currency_code:
                                  type: string
                                currency_symbol:
                                  type: string
                                separator:
                                  type: string
                                delimiter:
                                  type: string
                                address3:
                                  type: boolean
                                default:
                                  type: boolean
                                created_at:
                                  type: string
                                updated_at:
                                  type: string
                                geo_entity_id:
                                  type:
                                    - integer
                                    - 'null'
                                settings:
                                  type:
                                    - object
                                    - 'null'
                                tax_enabled:
                                  type:
                                    - boolean
                                    - 'null'
                                tax_inclusive:
                                  type:
                                    - boolean
                                    - 'null'
                                tax_standard_rate:
                                  type:
                                    - number
                                    - 'null'
                                tax_name:
                                  type:
                                    - string
                                    - 'null'
                                tax_local_name:
                                  type:
                                    - string
                                    - 'null'
                                tax_local_abbreviation:
                                  type:
                                    - string
                                    - 'null'
                                tax_provinces:
                                  type:
                                    - array
                                    - 'null'
                                tax_rates:
                                  type:
                                    - array
                                    - 'null'
                                tax_invoice_required:
                                  type:
                                    - boolean
                                    - 'null'
                                checkout_requires_terms:
                                  type:
                                    - boolean
                                    - 'null'
                                address_requires_province:
                                  type:
                                    - boolean
                                    - 'null'
                                eu:
                                  type:
                                    - boolean
                                    - 'null'
                                requires_3ds:
                                  type:
                                    - boolean
                                    - 'null'
                          stripped_description:
                            type:
                              - string
                              - 'null'
                            example: Page description
                          views:
                            type: integer
                            example: 100
                          leads:
                            type: integer
                            example: 10
                          image_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/image.jpg
                          source:
                            type:
                              - string
                              - 'null'
                            example: builder
                          publish:
                            type: boolean
                            example: true
                          prompts:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                title:
                                  type: string
                                content:
                                  type: string
                          html_code:
                            type: string
                          prompts_enabled:
                            type: boolean
                          json:
                            type:
                              - string
                              - 'null'
                          application_theme_template:
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                              name:
                                type: string
                              themeable_type:
                                type: string
                              content:
                                type: string
                              stylesheet:
                                type:
                                  - string
                                  - 'null'
                              status:
                                type: string
                              created_at:
                                type: string
                              updated_at:
                                type: string
                              script:
                                type: object
                              schema:
                                type: object
                              content_without_schema:
                                type: string
                              images:
                                type: array
                              metadata:
                                type: object
                              category:
                                type:
                                  - string
                                  - 'null'
                          search_engine_optimizer:
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                              title:
                                type: string
                              description:
                                type: string
                              image_url:
                                type: string
                          use_search_engine:
                            type: boolean
                          show_on_site_search:
                            type: boolean
                          email:
                            type:
                              - string
                              - 'null'
                          open_graph:
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                              title:
                                type: string
                              description:
                                type: string
                              image_url:
                                type: string
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                metadata:
                  type: object
                  description: >-
                    A JSON object that can store any custom data structure. When
                    provided, merges with existing metadata data.
              required:
                - metadata
  /api/v202506/pages:
    get:
      summary: List pages
      description: Get a list of pages with optional filtering and sorting
      tags:
        - Pages
      operationId: listPagesApi
      security:
        - bearer_auth: []
      parameters:
        - name: sorted_by
          in: query
          required: false
          schema:
            type: string
            enum:
              - priority_asc
              - priority_desc
              - title_asc
              - title_desc
              - updated_at_asc
              - updated_at_desc
              - views_asc
              - views_desc
              - leads_admin_asc
              - leads_admin_desc
              - created_at_asc
              - created_at_desc
              - status_asc
              - status_desc
            default: priority_desc
            description: >-
              Sort field and direction (leads_user_{user_id}_asc and
              leads_user_{user_id}_desc are also supported)
        - name: search_query
          in: query
          required: false
          schema:
            type: string
            description: Search term to filter pages by title or slug
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - active
              - draft
            description: Filter pages by publish status
        - name: with_tag_id
          in: query
          required: false
          schema:
            type: integer
            description: Filter pages by tag ID
        - name: with_category_id
          in: query
          required: false
          schema:
            type: integer
            description: Filter pages by category ID
        - name: country_id
          in: query
          required: false
          schema:
            type: integer
            description: Filter pages by country ID
        - name: by_language
          in: query
          required: false
          schema:
            type: string
            description: Filter pages by language code (e.g., 'en', 'es')
        - name: page
          in: query
          required: false
          schema:
            type: integer
            default: 1
            description: Page number for pagination
        - name: per_page
          in: query
          required: false
          schema:
            type: integer
            default: 20
            description: Number of items per page
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 1
                          description: Unique identifier for the page
                        title:
                          type: string
                          example: New Page
                          description: Title of the page
                        slug:
                          type: string
                          example: new-page
                          description: URL-friendly version of the title
                        active:
                          type: boolean
                          example: true
                          description: Whether the page is currently active
                        views:
                          type: integer
                          example: 0
                          description: Number of times the page has been viewed
                        leads:
                          type: integer
                          example: 0
                          description: Number of leads generated from the page
                        source:
                          type: string
                          example: builder
                          description: Origin or tool used to create the page
                        created_at:
                          type: string
                          example: '2021-01-01T00:00:00Z'
                          description: Date and time when the page was created
                        updated_at:
                          type: string
                          example: '2021-01-01T00:00:00Z'
                          description: Date and time when the page was last updated
                        image_url:
                          type: string
                          example: https://example.com/image.jpg
                          description: URL of the page's featured image
                        metadata:
                          type: object
                          example: {}
                          description: Additional data associated with the page
                        publish:
                          type: boolean
                          example: true
                          description: Whether the page is published
                        publish_at:
                          type:
                            - string
                            - 'null'
                          example: '2025-01-01T00:00:00Z'
                          description: Scheduled date and time for the page to go live
                        prompts_enabled:
                          type: boolean
                          example: true
                          description: Whether prompts are enabled on the page
                        default:
                          type: boolean
                          example: false
                          description: Whether this is the default page
                        use_for_enrollment_completion:
                          type: boolean
                          example: false
                          description: Whether the page is used for enrollment completion
                        use_search_engine:
                          type: boolean
                          example: true
                          description: Whether the page should be indexed by search engines
                        show_on_site_search:
                          type: boolean
                          example: true
                          description: Whether the page appears in site search results
                        email:
                          type:
                            - string
                            - 'null'
                          example: page@example.com
                          description: Email address associated with the page
                        page_content:
                          type:
                            - string
                            - 'null'
                          example: <h1>Hello, world!</h1>
                          description: Content of the page
                        application_theme_template_id:
                          type:
                            - integer
                            - 'null'
                          example: 1
                          description: >-
                            ID of the application theme template used for the
                            page
                        application_theme_id:
                          type:
                            - integer
                            - 'null'
                          example: 1
                          description: ID of the application theme used for the page
                        url:
                          type:
                            - string
                            - 'null'
                          example: https://acme.com/home/page/acme-page
                          description: URL of the page
                        custom_slug:
                          type: boolean
                          example: false
                          description: >-
                            Whether the page uses a custom slug instead of
                            auto-generated one
                      required:
                        - id
                        - title
                        - slug
                    description: List of pages
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        description: Unique identifier for the request
                      timestamp:
                        type: string
                        description: Time when the request was processed
                      pagination:
                        type: object
                        properties:
                          current_page:
                            type: integer
                            description: Current page number in the pagination
                          total_pages:
                            type: integer
                            description: Total number of pages available
                          total_count:
                            type: integer
                            description: Total number of items across all pages
                          per_page:
                            type: integer
                            description: Number of items per page
                        description: Pagination information for the response
                    description: Metadata about the request and response
                description: Successful response with pages list and metadata
    post:
      summary: Creates a page
      description: Create a new page
      tags:
        - Pages
      operationId: createPageApi
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: page created with content, variables, and stylesheet
        '422':
          description: missing page parameter
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                page:
                  type: object
                  properties:
                    title:
                      type: string
                      example: New Page
                      description: Title of the page
                    label:
                      type:
                        - string
                        - 'null'
                      example: Featured
                      description: Label for categorizing the page
                    display_tag:
                      type:
                        - string
                        - 'null'
                      example: Tag
                      description: Tag to be displayed on the page
                    stripped_description:
                      type:
                        - string
                        - 'null'
                      example: Page description
                      description: Plain text description without formatting
                    image_url:
                      type:
                        - string
                        - 'null'
                      example: https://example.com/image.jpg
                      description: URL of the page's featured image
                    source:
                      type:
                        - string
                        - 'null'
                      example: builder
                      description: Origin or tool used to create the page
                    publish:
                      type: boolean
                      example: true
                      description: Whether the page is published
                    prompts_enabled:
                      type: boolean
                      example: true
                      description: Whether prompts are enabled on the page
                    json:
                      type:
                        - string
                        - 'null'
                      example: '{}'
                      description: JSON data associated with the page
                    use_search_engine:
                      type: boolean
                      example: true
                      description: Whether the page should be indexed by search engines
                    show_on_site_search:
                      type: boolean
                      example: true
                      description: Whether the page appears in site search results
                    email:
                      type:
                        - string
                        - 'null'
                      example: page@example.com
                      description: Email address associated with the page
                    page_content:
                      type:
                        - string
                        - 'null'
                      example: <h1>Hello, world!</h1>
                      description: Content of the page
                    countries:
                      type: array
                      items:
                        type: string
                        example: US
                      description: List of country codes where the page is available
                    metadata:
                      type: object
                      example:
                        key: value
                      description: Additional data associated with the page
                    search_engine_optimizer:
                      type: object
                      properties:
                        title:
                          type: string
                          example: SEO Title
                          description: Page title optimized for search engines
                        description:
                          type: string
                          example: SEO Description
                          description: Page description optimized for search engines
                        image_url:
                          type: string
                          example: https://example.com/seo-image.jpg
                          description: Image URL optimized for search engines
                      description: SEO settings for the page
                    open_graph:
                      type: object
                      properties:
                        title:
                          type: string
                          example: OG Title
                          description: Title for Open Graph sharing
                        description:
                          type: string
                          example: OG Description
                          description: Description for Open Graph sharing
                        image_url:
                          type: string
                          example: https://example.com/og-image.jpg
                          description: Image URL for Open Graph sharing
                      description: Open Graph metadata for social media sharing
                    content:
                      type:
                        - string
                        - 'null'
                      example: <h1>Hello, world!</h1>
                      description: HTML content of the page
                    variables:
                      type:
                        - object
                        - 'null'
                      example:
                        company_name: ACME Inc.
                        site_url: https://example.com
                        current_year: '2025'
                      description: Variables for dynamic content substitution
                    stylesheet:
                      type:
                        - string
                        - 'null'
                      example: '<style>body { background-color: #f0f0f0; }</style>'
                      description: Custom CSS styling for the page
                    translations:
                      type:
                        - object
                        - 'null'
                      example:
                        en:
                          hello: Hello
                        fr:
                          hello: Bonjour
                      description: Translations for the page
                    taggings_attributes:
                      type: array
                      items:
                        type: object
                        properties:
                          tag_id:
                            type: integer
                            example: 1
                            description: ID of the tag to associate with the page
                      description: Tags to associate with the page
                  description: Page attributes
              description: Create request payload
        required: true
  /api/v202506/pages/{id}:
    get:
      summary: Retrieves a page
      description: Get a specific page by ID
      tags:
        - Pages
      operationId: getPageApi
      security:
        - bearer_auth: []
      responses:
        '200':
          description: page found
          content:
            application/json:
              schema:
                type: object
                properties:
                  item:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                        description: Unique identifier for the page
                      title:
                        type: string
                        example: New Page
                        description: Title of the page
                      slug:
                        type: string
                        example: new-page
                        description: URL-friendly version of the title
                      share_link:
                        type:
                          - string
                          - 'null'
                        example: https://example.com/p/abc123
                        description: Public shareable URL for the page
                      active:
                        type: boolean
                        example: true
                        description: Whether the page is currently active
                      stripped_description:
                        type:
                          - string
                          - 'null'
                        example: This is a page description
                        description: Plain text description of the page without formatting
                      views:
                        type: integer
                        example: 0
                        description: Number of times the page has been viewed
                      leads:
                        type: integer
                        example: 0
                        description: Number of leads generated from the page
                      image_url:
                        type: string
                        example: https://example.com/image.jpg
                        description: URL of the page's featured image
                      metadata:
                        type: object
                        example: {}
                        description: Additional data associated with the page
                      publish:
                        type: boolean
                        example: true
                        description: Whether the page is published
                      publish_at:
                        type:
                          - string
                          - 'null'
                        example: '2025-01-01T00:00:00Z'
                        description: Scheduled date and time for the page to go live
                      label:
                        type:
                          - string
                          - 'null'
                        example: Featured
                        description: Label for categorizing the page
                      display_tag:
                        type:
                          - string
                          - 'null'
                        example: Tag
                        description: Tag displayed on the page
                      prompts_enabled:
                        type: boolean
                        example: true
                        description: Whether prompts are enabled on the page
                      default:
                        type: boolean
                        example: false
                        description: Whether this is the default page
                      use_for_enrollment_completion:
                        type: boolean
                        example: false
                        description: Whether the page is used for enrollment completion
                      use_search_engine:
                        type: boolean
                        example: true
                        description: Whether the page should be indexed by search engines
                      show_on_site_search:
                        type: boolean
                        example: true
                        description: Whether the page appears in site search results
                      email:
                        type:
                          - string
                          - 'null'
                        example: page@example.com
                        description: Email address associated with the page
                      application_theme_template_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                        description: ID of the application theme template used for the page
                      application_theme_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                        description: ID of the application theme used for the page
                      created_at:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                        description: Date and time when the page was created
                      updated_at:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                        description: Date and time when the page was last updated
                      url:
                        type: string
                        example: https://example.com/page
                        description: URL of the page
                      page_content:
                        type:
                          - string
                          - 'null'
                        example: <h1>Hello, world!</h1>
                        description: Content of the page
                      prompts:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 39
                            content:
                              type: string
                              example: Check out this product
                            title:
                              type: string
                              example: Social Media
                        description: List of prompts configured for the page
                      source:
                        type: string
                        example: builder
                        description: Origin or tool used to create the page
                      countries:
                        type: array
                        description: List of countries where the page is available
                      open_graph:
                        type:
                          - object
                          - 'null'
                        properties:
                          title:
                            type: string
                            example: OG Title
                          description:
                            type: string
                            example: OG Description
                          image_url:
                            type: string
                            example: https://example.com/og-image.jpg
                        description: Open Graph metadata for social sharing
                      search_engine_optimizer:
                        type:
                          - object
                          - 'null'
                        properties:
                          title:
                            type: string
                            example: SEO Title
                          description:
                            type: string
                            example: SEO Description
                          image_url:
                            type: string
                            example: https://example.com/seo-image.jpg
                        description: SEO settings for the page
                      custom_slug:
                        type: boolean
                        example: false
                        description: >-
                          Whether the page uses a custom slug instead of
                          auto-generated one
                    required:
                      - id
                      - title
                      - slug
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        description: Unique identifier for the request
                      timestamp:
                        type: string
                        description: Time when the request was processed
                    required:
                      - request_id
                      - timestamp
                    description: Metadata about the request and response
                description: Successful response with page details and metadata
        '404':
          description: not found
    put:
      summary: Updates a page
      description: Update an existing page
      tags:
        - Pages
      operationId: updatePageApi
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: page updated with tag removed
        '404':
          description: not found
        '422':
          description: page parameter missing
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                page:
                  type: object
                  properties:
                    title:
                      type: string
                      example: Updated Page
                      description: Title of the page
                    label:
                      type:
                        - string
                        - 'null'
                      example: Trending
                      description: Label for categorizing the page
                    display_tag:
                      type:
                        - string
                        - 'null'
                      example: Display tag
                      description: Tag to be displayed on the page
                    stripped_description:
                      type:
                        - string
                        - 'null'
                      example: Updated description
                      description: Plain text description without formatting
                    image_url:
                      type:
                        - string
                        - 'null'
                      example: https://example.com/image.jpg
                      description: URL of the page's featured image
                    source:
                      type:
                        - string
                        - 'null'
                      example: builder
                      description: Origin or tool used to create the page
                    publish:
                      type: boolean
                      example: true
                      description: Whether the page is published
                    prompts_enabled:
                      type: boolean
                      example: true
                      description: Whether prompts are enabled on the page
                    json:
                      type:
                        - string
                        - 'null'
                      example: '{}'
                      description: JSON data associated with the page
                    use_search_engine:
                      type: boolean
                      example: true
                      description: Whether the page should be indexed by search engines
                    show_on_site_search:
                      type: boolean
                      example: true
                      description: Whether the page appears in site search results
                    email:
                      type:
                        - string
                        - 'null'
                      example: page@example.com
                      description: Email address associated with the page
                    countries:
                      type: array
                      items:
                        type: string
                        example: US
                      description: List of country codes where the page is available
                    metadata:
                      type: object
                      example:
                        key: value
                      description: Additional data associated with the page
                    search_engine_optimizer:
                      type: object
                      properties:
                        title:
                          type: string
                          example: SEO Title
                          description: Page title optimized for search engines
                        description:
                          type: string
                          example: SEO Description
                          description: Page description optimized for search engines
                        image_url:
                          type: string
                          example: https://example.com/seo-image.jpg
                          description: Image URL optimized for search engines
                      description: SEO settings for the page
                    open_graph:
                      type: object
                      properties:
                        title:
                          type: string
                          example: OG Title
                          description: Title for Open Graph sharing
                        description:
                          type: string
                          example: OG Description
                          description: Description for Open Graph sharing
                        image_url:
                          type: string
                          example: https://example.com/og-image.jpg
                          description: Image URL for Open Graph sharing
                      description: Open Graph metadata for social media sharing
                    content:
                      type:
                        - string
                        - 'null'
                      example: <h1>Hello, world!</h1>
                      description: HTML content of the page
                    variables:
                      type:
                        - object
                        - 'null'
                      example:
                        company_name: ACME Inc.
                        site_url: https://example.com
                        current_year: '2025'
                      description: Variables for dynamic content substitution
                    stylesheet:
                      type:
                        - string
                        - 'null'
                      example: '<style>body { background-color: #f0f0f0; }</style>'
                      description: Custom CSS styling for the page
                  description: Page attributes to update
              description: Update request payload
        required: true
    delete:
      summary: Deletes a page
      description: Delete a page
      tags:
        - Pages
      operationId: deletePageApi
      security:
        - bearer_auth: []
      responses:
        '200':
          description: page deleted
        '404':
          description: not found
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
  /api/v202506/pages/{id}/clone:
    post:
      summary: Clones a page
      description: Clone an existing page
      tags:
        - Pages
      operationId: clonePageApi
      security:
        - bearer_auth: []
      responses:
        '201':
          description: page cloned
        '404':
          description: not found
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
  /api/v202506/pages/{id}/views:
    get:
      summary: Get page views
      description: Get views for a specific page
      tags:
        - Pages
      operationId: getPageViewsApi
      security:
        - bearer_auth: []
      responses:
        '200':
          description: returns views when page has views
        '404':
          description: page not found
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
  /api/v202506/pages/{id}/leads:
    get:
      summary: Get page leads
      description: Get leads for a specific page
      tags:
        - Pages
      operationId: getPageLeadsApi
      security:
        - bearer_auth: []
      responses:
        '200':
          description: returns structured contact data
        '404':
          description: page not found
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
  /api/v202506/pages/bulk_status_update:
    patch:
      summary: Bulk update page statuses
      description: Update status for multiple pages
      tags:
        - Pages
      operationId: bulkUpdatePageStatusesApi
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: successful with delete status
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Pages were successfully deleted.
                    description: Success message
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        description: Unique identifier for the request
                      timestamp:
                        type: string
                        description: Time when the request was processed
                    description: Metadata about the request and response
                description: Successful bulk delete response
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Error while updating pages.
                    description: Error message describing what went wrong
                  errors:
                    type: object
                    properties:
                      bulk_update:
                        type: array
                        items:
                          type: string
                          example: failed
                        description: List of error messages related to the bulk update
                    description: Detailed error information
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        description: Unique identifier for the request
                      timestamp:
                        type: string
                        description: Time when the request was processed
                    description: Metadata about the request and response
                description: Error response for bulk update
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                status:
                  type: string
                  enum:
                    - active
                    - draft
                    - delete
                  example: active
                  description: >-
                    Set the status of the page(s) or 'delete' to perform soft
                    deletion
                page_ids:
                  type: array
                  items:
                    type: integer
                  description: IDs of pages to update
              required:
                - status
                - page_ids
              description: Bulk update request payload
        required: true
  /api/v202506/pages/import:
    post:
      summary: Imports pages from a zip file
      description: Import pages from a zip file
      tags:
        - Pages
      operationId: importPagesApi
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: import started
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Import has successfully started. Please check back later.
                    description: Success message
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        description: Unique identifier for the request
                      timestamp:
                        type: string
                        description: Time when the request was processed
                    description: Metadata about the request and response
                description: Successful import response
        '422':
          description: invalid zip file
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Please upload a valid zip file.
                    description: Error message describing what went wrong
                  errors:
                    type: object
                    properties:
                      zip:
                        type: array
                        items:
                          type: string
                        description: List of error messages related to the zip file
                    description: Detailed error information
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        description: Unique identifier for the request
                      timestamp:
                        type: string
                        description: Time when the request was processed
                    description: Metadata about the request and response
                description: Error response for import
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: string
        required: true
        description: Zip file containing pages
  /api/v202506/pages/{id}/promote_to_template:
    post:
      summary: Promotes a page to a template
      description: Convert a page into an application theme template
      tags:
        - Pages
      operationId: promotePageToTemplateApi
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: successfully promoted to template
          content:
            application/json:
              schema:
                type: object
                properties:
                  item:
                    type: object
                    properties:
                      application_theme_template:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                            description: ID of the created template
                          application_theme_id:
                            type: integer
                            example: 1
                            description: ID of the associated theme
                          company_id:
                            type:
                              - integer
                              - 'null'
                            example: 1
                            description: ID of the associated company
                          global:
                            type: boolean
                            example: false
                            description: Whether this is a global template
                          name:
                            type: string
                            example: Template Name
                            description: Name of the template
                          themeable_type:
                            type: string
                            example: product
                            description: Type of template
                          status:
                            type: string
                            example: active
                            description: Status of the template
                          default:
                            type: boolean
                            example: false
                            description: Whether this is the default template
                          content:
                            type: string
                            example: <h1>Hello</h1>
                            description: Template content
                          stylesheet:
                            type: string
                            example: 'body { color: red; }'
                            description: Template stylesheet
                          variables:
                            type: object
                            example: {}
                            description: Template variables
                          translations:
                            type: object
                            example: {}
                            description: Template translations
                          created_at:
                            type: string
                            format: date_time
                            description: Creation timestamp
                          updated_at:
                            type: string
                            format: date_time
                            description: Update timestamp
                          hide_navbar:
                            type: boolean
                            example: false
                            description: Whether to hide the navbar
                          use_active_application_theme:
                            type: boolean
                            example: false
                            description: Whether to use the active application theme
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        description: Unique identifier for the request
                      timestamp:
                        type: string
                        format: date_time
                        description: Timestamp of the response
                description: Template creation success response
        '404':
          description: page not found
        '422':
          description: promotion failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: unprocessable entity
                    description: Error message
                  errors:
                    type: object
                    properties:
                      base:
                        type: array
                        items:
                          type: string
                        description: List of error messages
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        description: Unique identifier for the request
                      timestamp:
                        type: string
                        format: date_time
                        description: Timestamp of the response
                description: Error response for failed promotion
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                themeable_type:
                  type: string
                  example: product
                  description: >-
                    Type of template to promote it to. Possible values:
                    'home_page', 'cart_page', 'product', 'medium',
                    'enrollment_pack', 'library', 'shop_page', 'category_page',
                    'collection_page', 'join_page
              required:
                - themeable_type
              description: Parameters for page promotion
        required: true
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
  /api/v202506/payments/tokenize_card:
    post:
      summary: Tokenize credit card
      tags:
        - Payment
      parameters: []
      responses:
        '200':
          description: Credit card response
          content:
            application/json:
              schema:
                type: object
                properties:
                  transaction:
                    type: object
                    properties:
                      token:
                        type: string
                        example: test_token_123
                      created_at:
                        type: string
                        example: '2025-03-06T12:00:00'
                      updated_at:
                        type: string
                        example: '2025-03-06T12:00:00'
                      succeeded:
                        type: boolean
                        example: true
                      transaction_type:
                        type: string
                        example: AddPaymentMethod
                      retained:
                        type: boolean
                        example: true
                      state:
                        type: string
                        example: succeeded
                      message_key:
                        type: string
                        example: messages.transaction_succeeded
                      message:
                        type: string
                        example: Succeeded!
                      payment_method:
                        type: object
                        properties:
                          token:
                            type: string
                            example: test_token_123
                          created_at:
                            type: string
                            example: '2025-03-06T12:00:00'
                          updated_at:
                            type: string
                            example: '2025-03-06T12:00:00'
                          storage_state:
                            type: string
                            example: cached
                          test:
                            type: boolean
                            example: true
                          last_four_digits:
                            type: string
                            example: '1111'
                          first_six_digits:
                            type: string
                            example: '411111'
                          card_type:
                            type: string
                            example: visa
                          first_name:
                            type: string
                            example: John
                          last_name:
                            type: string
                            example: Doe
                          month:
                            type: integer
                            example: 11
                          year:
                            type: integer
                            example: 2030
                          full_name:
                            type: string
                            example: John Doe
                          payment_method_type:
                            type: string
                            example: credit_card
                          errors:
                            type: array
                            example: []
                          fingerprint:
                            type: string
                            example: randomstring
                          verification_value:
                            type: string
                            example: '123'
                          number:
                            type: string
                            example: XXXX-XXXX-XXXX-1111
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2025-02-03T08:04:10Z'
        '400':
          description: Invalid credit card details
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid credit card details.
                  errors:
                    type: object
                    example:
                      credit_card:
                        month:
                          - is invalid
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2025-02-03T08:04:10Z'
        '422':
          description: Incomplete credit card details
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameters.
                  errors:
                    type: object
                    example:
                      credit_card:
                        month:
                          - is missing
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2025-02-03T08:04:10Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                credit_card:
                  type: object
                  properties:
                    first_name:
                      type: string
                    last_name:
                      type: string
                    number:
                      type: string
                    verification_value:
                      type: string
                    month:
                      type: string
                    year:
                      type: string
                    email:
                      type: string
                  required:
                    - first_name
                    - last_name
                    - number
                    - verification_value
                    - month
                    - year
              required:
                - credit_card
  /api/v202506/payments/{payment_account_id}:
    post:
      summary: Create payment record using payment account id and cart info
      tags:
        - Payment
      parameters:
        - name: payment_account_id
          in: path
          required: true
          description: ID of the existing payment account
          example: 123
          schema:
            type: integer
      responses:
        '201':
          description: Credit card response
          content:
            application/json:
              schema:
                type: object
                properties:
                  payment:
                    title: Commerce::Payment
                    type: object
                    properties:
                      id:
                        type: integer
                      uuid:
                        example: fpi_1cubfbteb6op7bld34xpae
                        type: string
                      action:
                        example: capture
                        type: string
                      status:
                        example: success
                        type: string
                      payment_account:
                        example: 272
                        type: integer
                      cart_token:
                        example: ct_4CeYE6VQNxASEBYZXpN4hi
                        type:
                          - string
                          - 'null'
                    required:
                      - id
                      - uuid
                      - action
                      - status
                      - payment_account
                      - cart_token
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '404':
          description: Payment Account is not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                cart_token:
                  type: string
                  example: cart_token
                payment_method:
                  type: object
                  properties:
                    integration_class:
                      type: string
                      example: Droplet
                    source:
                      type: string
                      example: droplet
                  required:
                    - integration_class
                    - source
              required:
                - cart_token
                - payment_method
        required: true
  /api/v202506/transactions:
    get:
      summary: List payment transactions with filtering, sorting, and pagination
      tags:
        - Payment
      security:
        - bearer_auth: []
      operationId: getPaymentTransactions
      parameters:
        - name: page
          in: query
          required: false
          style: deepObject
          explode: true
          schema:
            type: object
            properties:
              cursor:
                type:
                  - string
                  - 'null'
                example: eyJpZCI6MX0=
                description: Cursor for pagination
              limit:
                type:
                  - integer
                  - 'null'
                example: 20
                description: Number of items per page
                minimum: 1
                maximum: 100
                default: 20
            description: Pagination parameters
        - name: sorted_by
          in: query
          required: false
          example: amount_asc
          schema:
            type: string
        - name: order_id
          in: query
          required: false
          description: Filter by order ID or order token
          schema:
            type: integer
        - name: cart_id
          in: query
          required: false
          description: Filter by cart ID or cart token
          schema:
            type: integer
        - name: transaction_id
          in: query
          required: false
          description: Filter by transaction ID
          schema:
            type: string
        - name: payment_action
          in: query
          required: false
          description: Filter by payment action
          schema:
            type: string
            enum:
              - show
              - update
              - create_payment_source
              - create_payment_token
              - create_customer_token
              - create_paypal_order
              - retain
              - verify
              - authorize
              - capture
              - purchase
              - cancel
              - refund
              - void
              - settle
              - charge
          example: show
        - name: status
          in: query
          required: false
          description: Filter by payment status
          schema:
            type: string
            enum:
              - unsent
              - sent
              - received
              - success
              - declined
              - pending
              - error
              - expired
          example: sent
        - name: company_id
          in: query
          required: false
          description: Filter by company ID
          schema:
            type: integer
        - name: integration
          in: query
          required: false
          description: Filter by integration class
          schema:
            type: string
            enum:
              - Affirm
              - AliPayCitcon
              - AliPayHkCitcon
              - BankTransferCitcon
              - BlikPpro
              - Bread
              - CashAppCitcon
              - CreditCard
              - Droplet
              - GCashCitcon
              - GrabPayCitcon
              - IdealPpro
              - JkoPayCitcon
              - KakaoPayCitcon
              - Klarna
              - KlarnaCitcon
              - LinePayCitcon
              - MayaCitcon
              - OxxoCitcon
              - P24Ppro
              - PayPayCitcon
              - Paypal
              - PixCitcon
              - RakutenPayCitcon
              - SatispayPpro
              - SkrillPpro
              - TrustlyPpro
              - UPIIndiaCitcon
              - UnionPayCitcon
              - WechatPayCitcon
          example: Paypal
        - name: gateway
          in: query
          required: false
          description: Filter by gateway name
          schema:
            type: string
            enum:
              - ActiveMerchant::Billing::AdyenGateway
              - ActiveMerchant::Billing::Bogus
              - ActiveMerchant::Billing::BraintreeGateway
              - ActiveMerchant::Billing::CheckoutV2Gateway
              - ActiveMerchant::Billing::CyberSourceRestGateway
              - ActiveMerchant::Billing::HyperSwitchGateway
              - ActiveMerchant::Billing::NmiGateway
              - ActiveMerchant::Billing::PaypalRestGateway
              - ActiveMerchant::Billing::StripePaymentIntentsGateway
              - ActiveMerchant::Billing::WorldpayGateway
          example: ActiveMerchant::Billing::NmiGateway
        - name: currency
          in: query
          required: false
          description: Filter by currency code
          schema:
            type: integer
        - name: customer_id
          in: query
          required: false
          description: Filter by customer ID
          schema:
            type: string
        - name: order_source
          in: query
          required: false
          description: Filter by order source
          schema:
            type: string
        - name: type
          in: query
          required: false
          description: Filter by payment type (test/live)
          schema:
            type: string
            enum:
              - test
              - live
          example: test
      responses:
        '200':
          description: sorts by multiple fields
          content:
            application/json:
              schema:
                type: object
                properties:
                  transactions:
                    type: array
                    items:
                      title: Commerce::Payment
                      type: object
                      properties:
                        id:
                          type: integer
                        slug:
                          example: fpi_1cubfbteb6op7bld34xpae
                          type: string
                        action:
                          example: capture
                          type: string
                        status:
                          example: success
                          type: string
                        company_id:
                          example: 980191418
                          type: integer
                        company_name:
                          example: Acme Inc
                          type: string
                        customer_id:
                          type:
                            - integer
                            - 'null'
                        customer_name:
                          example: John Doe
                          type:
                            - string
                            - 'null'
                        cart_id:
                          example: 270825
                          type:
                            - integer
                            - 'null'
                        subscription_id:
                          type:
                            - integer
                            - 'null'
                        card_id:
                          type:
                            - integer
                            - 'null'
                        parent_id:
                          type:
                            - integer
                            - 'null'
                        amount:
                          example: '31.46'
                          type: string
                        currency_code:
                          example: USD
                          type: string
                        integration_class:
                          example: CreditCard
                          type: string
                        adapter_class:
                          example: ActiveMerchant::Billing::CyberSourceRestGateway
                          type:
                            - string
                            - 'null'
                        transaction_id:
                          example: '7555764170626662903812'
                          type:
                            - string
                            - 'null'
                        refunded_amount:
                          example: '0.0'
                          type: string
                        last_refunded_at:
                          type:
                            - string
                            - 'null'
                        voided_at:
                          type:
                            - string
                            - 'null'
                        created_at:
                          example: '2025-08-19T04:06:56.399Z'
                          type: string
                        updated_at:
                          example: '2025-08-19T04:06:58.467Z'
                          type: string
                        response_status:
                          type:
                            - string
                            - 'null'
                        response_message:
                          example: PENDING
                          type:
                            - string
                            - 'null'
                        processing_fee:
                          type:
                            - number
                            - 'null'
                        fee_status:
                          type:
                            - string
                            - 'null'
                        invoice_id:
                          type:
                            - integer
                            - 'null'
                        am_authorization:
                          example: 7555764170626662903812|31.46
                          type:
                            - string
                            - 'null'
                        cart_token:
                          example: ct_4CeYE6VQNxASEBYZXpN4hi
                          type:
                            - string
                            - 'null'
                        latency:
                          example: 0.45 seconds
                          type:
                            - string
                            - 'null'
                        order_source:
                          example: web
                          type:
                            - string
                            - 'null'
                        test_transaction:
                          example: false
                          type: boolean
                        payment_account:
                          title: Commerce::PaymentAccount
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              example: '272'
                              type: integer
                            name:
                              example: Staging CyberSourcet
                              type: string
                            integration_class:
                              example: CreditCard
                              type: string
                            adapter_class:
                              example: ActiveMerchant::Billing::CyberSourceRestGateway
                              type:
                                - string
                                - 'null'
                            entity:
                              title: Company::Entity
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                legal_name:
                                  example: Acme Corporation Inc.
                                  type: string
                                classification:
                                  example: Corporation
                                  type:
                                    - string
                                    - 'null'
                                trading_name:
                                  example: Acme Corp
                                  type:
                                    - string
                                    - 'null'
                                country_iso:
                                  example: US
                                  type:
                                    - string
                                    - 'null'
                                address1:
                                  example: 123 Business Street
                                  type:
                                    - string
                                    - 'null'
                                address2:
                                  example: Suite 100
                                  type:
                                    - string
                                    - 'null'
                                city:
                                  example: New York
                                  type:
                                    - string
                                    - 'null'
                                province:
                                  example: NY
                                  type:
                                    - string
                                    - 'null'
                                postal_code:
                                  example: '10001'
                                  type:
                                    - string
                                    - 'null'
                                registration_number:
                                  example: '123456789'
                                  type:
                                    - string
                                    - 'null'
                                date_of_incorporation:
                                  example: '2020-01-15'
                                  type:
                                    - string
                                    - 'null'
                                primary_mcc:
                                  example: 5411
                                  type:
                                    - integer
                                    - 'null'
                                secondary_mcc:
                                  example: 5999
                                  type:
                                    - integer
                                    - 'null'
                                phone_country_code:
                                  example: '+1'
                                  type:
                                    - string
                                    - 'null'
                                phone:
                                  example: 555-123-4567
                                  type:
                                    - string
                                    - 'null'
                                website:
                                  example: https://acme.com
                                  type:
                                    - string
                                    - 'null'
                                tax_id:
                                  example: GB123456789
                                  type:
                                    - string
                                    - 'null'
                                principal_same_as_registered_address:
                                  example: false
                                  type: boolean
                                primary:
                                  example: false
                                  type: boolean
                                status:
                                  example: active
                                  type: string
                                business_registration_file_url:
                                  example: >-
                                    https://example.com/business-registration.pdf
                                  type:
                                    - string
                                    - 'null'
                                business_registration_file_name:
                                  example: business-registration.pdf
                                  type:
                                    - string
                                    - 'null'
                                business_license_file_url:
                                  example: https://example.com/business-license.pdf
                                  type:
                                    - string
                                    - 'null'
                                business_license_file_name:
                                  example: business-license.pdf
                                  type:
                                    - string
                                    - 'null'
                                articles_of_incorporation_file_url:
                                  example: >-
                                    https://example.com/articles-of-incorporation.pdf
                                  type:
                                    - string
                                    - 'null'
                                articles_of_incorporation_file_name:
                                  example: articles-of-incorporation.pdf
                                  type:
                                    - string
                                    - 'null'
                                last_3_months_processing_statements_file_url:
                                  example: >-
                                    https://example.com/processing-statements.pdf
                                  type:
                                    - string
                                    - 'null'
                                last_3_months_processing_statements_file_name:
                                  example: processing-statements.pdf
                                  type:
                                    - string
                                    - 'null'
                                business_identification_number:
                                  example: '123456789'
                                  type:
                                    - string
                                    - 'null'
                                w_9_file_url:
                                  example: https://example.com/w-9.pdf
                                  type:
                                    - string
                                    - 'null'
                                w_9_file_name:
                                  example: w-9.pdf
                                  type:
                                    - string
                                    - 'null'
                                business_registration_certificate_file_url:
                                  example: >-
                                    https://example.com/business-registration-certificate.pdf
                                  type:
                                    - string
                                    - 'null'
                                business_registration_certificate_file_name:
                                  example: business-registration-certificate.pdf
                                  type:
                                    - string
                                    - 'null'
                                created_at:
                                  example: '2025-01-15T10:30:00Z'
                                  type: string
                                updated_at:
                                  example: '2025-01-15T10:30:00Z'
                                  type: string
                                registered_address:
                                  title: Address
                                  type:
                                    - object
                                    - 'null'
                                  properties:
                                    id:
                                      type: integer
                                    address1:
                                      example: 123 Main St
                                      type: string
                                    address2:
                                      example: Apt 4B
                                      type:
                                        - string
                                        - 'null'
                                    address3:
                                      example: Building 5
                                      type:
                                        - string
                                        - 'null'
                                    city:
                                      example: New York
                                      type: string
                                    state:
                                      example: NY
                                      type: string
                                    subdivision_code:
                                      example: NY
                                      type:
                                        - string
                                        - 'null'
                                    postal_code:
                                      example: '10001'
                                      type: string
                                    country_code:
                                      example: US
                                      type:
                                        - string
                                        - 'null'
                                  required:
                                    - id
                                    - address1
                                    - city
                                    - state
                                    - postal_code
                                principal_address:
                                  title: Address
                                  type:
                                    - object
                                    - 'null'
                                  properties:
                                    id:
                                      type: integer
                                    address1:
                                      example: 123 Main St
                                      type: string
                                    address2:
                                      example: Apt 4B
                                      type:
                                        - string
                                        - 'null'
                                    address3:
                                      example: Building 5
                                      type:
                                        - string
                                        - 'null'
                                    city:
                                      example: New York
                                      type: string
                                    state:
                                      example: NY
                                      type: string
                                    subdivision_code:
                                      example: NY
                                      type:
                                        - string
                                        - 'null'
                                    postal_code:
                                      example: '10001'
                                      type: string
                                    country_code:
                                      example: US
                                      type:
                                        - string
                                        - 'null'
                                  required:
                                    - id
                                    - address1
                                    - city
                                    - state
                                    - postal_code
                              required:
                                - id
                                - legal_name
                                - principal_same_as_registered_address
                                - primary
                                - status
                                - created_at
                                - updated_at
                            uuid:
                              example: pa_81iupl3azdmjpmrrnf1yzviosbwhtqfd
                              type: string
                          required:
                            - id
                            - name
                            - integration_class
                            - adapter_class
                            - uuid
                      required:
                        - id
                        - slug
                        - action
                        - status
                        - company_id
                        - company_name
                        - customer_id
                        - customer_name
                        - cart_id
                        - subscription_id
                        - card_id
                        - parent_id
                        - amount
                        - currency_code
                        - integration_class
                        - adapter_class
                        - transaction_id
                        - refunded_amount
                        - last_refunded_at
                        - voided_at
                        - created_at
                        - updated_at
                        - response_status
                        - response_message
                        - processing_fee
                        - fee_status
                        - invoice_id
                        - am_authorization
                        - cart_token
                        - latency
                        - order_source
                        - test_transaction
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      pagination:
                        type: object
                        properties:
                          cursor:
                            type:
                              - string
                              - 'null'
                          limit:
                            type: integer
                          prev_cursor:
                            type:
                              - string
                              - 'null'
                          next_cursor:
                            type:
                              - string
                              - 'null'
                          total_count:
                            type: integer
                          total_pages:
                            type: integer
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
  /api/v202506/transactions/filter_options:
    get:
      summary: List of filter options of transactions
      tags:
        - Payment
      security:
        - bearer_auth: []
      responses:
        '200':
          description: filter options
          content:
            application/json:
              schema:
                type: object
                properties:
                  integrations:
                    type: array
                    items:
                      properties:
                        name:
                          type: string
                          example: Ali Pay Citcon
                        value:
                          type: string
                          example: AliPayCitcon
                  payment_statuses:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                          example: success
                        value:
                          type: string
                          example: success
                  payment_actions:
                    type: array
                    items:
                      type: string
                      example: capture
                  gateways:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                          example: NmiGateway
                        value:
                          type: string
                          example: ActiveMerchant::Billing::NmiGateway
                  order_sources:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                          example: Web
                        value:
                          type: string
                          example: web
                  types:
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                          example: Test
                        value:
                          type: string
                          example: test
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/payments/{payment_uuid}:
    patch:
      summary: Update the payment transaction
      tags:
        - Payment
      security:
        - bearer_auth: []
      parameters:
        - name: payment_uuid
          in: path
          required: true
          description: UUID of the existing payment
          example: fpi_19dskrgidi2agx2glqpmks
          schema:
            type: string
      responses:
        '200':
          description: updates the payment
          content:
            application/json:
              schema:
                type: object
                properties:
                  payment:
                    title: Commerce::Payment
                    type: object
                    properties:
                      id:
                        type: integer
                      slug:
                        example: fpi_1cubfbteb6op7bld34xpae
                        type: string
                      action:
                        example: capture
                        type: string
                      status:
                        example: success
                        type: string
                      company_id:
                        example: 980191418
                        type: integer
                      company_name:
                        example: Acme Inc
                        type: string
                      customer_id:
                        type:
                          - integer
                          - 'null'
                      customer_name:
                        example: John Doe
                        type:
                          - string
                          - 'null'
                      cart_id:
                        example: 270825
                        type:
                          - integer
                          - 'null'
                      subscription_id:
                        type:
                          - integer
                          - 'null'
                      card_id:
                        type:
                          - integer
                          - 'null'
                      parent_id:
                        type:
                          - integer
                          - 'null'
                      amount:
                        example: '31.46'
                        type: string
                      currency_code:
                        example: USD
                        type: string
                      integration_class:
                        example: CreditCard
                        type: string
                      adapter_class:
                        example: ActiveMerchant::Billing::CyberSourceRestGateway
                        type:
                          - string
                          - 'null'
                      transaction_id:
                        example: '7555764170626662903812'
                        type:
                          - string
                          - 'null'
                      refunded_amount:
                        example: '0.0'
                        type: string
                      last_refunded_at:
                        type:
                          - string
                          - 'null'
                      voided_at:
                        type:
                          - string
                          - 'null'
                      created_at:
                        example: '2025-08-19T04:06:56.399Z'
                        type: string
                      updated_at:
                        example: '2025-08-19T04:06:58.467Z'
                        type: string
                      response_status:
                        type:
                          - string
                          - 'null'
                      response_message:
                        example: PENDING
                        type:
                          - string
                          - 'null'
                      processing_fee:
                        type:
                          - number
                          - 'null'
                      fee_status:
                        type:
                          - string
                          - 'null'
                      invoice_id:
                        type:
                          - integer
                          - 'null'
                      am_authorization:
                        example: 7555764170626662903812|31.46
                        type:
                          - string
                          - 'null'
                      cart_token:
                        example: ct_4CeYE6VQNxASEBYZXpN4hi
                        type:
                          - string
                          - 'null'
                      latency:
                        example: 0.45 seconds
                        type:
                          - string
                          - 'null'
                      order_source:
                        example: web
                        type:
                          - string
                          - 'null'
                      test_transaction:
                        example: false
                        type: boolean
                      payment_account:
                        title: Commerce::PaymentAccount
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            example: '272'
                            type: integer
                          name:
                            example: Staging CyberSourcet
                            type: string
                          integration_class:
                            example: CreditCard
                            type: string
                          adapter_class:
                            example: ActiveMerchant::Billing::CyberSourceRestGateway
                            type:
                              - string
                              - 'null'
                          entity:
                            title: Company::Entity
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                              legal_name:
                                example: Acme Corporation Inc.
                                type: string
                              classification:
                                example: Corporation
                                type:
                                  - string
                                  - 'null'
                              trading_name:
                                example: Acme Corp
                                type:
                                  - string
                                  - 'null'
                              country_iso:
                                example: US
                                type:
                                  - string
                                  - 'null'
                              address1:
                                example: 123 Business Street
                                type:
                                  - string
                                  - 'null'
                              address2:
                                example: Suite 100
                                type:
                                  - string
                                  - 'null'
                              city:
                                example: New York
                                type:
                                  - string
                                  - 'null'
                              province:
                                example: NY
                                type:
                                  - string
                                  - 'null'
                              postal_code:
                                example: '10001'
                                type:
                                  - string
                                  - 'null'
                              registration_number:
                                example: '123456789'
                                type:
                                  - string
                                  - 'null'
                              date_of_incorporation:
                                example: '2020-01-15'
                                type:
                                  - string
                                  - 'null'
                              primary_mcc:
                                example: 5411
                                type:
                                  - integer
                                  - 'null'
                              secondary_mcc:
                                example: 5999
                                type:
                                  - integer
                                  - 'null'
                              phone_country_code:
                                example: '+1'
                                type:
                                  - string
                                  - 'null'
                              phone:
                                example: 555-123-4567
                                type:
                                  - string
                                  - 'null'
                              website:
                                example: https://acme.com
                                type:
                                  - string
                                  - 'null'
                              tax_id:
                                example: GB123456789
                                type:
                                  - string
                                  - 'null'
                              principal_same_as_registered_address:
                                example: false
                                type: boolean
                              primary:
                                example: false
                                type: boolean
                              status:
                                example: active
                                type: string
                              business_registration_file_url:
                                example: https://example.com/business-registration.pdf
                                type:
                                  - string
                                  - 'null'
                              business_registration_file_name:
                                example: business-registration.pdf
                                type:
                                  - string
                                  - 'null'
                              business_license_file_url:
                                example: https://example.com/business-license.pdf
                                type:
                                  - string
                                  - 'null'
                              business_license_file_name:
                                example: business-license.pdf
                                type:
                                  - string
                                  - 'null'
                              articles_of_incorporation_file_url:
                                example: >-
                                  https://example.com/articles-of-incorporation.pdf
                                type:
                                  - string
                                  - 'null'
                              articles_of_incorporation_file_name:
                                example: articles-of-incorporation.pdf
                                type:
                                  - string
                                  - 'null'
                              last_3_months_processing_statements_file_url:
                                example: https://example.com/processing-statements.pdf
                                type:
                                  - string
                                  - 'null'
                              last_3_months_processing_statements_file_name:
                                example: processing-statements.pdf
                                type:
                                  - string
                                  - 'null'
                              business_identification_number:
                                example: '123456789'
                                type:
                                  - string
                                  - 'null'
                              w_9_file_url:
                                example: https://example.com/w-9.pdf
                                type:
                                  - string
                                  - 'null'
                              w_9_file_name:
                                example: w-9.pdf
                                type:
                                  - string
                                  - 'null'
                              business_registration_certificate_file_url:
                                example: >-
                                  https://example.com/business-registration-certificate.pdf
                                type:
                                  - string
                                  - 'null'
                              business_registration_certificate_file_name:
                                example: business-registration-certificate.pdf
                                type:
                                  - string
                                  - 'null'
                              created_at:
                                example: '2025-01-15T10:30:00Z'
                                type: string
                              updated_at:
                                example: '2025-01-15T10:30:00Z'
                                type: string
                              registered_address:
                                title: Address
                                type:
                                  - object
                                  - 'null'
                                properties:
                                  id:
                                    type: integer
                                  address1:
                                    example: 123 Main St
                                    type: string
                                  address2:
                                    example: Apt 4B
                                    type:
                                      - string
                                      - 'null'
                                  address3:
                                    example: Building 5
                                    type:
                                      - string
                                      - 'null'
                                  city:
                                    example: New York
                                    type: string
                                  state:
                                    example: NY
                                    type: string
                                  subdivision_code:
                                    example: NY
                                    type:
                                      - string
                                      - 'null'
                                  postal_code:
                                    example: '10001'
                                    type: string
                                  country_code:
                                    example: US
                                    type:
                                      - string
                                      - 'null'
                                required:
                                  - id
                                  - address1
                                  - city
                                  - state
                                  - postal_code
                              principal_address:
                                title: Address
                                type:
                                  - object
                                  - 'null'
                                properties:
                                  id:
                                    type: integer
                                  address1:
                                    example: 123 Main St
                                    type: string
                                  address2:
                                    example: Apt 4B
                                    type:
                                      - string
                                      - 'null'
                                  address3:
                                    example: Building 5
                                    type:
                                      - string
                                      - 'null'
                                  city:
                                    example: New York
                                    type: string
                                  state:
                                    example: NY
                                    type: string
                                  subdivision_code:
                                    example: NY
                                    type:
                                      - string
                                      - 'null'
                                  postal_code:
                                    example: '10001'
                                    type: string
                                  country_code:
                                    example: US
                                    type:
                                      - string
                                      - 'null'
                                required:
                                  - id
                                  - address1
                                  - city
                                  - state
                                  - postal_code
                            required:
                              - id
                              - legal_name
                              - principal_same_as_registered_address
                              - primary
                              - status
                              - created_at
                              - updated_at
                          uuid:
                            example: pa_81iupl3azdmjpmrrnf1yzviosbwhtqfd
                            type: string
                        required:
                          - id
                          - name
                          - integration_class
                          - adapter_class
                          - uuid
                    required:
                      - id
                      - slug
                      - action
                      - status
                      - company_id
                      - company_name
                      - customer_id
                      - customer_name
                      - cart_id
                      - subscription_id
                      - card_id
                      - parent_id
                      - amount
                      - currency_code
                      - integration_class
                      - adapter_class
                      - transaction_id
                      - refunded_amount
                      - last_refunded_at
                      - voided_at
                      - created_at
                      - updated_at
                      - response_status
                      - response_message
                      - processing_fee
                      - fee_status
                      - invoice_id
                      - am_authorization
                      - cart_token
                      - latency
                      - order_source
                      - test_transaction
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  type: string
                  example: some description
                metadata:
                  type: object
        required: true
    get:
      summary: Show the payment transaction
      tags:
        - Payment
      security:
        - bearer_auth: []
      parameters:
        - name: payment_uuid
          in: path
          required: true
          description: UUID of the existing payment
          example: fpi_19dskrgidi2agx2glqpmks
          schema:
            type: string
      responses:
        '200':
          description: show payment details
          content:
            application/json:
              schema:
                type: object
                properties:
                  payment:
                    title: Commerce::Payment
                    type: object
                    properties:
                      id:
                        type: integer
                      slug:
                        example: fpi_1cubfbteb6op7bld34xpae
                        type: string
                      action:
                        example: capture
                        type: string
                      status:
                        example: success
                        type: string
                      company_id:
                        example: 980191418
                        type: integer
                      company_name:
                        example: Acme Inc
                        type: string
                      customer_id:
                        type:
                          - integer
                          - 'null'
                      customer_name:
                        example: John Doe
                        type:
                          - string
                          - 'null'
                      cart_id:
                        example: 270825
                        type:
                          - integer
                          - 'null'
                      subscription_id:
                        type:
                          - integer
                          - 'null'
                      card_id:
                        type:
                          - integer
                          - 'null'
                      parent_id:
                        type:
                          - integer
                          - 'null'
                      amount:
                        example: '31.46'
                        type: string
                      currency_code:
                        example: USD
                        type: string
                      integration_class:
                        example: CreditCard
                        type: string
                      adapter_class:
                        example: ActiveMerchant::Billing::CyberSourceRestGateway
                        type:
                          - string
                          - 'null'
                      transaction_id:
                        example: '7555764170626662903812'
                        type:
                          - string
                          - 'null'
                      refunded_amount:
                        example: '0.0'
                        type: string
                      last_refunded_at:
                        type:
                          - string
                          - 'null'
                      voided_at:
                        type:
                          - string
                          - 'null'
                      created_at:
                        example: '2025-08-19T04:06:56.399Z'
                        type: string
                      updated_at:
                        example: '2025-08-19T04:06:58.467Z'
                        type: string
                      response_status:
                        type:
                          - string
                          - 'null'
                      response_message:
                        example: PENDING
                        type:
                          - string
                          - 'null'
                      processing_fee:
                        type:
                          - number
                          - 'null'
                      fee_status:
                        type:
                          - string
                          - 'null'
                      invoice_id:
                        type:
                          - integer
                          - 'null'
                      am_authorization:
                        example: 7555764170626662903812|31.46
                        type:
                          - string
                          - 'null'
                      cart_token:
                        example: ct_4CeYE6VQNxASEBYZXpN4hi
                        type:
                          - string
                          - 'null'
                      latency:
                        example: 0.45 seconds
                        type:
                          - string
                          - 'null'
                      order_source:
                        example: web
                        type:
                          - string
                          - 'null'
                      test_transaction:
                        example: false
                        type: boolean
                      payment_account:
                        title: Commerce::PaymentAccount
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            example: '272'
                            type: integer
                          name:
                            example: Staging CyberSourcet
                            type: string
                          integration_class:
                            example: CreditCard
                            type: string
                          adapter_class:
                            example: ActiveMerchant::Billing::CyberSourceRestGateway
                            type:
                              - string
                              - 'null'
                          entity:
                            title: Company::Entity
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                              legal_name:
                                example: Acme Corporation Inc.
                                type: string
                              classification:
                                example: Corporation
                                type:
                                  - string
                                  - 'null'
                              trading_name:
                                example: Acme Corp
                                type:
                                  - string
                                  - 'null'
                              country_iso:
                                example: US
                                type:
                                  - string
                                  - 'null'
                              address1:
                                example: 123 Business Street
                                type:
                                  - string
                                  - 'null'
                              address2:
                                example: Suite 100
                                type:
                                  - string
                                  - 'null'
                              city:
                                example: New York
                                type:
                                  - string
                                  - 'null'
                              province:
                                example: NY
                                type:
                                  - string
                                  - 'null'
                              postal_code:
                                example: '10001'
                                type:
                                  - string
                                  - 'null'
                              registration_number:
                                example: '123456789'
                                type:
                                  - string
                                  - 'null'
                              date_of_incorporation:
                                example: '2020-01-15'
                                type:
                                  - string
                                  - 'null'
                              primary_mcc:
                                example: 5411
                                type:
                                  - integer
                                  - 'null'
                              secondary_mcc:
                                example: 5999
                                type:
                                  - integer
                                  - 'null'
                              phone_country_code:
                                example: '+1'
                                type:
                                  - string
                                  - 'null'
                              phone:
                                example: 555-123-4567
                                type:
                                  - string
                                  - 'null'
                              website:
                                example: https://acme.com
                                type:
                                  - string
                                  - 'null'
                              tax_id:
                                example: GB123456789
                                type:
                                  - string
                                  - 'null'
                              principal_same_as_registered_address:
                                example: false
                                type: boolean
                              primary:
                                example: false
                                type: boolean
                              status:
                                example: active
                                type: string
                              business_registration_file_url:
                                example: https://example.com/business-registration.pdf
                                type:
                                  - string
                                  - 'null'
                              business_registration_file_name:
                                example: business-registration.pdf
                                type:
                                  - string
                                  - 'null'
                              business_license_file_url:
                                example: https://example.com/business-license.pdf
                                type:
                                  - string
                                  - 'null'
                              business_license_file_name:
                                example: business-license.pdf
                                type:
                                  - string
                                  - 'null'
                              articles_of_incorporation_file_url:
                                example: >-
                                  https://example.com/articles-of-incorporation.pdf
                                type:
                                  - string
                                  - 'null'
                              articles_of_incorporation_file_name:
                                example: articles-of-incorporation.pdf
                                type:
                                  - string
                                  - 'null'
                              last_3_months_processing_statements_file_url:
                                example: https://example.com/processing-statements.pdf
                                type:
                                  - string
                                  - 'null'
                              last_3_months_processing_statements_file_name:
                                example: processing-statements.pdf
                                type:
                                  - string
                                  - 'null'
                              business_identification_number:
                                example: '123456789'
                                type:
                                  - string
                                  - 'null'
                              w_9_file_url:
                                example: https://example.com/w-9.pdf
                                type:
                                  - string
                                  - 'null'
                              w_9_file_name:
                                example: w-9.pdf
                                type:
                                  - string
                                  - 'null'
                              business_registration_certificate_file_url:
                                example: >-
                                  https://example.com/business-registration-certificate.pdf
                                type:
                                  - string
                                  - 'null'
                              business_registration_certificate_file_name:
                                example: business-registration-certificate.pdf
                                type:
                                  - string
                                  - 'null'
                              created_at:
                                example: '2025-01-15T10:30:00Z'
                                type: string
                              updated_at:
                                example: '2025-01-15T10:30:00Z'
                                type: string
                              registered_address:
                                title: Address
                                type:
                                  - object
                                  - 'null'
                                properties:
                                  id:
                                    type: integer
                                  address1:
                                    example: 123 Main St
                                    type: string
                                  address2:
                                    example: Apt 4B
                                    type:
                                      - string
                                      - 'null'
                                  address3:
                                    example: Building 5
                                    type:
                                      - string
                                      - 'null'
                                  city:
                                    example: New York
                                    type: string
                                  state:
                                    example: NY
                                    type: string
                                  subdivision_code:
                                    example: NY
                                    type:
                                      - string
                                      - 'null'
                                  postal_code:
                                    example: '10001'
                                    type: string
                                  country_code:
                                    example: US
                                    type:
                                      - string
                                      - 'null'
                                required:
                                  - id
                                  - address1
                                  - city
                                  - state
                                  - postal_code
                              principal_address:
                                title: Address
                                type:
                                  - object
                                  - 'null'
                                properties:
                                  id:
                                    type: integer
                                  address1:
                                    example: 123 Main St
                                    type: string
                                  address2:
                                    example: Apt 4B
                                    type:
                                      - string
                                      - 'null'
                                  address3:
                                    example: Building 5
                                    type:
                                      - string
                                      - 'null'
                                  city:
                                    example: New York
                                    type: string
                                  state:
                                    example: NY
                                    type: string
                                  subdivision_code:
                                    example: NY
                                    type:
                                      - string
                                      - 'null'
                                  postal_code:
                                    example: '10001'
                                    type: string
                                  country_code:
                                    example: US
                                    type:
                                      - string
                                      - 'null'
                                required:
                                  - id
                                  - address1
                                  - city
                                  - state
                                  - postal_code
                            required:
                              - id
                              - legal_name
                              - principal_same_as_registered_address
                              - primary
                              - status
                              - created_at
                              - updated_at
                          uuid:
                            example: pa_81iupl3azdmjpmrrnf1yzviosbwhtqfd
                            type: string
                        required:
                          - id
                          - name
                          - integration_class
                          - adapter_class
                          - uuid
                      request:
                        example: {}
                        type:
                          - object
                          - string
                      response:
                        example: {}
                        type:
                          - object
                          - string
                      related_transactions:
                        type: array
                    required:
                      - id
                      - slug
                      - action
                      - status
                      - company_id
                      - company_name
                      - customer_id
                      - customer_name
                      - cart_id
                      - subscription_id
                      - card_id
                      - parent_id
                      - amount
                      - currency_code
                      - integration_class
                      - adapter_class
                      - transaction_id
                      - refunded_amount
                      - last_refunded_at
                      - voided_at
                      - created_at
                      - updated_at
                      - response_status
                      - response_message
                      - processing_fee
                      - fee_status
                      - invoice_id
                      - am_authorization
                      - cart_token
                      - latency
                      - order_source
                      - test_transaction
                      - request
                      - response
                      - related_transactions
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/v202506/payments/settle:
    post:
      summary: Settle authorized payment transaction
      tags:
        - Payment
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: settles the payment with partial amount
          content:
            application/json:
              schema:
                type: object
                properties:
                  payment:
                    title: Commerce::Payment
                    type: object
                    properties:
                      id:
                        type: integer
                      slug:
                        example: fpi_1cubfbteb6op7bld34xpae
                        type: string
                      action:
                        example: capture
                        type: string
                      status:
                        example: success
                        type: string
                      company_id:
                        example: 980191418
                        type: integer
                      company_name:
                        example: Acme Inc
                        type: string
                      customer_id:
                        type:
                          - integer
                          - 'null'
                      customer_name:
                        example: John Doe
                        type:
                          - string
                          - 'null'
                      cart_id:
                        example: 270825
                        type:
                          - integer
                          - 'null'
                      subscription_id:
                        type:
                          - integer
                          - 'null'
                      card_id:
                        type:
                          - integer
                          - 'null'
                      parent_id:
                        type:
                          - integer
                          - 'null'
                      amount:
                        example: '31.46'
                        type: string
                      currency_code:
                        example: USD
                        type: string
                      integration_class:
                        example: CreditCard
                        type: string
                      adapter_class:
                        example: ActiveMerchant::Billing::CyberSourceRestGateway
                        type:
                          - string
                          - 'null'
                      transaction_id:
                        example: '7555764170626662903812'
                        type:
                          - string
                          - 'null'
                      refunded_amount:
                        example: '0.0'
                        type: string
                      last_refunded_at:
                        type:
                          - string
                          - 'null'
                      voided_at:
                        type:
                          - string
                          - 'null'
                      created_at:
                        example: '2025-08-19T04:06:56.399Z'
                        type: string
                      updated_at:
                        example: '2025-08-19T04:06:58.467Z'
                        type: string
                      response_status:
                        type:
                          - string
                          - 'null'
                      response_message:
                        example: PENDING
                        type:
                          - string
                          - 'null'
                      processing_fee:
                        type:
                          - number
                          - 'null'
                      fee_status:
                        type:
                          - string
                          - 'null'
                      invoice_id:
                        type:
                          - integer
                          - 'null'
                      am_authorization:
                        example: 7555764170626662903812|31.46
                        type:
                          - string
                          - 'null'
                      cart_token:
                        example: ct_4CeYE6VQNxASEBYZXpN4hi
                        type:
                          - string
                          - 'null'
                      latency:
                        example: 0.45 seconds
                        type:
                          - string
                          - 'null'
                      order_source:
                        example: web
                        type:
                          - string
                          - 'null'
                      test_transaction:
                        example: false
                        type: boolean
                      payment_account:
                        title: Commerce::PaymentAccount
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            example: '272'
                            type: integer
                          name:
                            example: Staging CyberSourcet
                            type: string
                          integration_class:
                            example: CreditCard
                            type: string
                          adapter_class:
                            example: ActiveMerchant::Billing::CyberSourceRestGateway
                            type:
                              - string
                              - 'null'
                          entity:
                            title: Company::Entity
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                              legal_name:
                                example: Acme Corporation Inc.
                                type: string
                              classification:
                                example: Corporation
                                type:
                                  - string
                                  - 'null'
                              trading_name:
                                example: Acme Corp
                                type:
                                  - string
                                  - 'null'
                              country_iso:
                                example: US
                                type:
                                  - string
                                  - 'null'
                              address1:
                                example: 123 Business Street
                                type:
                                  - string
                                  - 'null'
                              address2:
                                example: Suite 100
                                type:
                                  - string
                                  - 'null'
                              city:
                                example: New York
                                type:
                                  - string
                                  - 'null'
                              province:
                                example: NY
                                type:
                                  - string
                                  - 'null'
                              postal_code:
                                example: '10001'
                                type:
                                  - string
                                  - 'null'
                              registration_number:
                                example: '123456789'
                                type:
                                  - string
                                  - 'null'
                              date_of_incorporation:
                                example: '2020-01-15'
                                type:
                                  - string
                                  - 'null'
                              primary_mcc:
                                example: 5411
                                type:
                                  - integer
                                  - 'null'
                              secondary_mcc:
                                example: 5999
                                type:
                                  - integer
                                  - 'null'
                              phone_country_code:
                                example: '+1'
                                type:
                                  - string
                                  - 'null'
                              phone:
                                example: 555-123-4567
                                type:
                                  - string
                                  - 'null'
                              website:
                                example: https://acme.com
                                type:
                                  - string
                                  - 'null'
                              tax_id:
                                example: GB123456789
                                type:
                                  - string
                                  - 'null'
                              principal_same_as_registered_address:
                                example: false
                                type: boolean
                              primary:
                                example: false
                                type: boolean
                              status:
                                example: active
                                type: string
                              business_registration_file_url:
                                example: https://example.com/business-registration.pdf
                                type:
                                  - string
                                  - 'null'
                              business_registration_file_name:
                                example: business-registration.pdf
                                type:
                                  - string
                                  - 'null'
                              business_license_file_url:
                                example: https://example.com/business-license.pdf
                                type:
                                  - string
                                  - 'null'
                              business_license_file_name:
                                example: business-license.pdf
                                type:
                                  - string
                                  - 'null'
                              articles_of_incorporation_file_url:
                                example: >-
                                  https://example.com/articles-of-incorporation.pdf
                                type:
                                  - string
                                  - 'null'
                              articles_of_incorporation_file_name:
                                example: articles-of-incorporation.pdf
                                type:
                                  - string
                                  - 'null'
                              last_3_months_processing_statements_file_url:
                                example: https://example.com/processing-statements.pdf
                                type:
                                  - string
                                  - 'null'
                              last_3_months_processing_statements_file_name:
                                example: processing-statements.pdf
                                type:
                                  - string
                                  - 'null'
                              business_identification_number:
                                example: '123456789'
                                type:
                                  - string
                                  - 'null'
                              w_9_file_url:
                                example: https://example.com/w-9.pdf
                                type:
                                  - string
                                  - 'null'
                              w_9_file_name:
                                example: w-9.pdf
                                type:
                                  - string
                                  - 'null'
                              business_registration_certificate_file_url:
                                example: >-
                                  https://example.com/business-registration-certificate.pdf
                                type:
                                  - string
                                  - 'null'
                              business_registration_certificate_file_name:
                                example: business-registration-certificate.pdf
                                type:
                                  - string
                                  - 'null'
                              created_at:
                                example: '2025-01-15T10:30:00Z'
                                type: string
                              updated_at:
                                example: '2025-01-15T10:30:00Z'
                                type: string
                              registered_address:
                                title: Address
                                type:
                                  - object
                                  - 'null'
                                properties:
                                  id:
                                    type: integer
                                  address1:
                                    example: 123 Main St
                                    type: string
                                  address2:
                                    example: Apt 4B
                                    type:
                                      - string
                                      - 'null'
                                  address3:
                                    example: Building 5
                                    type:
                                      - string
                                      - 'null'
                                  city:
                                    example: New York
                                    type: string
                                  state:
                                    example: NY
                                    type: string
                                  subdivision_code:
                                    example: NY
                                    type:
                                      - string
                                      - 'null'
                                  postal_code:
                                    example: '10001'
                                    type: string
                                  country_code:
                                    example: US
                                    type:
                                      - string
                                      - 'null'
                                required:
                                  - id
                                  - address1
                                  - city
                                  - state
                                  - postal_code
                              principal_address:
                                title: Address
                                type:
                                  - object
                                  - 'null'
                                properties:
                                  id:
                                    type: integer
                                  address1:
                                    example: 123 Main St
                                    type: string
                                  address2:
                                    example: Apt 4B
                                    type:
                                      - string
                                      - 'null'
                                  address3:
                                    example: Building 5
                                    type:
                                      - string
                                      - 'null'
                                  city:
                                    example: New York
                                    type: string
                                  state:
                                    example: NY
                                    type: string
                                  subdivision_code:
                                    example: NY
                                    type:
                                      - string
                                      - 'null'
                                  postal_code:
                                    example: '10001'
                                    type: string
                                  country_code:
                                    example: US
                                    type:
                                      - string
                                      - 'null'
                                required:
                                  - id
                                  - address1
                                  - city
                                  - state
                                  - postal_code
                            required:
                              - id
                              - legal_name
                              - principal_same_as_registered_address
                              - primary
                              - status
                              - created_at
                              - updated_at
                          uuid:
                            example: pa_81iupl3azdmjpmrrnf1yzviosbwhtqfd
                            type: string
                        required:
                          - id
                          - name
                          - integration_class
                          - adapter_class
                          - uuid
                    required:
                      - id
                      - slug
                      - action
                      - status
                      - company_id
                      - company_name
                      - customer_id
                      - customer_name
                      - cart_id
                      - subscription_id
                      - card_id
                      - parent_id
                      - amount
                      - currency_code
                      - integration_class
                      - adapter_class
                      - transaction_id
                      - refunded_amount
                      - last_refunded_at
                      - voided_at
                      - created_at
                      - updated_at
                      - response_status
                      - response_message
                      - processing_fee
                      - fee_status
                      - invoice_id
                      - am_authorization
                      - cart_token
                      - latency
                      - order_source
                      - test_transaction
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '404':
          description: Order not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                order_token:
                  type: string
                  example: fo_19dskrgidi2agx2glqpmks
                  description: token of the existing order
                order_id:
                  type: string
                  example: '123'
                  description: id of the existing order
                amount:
                  type: number
                  example: 5.5
                  description: Amount to settle (defaults to order amount)
                currency_code:
                  type: string
                  example: USD
                  description: >-
                    Currency code for the settle amount (defaults to order
                    currency)
        required: true
  /api/v202506/payments/cancel/{order_token}:
    patch:
      summary: Cancel authorized Bread payment transaction
      tags:
        - Payment
      security:
        - bearer_auth: []
      parameters:
        - name: order_token
          in: path
          required: true
          description: Token of the existing order
          example: fo_19dskrgidi2agx2glqpmks
          schema:
            type: string
      responses:
        '200':
          description: cancels the Bread payment
          content:
            application/json:
              schema:
                type: object
                properties:
                  payment:
                    title: Commerce::Payment
                    type: object
                    properties:
                      id:
                        type: integer
                      slug:
                        example: fpi_1cubfbteb6op7bld34xpae
                        type: string
                      action:
                        example: capture
                        type: string
                      status:
                        example: success
                        type: string
                      company_id:
                        example: 980191418
                        type: integer
                      company_name:
                        example: Acme Inc
                        type: string
                      customer_id:
                        type:
                          - integer
                          - 'null'
                      customer_name:
                        example: John Doe
                        type:
                          - string
                          - 'null'
                      cart_id:
                        example: 270825
                        type:
                          - integer
                          - 'null'
                      subscription_id:
                        type:
                          - integer
                          - 'null'
                      card_id:
                        type:
                          - integer
                          - 'null'
                      parent_id:
                        type:
                          - integer
                          - 'null'
                      amount:
                        example: '31.46'
                        type: string
                      currency_code:
                        example: USD
                        type: string
                      integration_class:
                        example: CreditCard
                        type: string
                      adapter_class:
                        example: ActiveMerchant::Billing::CyberSourceRestGateway
                        type:
                          - string
                          - 'null'
                      transaction_id:
                        example: '7555764170626662903812'
                        type:
                          - string
                          - 'null'
                      refunded_amount:
                        example: '0.0'
                        type: string
                      last_refunded_at:
                        type:
                          - string
                          - 'null'
                      voided_at:
                        type:
                          - string
                          - 'null'
                      created_at:
                        example: '2025-08-19T04:06:56.399Z'
                        type: string
                      updated_at:
                        example: '2025-08-19T04:06:58.467Z'
                        type: string
                      response_status:
                        type:
                          - string
                          - 'null'
                      response_message:
                        example: PENDING
                        type:
                          - string
                          - 'null'
                      processing_fee:
                        type:
                          - number
                          - 'null'
                      fee_status:
                        type:
                          - string
                          - 'null'
                      invoice_id:
                        type:
                          - integer
                          - 'null'
                      am_authorization:
                        example: 7555764170626662903812|31.46
                        type:
                          - string
                          - 'null'
                      cart_token:
                        example: ct_4CeYE6VQNxASEBYZXpN4hi
                        type:
                          - string
                          - 'null'
                      latency:
                        example: 0.45 seconds
                        type:
                          - string
                          - 'null'
                      order_source:
                        example: web
                        type:
                          - string
                          - 'null'
                      test_transaction:
                        example: false
                        type: boolean
                      payment_account:
                        title: Commerce::PaymentAccount
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            example: '272'
                            type: integer
                          name:
                            example: Staging CyberSourcet
                            type: string
                          integration_class:
                            example: CreditCard
                            type: string
                          adapter_class:
                            example: ActiveMerchant::Billing::CyberSourceRestGateway
                            type:
                              - string
                              - 'null'
                          entity:
                            title: Company::Entity
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                              legal_name:
                                example: Acme Corporation Inc.
                                type: string
                              classification:
                                example: Corporation
                                type:
                                  - string
                                  - 'null'
                              trading_name:
                                example: Acme Corp
                                type:
                                  - string
                                  - 'null'
                              country_iso:
                                example: US
                                type:
                                  - string
                                  - 'null'
                              address1:
                                example: 123 Business Street
                                type:
                                  - string
                                  - 'null'
                              address2:
                                example: Suite 100
                                type:
                                  - string
                                  - 'null'
                              city:
                                example: New York
                                type:
                                  - string
                                  - 'null'
                              province:
                                example: NY
                                type:
                                  - string
                                  - 'null'
                              postal_code:
                                example: '10001'
                                type:
                                  - string
                                  - 'null'
                              registration_number:
                                example: '123456789'
                                type:
                                  - string
                                  - 'null'
                              date_of_incorporation:
                                example: '2020-01-15'
                                type:
                                  - string
                                  - 'null'
                              primary_mcc:
                                example: 5411
                                type:
                                  - integer
                                  - 'null'
                              secondary_mcc:
                                example: 5999
                                type:
                                  - integer
                                  - 'null'
                              phone_country_code:
                                example: '+1'
                                type:
                                  - string
                                  - 'null'
                              phone:
                                example: 555-123-4567
                                type:
                                  - string
                                  - 'null'
                              website:
                                example: https://acme.com
                                type:
                                  - string
                                  - 'null'
                              tax_id:
                                example: GB123456789
                                type:
                                  - string
                                  - 'null'
                              principal_same_as_registered_address:
                                example: false
                                type: boolean
                              primary:
                                example: false
                                type: boolean
                              status:
                                example: active
                                type: string
                              business_registration_file_url:
                                example: https://example.com/business-registration.pdf
                                type:
                                  - string
                                  - 'null'
                              business_registration_file_name:
                                example: business-registration.pdf
                                type:
                                  - string
                                  - 'null'
                              business_license_file_url:
                                example: https://example.com/business-license.pdf
                                type:
                                  - string
                                  - 'null'
                              business_license_file_name:
                                example: business-license.pdf
                                type:
                                  - string
                                  - 'null'
                              articles_of_incorporation_file_url:
                                example: >-
                                  https://example.com/articles-of-incorporation.pdf
                                type:
                                  - string
                                  - 'null'
                              articles_of_incorporation_file_name:
                                example: articles-of-incorporation.pdf
                                type:
                                  - string
                                  - 'null'
                              last_3_months_processing_statements_file_url:
                                example: https://example.com/processing-statements.pdf
                                type:
                                  - string
                                  - 'null'
                              last_3_months_processing_statements_file_name:
                                example: processing-statements.pdf
                                type:
                                  - string
                                  - 'null'
                              business_identification_number:
                                example: '123456789'
                                type:
                                  - string
                                  - 'null'
                              w_9_file_url:
                                example: https://example.com/w-9.pdf
                                type:
                                  - string
                                  - 'null'
                              w_9_file_name:
                                example: w-9.pdf
                                type:
                                  - string
                                  - 'null'
                              business_registration_certificate_file_url:
                                example: >-
                                  https://example.com/business-registration-certificate.pdf
                                type:
                                  - string
                                  - 'null'
                              business_registration_certificate_file_name:
                                example: business-registration-certificate.pdf
                                type:
                                  - string
                                  - 'null'
                              created_at:
                                example: '2025-01-15T10:30:00Z'
                                type: string
                              updated_at:
                                example: '2025-01-15T10:30:00Z'
                                type: string
                              registered_address:
                                title: Address
                                type:
                                  - object
                                  - 'null'
                                properties:
                                  id:
                                    type: integer
                                  address1:
                                    example: 123 Main St
                                    type: string
                                  address2:
                                    example: Apt 4B
                                    type:
                                      - string
                                      - 'null'
                                  address3:
                                    example: Building 5
                                    type:
                                      - string
                                      - 'null'
                                  city:
                                    example: New York
                                    type: string
                                  state:
                                    example: NY
                                    type: string
                                  subdivision_code:
                                    example: NY
                                    type:
                                      - string
                                      - 'null'
                                  postal_code:
                                    example: '10001'
                                    type: string
                                  country_code:
                                    example: US
                                    type:
                                      - string
                                      - 'null'
                                required:
                                  - id
                                  - address1
                                  - city
                                  - state
                                  - postal_code
                              principal_address:
                                title: Address
                                type:
                                  - object
                                  - 'null'
                                properties:
                                  id:
                                    type: integer
                                  address1:
                                    example: 123 Main St
                                    type: string
                                  address2:
                                    example: Apt 4B
                                    type:
                                      - string
                                      - 'null'
                                  address3:
                                    example: Building 5
                                    type:
                                      - string
                                      - 'null'
                                  city:
                                    example: New York
                                    type: string
                                  state:
                                    example: NY
                                    type: string
                                  subdivision_code:
                                    example: NY
                                    type:
                                      - string
                                      - 'null'
                                  postal_code:
                                    example: '10001'
                                    type: string
                                  country_code:
                                    example: US
                                    type:
                                      - string
                                      - 'null'
                                required:
                                  - id
                                  - address1
                                  - city
                                  - state
                                  - postal_code
                            required:
                              - id
                              - legal_name
                              - principal_same_as_registered_address
                              - primary
                              - status
                              - created_at
                              - updated_at
                          uuid:
                            example: pa_81iupl3azdmjpmrrnf1yzviosbwhtqfd
                            type: string
                        required:
                          - id
                          - name
                          - integration_class
                          - adapter_class
                          - uuid
                    required:
                      - id
                      - slug
                      - action
                      - status
                      - company_id
                      - company_name
                      - customer_id
                      - customer_name
                      - cart_id
                      - subscription_id
                      - card_id
                      - parent_id
                      - amount
                      - currency_code
                      - integration_class
                      - adapter_class
                      - transaction_id
                      - refunded_amount
                      - last_refunded_at
                      - voided_at
                      - created_at
                      - updated_at
                      - response_status
                      - response_message
                      - processing_fee
                      - fee_status
                      - invoice_id
                      - am_authorization
                      - cart_token
                      - latency
                      - order_source
                      - test_transaction
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '404':
          description: No authorized Bread payment found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: Cancel operation failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                amount:
                  type: number
                  example: 10.99
                  description: Amount to cancel (defaults to remaining authorized amount)
                currency_code:
                  type: string
                  example: USD
                  description: Currency code for the cancel amount
  /api/payment_accounts:
    get:
      summary: List of payment accounts
      description: >-
        List all payment accounts with filtering, searching, and sorting
        capabilities
      tags:
        - Payment Accounts
      operationId: listPaymentAccounts
      security:
        - bearer_auth: []
      parameters:
        - name: page
          in: query
          required: false
          description: Page number for pagination
          example: 1
          schema:
            type: integer
        - name: per_page
          in: query
          required: false
          description: Number of items per page
          example: 10
          schema:
            type: integer
        - name: search_query
          in: query
          required: false
          description: Search payment accounts by name
          example: PayPal
          schema:
            type: string
        - name: sorted_by
          in: query
          required: false
          description: >-
            Sort field and direction (e.g. name_asc, name_desc, status_asc,
            status_desc, country_asc, country_desc)
          example: name_asc
          schema:
            type: string
        - name: status
          in: query
          required: false
          description: Filter by status (active/inactive)
          example: active
          schema:
            type: string
        - name: sandbox
          in: query
          required: false
          description: Filter by sandbox mode
          example: true
          schema:
            type: boolean
        - name: country_ids[]
          in: query
          description: Filter by country IDs (e.g., ?country_ids=1&country_ids=2)
          required: false
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  payment_accounts:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 1
                        active:
                          type: boolean
                          example: true
                        integration_class:
                          type: string
                          example: Paypal
                        adapter_class:
                          type:
                            - string
                            - 'null'
                          example: ActiveMerchant::Billing::SpreedlyCoreGateway
                        adapter_class_label:
                          type:
                            - string
                            - 'null'
                          example: SpreedlyCoreGateway
                        name:
                          type: string
                          example: Test Payment
                        settings:
                          type: object
                          example: {}
                        test:
                          type: boolean
                          example: false
                        domain:
                          type:
                            - object
                            - 'null'
                          properties:
                            domain:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 101
                                hostname:
                                  type: string
                                  example: example.com
                                created_at:
                                  type: string
                                  example: '2024-04-20T12:34:56.000Z'
                                updated_at:
                                  type: string
                                  example: '2024-08-20T12:34:56.000Z'
                                apex_domain:
                                  type: string
                                  example: example1.com
                                certificate_domain_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 101
                                company_id:
                                  type: integer
                                  example: 101
                                dns_config:
                                  type:
                                    - object
                                    - 'null'
                                  example: {}
                                primary:
                                  type: boolean
                                  example: false
                                redirection_domain_id:
                                  type:
                                    - integer
                                    - 'null'
                                  example: 101
                                redirection_domain_hostname:
                                  type:
                                    - string
                                    - 'null'
                                  example: example2.com
                                verification_status:
                                  type: string
                                  example: pending_cname
                                wildcard_subdomain:
                                  type: boolean
                                  example: false
                                dns_fluid_verified:
                                  type: string
                                  example: 'no'
                                cert_created:
                                  type: boolean
                                  example: true
                                connected:
                                  type: boolean
                                  example: false
                                verifying_cname:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: false
                            meta:
                              type: object
                              properties:
                                request_id:
                                  type: string
                                  example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                                timestamp:
                                  type: string
                                  example: '2024-12-10T08:04:10Z'
                        countries:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              iso:
                                type: string
                                example: US
                              name:
                                type: string
                                example: United States
                        icon:
                          type:
                            - string
                            - 'null'
                          example: https://example.com/icon.png
                        droplet_installation:
                          oneOf:
                            - type: 'null'
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1
                                uuid:
                                  type: string
                                  example: drp_p4r9jsl305iduqrsl0ujdth35jhuy2al
                                droplet_uuid:
                                  type: string
                                  example: drp_p4r9jsl305iduqrsl0ujdth35jhuy2al
                                droplet_name:
                                  type: string
                                  example: Sample Droplet
                                active:
                                  type: boolean
                                  example: true
                              required:
                                - uuid
                                - droplet_uuid
                                - droplet_name
                                - active
                                - id
                        auto_assign_to_cart:
                          type: boolean
                          example: false
                        mid:
                          type:
                            - string
                            - 'null'
                          example: '123456789012345'
                        entity:
                          oneOf:
                            - type: 'null'
                            - title: Company::Entity
                              type: object
                              properties:
                                id:
                                  type: integer
                                legal_name:
                                  example: Acme Corporation Inc.
                                  type: string
                                classification:
                                  example: Corporation
                                  type:
                                    - string
                                    - 'null'
                                trading_name:
                                  example: Acme Corp
                                  type:
                                    - string
                                    - 'null'
                                country_iso:
                                  example: US
                                  type:
                                    - string
                                    - 'null'
                                address1:
                                  example: 123 Business Street
                                  type:
                                    - string
                                    - 'null'
                                address2:
                                  example: Suite 100
                                  type:
                                    - string
                                    - 'null'
                                city:
                                  example: New York
                                  type:
                                    - string
                                    - 'null'
                                province:
                                  example: NY
                                  type:
                                    - string
                                    - 'null'
                                postal_code:
                                  example: '10001'
                                  type:
                                    - string
                                    - 'null'
                                registration_number:
                                  example: '123456789'
                                  type:
                                    - string
                                    - 'null'
                                date_of_incorporation:
                                  example: '2020-01-15'
                                  type:
                                    - string
                                    - 'null'
                                primary_mcc:
                                  example: 5411
                                  type:
                                    - integer
                                    - 'null'
                                secondary_mcc:
                                  example: 5999
                                  type:
                                    - integer
                                    - 'null'
                                phone_country_code:
                                  example: '+1'
                                  type:
                                    - string
                                    - 'null'
                                phone:
                                  example: 555-123-4567
                                  type:
                                    - string
                                    - 'null'
                                website:
                                  example: https://acme.com
                                  type:
                                    - string
                                    - 'null'
                                tax_id:
                                  example: GB123456789
                                  type:
                                    - string
                                    - 'null'
                                principal_same_as_registered_address:
                                  example: false
                                  type: boolean
                                primary:
                                  example: false
                                  type: boolean
                                status:
                                  example: active
                                  type: string
                                business_registration_file_url:
                                  example: >-
                                    https://example.com/business-registration.pdf
                                  type:
                                    - string
                                    - 'null'
                                business_registration_file_name:
                                  example: business-registration.pdf
                                  type:
                                    - string
                                    - 'null'
                                business_license_file_url:
                                  example: https://example.com/business-license.pdf
                                  type:
                                    - string
                                    - 'null'
                                business_license_file_name:
                                  example: business-license.pdf
                                  type:
                                    - string
                                    - 'null'
                                articles_of_incorporation_file_url:
                                  example: >-
                                    https://example.com/articles-of-incorporation.pdf
                                  type:
                                    - string
                                    - 'null'
                                articles_of_incorporation_file_name:
                                  example: articles-of-incorporation.pdf
                                  type:
                                    - string
                                    - 'null'
                                last_3_months_processing_statements_file_url:
                                  example: >-
                                    https://example.com/processing-statements.pdf
                                  type:
                                    - string
                                    - 'null'
                                last_3_months_processing_statements_file_name:
                                  example: processing-statements.pdf
                                  type:
                                    - string
                                    - 'null'
                                business_identification_number:
                                  example: '123456789'
                                  type:
                                    - string
                                    - 'null'
                                w_9_file_url:
                                  example: https://example.com/w-9.pdf
                                  type:
                                    - string
                                    - 'null'
                                w_9_file_name:
                                  example: w-9.pdf
                                  type:
                                    - string
                                    - 'null'
                                business_registration_certificate_file_url:
                                  example: >-
                                    https://example.com/business-registration-certificate.pdf
                                  type:
                                    - string
                                    - 'null'
                                business_registration_certificate_file_name:
                                  example: business-registration-certificate.pdf
                                  type:
                                    - string
                                    - 'null'
                                created_at:
                                  example: '2025-01-15T10:30:00Z'
                                  type: string
                                updated_at:
                                  example: '2025-01-15T10:30:00Z'
                                  type: string
                                registered_address:
                                  title: Address
                                  type:
                                    - object
                                    - 'null'
                                  properties:
                                    id:
                                      type: integer
                                    address1:
                                      example: 123 Main St
                                      type: string
                                    address2:
                                      example: Apt 4B
                                      type:
                                        - string
                                        - 'null'
                                    address3:
                                      example: Building 5
                                      type:
                                        - string
                                        - 'null'
                                    city:
                                      example: New York
                                      type: string
                                    state:
                                      example: NY
                                      type: string
                                    subdivision_code:
                                      example: NY
                                      type:
                                        - string
                                        - 'null'
                                    postal_code:
                                      example: '10001'
                                      type: string
                                    country_code:
                                      example: US
                                      type:
                                        - string
                                        - 'null'
                                  required:
                                    - id
                                    - address1
                                    - city
                                    - state
                                    - postal_code
                                principal_address:
                                  title: Address
                                  type:
                                    - object
                                    - 'null'
                                  properties:
                                    id:
                                      type: integer
                                    address1:
                                      example: 123 Main St
                                      type: string
                                    address2:
                                      example: Apt 4B
                                      type:
                                        - string
                                        - 'null'
                                    address3:
                                      example: Building 5
                                      type:
                                        - string
                                        - 'null'
                                    city:
                                      example: New York
                                      type: string
                                    state:
                                      example: NY
                                      type: string
                                    subdivision_code:
                                      example: NY
                                      type:
                                        - string
                                        - 'null'
                                    postal_code:
                                      example: '10001'
                                      type: string
                                    country_code:
                                      example: US
                                      type:
                                        - string
                                        - 'null'
                                  required:
                                    - id
                                    - address1
                                    - city
                                    - state
                                    - postal_code
                              required:
                                - id
                                - legal_name
                                - principal_same_as_registered_address
                                - primary
                                - status
                                - created_at
                                - updated_at
                        paypal_seller_verified:
                          type:
                            - 'null'
                            - boolean
                          example: false
                        recurring_only:
                          type: boolean
                          example: false
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      pagination:
                        type: object
                        properties:
                          current_page:
                            type: integer
                            example: 1
                          total_pages:
                            type: integer
                            example: 10
                          total_count:
                            type: integer
                            example: 100
                          per_page:
                            type: integer
                            example: 10
    post:
      summary: Create a payment account
      description: Create a payment account
      tags:
        - Payment Accounts
      operationId: createPaymentAccount
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: created
          content:
            application/json:
              schema:
                type: object
                properties:
                  payment_account:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      active:
                        type: boolean
                        example: true
                      integration_class:
                        type: string
                        example: Paypal
                      adapter_class:
                        type:
                          - string
                          - 'null'
                        example: ActiveMerchant::Billing::SpreedlyCoreGateway
                      adapter_class_label:
                        type:
                          - string
                          - 'null'
                        example: SpreedlyCoreGateway
                      name:
                        type: string
                        example: Test Payment
                      settings:
                        type: object
                        example: {}
                      test:
                        type: boolean
                        example: false
                      domain:
                        type:
                          - object
                          - 'null'
                        properties:
                          domain:
                            type: object
                            properties:
                              id:
                                type: integer
                                example: 101
                              hostname:
                                type: string
                                example: example.com
                              created_at:
                                type: string
                                example: '2024-04-20T12:34:56.000Z'
                              updated_at:
                                type: string
                                example: '2024-08-20T12:34:56.000Z'
                              apex_domain:
                                type: string
                                example: example1.com
                              certificate_domain_id:
                                type:
                                  - integer
                                  - 'null'
                                example: 101
                              company_id:
                                type: integer
                                example: 101
                              dns_config:
                                type:
                                  - object
                                  - 'null'
                                example: {}
                              primary:
                                type: boolean
                                example: false
                              redirection_domain_id:
                                type:
                                  - integer
                                  - 'null'
                                example: 101
                              redirection_domain_hostname:
                                type:
                                  - string
                                  - 'null'
                                example: example2.com
                              verification_status:
                                type: string
                                example: pending_cname
                              wildcard_subdomain:
                                type: boolean
                                example: false
                              dns_fluid_verified:
                                type: string
                                example: 'no'
                              cert_created:
                                type: boolean
                                example: true
                              connected:
                                type: boolean
                                example: false
                              verifying_cname:
                                type:
                                  - boolean
                                  - 'null'
                                example: false
                          meta:
                            type: object
                            properties:
                              request_id:
                                type: string
                                example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                              timestamp:
                                type: string
                                example: '2024-12-10T08:04:10Z'
                      countries:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            iso:
                              type: string
                              example: US
                            name:
                              type: string
                              example: United States
                      icon:
                        type:
                          - string
                          - 'null'
                        example: https://example.com/icon.png
                      droplet_installation:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              uuid:
                                type: string
                                example: drp_p4r9jsl305iduqrsl0ujdth35jhuy2al
                              droplet_uuid:
                                type: string
                                example: drp_p4r9jsl305iduqrsl0ujdth35jhuy2al
                              droplet_name:
                                type: string
                                example: Sample Droplet
                              active:
                                type: boolean
                                example: true
                            required:
                              - uuid
                              - droplet_uuid
                              - droplet_name
                              - active
                              - id
                      auto_assign_to_cart:
                        type: boolean
                        example: false
                      mid:
                        type:
                          - string
                          - 'null'
                        example: '123456789012345'
                      entity:
                        oneOf:
                          - type: 'null'
                          - title: Company::Entity
                            type: object
                            properties:
                              id:
                                type: integer
                              legal_name:
                                example: Acme Corporation Inc.
                                type: string
                              classification:
                                example: Corporation
                                type:
                                  - string
                                  - 'null'
                              trading_name:
                                example: Acme Corp
                                type:
                                  - string
                                  - 'null'
                              country_iso:
                                example: US
                                type:
                                  - string
                                  - 'null'
                              address1:
                                example: 123 Business Street
                                type:
                                  - string
                                  - 'null'
                              address2:
                                example: Suite 100
                                type:
                                  - string
                                  - 'null'
                              city:
                                example: New York
                                type:
                                  - string
                                  - 'null'
                              province:
                                example: NY
                                type:
                                  - string
                                  - 'null'
                              postal_code:
                                example: '10001'
                                type:
                                  - string
                                  - 'null'
                              registration_number:
                                example: '123456789'
                                type:
                                  - string
                                  - 'null'
                              date_of_incorporation:
                                example: '2020-01-15'
                                type:
                                  - string
                                  - 'null'
                              primary_mcc:
                                example: 5411
                                type:
                                  - integer
                                  - 'null'
                              secondary_mcc:
                                example: 5999
                                type:
                                  - integer
                                  - 'null'
                              phone_country_code:
                                example: '+1'
                                type:
                                  - string
                                  - 'null'
                              phone:
                                example: 555-123-4567
                                type:
                                  - string
                                  - 'null'
                              website:
                                example: https://acme.com
                                type:
                                  - string
                                  - 'null'
                              tax_id:
                                example: GB123456789
                                type:
                                  - string
                                  - 'null'
                              principal_same_as_registered_address:
                                example: false
                                type: boolean
                              primary:
                                example: false
                                type: boolean
                              status:
                                example: active
                                type: string
                              business_registration_file_url:
                                example: https://example.com/business-registration.pdf
                                type:
                                  - string
                                  - 'null'
                              business_registration_file_name:
                                example: business-registration.pdf
                                type:
                                  - string
                                  - 'null'
                              business_license_file_url:
                                example: https://example.com/business-license.pdf
                                type:
                                  - string
                                  - 'null'
                              business_license_file_name:
                                example: business-license.pdf
                                type:
                                  - string
                                  - 'null'
                              articles_of_incorporation_file_url:
                                example: >-
                                  https://example.com/articles-of-incorporation.pdf
                                type:
                                  - string
                                  - 'null'
                              articles_of_incorporation_file_name:
                                example: articles-of-incorporation.pdf
                                type:
                                  - string
                                  - 'null'
                              last_3_months_processing_statements_file_url:
                                example: https://example.com/processing-statements.pdf
                                type:
                                  - string
                                  - 'null'
                              last_3_months_processing_statements_file_name:
                                example: processing-statements.pdf
                                type:
                                  - string
                                  - 'null'
                              business_identification_number:
                                example: '123456789'
                                type:
                                  - string
                                  - 'null'
                              w_9_file_url:
                                example: https://example.com/w-9.pdf
                                type:
                                  - string
                                  - 'null'
                              w_9_file_name:
                                example: w-9.pdf
                                type:
                                  - string
                                  - 'null'
                              business_registration_certificate_file_url:
                                example: >-
                                  https://example.com/business-registration-certificate.pdf
                                type:
                                  - string
                                  - 'null'
                              business_registration_certificate_file_name:
                                example: business-registration-certificate.pdf
                                type:
                                  - string
                                  - 'null'
                              created_at:
                                example: '2025-01-15T10:30:00Z'
                                type: string
                              updated_at:
                                example: '2025-01-15T10:30:00Z'
                                type: string
                              registered_address:
                                title: Address
                                type:
                                  - object
                                  - 'null'
                                properties:
                                  id:
                                    type: integer
                                  address1:
                                    example: 123 Main St
                                    type: string
                                  address2:
                                    example: Apt 4B
                                    type:
                                      - string
                                      - 'null'
                                  address3:
                                    example: Building 5
                                    type:
                                      - string
                                      - 'null'
                                  city:
                                    example: New York
                                    type: string
                                  state:
                                    example: NY
                                    type: string
                                  subdivision_code:
                                    example: NY
                                    type:
                                      - string
                                      - 'null'
                                  postal_code:
                                    example: '10001'
                                    type: string
                                  country_code:
                                    example: US
                                    type:
                                      - string
                                      - 'null'
                                required:
                                  - id
                                  - address1
                                  - city
                                  - state
                                  - postal_code
                              principal_address:
                                title: Address
                                type:
                                  - object
                                  - 'null'
                                properties:
                                  id:
                                    type: integer
                                  address1:
                                    example: 123 Main St
                                    type: string
                                  address2:
                                    example: Apt 4B
                                    type:
                                      - string
                                      - 'null'
                                  address3:
                                    example: Building 5
                                    type:
                                      - string
                                      - 'null'
                                  city:
                                    example: New York
                                    type: string
                                  state:
                                    example: NY
                                    type: string
                                  subdivision_code:
                                    example: NY
                                    type:
                                      - string
                                      - 'null'
                                  postal_code:
                                    example: '10001'
                                    type: string
                                  country_code:
                                    example: US
                                    type:
                                      - string
                                      - 'null'
                                required:
                                  - id
                                  - address1
                                  - city
                                  - state
                                  - postal_code
                            required:
                              - id
                              - legal_name
                              - principal_same_as_registered_address
                              - primary
                              - status
                              - created_at
                              - updated_at
                      paypal_seller_verified:
                        type:
                          - 'null'
                          - boolean
                        example: false
                      recurring_only:
                        type: boolean
                        example: false
                      sandbox:
                        type:
                          - 'null'
                          - boolean
                        example: false
                      apple_pay_enabled:
                        type:
                          - 'null'
                          - boolean
                        example: false
                      google_pay_enabled:
                        type:
                          - 'null'
                          - boolean
                        example: false
                      sub_adapter:
                        type:
                          - 'null'
                          - string
                        example: acapture
                      credentials:
                        type:
                          - 'null'
                          - object
                        example: {}
                      paypal_seller_email:
                        type:
                          - 'null'
                          - string
                        example: test@example.com
                      paypal_consent_revoked:
                        type:
                          - 'null'
                          - boolean
                        example: false
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '400':
          description: error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: There was an error in creating payment account.
                  errors:
                    type: object
                    example: {}
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid credentials schema
                  errors:
                    type: object
                    example: {}
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                payment_account:
                  type: object
                  properties:
                    name:
                      type: string
                    integration_class:
                      type: string
                    adapter_class:
                      type: string
                    active:
                      type: boolean
                    test:
                      type: boolean
                    gateway_type:
                      type: string
                    sandbox:
                      type: boolean
                    apple_pay_enabled:
                      type: boolean
                    google_pay_enabled:
                      type: boolean
                    sub_adapter:
                      type: string
                    credentials:
                      type: object
                    company_country_ids:
                      type: array
                      items:
                        type: integer
                    droplet_installation_id:
                      type: integer
                    auto_assign_to_cart:
                      type: boolean
                    mid:
                      type:
                        - 'null'
                        - string
                    entity_id:
                      type:
                        - 'null'
                        - integer
                    recurring_only:
                      type:
                        - 'null'
                        - boolean
                  required:
                    - name
                    - integration_class
                    - credentials
              required:
                - payment_account
  /api/payment_accounts/{id}:
    get:
      summary: Get a payment account
      description: Get a payment account
      tags:
        - Payment Accounts
      operationId: getPaymentAccount
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Id of payment account.
          example: '1'
          schema:
            type: string
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  payment_account:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      active:
                        type: boolean
                        example: true
                      integration_class:
                        type: string
                        example: Paypal
                      adapter_class:
                        type:
                          - string
                          - 'null'
                        example: ActiveMerchant::Billing::SpreedlyCoreGateway
                      adapter_class_label:
                        type:
                          - string
                          - 'null'
                        example: SpreedlyCoreGateway
                      name:
                        type: string
                        example: Test Payment
                      settings:
                        type: object
                        example: {}
                      test:
                        type: boolean
                        example: false
                      domain:
                        type:
                          - object
                          - 'null'
                        properties:
                          domain:
                            type: object
                            properties:
                              id:
                                type: integer
                                example: 101
                              hostname:
                                type: string
                                example: example.com
                              created_at:
                                type: string
                                example: '2024-04-20T12:34:56.000Z'
                              updated_at:
                                type: string
                                example: '2024-08-20T12:34:56.000Z'
                              apex_domain:
                                type: string
                                example: example1.com
                              certificate_domain_id:
                                type:
                                  - integer
                                  - 'null'
                                example: 101
                              company_id:
                                type: integer
                                example: 101
                              dns_config:
                                type:
                                  - object
                                  - 'null'
                                example: {}
                              primary:
                                type: boolean
                                example: false
                              redirection_domain_id:
                                type:
                                  - integer
                                  - 'null'
                                example: 101
                              redirection_domain_hostname:
                                type:
                                  - string
                                  - 'null'
                                example: example2.com
                              verification_status:
                                type: string
                                example: pending_cname
                              wildcard_subdomain:
                                type: boolean
                                example: false
                              dns_fluid_verified:
                                type: string
                                example: 'no'
                              cert_created:
                                type: boolean
                                example: true
                              connected:
                                type: boolean
                                example: false
                              verifying_cname:
                                type:
                                  - boolean
                                  - 'null'
                                example: false
                          meta:
                            type: object
                            properties:
                              request_id:
                                type: string
                                example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                              timestamp:
                                type: string
                                example: '2024-12-10T08:04:10Z'
                      countries:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            iso:
                              type: string
                              example: US
                            name:
                              type: string
                              example: United States
                      icon:
                        type:
                          - string
                          - 'null'
                        example: https://example.com/icon.png
                      droplet_installation:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              uuid:
                                type: string
                                example: drp_p4r9jsl305iduqrsl0ujdth35jhuy2al
                              droplet_uuid:
                                type: string
                                example: drp_p4r9jsl305iduqrsl0ujdth35jhuy2al
                              droplet_name:
                                type: string
                                example: Sample Droplet
                              active:
                                type: boolean
                                example: true
                            required:
                              - uuid
                              - droplet_uuid
                              - droplet_name
                              - active
                              - id
                      auto_assign_to_cart:
                        type: boolean
                        example: false
                      mid:
                        type:
                          - string
                          - 'null'
                        example: '123456789012345'
                      entity:
                        oneOf:
                          - type: 'null'
                          - title: Company::Entity
                            type: object
                            properties:
                              id:
                                type: integer
                              legal_name:
                                example: Acme Corporation Inc.
                                type: string
                              classification:
                                example: Corporation
                                type:
                                  - string
                                  - 'null'
                              trading_name:
                                example: Acme Corp
                                type:
                                  - string
                                  - 'null'
                              country_iso:
                                example: US
                                type:
                                  - string
                                  - 'null'
                              address1:
                                example: 123 Business Street
                                type:
                                  - string
                                  - 'null'
                              address2:
                                example: Suite 100
                                type:
                                  - string
                                  - 'null'
                              city:
                                example: New York
                                type:
                                  - string
                                  - 'null'
                              province:
                                example: NY
                                type:
                                  - string
                                  - 'null'
                              postal_code:
                                example: '10001'
                                type:
                                  - string
                                  - 'null'
                              registration_number:
                                example: '123456789'
                                type:
                                  - string
                                  - 'null'
                              date_of_incorporation:
                                example: '2020-01-15'
                                type:
                                  - string
                                  - 'null'
                              primary_mcc:
                                example: 5411
                                type:
                                  - integer
                                  - 'null'
                              secondary_mcc:
                                example: 5999
                                type:
                                  - integer
                                  - 'null'
                              phone_country_code:
                                example: '+1'
                                type:
                                  - string
                                  - 'null'
                              phone:
                                example: 555-123-4567
                                type:
                                  - string
                                  - 'null'
                              website:
                                example: https://acme.com
                                type:
                                  - string
                                  - 'null'
                              tax_id:
                                example: GB123456789
                                type:
                                  - string
                                  - 'null'
                              principal_same_as_registered_address:
                                example: false
                                type: boolean
                              primary:
                                example: false
                                type: boolean
                              status:
                                example: active
                                type: string
                              business_registration_file_url:
                                example: https://example.com/business-registration.pdf
                                type:
                                  - string
                                  - 'null'
                              business_registration_file_name:
                                example: business-registration.pdf
                                type:
                                  - string
                                  - 'null'
                              business_license_file_url:
                                example: https://example.com/business-license.pdf
                                type:
                                  - string
                                  - 'null'
                              business_license_file_name:
                                example: business-license.pdf
                                type:
                                  - string
                                  - 'null'
                              articles_of_incorporation_file_url:
                                example: >-
                                  https://example.com/articles-of-incorporation.pdf
                                type:
                                  - string
                                  - 'null'
                              articles_of_incorporation_file_name:
                                example: articles-of-incorporation.pdf
                                type:
                                  - string
                                  - 'null'
                              last_3_months_processing_statements_file_url:
                                example: https://example.com/processing-statements.pdf
                                type:
                                  - string
                                  - 'null'
                              last_3_months_processing_statements_file_name:
                                example: processing-statements.pdf
                                type:
                                  - string
                                  - 'null'
                              business_identification_number:
                                example: '123456789'
                                type:
                                  - string
                                  - 'null'
                              w_9_file_url:
                                example: https://example.com/w-9.pdf
                                type:
                                  - string
                                  - 'null'
                              w_9_file_name:
                                example: w-9.pdf
                                type:
                                  - string
                                  - 'null'
                              business_registration_certificate_file_url:
                                example: >-
                                  https://example.com/business-registration-certificate.pdf
                                type:
                                  - string
                                  - 'null'
                              business_registration_certificate_file_name:
                                example: business-registration-certificate.pdf
                                type:
                                  - string
                                  - 'null'
                              created_at:
                                example: '2025-01-15T10:30:00Z'
                                type: string
                              updated_at:
                                example: '2025-01-15T10:30:00Z'
                                type: string
                              registered_address:
                                title: Address
                                type:
                                  - object
                                  - 'null'
                                properties:
                                  id:
                                    type: integer
                                  address1:
                                    example: 123 Main St
                                    type: string
                                  address2:
                                    example: Apt 4B
                                    type:
                                      - string
                                      - 'null'
                                  address3:
                                    example: Building 5
                                    type:
                                      - string
                                      - 'null'
                                  city:
                                    example: New York
                                    type: string
                                  state:
                                    example: NY
                                    type: string
                                  subdivision_code:
                                    example: NY
                                    type:
                                      - string
                                      - 'null'
                                  postal_code:
                                    example: '10001'
                                    type: string
                                  country_code:
                                    example: US
                                    type:
                                      - string
                                      - 'null'
                                required:
                                  - id
                                  - address1
                                  - city
                                  - state
                                  - postal_code
                              principal_address:
                                title: Address
                                type:
                                  - object
                                  - 'null'
                                properties:
                                  id:
                                    type: integer
                                  address1:
                                    example: 123 Main St
                                    type: string
                                  address2:
                                    example: Apt 4B
                                    type:
                                      - string
                                      - 'null'
                                  address3:
                                    example: Building 5
                                    type:
                                      - string
                                      - 'null'
                                  city:
                                    example: New York
                                    type: string
                                  state:
                                    example: NY
                                    type: string
                                  subdivision_code:
                                    example: NY
                                    type:
                                      - string
                                      - 'null'
                                  postal_code:
                                    example: '10001'
                                    type: string
                                  country_code:
                                    example: US
                                    type:
                                      - string
                                      - 'null'
                                required:
                                  - id
                                  - address1
                                  - city
                                  - state
                                  - postal_code
                            required:
                              - id
                              - legal_name
                              - principal_same_as_registered_address
                              - primary
                              - status
                              - created_at
                              - updated_at
                      paypal_seller_verified:
                        type:
                          - 'null'
                          - boolean
                        example: false
                      recurring_only:
                        type: boolean
                        example: false
                      sandbox:
                        type:
                          - 'null'
                          - boolean
                        example: false
                      apple_pay_enabled:
                        type:
                          - 'null'
                          - boolean
                        example: false
                      google_pay_enabled:
                        type:
                          - 'null'
                          - boolean
                        example: false
                      sub_adapter:
                        type:
                          - 'null'
                          - string
                        example: acapture
                      credentials:
                        type:
                          - 'null'
                          - object
                        example: {}
                      paypal_seller_email:
                        type:
                          - 'null'
                          - string
                        example: test@example.com
                      paypal_consent_revoked:
                        type:
                          - 'null'
                          - boolean
                        example: false
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: 'Payment account with id: 1 not found'
                  errors:
                    type: array
                    example: []
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
    put:
      summary: Update a payment account
      description: Update a payment account
      tags:
        - Payment Accounts
      operationId: updatePaymentAccount
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: updated with entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  payment_account:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      active:
                        type: boolean
                        example: true
                      integration_class:
                        type: string
                        example: Paypal
                      adapter_class:
                        type:
                          - string
                          - 'null'
                        example: ActiveMerchant::Billing::SpreedlyCoreGateway
                      adapter_class_label:
                        type:
                          - string
                          - 'null'
                        example: SpreedlyCoreGateway
                      name:
                        type: string
                        example: Test Payment
                      settings:
                        type: object
                        example: {}
                      test:
                        type: boolean
                        example: false
                      domain:
                        type:
                          - object
                          - 'null'
                        properties:
                          domain:
                            type: object
                            properties:
                              id:
                                type: integer
                                example: 101
                              hostname:
                                type: string
                                example: example.com
                              created_at:
                                type: string
                                example: '2024-04-20T12:34:56.000Z'
                              updated_at:
                                type: string
                                example: '2024-08-20T12:34:56.000Z'
                              apex_domain:
                                type: string
                                example: example1.com
                              certificate_domain_id:
                                type:
                                  - integer
                                  - 'null'
                                example: 101
                              company_id:
                                type: integer
                                example: 101
                              dns_config:
                                type:
                                  - object
                                  - 'null'
                                example: {}
                              primary:
                                type: boolean
                                example: false
                              redirection_domain_id:
                                type:
                                  - integer
                                  - 'null'
                                example: 101
                              redirection_domain_hostname:
                                type:
                                  - string
                                  - 'null'
                                example: example2.com
                              verification_status:
                                type: string
                                example: pending_cname
                              wildcard_subdomain:
                                type: boolean
                                example: false
                              dns_fluid_verified:
                                type: string
                                example: 'no'
                              cert_created:
                                type: boolean
                                example: true
                              connected:
                                type: boolean
                                example: false
                              verifying_cname:
                                type:
                                  - boolean
                                  - 'null'
                                example: false
                          meta:
                            type: object
                            properties:
                              request_id:
                                type: string
                                example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                              timestamp:
                                type: string
                                example: '2024-12-10T08:04:10Z'
                      countries:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 1
                            iso:
                              type: string
                              example: US
                            name:
                              type: string
                              example: United States
                      icon:
                        type:
                          - string
                          - 'null'
                        example: https://example.com/icon.png
                      droplet_installation:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              uuid:
                                type: string
                                example: drp_p4r9jsl305iduqrsl0ujdth35jhuy2al
                              droplet_uuid:
                                type: string
                                example: drp_p4r9jsl305iduqrsl0ujdth35jhuy2al
                              droplet_name:
                                type: string
                                example: Sample Droplet
                              active:
                                type: boolean
                                example: true
                            required:
                              - uuid
                              - droplet_uuid
                              - droplet_name
                              - active
                              - id
                      auto_assign_to_cart:
                        type: boolean
                        example: false
                      mid:
                        type:
                          - string
                          - 'null'
                        example: '123456789012345'
                      entity:
                        oneOf:
                          - type: 'null'
                          - title: Company::Entity
                            type: object
                            properties:
                              id:
                                type: integer
                              legal_name:
                                example: Acme Corporation Inc.
                                type: string
                              classification:
                                example: Corporation
                                type:
                                  - string
                                  - 'null'
                              trading_name:
                                example: Acme Corp
                                type:
                                  - string
                                  - 'null'
                              country_iso:
                                example: US
                                type:
                                  - string
                                  - 'null'
                              address1:
                                example: 123 Business Street
                                type:
                                  - string
                                  - 'null'
                              address2:
                                example: Suite 100
                                type:
                                  - string
                                  - 'null'
                              city:
                                example: New York
                                type:
                                  - string
                                  - 'null'
                              province:
                                example: NY
                                type:
                                  - string
                                  - 'null'
                              postal_code:
                                example: '10001'
                                type:
                                  - string
                                  - 'null'
                              registration_number:
                                example: '123456789'
                                type:
                                  - string
                                  - 'null'
                              date_of_incorporation:
                                example: '2020-01-15'
                                type:
                                  - string
                                  - 'null'
                              primary_mcc:
                                example: 5411
                                type:
                                  - integer
                                  - 'null'
                              secondary_mcc:
                                example: 5999
                                type:
                                  - integer
                                  - 'null'
                              phone_country_code:
                                example: '+1'
                                type:
                                  - string
                                  - 'null'
                              phone:
                                example: 555-123-4567
                                type:
                                  - string
                                  - 'null'
                              website:
                                example: https://acme.com
                                type:
                                  - string
                                  - 'null'
                              tax_id:
                                example: GB123456789
                                type:
                                  - string
                                  - 'null'
                              principal_same_as_registered_address:
                                example: false
                                type: boolean
                              primary:
                                example: false
                                type: boolean
                              status:
                                example: active
                                type: string
                              business_registration_file_url:
                                example: https://example.com/business-registration.pdf
                                type:
                                  - string
                                  - 'null'
                              business_registration_file_name:
                                example: business-registration.pdf
                                type:
                                  - string
                                  - 'null'
                              business_license_file_url:
                                example: https://example.com/business-license.pdf
                                type:
                                  - string
                                  - 'null'
                              business_license_file_name:
                                example: business-license.pdf
                                type:
                                  - string
                                  - 'null'
                              articles_of_incorporation_file_url:
                                example: >-
                                  https://example.com/articles-of-incorporation.pdf
                                type:
                                  - string
                                  - 'null'
                              articles_of_incorporation_file_name:
                                example: articles-of-incorporation.pdf
                                type:
                                  - string
                                  - 'null'
                              last_3_months_processing_statements_file_url:
                                example: https://example.com/processing-statements.pdf
                                type:
                                  - string
                                  - 'null'
                              last_3_months_processing_statements_file_name:
                                example: processing-statements.pdf
                                type:
                                  - string
                                  - 'null'
                              business_identification_number:
                                example: '123456789'
                                type:
                                  - string
                                  - 'null'
                              w_9_file_url:
                                example: https://example.com/w-9.pdf
                                type:
                                  - string
                                  - 'null'
                              w_9_file_name:
                                example: w-9.pdf
                                type:
                                  - string
                                  - 'null'
                              business_registration_certificate_file_url:
                                example: >-
                                  https://example.com/business-registration-certificate.pdf
                                type:
                                  - string
                                  - 'null'
                              business_registration_certificate_file_name:
                                example: business-registration-certificate.pdf
                                type:
                                  - string
                                  - 'null'
                              created_at:
                                example: '2025-01-15T10:30:00Z'
                                type: string
                              updated_at:
                                example: '2025-01-15T10:30:00Z'
                                type: string
                              registered_address:
                                title: Address
                                type:
                                  - object
                                  - 'null'
                                properties:
                                  id:
                                    type: integer
                                  address1:
                                    example: 123 Main St
                                    type: string
                                  address2:
                                    example: Apt 4B
                                    type:
                                      - string
                                      - 'null'
                                  address3:
                                    example: Building 5
                                    type:
                                      - string
                                      - 'null'
                                  city:
                                    example: New York
                                    type: string
                                  state:
                                    example: NY
                                    type: string
                                  subdivision_code:
                                    example: NY
                                    type:
                                      - string
                                      - 'null'
                                  postal_code:
                                    example: '10001'
                                    type: string
                                  country_code:
                                    example: US
                                    type:
                                      - string
                                      - 'null'
                                required:
                                  - id
                                  - address1
                                  - city
                                  - state
                                  - postal_code
                              principal_address:
                                title: Address
                                type:
                                  - object
                                  - 'null'
                                properties:
                                  id:
                                    type: integer
                                  address1:
                                    example: 123 Main St
                                    type: string
                                  address2:
                                    example: Apt 4B
                                    type:
                                      - string
                                      - 'null'
                                  address3:
                                    example: Building 5
                                    type:
                                      - string
                                      - 'null'
                                  city:
                                    example: New York
                                    type: string
                                  state:
                                    example: NY
                                    type: string
                                  subdivision_code:
                                    example: NY
                                    type:
                                      - string
                                      - 'null'
                                  postal_code:
                                    example: '10001'
                                    type: string
                                  country_code:
                                    example: US
                                    type:
                                      - string
                                      - 'null'
                                required:
                                  - id
                                  - address1
                                  - city
                                  - state
                                  - postal_code
                            required:
                              - id
                              - legal_name
                              - principal_same_as_registered_address
                              - primary
                              - status
                              - created_at
                              - updated_at
                      paypal_seller_verified:
                        type:
                          - 'null'
                          - boolean
                        example: false
                      recurring_only:
                        type: boolean
                        example: false
                      sandbox:
                        type:
                          - 'null'
                          - boolean
                        example: false
                      apple_pay_enabled:
                        type:
                          - 'null'
                          - boolean
                        example: false
                      google_pay_enabled:
                        type:
                          - 'null'
                          - boolean
                        example: false
                      sub_adapter:
                        type:
                          - 'null'
                          - string
                        example: acapture
                      credentials:
                        type:
                          - 'null'
                          - object
                        example: {}
                      paypal_seller_email:
                        type:
                          - 'null'
                          - string
                        example: test@example.com
                      paypal_consent_revoked:
                        type:
                          - 'null'
                          - boolean
                        example: false
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '400':
          description: error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: There was an error in creating payment account.
                  errors:
                    type: object
                    example: {}
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid credentials schema
                  errors:
                    type: object
                    example: {}
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid credentials schema
                  errors:
                    type: object
                    example: {}
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id: {}
                payment_account:
                  type: object
                  properties:
                    name:
                      type: string
                      minLength: 1
                    integration_class:
                      type: string
                      minLength: 1
                    adapter_class:
                      type: string
                      minLength: 1
                    active:
                      type: boolean
                      not:
                        type: 'null'
                    test:
                      type: boolean
                      not:
                        type: 'null'
                    gateway_type:
                      type: string
                    sandbox:
                      type: boolean
                    apple_pay_enabled:
                      type: boolean
                    google_pay_enabled:
                      type: boolean
                    sub_adapter:
                      type: string
                    credentials:
                      type: object
                    company_country_ids:
                      type: array
                      items:
                        type: integer
                    droplet_installation_id:
                      type: integer
                    auto_assign_to_cart:
                      type: boolean
                    mid:
                      type:
                        - 'null'
                        - string
                    entity_id:
                      type:
                        - 'null'
                        - integer
                    recurring_only:
                      type:
                        - 'null'
                        - boolean
                  required: []
              required:
                - payment_account
    delete:
      summary: Delete a payment account
      description: Delete a single payment account
      tags:
        - Payment Accounts
      operationId: deletePaymentAccount
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Id of payment account to be deleted.
          example: '1'
          schema:
            type: string
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  payment_account:
                    type: object
                    properties:
                      id:
                        type:
                          - integer
                          - string
                        example: 1
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: 'Payment account with id: 1 not found'
                  errors:
                    type: object
                    example: {}
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
        '422':
          description: error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: 'Payment account with id: 1 could not be deleted'
                  errors:
                    type: object
                    example: {}
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
  /api/payment_accounts/credentials_schema:
    get:
      summary: Get credentials schema for a payment integration
      description: Returns the credentials schema for a specific payment integration
      tags:
        - Payment Accounts
      operationId: getCredentialsSchemaForPaymentIntegration
      security:
        - bearer_auth: []
      parameters:
        - name: integration_class
          in: query
          required: true
          example: CreditCard
          description: Name of Integration
          schema:
            type: string
        - name: adapter_class
          in: query
          required: false
          example: ActiveMerchant::Billing::SpreedlyCoreGateway
          description: Optional adapter class for integrations that support it
          schema:
            type: string
        - name: sub_adapter
          in: query
          required: false
          example: adyen
          description: Optional sub-adapter for integrations that support it
          schema:
            type: string
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  credentials_schema:
                    type: object
                    description: Schema for credentials required by the integration
                    example:
                      merchant_account:
                        label: Merchant Account
                        type: string
                        required: true
                        safe: true
                      username:
                        label: Username
                        type: string
                        required: true
                        safe: true
                      password:
                        label: Password
                        type: string
                        required: true
                        safe: false
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: integration class not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Integration class not found
                  errors:
                    type: object
                    example:
                      integration_class:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameters
                  errors:
                    type: object
                    example:
                      payment_account:
                        integration_class:
                          - is missing
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
  /api/payment_integrations:
    get:
      summary: List payment integrations
      description: List payment integrations
      tags:
        - Payment Integrations
      operationId: listPaymentIntegrations
      security:
        - bearer_auth: []
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  payment_integrations:
                    type: array
                    items:
                      title: Commerce::Payments::Integrations::Integration
                      type: object
                      properties:
                        integration_class:
                          example: CreditCard
                          type: string
                        title:
                          example: Credit Card
                          type: string
                        image_url:
                          example: >-
                            https://assets.fluid.app/images/payment_icons/generic.svg
                          type: string
                        features:
                          example:
                            subscription: false
                            test_mode: false
                            sandbox: true
                          type: object
                      required:
                        - integration_class
                        - title
                        - image_url
                        - features
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - payment_integrations
  /api/payment_integrations/{integration_class}:
    get:
      summary: Show a payment integration
      description: Show a payment integration
      tags:
        - Payment Integrations
      operationId: showPaymentIntegration
      security:
        - bearer_auth: []
      parameters:
        - name: integration_class
          in: path
          required: true
          example: CreditCard
          description: The integration class of payment integration to show
          schema:
            type: string
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  payment_integration:
                    title: Commerce::Payments::Integrations::Integration
                    type: object
                    properties:
                      integration_class:
                        example: CreditCard
                        type: string
                      title:
                        example: Credit Card
                        type: string
                      image_url:
                        example: >-
                          https://assets.fluid.app/images/payment_icons/generic.svg
                        type: string
                      features:
                        example:
                          subscription: false
                          test_mode: false
                          sandbox: true
                        type: object
                      adapters:
                        example:
                          adapter_label: Gateway
                          sub_adapter_label: Merchant Gateway
                          adapter_classes:
                            - label: SpreedlyCoreGateway
                              class_name: ActiveMerchant::Billing::SpreedlyCoreGateway
                              sub_adapter_list:
                                - label: Acapture
                                  class_name: acapture
                                - label: Stripe Payment Intents
                                  class_name: stripe_payment_intents
                                - label: Spreedly Test
                                  class_name: test
                                - label: X Pay
                                  class_name: xpay
                            - label: Bogus
                              class_name: ActiveMerchant::Billing::Bogus
                              sub_adapter_list:
                                - label: Acapture
                                  class_name: acapture
                                - label: Quantum
                                  class_name: quantum
                                - label: Quickbooks
                                  class_name: quickbooks
                                - label: Worldpay US
                                  class_name: worldpay_us
                        type:
                          - object
                          - 'null'
                    required:
                      - integration_class
                      - title
                      - image_url
                      - features
                      - adapters
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - payment_integration
        '404':
          description: integration class not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Integration class not found
                  errors:
                    type: object
                    example:
                      integration_class:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/v202506/carts/{cart_token}/klarna/create_session:
    post:
      summary: Creates a Klarna payment session
      tags:
        - Payments
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
      responses:
        '201':
          description: session created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  session_id:
                    type: string
                    example: test_session_id
                  client_token:
                    type: string
                    example: test_client_token
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
        '400':
          description: invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: string
                    example:
                      - Invalid request
                  error_message:
                    type: string
                    example: Failed to create Klarna session
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
        '404':
          description: cart not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Cart with cart_token non_existent_token not found.
                  errors:
                    type: object
                    properties:
                      cart_token:
                        type: array
                        items:
                          type: string
                        example:
                          - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                intent:
                  type: string
                  enum:
                    - buy
                    - tokenize
                    - buy_and_tokenize
                    - buy_and_default_tokenize
  /api/v202506/carts/{cart_token}/klarna/update_session:
    post:
      summary: Updates a Klarna session
      tags:
        - Payments
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: session updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
        '400':
          description: failed to update session
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: string
                    example:
                      - Invalid session
                  error_message:
                    type: string
                    example: Failed to update Klarna session
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
        '404':
          description: cart not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Cart with cart_token non_existent_token not found.
                  errors:
                    type: object
                    properties:
                      cart_token:
                        type: array
                        items:
                          type: string
                        example:
                          - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                session_id:
                  type: string
                  description: Klarna session ID
                  example: test_session_id
              required:
                - session_id
  /api/v202506/payments/reports/transaction_volume:
    get:
      summary: Get transaction volume time series
      tags:
        - Payments Reports
      description: >-
        Returns time series data for transaction volume (count) over a specified
        period with configurable intervals
      operationId: getTransactionVolume
      security:
        - bearer_auth: []
      parameters:
        - name: period
          in: query
          required: true
          schema:
            type: string
        - name: start_date
          in: query
          required: false
          schema:
            type: string
        - name: end_date
          in: query
          required: false
          schema:
            type: string
        - name: interval
          in: query
          required: false
          schema:
            type: string
        - name: filters[integration_class][]
          in: query
          required: false
          description: Filter by integration classes (transaction providers)
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
          example:
            - CreditCard
            - PayPal
        - name: filters[adapter_class][]
          in: query
          required: false
          description: Filter by adapter classes (gateways)
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
          example:
            - Stripe
            - AuthorizeNet
        - name: filters[status][]
          in: query
          required: false
          description: Filter by payment status
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
          example:
            - success
            - declined
        - name: filters[currency_code][]
          in: query
          required: false
          description: Filter by currency codes
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
          example:
            - USD
            - EUR
        - name: filters[payment_action][]
          in: query
          required: false
          description: Filter by payment actions
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
          example:
            - authorize
            - capture
        - name: filters[type]
          in: query
          required: false
          description: Filter by payment type
          schema:
            type: string
            enum:
              - test
              - live
          example: live
      responses:
        '200':
          description: Transaction volume data retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  data_points:
                    type: array
                    items:
                      type: object
                      properties:
                        timestamp:
                          type: string
                          format: date-time
                          example: '2025-01-15T10:00:00Z'
                        value:
                          type:
                            - number
                            - 'null'
                          example: 150
                        interval:
                          type: string
                          example: hourly
                          enum:
                            - hourly
                            - daily
                            - weekly
                            - monthly
                      required:
                        - timestamp
                        - interval
                  kpis:
                    type: object
                    properties:
                      total:
                        type: number
                        example: 3250
                      previous_period_total:
                        type: number
                        example: 2800
                      growth:
                        type: object
                        properties:
                          value:
                            type: number
                            example: 450
                          percent:
                            type: number
                            example: 16.07
                        required:
                          - value
                          - percent
                      average:
                        type: number
                        example: 135.42
                      min:
                        type: number
                        example: 50
                      max:
                        type: number
                        example: 200
                    required:
                      - total
                      - previous_period_total
                      - growth
                      - average
                      - min
                      - max
                  period:
                    type: object
                    properties:
                      from:
                        type: string
                        format: date-time
                        example: '2025-01-15T00:00:00Z'
                      to:
                        type: string
                        format: date-time
                        example: '2025-01-15T23:59:59Z'
                      interval:
                        type: string
                        example: hourly
                        enum:
                          - hourly
                          - daily
                          - weekly
                          - monthly
                    required:
                      - from
                      - to
                      - interval
                  previous_period:
                    type: object
                    properties:
                      from:
                        type: string
                        format: date-time
                        example: '2025-01-14T00:00:00Z'
                      to:
                        type: string
                        format: date-time
                        example: '2025-01-14T23:59:59Z'
                    required:
                      - from
                      - to
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
                    required:
                      - request_id
                      - timestamp
                required:
                  - data_points
                  - kpis
                  - period
                  - previous_period
                  - meta
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
        '422':
          description: Invalid parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameters
                  errors:
                    type: object
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
                required:
                  - error_message
                  - errors
  /api/v202506/payments/reports/average_latency:
    get:
      summary: Get average latency time series
      tags:
        - Payments Reports
      description: >-
        Returns time series data for average transaction response time (latency)
        in milliseconds over a specified period
      operationId: getAverageLatency
      security:
        - bearer_auth: []
      parameters:
        - name: period
          in: query
          required: true
          schema:
            type: string
        - name: start_date
          in: query
          required: false
          schema:
            type: string
        - name: end_date
          in: query
          required: false
          schema:
            type: string
        - name: interval
          in: query
          required: false
          schema:
            type: string
        - name: filters[integration_class][]
          in: query
          required: false
          description: Filter by integration classes (transaction providers)
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
          example:
            - CreditCard
        - name: filters[adapter_class][]
          in: query
          required: false
          description: Filter by adapter classes (gateways)
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
          example:
            - Stripe
        - name: filters[type]
          in: query
          required: false
          description: Filter by payment type
          schema:
            type: string
            enum:
              - test
              - live
          example: live
      responses:
        '200':
          description: Average latency data retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  data_points:
                    type: array
                    items:
                      type: object
                      properties:
                        timestamp:
                          type: string
                          format: date-time
                          example: '2025-01-15T10:00:00Z'
                        value:
                          type:
                            - number
                            - 'null'
                          example: 150
                        interval:
                          type: string
                          example: hourly
                          enum:
                            - hourly
                            - daily
                            - weekly
                            - monthly
                      required:
                        - timestamp
                        - interval
                  kpis:
                    type: object
                    properties:
                      total:
                        type: number
                        example: 3250
                      previous_period_total:
                        type: number
                        example: 2800
                      growth:
                        type: object
                        properties:
                          value:
                            type: number
                            example: 450
                          percent:
                            type: number
                            example: 16.07
                        required:
                          - value
                          - percent
                      average:
                        type: number
                        example: 135.42
                      min:
                        type: number
                        example: 50
                      max:
                        type: number
                        example: 200
                    required:
                      - total
                      - previous_period_total
                      - growth
                      - average
                      - min
                      - max
                  period:
                    type: object
                    properties:
                      from:
                        type: string
                        format: date-time
                        example: '2025-01-15T00:00:00Z'
                      to:
                        type: string
                        format: date-time
                        example: '2025-01-15T23:59:59Z'
                      interval:
                        type: string
                        example: hourly
                        enum:
                          - hourly
                          - daily
                          - weekly
                          - monthly
                    required:
                      - from
                      - to
                      - interval
                  previous_period:
                    type: object
                    properties:
                      from:
                        type: string
                        format: date-time
                        example: '2025-01-14T00:00:00Z'
                      to:
                        type: string
                        format: date-time
                        example: '2025-01-14T23:59:59Z'
                    required:
                      - from
                      - to
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
                    required:
                      - request_id
                      - timestamp
                required:
                  - data_points
                  - kpis
                  - period
                  - previous_period
                  - meta
        '422':
          description: Invalid parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameters
                  errors:
                    type: object
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
                required:
                  - error_message
                  - errors
  /api/v202506/payments/reports/approval_rate:
    get:
      summary: Get approval rate time series
      tags:
        - Payments Reports
      description: >-
        Returns time series data for transaction approval rate (success
        percentage) over a specified period
      operationId: getApprovalRate
      security:
        - bearer_auth: []
      parameters:
        - name: period
          in: query
          required: true
          schema:
            type: string
        - name: start_date
          in: query
          required: false
          schema:
            type: string
        - name: end_date
          in: query
          required: false
          schema:
            type: string
        - name: interval
          in: query
          required: false
          schema:
            type: string
        - name: filters[integration_class][]
          in: query
          required: false
          description: Filter by integration classes (transaction providers)
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
          example:
            - CreditCard
            - PayPal
        - name: filters[type]
          in: query
          required: false
          description: Filter by payment type
          schema:
            type: string
            enum:
              - test
              - live
          example: live
      responses:
        '200':
          description: Approval rate data retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  data_points:
                    type: array
                    items:
                      type: object
                      properties:
                        timestamp:
                          type: string
                          format: date-time
                          example: '2025-01-15T10:00:00Z'
                        value:
                          type:
                            - number
                            - 'null'
                          example: 150
                        interval:
                          type: string
                          example: hourly
                          enum:
                            - hourly
                            - daily
                            - weekly
                            - monthly
                        breakdown:
                          type: object
                          additionalProperties:
                            type: integer
                            description: Count of payments in this category
                          description: >-
                            Breakdown of payments by category. Categories vary
                            by endpoint (e.g., approved/declined for
                            approval_rate, error types for error breakdowns).
                          example:
                            approved: 145
                            declined: 5
                      required:
                        - timestamp
                        - interval
                        - breakdown
                  kpis:
                    type: object
                    properties:
                      total:
                        type: number
                        example: 3250
                      previous_period_total:
                        type: number
                        example: 2800
                      growth:
                        type: object
                        properties:
                          value:
                            type: number
                            example: 450
                          percent:
                            type: number
                            example: 16.07
                        required:
                          - value
                          - percent
                      average:
                        type: number
                        example: 135.42
                      min:
                        type: number
                        example: 50
                      max:
                        type: number
                        example: 200
                    required:
                      - total
                      - previous_period_total
                      - growth
                      - average
                      - min
                      - max
                  period:
                    type: object
                    properties:
                      from:
                        type: string
                        format: date-time
                        example: '2025-01-15T00:00:00Z'
                      to:
                        type: string
                        format: date-time
                        example: '2025-01-15T23:59:59Z'
                      interval:
                        type: string
                        example: hourly
                        enum:
                          - hourly
                          - daily
                          - weekly
                          - monthly
                    required:
                      - from
                      - to
                      - interval
                  previous_period:
                    type: object
                    properties:
                      from:
                        type: string
                        format: date-time
                        example: '2025-01-14T00:00:00Z'
                      to:
                        type: string
                        format: date-time
                        example: '2025-01-14T23:59:59Z'
                    required:
                      - from
                      - to
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
                    required:
                      - request_id
                      - timestamp
                required:
                  - data_points
                  - kpis
                  - period
                  - previous_period
                  - meta
        '422':
          description: Invalid parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameters
                  errors:
                    type: object
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
                required:
                  - error_message
                  - errors
  /api/v202506/payments/reports/error_rate:
    get:
      summary: Get error rate time series
      tags:
        - Payments Reports
      description: >-
        Returns time series data for transaction error rate (failure percentage)
        over a specified period
      operationId: getErrorRate
      security:
        - bearer_auth: []
      parameters:
        - name: period
          in: query
          required: true
          schema:
            type: string
        - name: start_date
          in: query
          required: false
          schema:
            type: string
        - name: end_date
          in: query
          required: false
          schema:
            type: string
        - name: interval
          in: query
          required: false
          schema:
            type: string
        - name: filters[integration_class][]
          in: query
          required: false
          description: Filter by integration classes (transaction providers)
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
          example:
            - CreditCard
        - name: filters[type]
          in: query
          required: false
          description: Filter by payment type
          schema:
            type: string
            enum:
              - test
              - live
          example: live
      responses:
        '200':
          description: Error rate data retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  data_points:
                    type: array
                    items:
                      type: object
                      properties:
                        timestamp:
                          type: string
                          format: date-time
                          example: '2025-01-15T10:00:00Z'
                        value:
                          type:
                            - number
                            - 'null'
                          example: 150
                        interval:
                          type: string
                          example: hourly
                          enum:
                            - hourly
                            - daily
                            - weekly
                            - monthly
                      required:
                        - timestamp
                        - interval
                  kpis:
                    type: object
                    properties:
                      total:
                        type: number
                        example: 3250
                      previous_period_total:
                        type: number
                        example: 2800
                      growth:
                        type: object
                        properties:
                          value:
                            type: number
                            example: 450
                          percent:
                            type: number
                            example: 16.07
                        required:
                          - value
                          - percent
                      average:
                        type: number
                        example: 135.42
                      min:
                        type: number
                        example: 50
                      max:
                        type: number
                        example: 200
                    required:
                      - total
                      - previous_period_total
                      - growth
                      - average
                      - min
                      - max
                  period:
                    type: object
                    properties:
                      from:
                        type: string
                        format: date-time
                        example: '2025-01-15T00:00:00Z'
                      to:
                        type: string
                        format: date-time
                        example: '2025-01-15T23:59:59Z'
                      interval:
                        type: string
                        example: hourly
                        enum:
                          - hourly
                          - daily
                          - weekly
                          - monthly
                    required:
                      - from
                      - to
                      - interval
                  previous_period:
                    type: object
                    properties:
                      from:
                        type: string
                        format: date-time
                        example: '2025-01-14T00:00:00Z'
                      to:
                        type: string
                        format: date-time
                        example: '2025-01-14T23:59:59Z'
                    required:
                      - from
                      - to
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
                    required:
                      - request_id
                      - timestamp
                required:
                  - data_points
                  - kpis
                  - period
                  - previous_period
                  - meta
        '422':
          description: Invalid parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameters
                  errors:
                    type: object
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
                required:
                  - error_message
                  - errors
  /api/v202506/payments/reports/kpis:
    get:
      summary: Get aggregated KPIs
      tags:
        - Payments Reports
      description: >-
        Returns aggregated KPIs including transaction count, approval rate,
        average latency, and error rate with growth comparisons
      operationId: getPaymentKPIs
      security:
        - bearer_auth: []
      parameters:
        - name: period
          in: query
          required: true
          schema:
            type: string
        - name: start_date
          in: query
          required: false
          schema:
            type: string
        - name: end_date
          in: query
          required: false
          schema:
            type: string
        - name: filters[integration_class][]
          in: query
          required: false
          description: Filter by integration classes (transaction providers)
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
          example:
            - CreditCard
            - PayPal
        - name: filters[adapter_class][]
          in: query
          required: false
          description: Filter by adapter classes (gateways)
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
          example:
            - Stripe
        - name: filters[status][]
          in: query
          required: false
          description: Filter by payment status
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
          example:
            - success
        - name: filters[currency_code][]
          in: query
          required: false
          description: Filter by currency codes
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
          example:
            - USD
        - name: filters[payment_action][]
          in: query
          required: false
          description: Filter by payment actions
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
          example:
            - authorize
        - name: filters[type]
          in: query
          required: false
          description: Filter by payment type
          schema:
            type: string
            enum:
              - test
              - live
          example: live
      responses:
        '200':
          description: KPIs retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  kpis:
                    type: object
                    properties:
                      transaction_count:
                        type: object
                        properties:
                          current:
                            type: number
                            example: 3250
                          previous:
                            type: number
                            example: 2800
                          growth:
                            type: object
                            properties:
                              value:
                                type: number
                                example: 450
                              percent:
                                type: number
                                example: 16.07
                            required:
                              - value
                              - percent
                        required:
                          - current
                          - previous
                          - growth
                      approval_rate:
                        type: object
                        properties:
                          current:
                            type: number
                            example: 95.5
                          previous:
                            type: number
                            example: 94.2
                          growth:
                            type: object
                            properties:
                              value:
                                type: number
                                example: 450
                              percent:
                                type: number
                                example: 16.07
                            required:
                              - value
                              - percent
                        required:
                          - current
                          - previous
                          - growth
                      average_latency_ms:
                        type: object
                        properties:
                          current:
                            type: number
                            example: 1250
                          previous:
                            type: number
                            example: 1320
                          growth:
                            type: object
                            properties:
                              value:
                                type: number
                                example: 450
                              percent:
                                type: number
                                example: 16.07
                            required:
                              - value
                              - percent
                        required:
                          - current
                          - previous
                          - growth
                      error_rate:
                        type: object
                        properties:
                          current:
                            type: number
                            example: 2.1
                          previous:
                            type: number
                            example: 2.5
                          growth:
                            type: object
                            properties:
                              value:
                                type: number
                                example: 450
                              percent:
                                type: number
                                example: 16.07
                            required:
                              - value
                              - percent
                        required:
                          - current
                          - previous
                          - growth
                    required:
                      - transaction_count
                      - approval_rate
                      - average_latency_ms
                      - error_rate
                  period:
                    type: object
                    properties:
                      from:
                        type: string
                        format: date-time
                        example: '2025-01-01T00:00:00Z'
                      to:
                        type: string
                        format: date-time
                        example: '2025-01-31T23:59:59Z'
                      interval:
                        type: string
                        example: daily
                        enum:
                          - hourly
                          - daily
                          - weekly
                          - monthly
                    required:
                      - from
                      - to
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
                    required:
                      - request_id
                      - timestamp
                required:
                  - kpis
                  - period
                  - meta
        '400':
          description: Invalid parameters for custom period
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameters
                  errors:
                    type: object
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
                required:
                  - error_message
                  - errors
  /api/v202506/payments/reports/available_providers:
    get:
      summary: Get available payment providers
      tags:
        - Payments Reports
      description: >-
        Returns available integration classes, adapter classes, and payment
        accounts that are active
      operationId: getAvailableProviders
      security:
        - bearer_auth: []
      parameters:
        - name: filters[company_id]
          in: query
          required: false
          description: Filter by company ID
          schema:
            type: integer
          example: 1
      responses:
        '200':
          description: Available providers filtered by company_id
          content:
            application/json:
              schema:
                type: object
                properties:
                  integration_classes:
                    type: array
                    items:
                      type: string
                    example:
                      - CreditCard
                      - GCashCitcon
                      - PayPal
                  adapter_classes:
                    type: array
                    items:
                      type: string
                    example:
                      - ActiveMerchant::Billing::Bogus
                  payment_accounts:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 1
                        name:
                          type: string
                          example: Main Payment Account
                        integration_class:
                          type: string
                          example: CreditCard
                        adapter_class:
                          type:
                            - string
                            - 'null'
                          example: ActiveMerchant::Billing::Bogus
                        active:
                          type: boolean
                          example: true
                      required:
                        - id
                        - name
                        - integration_class
                        - adapter_class
                        - active
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
                    required:
                      - request_id
                      - timestamp
                required:
                  - integration_classes
                  - adapter_classes
                  - payment_accounts
                  - meta
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
  /api/v202506/payments/reports/transaction_amount:
    get:
      summary: Get transaction amount time series
      tags:
        - Payments Reports
      description: >-
        Returns time series data for transaction amounts (monetary values) over
        a specified period with configurable intervals. Only includes successful
        capture, purchase, and settle actions.
      operationId: getTransactionAmount
      security:
        - bearer_auth: []
      parameters:
        - name: period
          in: query
          required: true
          schema:
            type: string
        - name: start_date
          in: query
          required: false
          schema:
            type: string
        - name: end_date
          in: query
          required: false
          schema:
            type: string
        - name: interval
          in: query
          required: false
          schema:
            type: string
        - name: filters[integration_class][]
          in: query
          required: false
          description: Filter by integration classes (transaction providers)
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
          example:
            - CreditCard
            - PayPal
        - name: filters[adapter_class][]
          in: query
          required: false
          description: Filter by adapter classes (gateways)
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
          example:
            - Stripe
            - AuthorizeNet
        - name: filters[status][]
          in: query
          required: false
          description: Filter by payment status
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
          example:
            - success
            - declined
        - name: filters[currency_code][]
          in: query
          required: false
          description: Filter by currency codes
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
          example:
            - USD
            - EUR
        - name: filters[payment_action][]
          in: query
          required: false
          description: Filter by payment actions
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
          example:
            - authorize
            - capture
        - name: filters[type]
          in: query
          required: false
          description: Filter by payment type
          schema:
            type: string
            enum:
              - test
              - live
          example: live
      responses:
        '200':
          description: Transaction amount data retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  data_points:
                    type: array
                    items:
                      type: object
                      properties:
                        timestamp:
                          type: string
                          format: date-time
                          example: '2025-01-15T10:00:00Z'
                        value:
                          type:
                            - number
                            - 'null'
                          example: 150
                        interval:
                          type: string
                          example: hourly
                          enum:
                            - hourly
                            - daily
                            - weekly
                            - monthly
                      required:
                        - timestamp
                        - interval
                  kpis:
                    type: object
                    properties:
                      total:
                        type: number
                        example: 3250
                      previous_period_total:
                        type: number
                        example: 2800
                      growth:
                        type: object
                        properties:
                          value:
                            type: number
                            example: 450
                          percent:
                            type: number
                            example: 16.07
                        required:
                          - value
                          - percent
                      average:
                        type: number
                        example: 135.42
                      min:
                        type: number
                        example: 50
                      max:
                        type: number
                        example: 200
                    required:
                      - total
                      - previous_period_total
                      - growth
                      - average
                      - min
                      - max
                  period:
                    type: object
                    properties:
                      from:
                        type: string
                        format: date-time
                        example: '2025-01-15T00:00:00Z'
                      to:
                        type: string
                        format: date-time
                        example: '2025-01-15T23:59:59Z'
                      interval:
                        type: string
                        example: hourly
                        enum:
                          - hourly
                          - daily
                          - weekly
                          - monthly
                    required:
                      - from
                      - to
                      - interval
                  previous_period:
                    type: object
                    properties:
                      from:
                        type: string
                        format: date-time
                        example: '2025-01-14T00:00:00Z'
                      to:
                        type: string
                        format: date-time
                        example: '2025-01-14T23:59:59Z'
                    required:
                      - from
                      - to
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
                    required:
                      - request_id
                      - timestamp
                required:
                  - data_points
                  - kpis
                  - period
                  - previous_period
                  - meta
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
        '422':
          description: Invalid parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameters
                  errors:
                    type: object
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
                required:
                  - error_message
                  - errors
  /api/v202506/payments/reports/average_latency_by_provider:
    get:
      summary: Get average latency time series grouped by provider
      tags:
        - Payments Reports
      description: >-
        Returns time series data for average transaction response time (latency)
        in milliseconds grouped by unique combinations of
        payment_account.integration_class and payment_account.adapter_class,
        allowing comparison of latency across different payment providers
      operationId: getAverageLatencyByProvider
      security:
        - bearer_auth: []
      parameters:
        - name: period
          in: query
          required: true
          schema:
            type: string
        - name: start_date
          in: query
          required: false
          schema:
            type: string
        - name: end_date
          in: query
          required: false
          schema:
            type: string
        - name: interval
          in: query
          required: false
          schema:
            type: string
        - name: filters[status][]
          in: query
          required: false
          description: Filter by payment status
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
          example:
            - success
            - declined
        - name: filters[currency_code][]
          in: query
          required: false
          description: Filter by currency codes
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
          example:
            - USD
            - EUR
        - name: filters[payment_action][]
          in: query
          required: false
          description: Filter by payment actions
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
          example:
            - authorize
            - capture
        - name: filters[type]
          in: query
          required: false
          description: Filter by payment type
          schema:
            type: string
            enum:
              - test
              - live
          example: live
      responses:
        '200':
          description: Average latency by provider data retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  providers:
                    type: array
                    items:
                      type: object
                      properties:
                        integration_class:
                          type:
                            - string
                            - 'null'
                          example: CreditCard
                        adapter_class:
                          type:
                            - string
                            - 'null'
                          example: ActiveMerchant::Billing::Bogus
                        data_points:
                          type: array
                          items:
                            type: object
                            properties:
                              timestamp:
                                type: string
                                format: date-time
                                example: '2025-01-15T10:00:00Z'
                              value:
                                type:
                                  - number
                                  - 'null'
                                example: 150
                              interval:
                                type: string
                                example: hourly
                                enum:
                                  - hourly
                                  - daily
                                  - weekly
                                  - monthly
                            required:
                              - timestamp
                              - interval
                        kpis:
                          type: object
                          properties:
                            total:
                              type: number
                              example: 3250
                            previous_period_total:
                              type: number
                              example: 2800
                            growth:
                              type: object
                              properties:
                                value:
                                  type: number
                                  example: 450
                                percent:
                                  type: number
                                  example: 16.07
                              required:
                                - value
                                - percent
                            average:
                              type: number
                              example: 135.42
                            min:
                              type: number
                              example: 50
                            max:
                              type: number
                              example: 200
                          required:
                            - total
                            - previous_period_total
                            - growth
                            - average
                            - min
                            - max
                      required:
                        - integration_class
                        - adapter_class
                        - data_points
                        - kpis
                  period:
                    type: object
                    properties:
                      from:
                        type: string
                        format: date-time
                        example: '2025-01-15T00:00:00Z'
                      to:
                        type: string
                        format: date-time
                        example: '2025-01-15T23:59:59Z'
                      interval:
                        type: string
                        example: hourly
                        enum:
                          - hourly
                          - daily
                          - weekly
                          - monthly
                    required:
                      - from
                      - to
                      - interval
                  previous_period:
                    type: object
                    properties:
                      from:
                        type: string
                        format: date-time
                        example: '2025-01-14T00:00:00Z'
                      to:
                        type: string
                        format: date-time
                        example: '2025-01-14T23:59:59Z'
                    required:
                      - from
                      - to
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
                    required:
                      - request_id
                      - timestamp
                required:
                  - providers
                  - period
                  - previous_period
                  - meta
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
        '422':
          description: Invalid parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameters
                  errors:
                    type: object
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
                required:
                  - error_message
                  - errors
  /api/paypal/onboard:
    get:
      summary: Onboard with Paypal
      description: Get Paypal Partner Referral Link
      tags:
        - Paypal
      operationId: getPaypalPartnerReferralLink
      security:
        - bearer_auth: []
      parameters:
        - name: entity_id
          in: query
          required: false
          example: 1
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  partner_referral:
                    type: object
                    properties:
                      link:
                        type: string
                        example: >-
                          https://www.paypal.com/v1/partners/22/merchant-integrations/
                    required:
                      - link
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - partner_referral
                  - meta
  /api/paypal/client_sdk_token/{payment_account_id}:
    get:
      summary: Client SDK Token with Paypal
      description: Get Paypal Client SDK Token
      tags:
        - Paypal
      operationId: getPaypalClientSdkToken
      security:
        - bearer_auth: []
      parameters:
        - name: payment_account_id
          in: path
          required: true
          example: 101
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  client_sdk:
                    type: object
                    properties:
                      token:
                        type: string
                        example: eye..jwt_token
                    required:
                      - token
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - client_sdk
                  - meta
  /api/v202506/carts/{cart_token}/paypal/create_order:
    post:
      summary: Create order in paypal
      tags:
        - Paypal
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
        - name: funding_source
          in: query
          required: true
          schema:
            type: string
        - name: is_pay_later
          in: query
          required: true
          schema:
            type: boolean
      responses:
        '201':
          description: Order Created
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  order_id:
                    type:
                      - string
                      - 'null'
                    example: test1232
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
        '404':
          description: Cart not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Cart with token test-cart-token not found.
                  errors:
                    type: object
                    example:
                      cart_token:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
  /api/v202506/carts/{cart_token}/paypal/authorize_order:
    post:
      summary: Authorize order in paypal
      tags:
        - Paypal
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
      responses:
        '400':
          description: Invalid order id
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid order_id test-order-id.
                  errors:
                    type: object
                    example:
                      order_id:
                        - is invalid
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
        '404':
          description: Cart not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Cart with token test-cart-token not found.
                  errors:
                    type: object
                    example:
                      cart_token:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
        required: true
  /api/company/points:
    get:
      tags:
        - Points
      summary: index
      operationId: Getindex5
      parameters:
        - name: username
          in: query
          description: ''
          required: true
          style: form
          explode: true
          schema:
            type: string
            example: sammysample12
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/index8'
                description: ''
                example:
                  - id: 62
                    points: 122
                    slug: best
                    point_type: fantasy
                    title: We rock
                    description: We make earning fun
                    created_at: '2024-01-04T08:11:23.388Z'
                  - id: 61
                    points: 25
                    slug: order
                    point_type: fantasy
                    title: a placed an order on Fluid
                    description: 'Order ID: 54.  Amount: 120.96'
                    created_at: '2023-12-27T12:48:04.375Z'
              example:
                - id: 62
                  points: 122
                  slug: best
                  point_type: fantasy
                  title: We rock
                  description: We make earning fun
                  created_at: '2024-01-04T08:11:23.388Z'
                - id: 61
                  points: 25
                  slug: order
                  point_type: fantasy
                  title: a placed an order on Fluid
                  description: 'Order ID: 54.  Amount: 120.96'
                  created_at: '2023-12-27T12:48:04.375Z'
      deprecated: false
      security:
        - bearer: []
    post:
      tags:
        - Points
      summary: create
      operationId: Postcreate7
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/createrequest8'
                - example:
                    point:
                      title: hello point
                      points: 5
                      point_type: fantasy
                      description: hello point description here.
                      affiliate:
                        id: null
                        external_id: null
                        username: sammysample12
                        email: null
            example:
              point:
                title: hello point
                points: 5
                point_type: fantasy
                description: hello point description here.
                affiliate:
                  id: null
                  external_id: null
                  username: sammysample12
                  email: null
        required: true
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/create8'
                  - example:
                      id: 63
                      points: 5
                      slug: imported
                      point_type: fantasy
                      title: hello point
                      description: hello point description here.
                      created_at: '2024-01-04T08:18:16.346Z'
              example:
                id: 63
                points: 5
                slug: imported
                point_type: fantasy
                title: hello point
                description: hello point description here.
                created_at: '2024-01-04T08:18:16.346Z'
      deprecated: false
      security:
        - bearer: []
  /api/company/points/2:
    get:
      tags:
        - Points
      summary: show
      operationId: Getshow6
      parameters: []
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/show7'
                  - example:
                      id: 1
                      points: 1
                      slug: initial
                      point_type: giveaway
                      title: Welcome to Fluid's giveaways platform!
                      description: >-
                        Welcome to Fluid!  Your first point is here just because
                        you signed up. Start sharing and see your entries
                        explode!
                      created_at: '2023-12-26T04:48:56.940Z'
              example:
                id: 1
                points: 1
                slug: initial
                point_type: giveaway
                title: Welcome to Fluid's giveaways platform!
                description: >-
                  Welcome to Fluid!  Your first point is here just because you
                  signed up. Start sharing and see your entries explode!
                created_at: '2023-12-26T04:48:56.940Z'
      deprecated: false
      security:
        - bearer: []
  /api/company/points/69:
    patch:
      tags:
        - Points
      summary: update
      operationId: Patchupdate3
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/updaterequest7'
                - example:
                    point:
                      title: hello point update
                      points: 3
                      point_type: giveaway
                      description: hello point description updated.
            example:
              point:
                title: hello point update
                points: 3
                point_type: giveaway
                description: hello point description updated.
        required: true
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/update7'
                  - example:
                      id: 63
                      points: 3
                      slug: imported
                      point_type: giveaway
                      title: hello point update
                      description: hello point description updated.
                      created_at: '2024-01-04T08:18:16.346Z'
              example:
                id: 63
                points: 3
                slug: imported
                point_type: giveaway
                title: hello point update
                description: hello point description updated.
                created_at: '2024-01-04T08:18:16.346Z'
      deprecated: false
      security:
        - bearer: []
  /api/company/points/12:
    delete:
      tags:
        - Points
      summary: destroy
      operationId: Deletedestroy3
      parameters: []
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                type: string
                example: Point deleted successfully.
              example: Point deleted successfully.
      deprecated: false
      security:
        - bearer: []
  /api/v202506/customers/{customer_id}/points_ledgers:
    get:
      summary: Retrieve a list of points ledger entries for a customer
      description: >
        Get all points ledger entries for a specific customer.

        --- Access Rules ---

        - Admin/root_admin: can view any customer's ledger entries within their
        company.

        - Customer: can view only their own.
      tags:
        - Points Ledgers
      operationId: listPointsLedgers
      security:
        - bearer_auth: []
      parameters:
        - name: customer_id
          in: path
          description: Customer ID
          required: true
          schema:
            type: integer
        - name: page
          in: query
          schema:
            type: integer
            default: 1
          required: false
          description: Page number for pagination
        - name: per_page
          in: query
          schema:
            type: integer
            default: 10
          required: false
          description: Number of records per page
      responses:
        '200':
          description: points ledgers retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  points_ledgers:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        amount:
                          type: integer
                          default: 0
                        metadata:
                          type: object
                          default: '{}'
                        customer_id:
                          type: integer
                        company_id:
                          type: integer
                        created_at:
                          type: string
                          format: date-time
                        updated_at:
                          type: string
                          format: date-time
                        total_balance:
                          type: integer
                          default: 0
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                      pagination:
                        type: object
                        properties:
                          total_count:
                            type: integer
                            example: 5
                          total_pages:
                            type: integer
                            example: 1
                          per_page:
                            type: integer
                            example: 10
                          current_page:
                            type: integer
                            example: 1
        '404':
          description: customer not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      customer_id:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
    post:
      summary: Create a new points ledger entry
      description: Create a new points ledger entry for a customer.
      tags:
        - Points Ledgers
      operationId: createPointsLedger
      security:
        - bearer_auth: []
      parameters:
        - name: customer_id
          in: path
          description: Customer ID
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: points ledger entry created
          content:
            application/json:
              schema:
                type: object
                properties:
                  points_ledger:
                    type: object
                    properties:
                      id:
                        type: integer
                      amount:
                        type: integer
                        default: 0
                      metadata:
                        type: object
                        default: '{}'
                      customer_id:
                        type: integer
                      company_id:
                        type: integer
                      created_at:
                        type: string
                        format: date-time
                      updated_at:
                        type: string
                        format: date-time
                      total_balance:
                        type: integer
                        default: 0
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: customer not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      customer_id:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                  meta:
                    type: object
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                points_ledger:
                  type: object
                  properties:
                    amount:
                      type: integer
                      example: 100
                      description: >-
                        Amount of points to add (positive) or subtract
                        (negative)
                    idempotency_key:
                      type: string
                      example: 550e8400-e29b-41d4-a716-446655440000
                      description: >-
                        Has to be unique per request to prevent duplicate
                        entries
                    metadata:
                      type: object
                      example:
                        source:
                          name: Admin
                          user_id: 123
                          email: admin@example.com
                          reason: Test
                      description: >-
                        Metadata to store information about the reason/source of
                        the points credit/debit
                  required:
                    - amount
                    - idempotency_key
  /api/v202506/points_values:
    get:
      summary: Retrieve a list of points values for company currencies
      description: Get all points values for currencies used by the company.
      tags:
        - Points Values
      operationId: listPointsValues
      security:
        - bearer_auth: []
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            default: 1
          required: false
          description: Page number for pagination
        - name: per_page
          in: query
          schema:
            type: integer
            default: 25
          required: false
          description: Number of records per page
      responses:
        '200':
          description: points values retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  points_values:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type:
                            - integer
                            - 'null'
                        currency_code:
                          type: string
                        points_amount:
                          type: integer
                          default: 1
                          minimum: 1
                        currency_symbol:
                          type: string
                        currency_name:
                          type: string
                  primary_currency:
                    type: string
                    example: USD
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                      pagination:
                        type: object
                        properties:
                          total_count:
                            type: integer
                            example: 2
                          total_pages:
                            type: integer
                            example: 1
                          per_page:
                            type: integer
                            example: 25
                          current_page:
                            type: integer
                            example: 1
    patch:
      summary: Update a points value for a currency
      description: Update or create a points value for a specific currency.
      tags:
        - Points Values
      operationId: updatePointsValue
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: updates existing points value
          content:
            application/json:
              schema:
                type: object
                properties:
                  points_value:
                    type: object
                    properties:
                      id:
                        type:
                          - integer
                          - 'null'
                      currency_code:
                        type: string
                      points_amount:
                        type: integer
                        default: 1
                        minimum: 1
                      currency_symbol:
                        type: string
                      currency_name:
                        type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                  meta:
                    type: object
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                points_value:
                  type: object
                  properties:
                    currency_code:
                      type: string
                      example: USD
                      description: Currency code (e.g., USD, EUR, GBP)
                    points_amount:
                      type: integer
                      example: 100
                      description: >-
                        Amount of points per currency unit (must be greater than
                        0)
                  required:
                    - currency_code
                    - points_amount
  /api/v202506/points_values/refresh:
    post:
      summary: Refresh points values
      description: Refresh points values for all currencies used by the company.
      tags:
        - Points Values
      operationId: refreshPointsValues
      security:
        - bearer_auth: []
      responses:
        '200':
          description: points values refreshed
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Point values refreshed
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      default_country:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
  /api/posts:
    get:
      summary: List posts
      description: List all posts for a company with pagination and filtering
      tags:
        - Posts
      operationId: listPosts
      security:
        - bearer_auth: []
      parameters:
        - name: page
          in: query
          required: false
          description: Page number for pagination
          schema:
            type: integer
        - name: per_page
          in: query
          required: false
          description: Number of items per page
          schema:
            type: integer
        - name: active
          in: query
          required: false
          description: Filter by active status
          schema:
            type: boolean
        - name: search_query
          in: query
          required: false
          description: Search query for posts
          schema:
            type: string
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  posts:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 1
                        title:
                          type: string
                          example: My First Post
                        description:
                          type:
                            - string
                            - 'null'
                          example: This is a post
                        slug:
                          type:
                            - string
                            - 'null'
                          example: my-first-post
                        image_url:
                          type:
                            - string
                            - 'null'
                          example: https://example.com/image.jpg
                        active:
                          type: boolean
                          example: true
                        application_theme_template_id:
                          type:
                            - integer
                            - 'null'
                          example: 1
                        created_at:
                          type: string
                          format: date_time
                        updated_at:
                          type: string
                          format: date_time
                        countries:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                              name:
                                type: string
                        custom_slug:
                          type: boolean
                          example: true
                        use_search_engine:
                          type: boolean
                          example: true
                        show_on_site_search:
                          type: boolean
                          example: false
                        post_date:
                          type: string
                          format: date
                          example: '2021-01-01'
                        post_author:
                          type: string
                          example: John Doe
                        summary:
                          type: string
                          example: This is a summary of the post
                        preview_url:
                          type: string
                          example: https://example.com/preview
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      total_count:
                        type: integer
                        example: 10
                      total_pages:
                        type: integer
                        example: 2
                      current_page:
                        type: integer
                        example: 1
        '401':
          description: unauthorized
    post:
      summary: Create a post
      description: Create a new post post
      tags:
        - Posts
      operationId: createPost
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: created
          content:
            application/json:
              schema:
                type: object
                properties:
                  post:
                    type: object
                    properties:
                      id:
                        type: integer
                      title:
                        type: string
                      description:
                        type:
                          - string
                          - 'null'
                      slug:
                        type:
                          - string
                          - 'null'
                      image_url:
                        type:
                          - string
                          - 'null'
                      active:
                        type: boolean
                      application_theme_template_id:
                        type:
                          - integer
                          - 'null'
                      created_at:
                        type: string
                        format: date_time
                      updated_at:
                        type: string
                        format: date_time
                      countries:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            iso:
                              type: string
                            name:
                              type: string
                      custom_slug:
                        type:
                          - boolean
                          - 'null'
                        example: true
                      use_search_engine:
                        type: boolean
                        example: true
                      show_on_site_search:
                        type: boolean
                        example: false
                      post_date:
                        type: string
                        format: date
                        example: '2021-01-01'
                      post_author:
                        type: string
                        example: John Doe
                      summary:
                        type: string
                        example: This is a summary of the post
                      preview_url:
                        type: string
                        example: https://example.com/preview
                      search_engine_optimizer:
                        type: object
                        properties:
                          title:
                            type:
                              - string
                              - 'null'
                            example: Test Post
                          description:
                            type:
                              - string
                              - 'null'
                            example: Test post description
                          image_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/image.jpg
                          image_path:
                            type:
                              - string
                              - 'null'
                            example: /uploads/seo_image.jpg
                          id:
                            type: integer
                            example: 1
                          block_crawler:
                            type: boolean
                            example: false
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '401':
          description: unauthorized
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameters
                  errors:
                    type: object
                    properties:
                      post:
                        type: object
                        properties:
                          title:
                            type: array
                            items:
                              type: string
                        example:
                          title:
                            - must be filled
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                post:
                  type: object
                  properties:
                    title:
                      type: string
                      example: My New Post
                      description: Title of the post
                    description:
                      type: string
                      example: Post content here
                      description: Content/description of the post
                    image_url:
                      type: string
                      example: https://example.com/image.jpg
                      description: URL to post cover image
                    active:
                      type: boolean
                      example: true
                      description: Whether the post is active
                    application_theme_template_id:
                      type: integer
                      example: 1
                      description: ID of the theme template to use
                    country_ids:
                      type: array
                      example:
                        - 1
                        - 2
                      description: Array of country IDs
                    use_search_engine:
                      type: boolean
                      example: true
                      description: Whether to optimize for search engines
                    show_on_site_search:
                      type: boolean
                      example: true
                      description: Whether to show in site search
                    post_date:
                      type: string
                      format: date
                      example: '2021-01-01'
                      description: Date of the post
                    post_author:
                      type: string
                      example: John Doe
                      description: Author of the post
                    summary:
                      type: string
                      example: This is a summary of the post
                      description: Summary of the post
                    preview_url:
                      type: string
                      example: https://example.com/preview
                      description: URL to preview the post
                    search_engine_optimizer_attributes:
                      type: object
                      properties:
                        title:
                          type: string
                          description: SEO title for the post
                        description:
                          type: string
                          description: SEO description for the post
                        image_url:
                          type: string
                          description: SEO image URL for the post
                  required:
                    - title
              required:
                - post
  /api/posts/{id}:
    get:
      summary: Show a post
      description: Get details of a specific post
      tags:
        - Posts
      operationId: showPost
      security:
        - bearer_auth: []
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  post:
                    type: object
                    properties:
                      id:
                        type: integer
                      title:
                        type: string
                      description:
                        type:
                          - string
                          - 'null'
                      slug:
                        type:
                          - string
                          - 'null'
                      image_url:
                        type:
                          - string
                          - 'null'
                      active:
                        type: boolean
                      application_theme_template_id:
                        type:
                          - integer
                          - 'null'
                      created_at:
                        type: string
                        format: date_time
                      updated_at:
                        type: string
                        format: date_time
                      countries:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            iso:
                              type: string
                            name:
                              type: string
                      custom_slug:
                        type:
                          - boolean
                          - 'null'
                        example: true
                      use_search_engine:
                        type: boolean
                        example: true
                      show_on_site_search:
                        type: boolean
                        example: false
                      post_date:
                        type: string
                        format: date
                        example: '2021-01-01'
                      post_author:
                        type: string
                        example: John Doe
                      summary:
                        type: string
                        example: This is a summary of the post
                      preview_url:
                        type: string
                        example: https://example.com/preview
                      search_engine_optimizer:
                        type:
                          - object
                          - 'null'
                        properties:
                          title:
                            type:
                              - string
                              - 'null'
                            example: Test Post
                          description:
                            type:
                              - string
                              - 'null'
                            example: Test post description
                          image_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/image.jpg
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '401':
          description: unauthorized
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    properties:
                      post:
                        type: array
                        items:
                          type: string
                        example:
                          - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
    patch:
      summary: Update a post
      description: Update an existing post
      tags:
        - Posts
      operationId: updatePost
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  post:
                    type: object
                    properties:
                      id:
                        type: integer
                      title:
                        type: string
                      description:
                        type:
                          - string
                          - 'null'
                      slug:
                        type:
                          - string
                          - 'null'
                      image_url:
                        type:
                          - string
                          - 'null'
                      active:
                        type: boolean
                      application_theme_template_id:
                        type:
                          - integer
                          - 'null'
                      created_at:
                        type: string
                        format: date_time
                      updated_at:
                        type: string
                        format: date_time
                      countries:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            iso:
                              type: string
                            name:
                              type: string
                      custom_slug:
                        type:
                          - boolean
                          - 'null'
                        example: true
                      use_search_engine:
                        type: boolean
                        example: true
                      show_on_site_search:
                        type: boolean
                        example: false
                      post_date:
                        type: string
                        format: date
                        example: '2021-01-01'
                      post_author:
                        type: string
                        example: John Doe
                      summary:
                        type: string
                        example: This is a summary of the post
                      preview_url:
                        type: string
                        example: https://example.com/preview
                      search_engine_optimizer:
                        type:
                          - object
                          - 'null'
                        properties:
                          title:
                            type:
                              - string
                              - 'null'
                            example: Test Post
                          description:
                            type:
                              - string
                              - 'null'
                            example: Test post description
                          image_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/image.jpg
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '401':
          description: unauthorized
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    properties:
                      post:
                        type: array
                        items:
                          type: string
                        example:
                          - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameters
                  errors:
                    type: object
                    properties:
                      post:
                        type: object
                        properties:
                          title:
                            type: array
                            items:
                              type: string
                            example:
                              - is missing
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                post:
                  type: object
                  properties:
                    title:
                      type: string
                      example: Updated Post Title
                      description: Title of the post
                    description:
                      type: string
                      example: Updated content
                      description: Content/description of the post
                    image_url:
                      type: string
                      example: https://example.com/new-image.jpg
                      description: URL to post cover image
                    active:
                      type: boolean
                      example: false
                      description: Whether the post is active
                    application_theme_template_id:
                      type: integer
                      example: 2
                      description: ID of the theme template to use
                    post_date:
                      type: string
                      format: date
                      example: '2021-01-01'
                    post_author:
                      type: string
                      example: John Doe
                    summary:
                      type: string
                      example: This is a summary of the post
              required:
                - post
    put:
      summary: Update a post
      description: Update an existing post (PUT method)
      tags:
        - Posts
      operationId: updatePostPut
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  post:
                    type: object
                    properties:
                      id:
                        type: integer
                      title:
                        type: string
                      description:
                        type:
                          - string
                          - 'null'
                      slug:
                        type:
                          - string
                          - 'null'
                      image_url:
                        type:
                          - string
                          - 'null'
                      active:
                        type: boolean
                      application_theme_template_id:
                        type:
                          - integer
                          - 'null'
                      created_at:
                        type: string
                        format: date_time
                      updated_at:
                        type: string
                        format: date_time
                      countries:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            iso:
                              type: string
                            name:
                              type: string
                      custom_slug:
                        type:
                          - boolean
                          - 'null'
                        example: true
                      use_search_engine:
                        type: boolean
                        example: true
                      show_on_site_search:
                        type: boolean
                        example: false
                      post_date:
                        type: string
                        format: date
                        example: '2021-01-01'
                      post_author:
                        type: string
                        example: John Doe
                      summary:
                        type: string
                        example: This is a summary of the post
                      preview_url:
                        type: string
                        example: https://example.com/preview
                      search_engine_optimizer:
                        type:
                          - object
                          - 'null'
                        properties:
                          title:
                            type:
                              - string
                              - 'null'
                            example: Test Post
                          description:
                            type:
                              - string
                              - 'null'
                            example: Test post description
                          image_url:
                            type:
                              - string
                              - 'null'
                            example: https://example.com/image.jpg
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                post:
                  type: object
                  properties:
                    title:
                      type: string
                      example: Updated Post Title
                      description: Title of the post
                    description:
                      type: string
                      example: Updated content
                      description: Content/description of the post
                    image_url:
                      type: string
                      example: https://example.com/new-image.jpg
                      description: URL to post cover image
                    active:
                      type: boolean
                      example: false
                      description: Whether the post is active
                    application_theme_template_id:
                      type: integer
                      example: 2
                      description: ID of the theme template to use
                    post_date:
                      type: string
                      format: date
                      example: '2021-01-01'
                    post_author:
                      type: string
                      example: John Doe
                    summary:
                      type: string
                      example: This is a summary of the post
              required:
                - post
    delete:
      summary: Delete a post
      description: Delete a post (hard delete)
      tags:
        - Posts
      operationId: deletePost
      security:
        - bearer_auth: []
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  post:
                    type: object
                    properties:
                      id:
                        type: integer
                      title:
                        type: string
                      description:
                        type:
                          - string
                          - 'null'
                      slug:
                        type:
                          - string
                          - 'null'
                      image_url:
                        type:
                          - string
                          - 'null'
                      active:
                        type: boolean
                      application_theme_template_id:
                        type:
                          - integer
                          - 'null'
                      created_at:
                        type: string
                        format: date_time
                      updated_at:
                        type: string
                        format: date_time
                      countries:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            iso:
                              type: string
                            name:
                              type: string
                      custom_slug:
                        type:
                          - boolean
                          - 'null'
                        example: true
                      use_search_engine:
                        type: boolean
                        example: true
                      show_on_site_search:
                        type: boolean
                        example: false
                      post_date:
                        type: string
                        format: date
                        example: '2021-01-01'
                      post_author:
                        type: string
                        example: John Doe
                      summary:
                        type: string
                        example: This is a summary of the post
                      preview_url:
                        type: string
                        example: https://example.com/preview
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '401':
          description: unauthorized
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    properties:
                      post:
                        type: array
                        items:
                          type: string
                        example:
                          - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
    parameters:
      - name: id
        in: path
        description: Post ID
        required: true
        schema:
          type: integer
  /api/company/v1/products/{product_id}/product_bundles:
    post:
      summary: Create a product bundle
      tags:
        - Product Bundles
      description: Creates a new product bundle for a product
      operationId: createProductBundle
      security:
        - bearer_auth: []
      parameters:
        - name: product_id
          in: path
          required: true
          description: Product ID
          example: 1
          schema:
            type: integer
      responses:
        '201':
          description: Product bundle created
          content:
            application/json:
              schema:
                type: object
                properties:
                  product_bundle:
                    title: ProductBundle
                    type: object
                    properties:
                      id:
                        type: integer
                      quantity:
                        type: integer
                        default: 1
                        minimum: 1
                      tax_percentage:
                        type:
                          - number
                          - string
                          - 'null'
                        minimum: 0.01
                        maximum: 100
                      display_externally:
                        type:
                          - boolean
                          - 'null'
                        default: true
                      bundled_variant:
                        title: Variant
                        type: object
                        properties:
                          id:
                            type: integer
                          title:
                            example: Variant 1
                            type:
                              - string
                              - 'null'
                          image_url:
                            example: https://via.placeholder.com/150
                            type:
                              - string
                              - 'null'
                          image_path:
                            example: https://via.placeholder.com/150
                            type:
                              - string
                              - 'null'
                          sku:
                            example: SKU-123456
                            type:
                              - string
                              - 'null'
                          primary_image:
                            example: https://via.placeholder.com/150
                            type:
                              - string
                              - 'null'
                          price:
                            example: 100
                            type:
                              - number
                              - string
                              - 'null'
                          price_in_currency:
                            example: USD 100.00
                            type: string
                          options:
                            items:
                              type: object
                              properties:
                                title:
                                  type: string
                                  example: Size
                                value:
                                  type: string
                                  example: XL
                            type: array
                          product:
                            title: Product
                            type: object
                            properties:
                              id:
                                type: integer
                              title:
                                type: string
                              image_url:
                                type:
                                  - string
                                  - 'null'
                              image_path:
                                type:
                                  - string
                                  - 'null'
                              cv:
                                type:
                                  - integer
                                  - 'null'
                                default: 0
                              tax:
                                type:
                                  - number
                                  - string
                                  - 'null'
                                default: '0.0'
                              sku:
                                type:
                                  - string
                                  - 'null'
                              metadata:
                                type: object
                                default: '{}'
                              external_id:
                                type:
                                  - string
                                  - 'null'
                              price:
                                type:
                                  - number
                                  - string
                                  - 'null'
                                default: '0.0'
                                minimum: 0
                                maximum: 99999999
                              introduction:
                                type:
                                  - string
                                  - 'null'
                              price_in_currency:
                                type: string
                              tax_in_currency:
                                type: string
                              cv_in_currency:
                                type: string
                              metafields:
                                type: array
                                items:
                                  title: LegacyMetafield
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                    namespace:
                                      description: >-
                                        A container for related metafields.
                                        Commonly used to group metafields by app
                                        or functionality.
                                      example: custom
                                      type: string
                                      maxLength: 20
                                      pattern: ^[a-zA-Z0-9_]+$
                                    key:
                                      description: >-
                                        The unique identifier for the metafield
                                        within its namespace. Must be unique per
                                        namespace and owner.
                                      example: material
                                      type: string
                                      maxLength: 30
                                      pattern: ^[a-zA-Z0-9_]+$
                                    value:
                                      description: >-
                                        The actual data stored in the metafield.
                                        Type depends on value_type.
                                      example: cotton
                                      type:
                                        - string
                                        - object
                                    value_type:
                                      description: >-
                                        The data type that defines how the value
                                        should be interpreted and validated.
                                      example: single_line_text_field
                                      type: string
                                    description:
                                      description: >-
                                        Optional human-readable description
                                        explaining the purpose of this
                                        metafield.
                                      example: >-
                                        The primary material used in this
                                        product
                                      type:
                                        - string
                                        - 'null'
                                    owner_type:
                                      description: >-
                                        The type of resource that this metafield
                                        belongs to (polymorphic association).
                                      example: Product
                                      type: string
                                    owner_id:
                                      description: >-
                                        The ID of the specific resource that
                                        this metafield belongs to.
                                      example: 12345
                                      type: integer
                                    created_at:
                                      description: >-
                                        Timestamp when the metafield was
                                        created.
                                      example: '2021-01-01T00:00:00Z'
                                      type: string
                                      format: date-time
                                    updated_at:
                                      description: >-
                                        Timestamp when the metafield was last
                                        updated.
                                      example: '2021-01-01T00:00:00Z'
                                      type: string
                                      format: date-time
                                    metafield_definition:
                                      title: MetafieldDefinition
                                      type:
                                        - object
                                        - 'null'
                                      properties:
                                        id:
                                          type: integer
                                        company_id:
                                          description: >-
                                            The ID of the company that owns this
                                            metafield definition.
                                          example: 1
                                          type: integer
                                        namespace:
                                          description: >-
                                            A container for related metafield
                                            definitions. Used to group definitions
                                            by app or functionality. Must be unique
                                            within company and owner_resource.
                                          example: product_details
                                          type: string
                                          maxLength: 20
                                          pattern: ^[a-zA-Z0-9_]+$
                                        key:
                                          description: >-
                                            The unique identifier for the metafield
                                            definition within its namespace and
                                            owner_resource. Combined with namespace
                                            and owner_resource, this must be unique
                                            per company.
                                          example: material_type
                                          type: string
                                          maxLength: 30
                                          pattern: ^[a-zA-Z0-9_]+$
                                        name:
                                          description: >-
                                            Human-readable display name for the
                                            metafield definition, shown in admin
                                            interfaces and forms.
                                          example: Material Type
                                          type: string
                                          maxLength: 100
                                        description:
                                          description: >-
                                            Detailed explanation of what this
                                            metafield definition represents, how it
                                            should be used, and any special
                                            instructions for content creators.
                                          example: >-
                                            Specify the primary material composition
                                            of the product (e.g., cotton, polyester,
                                            silk). This will be displayed on the
                                            product detail page.
                                          type:
                                            - string
                                            - 'null'
                                        value_type:
                                          description: >-
                                            The data type that defines how metafield
                                            values should be validated, stored, and
                                            displayed. Determines which validation
                                            rules are available.
                                          example: single_line_text_field
                                          type: string
                                        validation_rules:
                                          description: >-
                                            JSON object containing validation
                                            constraints that will be applied to
                                            metafield values. Available rules depend
                                            on the value_type.
                                          example:
                                            choices:
                                              - cotton
                                              - polyester
                                              - silk
                                              - wool
                                              - linen
                                              - bamboo
                                            max: 50
                                            min: 2
                                          type:
                                            - object
                                            - 'null'
                                        owner_resource:
                                          description: >-
                                            The type of resource (model class name)
                                            that metafields using this definition
                                            can be attached to. Must match the
                                            polymorphic owner_type.
                                          example: Product
                                          type: string
                                        pinned:
                                          description: >-
                                            Whether this definition should be
                                            prominently displayed or prioritized in
                                            admin interfaces and forms.
                                          example: false
                                          type:
                                            - boolean
                                            - 'null'
                                          default: false
                                        position:
                                          default: 0
                                          description: >-
                                            Sort order for displaying this
                                            definition relative to others in the
                                            same category and owner_resource. Lower
                                            numbers appear first.
                                          example: 1
                                          type:
                                            - integer
                                            - 'null'
                                        locked:
                                          description: >-
                                            Whether this metafield definition is
                                            locked, preventing direct updates or
                                            deletions of metafields using this
                                            definition.
                                          example: false
                                          type:
                                            - boolean
                                            - 'null'
                                          default: false
                                        created_at:
                                          description: >-
                                            Timestamp when the metafield definition
                                            was created.
                                          example: '2024-01-15T10:30:00Z'
                                          type: string
                                          format: date-time
                                        updated_at:
                                          description: >-
                                            Timestamp when the metafield definition
                                            was last updated.
                                          example: '2024-02-20T14:45:00Z'
                                          type: string
                                          format: date-time
                                        list_type:
                                          description: >-
                                            Whether this definition is for list-type
                                            metafields that store arrays of values.
                                          example: false
                                          type: boolean
                                        reference_type:
                                          description: >-
                                            Whether this definition is for
                                            reference-type metafields that store
                                            references to other resources.
                                          example: false
                                          type: boolean
                                        supported_validations:
                                          description: >-
                                            Array of validation rule names that are
                                            supported for this value_type.
                                          example:
                                            - min
                                            - max
                                            - choices
                                            - regex
                                          type: array
                                        validation_description:
                                          description: >-
                                            Human-readable description of what the
                                            value_type represents and its
                                            constraints.
                                          example: Single line text up to 5000 characters
                                          type: string
                                        category_ids:
                                          description: >-
                                            Array of category IDs that this
                                            metafield definition is associated with
                                            for organizational purposes.
                                          example:
                                            - 1
                                            - 2
                                            - 3
                                          items:
                                            type: integer
                                          type: array
                                      required:
                                        - id
                                        - company_id
                                        - namespace
                                        - key
                                        - name
                                        - value_type
                                        - owner_resource
                                        - created_at
                                        - updated_at
                                        - list_type
                                        - reference_type
                                        - supported_validations
                                        - validation_description
                                        - category_ids
                                  required:
                                    - id
                                    - namespace
                                    - key
                                    - value
                                    - value_type
                                    - owner_type
                                    - owner_id
                                    - created_at
                                    - updated_at
                            required:
                              - id
                              - title
                              - metadata
                              - price_in_currency
                              - tax_in_currency
                              - cv_in_currency
                              - metafields
                        required:
                          - id
                          - price_in_currency
                          - options
                          - product
                    required:
                      - id
                      - quantity
                      - bundled_variant
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - product_bundle
                  - meta
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '404':
          description: Bundled variant not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: Validation failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                bundled_variant_id:
                  type: integer
                  example: 123
                quantity:
                  type: integer
                  example: 2
                display_externally:
                  type: boolean
                  example: true
              required:
                - bundled_variant_id
                - quantity
    get:
      summary: List product bundles
      tags:
        - Product Bundles
      operationId: listProductBundles
      security:
        - bearer_auth: []
      parameters:
        - name: product_id
          in: path
          required: true
          description: Product ID
          example: 1
          schema:
            type: integer
      responses:
        '200':
          description: Empty product bundles list
          content:
            application/json:
              schema:
                type: object
                properties:
                  product_bundles:
                    type: array
                    items:
                      title: ProductBundle
                      type: object
                      properties:
                        id:
                          type: integer
                        quantity:
                          type: integer
                          default: 1
                          minimum: 1
                        tax_percentage:
                          type:
                            - number
                            - string
                            - 'null'
                          minimum: 0.01
                          maximum: 100
                        display_externally:
                          type:
                            - boolean
                            - 'null'
                          default: true
                        bundled_variant:
                          title: Variant
                          type: object
                          properties:
                            id:
                              type: integer
                            title:
                              example: Variant 1
                              type:
                                - string
                                - 'null'
                            image_url:
                              example: https://via.placeholder.com/150
                              type:
                                - string
                                - 'null'
                            image_path:
                              example: https://via.placeholder.com/150
                              type:
                                - string
                                - 'null'
                            sku:
                              example: SKU-123456
                              type:
                                - string
                                - 'null'
                            primary_image:
                              example: https://via.placeholder.com/150
                              type:
                                - string
                                - 'null'
                            price:
                              example: 100
                              type:
                                - number
                                - string
                                - 'null'
                            price_in_currency:
                              example: USD 100.00
                              type: string
                            options:
                              items:
                                type: object
                                properties:
                                  title:
                                    type: string
                                    example: Size
                                  value:
                                    type: string
                                    example: XL
                              type: array
                            product:
                              title: Product
                              type: object
                              properties:
                                id:
                                  type: integer
                                title:
                                  type: string
                                image_url:
                                  type:
                                    - string
                                    - 'null'
                                image_path:
                                  type:
                                    - string
                                    - 'null'
                                cv:
                                  type:
                                    - integer
                                    - 'null'
                                  default: 0
                                tax:
                                  type:
                                    - number
                                    - string
                                    - 'null'
                                  default: '0.0'
                                sku:
                                  type:
                                    - string
                                    - 'null'
                                metadata:
                                  type: object
                                  default: '{}'
                                external_id:
                                  type:
                                    - string
                                    - 'null'
                                price:
                                  type:
                                    - number
                                    - string
                                    - 'null'
                                  default: '0.0'
                                  minimum: 0
                                  maximum: 99999999
                                introduction:
                                  type:
                                    - string
                                    - 'null'
                                price_in_currency:
                                  type: string
                                tax_in_currency:
                                  type: string
                                cv_in_currency:
                                  type: string
                                metafields:
                                  type: array
                                  items:
                                    title: LegacyMetafield
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      namespace:
                                        description: >-
                                          A container for related metafields.
                                          Commonly used to group metafields by app
                                          or functionality.
                                        example: custom
                                        type: string
                                        maxLength: 20
                                        pattern: ^[a-zA-Z0-9_]+$
                                      key:
                                        description: >-
                                          The unique identifier for the metafield
                                          within its namespace. Must be unique per
                                          namespace and owner.
                                        example: material
                                        type: string
                                        maxLength: 30
                                        pattern: ^[a-zA-Z0-9_]+$
                                      value:
                                        description: >-
                                          The actual data stored in the metafield.
                                          Type depends on value_type.
                                        example: cotton
                                        type:
                                          - string
                                          - object
                                      value_type:
                                        description: >-
                                          The data type that defines how the value
                                          should be interpreted and validated.
                                        example: single_line_text_field
                                        type: string
                                      description:
                                        description: >-
                                          Optional human-readable description
                                          explaining the purpose of this
                                          metafield.
                                        example: >-
                                          The primary material used in this
                                          product
                                        type:
                                          - string
                                          - 'null'
                                      owner_type:
                                        description: >-
                                          The type of resource that this metafield
                                          belongs to (polymorphic association).
                                        example: Product
                                        type: string
                                      owner_id:
                                        description: >-
                                          The ID of the specific resource that
                                          this metafield belongs to.
                                        example: 12345
                                        type: integer
                                      created_at:
                                        description: >-
                                          Timestamp when the metafield was
                                          created.
                                        example: '2021-01-01T00:00:00Z'
                                        type: string
                                        format: date-time
                                      updated_at:
                                        description: >-
                                          Timestamp when the metafield was last
                                          updated.
                                        example: '2021-01-01T00:00:00Z'
                                        type: string
                                        format: date-time
                                      metafield_definition:
                                        title: MetafieldDefinition
                                        type:
                                          - object
                                          - 'null'
                                        properties:
                                          id:
                                            type: integer
                                          company_id:
                                            description: >-
                                              The ID of the company that owns this
                                              metafield definition.
                                            example: 1
                                            type: integer
                                          namespace:
                                            description: >-
                                              A container for related metafield
                                              definitions. Used to group definitions
                                              by app or functionality. Must be unique
                                              within company and owner_resource.
                                            example: product_details
                                            type: string
                                            maxLength: 20
                                            pattern: ^[a-zA-Z0-9_]+$
                                          key:
                                            description: >-
                                              The unique identifier for the metafield
                                              definition within its namespace and
                                              owner_resource. Combined with namespace
                                              and owner_resource, this must be unique
                                              per company.
                                            example: material_type
                                            type: string
                                            maxLength: 30
                                            pattern: ^[a-zA-Z0-9_]+$
                                          name:
                                            description: >-
                                              Human-readable display name for the
                                              metafield definition, shown in admin
                                              interfaces and forms.
                                            example: Material Type
                                            type: string
                                            maxLength: 100
                                          description:
                                            description: >-
                                              Detailed explanation of what this
                                              metafield definition represents, how it
                                              should be used, and any special
                                              instructions for content creators.
                                            example: >-
                                              Specify the primary material composition
                                              of the product (e.g., cotton, polyester,
                                              silk). This will be displayed on the
                                              product detail page.
                                            type:
                                              - string
                                              - 'null'
                                          value_type:
                                            description: >-
                                              The data type that defines how metafield
                                              values should be validated, stored, and
                                              displayed. Determines which validation
                                              rules are available.
                                            example: single_line_text_field
                                            type: string
                                          validation_rules:
                                            description: >-
                                              JSON object containing validation
                                              constraints that will be applied to
                                              metafield values. Available rules depend
                                              on the value_type.
                                            example:
                                              choices:
                                                - cotton
                                                - polyester
                                                - silk
                                                - wool
                                                - linen
                                                - bamboo
                                              max: 50
                                              min: 2
                                            type:
                                              - object
                                              - 'null'
                                          owner_resource:
                                            description: >-
                                              The type of resource (model class name)
                                              that metafields using this definition
                                              can be attached to. Must match the
                                              polymorphic owner_type.
                                            example: Product
                                            type: string
                                          pinned:
                                            description: >-
                                              Whether this definition should be
                                              prominently displayed or prioritized in
                                              admin interfaces and forms.
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          position:
                                            default: 0
                                            description: >-
                                              Sort order for displaying this
                                              definition relative to others in the
                                              same category and owner_resource. Lower
                                              numbers appear first.
                                            example: 1
                                            type:
                                              - integer
                                              - 'null'
                                          locked:
                                            description: >-
                                              Whether this metafield definition is
                                              locked, preventing direct updates or
                                              deletions of metafields using this
                                              definition.
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                            default: false
                                          created_at:
                                            description: >-
                                              Timestamp when the metafield definition
                                              was created.
                                            example: '2024-01-15T10:30:00Z'
                                            type: string
                                            format: date-time
                                          updated_at:
                                            description: >-
                                              Timestamp when the metafield definition
                                              was last updated.
                                            example: '2024-02-20T14:45:00Z'
                                            type: string
                                            format: date-time
                                          list_type:
                                            description: >-
                                              Whether this definition is for list-type
                                              metafields that store arrays of values.
                                            example: false
                                            type: boolean
                                          reference_type:
                                            description: >-
                                              Whether this definition is for
                                              reference-type metafields that store
                                              references to other resources.
                                            example: false
                                            type: boolean
                                          supported_validations:
                                            description: >-
                                              Array of validation rule names that are
                                              supported for this value_type.
                                            example:
                                              - min
                                              - max
                                              - choices
                                              - regex
                                            type: array
                                          validation_description:
                                            description: >-
                                              Human-readable description of what the
                                              value_type represents and its
                                              constraints.
                                            example: Single line text up to 5000 characters
                                            type: string
                                          category_ids:
                                            description: >-
                                              Array of category IDs that this
                                              metafield definition is associated with
                                              for organizational purposes.
                                            example:
                                              - 1
                                              - 2
                                              - 3
                                            items:
                                              type: integer
                                            type: array
                                        required:
                                          - id
                                          - company_id
                                          - namespace
                                          - key
                                          - name
                                          - value_type
                                          - owner_resource
                                          - created_at
                                          - updated_at
                                          - list_type
                                          - reference_type
                                          - supported_validations
                                          - validation_description
                                          - category_ids
                                    required:
                                      - id
                                      - namespace
                                      - key
                                      - value
                                      - value_type
                                      - owner_type
                                      - owner_id
                                      - created_at
                                      - updated_at
                              required:
                                - id
                                - title
                                - metadata
                                - price_in_currency
                                - tax_in_currency
                                - cv_in_currency
                                - metafields
                          required:
                            - id
                            - price_in_currency
                            - options
                            - product
                        bundled_variant_id:
                          type: integer
                      required:
                        - id
                        - bundled_variant_id
                        - quantity
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - product_bundles
                  - meta
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '404':
          description: Product not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/company/v1/products/{product_id}/product_bundles/{id}:
    delete:
      summary: Delete a product bundle
      tags:
        - Product Bundles
      description: Removes a product bundle from a product
      operationId: deleteProductBundle
      security:
        - bearer_auth: []
      parameters:
        - name: product_id
          in: path
          required: true
          description: Product ID
          example: 1
          schema:
            type: integer
        - name: id
          in: path
          required: true
          description: Product bundle ID
          example: 1
          schema:
            type: integer
      responses:
        '200':
          description: Product bundle deleted
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Product bundle deleted
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - message
                  - meta
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '404':
          description: Product bundle not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: Cannot delete product bundle
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
    patch:
      summary: Update a product bundle
      tags:
        - Product Bundles
      description: Updates an existing product bundle for a product
      operationId: updateProductBundle
      security:
        - bearer_auth: []
      parameters:
        - name: product_id
          in: path
          required: true
          description: Product ID
          example: 1
          schema:
            type: integer
        - name: id
          in: path
          required: true
          description: Product Bundle ID
          example: 1
          schema:
            type: integer
      responses:
        '200':
          description: Product bundle updated with new bundled variant
          content:
            application/json:
              schema:
                type: object
                properties:
                  product_bundle:
                    title: ProductBundle
                    type: object
                    properties:
                      id:
                        type: integer
                      quantity:
                        type: integer
                        default: 1
                        minimum: 1
                      tax_percentage:
                        type:
                          - number
                          - string
                          - 'null'
                        minimum: 0.01
                        maximum: 100
                      display_externally:
                        type:
                          - boolean
                          - 'null'
                        default: true
                      bundled_variant:
                        title: Variant
                        type: object
                        properties:
                          id:
                            type: integer
                          title:
                            example: Variant 1
                            type:
                              - string
                              - 'null'
                          image_url:
                            example: https://via.placeholder.com/150
                            type:
                              - string
                              - 'null'
                          image_path:
                            example: https://via.placeholder.com/150
                            type:
                              - string
                              - 'null'
                          sku:
                            example: SKU-123456
                            type:
                              - string
                              - 'null'
                          primary_image:
                            example: https://via.placeholder.com/150
                            type:
                              - string
                              - 'null'
                          price:
                            example: 100
                            type:
                              - number
                              - string
                              - 'null'
                          price_in_currency:
                            example: USD 100.00
                            type: string
                          options:
                            items:
                              type: object
                              properties:
                                title:
                                  type: string
                                  example: Size
                                value:
                                  type: string
                                  example: XL
                            type: array
                          product:
                            title: Product
                            type: object
                            properties:
                              id:
                                type: integer
                              title:
                                type: string
                              image_url:
                                type:
                                  - string
                                  - 'null'
                              image_path:
                                type:
                                  - string
                                  - 'null'
                              cv:
                                type:
                                  - integer
                                  - 'null'
                                default: 0
                              tax:
                                type:
                                  - number
                                  - string
                                  - 'null'
                                default: '0.0'
                              sku:
                                type:
                                  - string
                                  - 'null'
                              metadata:
                                type: object
                                default: '{}'
                              external_id:
                                type:
                                  - string
                                  - 'null'
                              price:
                                type:
                                  - number
                                  - string
                                  - 'null'
                                default: '0.0'
                                minimum: 0
                                maximum: 99999999
                              introduction:
                                type:
                                  - string
                                  - 'null'
                              price_in_currency:
                                type: string
                              tax_in_currency:
                                type: string
                              cv_in_currency:
                                type: string
                              metafields:
                                type: array
                                items:
                                  title: LegacyMetafield
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                    namespace:
                                      description: >-
                                        A container for related metafields.
                                        Commonly used to group metafields by app
                                        or functionality.
                                      example: custom
                                      type: string
                                      maxLength: 20
                                      pattern: ^[a-zA-Z0-9_]+$
                                    key:
                                      description: >-
                                        The unique identifier for the metafield
                                        within its namespace. Must be unique per
                                        namespace and owner.
                                      example: material
                                      type: string
                                      maxLength: 30
                                      pattern: ^[a-zA-Z0-9_]+$
                                    value:
                                      description: >-
                                        The actual data stored in the metafield.
                                        Type depends on value_type.
                                      example: cotton
                                      type:
                                        - string
                                        - object
                                    value_type:
                                      description: >-
                                        The data type that defines how the value
                                        should be interpreted and validated.
                                      example: single_line_text_field
                                      type: string
                                    description:
                                      description: >-
                                        Optional human-readable description
                                        explaining the purpose of this
                                        metafield.
                                      example: >-
                                        The primary material used in this
                                        product
                                      type:
                                        - string
                                        - 'null'
                                    owner_type:
                                      description: >-
                                        The type of resource that this metafield
                                        belongs to (polymorphic association).
                                      example: Product
                                      type: string
                                    owner_id:
                                      description: >-
                                        The ID of the specific resource that
                                        this metafield belongs to.
                                      example: 12345
                                      type: integer
                                    created_at:
                                      description: >-
                                        Timestamp when the metafield was
                                        created.
                                      example: '2021-01-01T00:00:00Z'
                                      type: string
                                      format: date-time
                                    updated_at:
                                      description: >-
                                        Timestamp when the metafield was last
                                        updated.
                                      example: '2021-01-01T00:00:00Z'
                                      type: string
                                      format: date-time
                                    metafield_definition:
                                      title: MetafieldDefinition
                                      type:
                                        - object
                                        - 'null'
                                      properties:
                                        id:
                                          type: integer
                                        company_id:
                                          description: >-
                                            The ID of the company that owns this
                                            metafield definition.
                                          example: 1
                                          type: integer
                                        namespace:
                                          description: >-
                                            A container for related metafield
                                            definitions. Used to group definitions
                                            by app or functionality. Must be unique
                                            within company and owner_resource.
                                          example: product_details
                                          type: string
                                          maxLength: 20
                                          pattern: ^[a-zA-Z0-9_]+$
                                        key:
                                          description: >-
                                            The unique identifier for the metafield
                                            definition within its namespace and
                                            owner_resource. Combined with namespace
                                            and owner_resource, this must be unique
                                            per company.
                                          example: material_type
                                          type: string
                                          maxLength: 30
                                          pattern: ^[a-zA-Z0-9_]+$
                                        name:
                                          description: >-
                                            Human-readable display name for the
                                            metafield definition, shown in admin
                                            interfaces and forms.
                                          example: Material Type
                                          type: string
                                          maxLength: 100
                                        description:
                                          description: >-
                                            Detailed explanation of what this
                                            metafield definition represents, how it
                                            should be used, and any special
                                            instructions for content creators.
                                          example: >-
                                            Specify the primary material composition
                                            of the product (e.g., cotton, polyester,
                                            silk). This will be displayed on the
                                            product detail page.
                                          type:
                                            - string
                                            - 'null'
                                        value_type:
                                          description: >-
                                            The data type that defines how metafield
                                            values should be validated, stored, and
                                            displayed. Determines which validation
                                            rules are available.
                                          example: single_line_text_field
                                          type: string
                                        validation_rules:
                                          description: >-
                                            JSON object containing validation
                                            constraints that will be applied to
                                            metafield values. Available rules depend
                                            on the value_type.
                                          example:
                                            choices:
                                              - cotton
                                              - polyester
                                              - silk
                                              - wool
                                              - linen
                                              - bamboo
                                            max: 50
                                            min: 2
                                          type:
                                            - object
                                            - 'null'
                                        owner_resource:
                                          description: >-
                                            The type of resource (model class name)
                                            that metafields using this definition
                                            can be attached to. Must match the
                                            polymorphic owner_type.
                                          example: Product
                                          type: string
                                        pinned:
                                          description: >-
                                            Whether this definition should be
                                            prominently displayed or prioritized in
                                            admin interfaces and forms.
                                          example: false
                                          type:
                                            - boolean
                                            - 'null'
                                          default: false
                                        position:
                                          default: 0
                                          description: >-
                                            Sort order for displaying this
                                            definition relative to others in the
                                            same category and owner_resource. Lower
                                            numbers appear first.
                                          example: 1
                                          type:
                                            - integer
                                            - 'null'
                                        locked:
                                          description: >-
                                            Whether this metafield definition is
                                            locked, preventing direct updates or
                                            deletions of metafields using this
                                            definition.
                                          example: false
                                          type:
                                            - boolean
                                            - 'null'
                                          default: false
                                        created_at:
                                          description: >-
                                            Timestamp when the metafield definition
                                            was created.
                                          example: '2024-01-15T10:30:00Z'
                                          type: string
                                          format: date-time
                                        updated_at:
                                          description: >-
                                            Timestamp when the metafield definition
                                            was last updated.
                                          example: '2024-02-20T14:45:00Z'
                                          type: string
                                          format: date-time
                                        list_type:
                                          description: >-
                                            Whether this definition is for list-type
                                            metafields that store arrays of values.
                                          example: false
                                          type: boolean
                                        reference_type:
                                          description: >-
                                            Whether this definition is for
                                            reference-type metafields that store
                                            references to other resources.
                                          example: false
                                          type: boolean
                                        supported_validations:
                                          description: >-
                                            Array of validation rule names that are
                                            supported for this value_type.
                                          example:
                                            - min
                                            - max
                                            - choices
                                            - regex
                                          type: array
                                        validation_description:
                                          description: >-
                                            Human-readable description of what the
                                            value_type represents and its
                                            constraints.
                                          example: Single line text up to 5000 characters
                                          type: string
                                        category_ids:
                                          description: >-
                                            Array of category IDs that this
                                            metafield definition is associated with
                                            for organizational purposes.
                                          example:
                                            - 1
                                            - 2
                                            - 3
                                          items:
                                            type: integer
                                          type: array
                                      required:
                                        - id
                                        - company_id
                                        - namespace
                                        - key
                                        - name
                                        - value_type
                                        - owner_resource
                                        - created_at
                                        - updated_at
                                        - list_type
                                        - reference_type
                                        - supported_validations
                                        - validation_description
                                        - category_ids
                                  required:
                                    - id
                                    - namespace
                                    - key
                                    - value
                                    - value_type
                                    - owner_type
                                    - owner_id
                                    - created_at
                                    - updated_at
                            required:
                              - id
                              - title
                              - metadata
                              - price_in_currency
                              - tax_in_currency
                              - cv_in_currency
                              - metafields
                        required:
                          - id
                          - price_in_currency
                          - options
                          - product
                    required:
                      - id
                      - quantity
                      - bundled_variant
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - product_bundle
                  - meta
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '404':
          description: Product bundle not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: Validation failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                bundled_variant_id:
                  type: integer
                  example: 123
                quantity:
                  type: integer
                  example: 3
                display_externally:
                  type: boolean
                  example: true
  /api/company/v1/products/{product_id}/images:
    post:
      summary: Create a new product image
      tags:
        - Product Images
      operationId: createProductImage
      security:
        - bearer_auth: []
      parameters:
        - name: product_id
          in: path
          required: true
          description: Product ID
          example: 1
          schema:
            type: integer
      responses:
        '201':
          description: Product image created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  product_image:
                    title: Image
                    type: object
                    properties:
                      id:
                        type: integer
                      image_url:
                        description: The URL of the image
                        example: https://example.com/images/product-123.jpg
                        type:
                          - string
                          - 'null'
                      image_path:
                        description: The file path of the image
                        example: uploads/products/images/product-123.jpg
                        type:
                          - string
                          - 'null'
                      position:
                        description: >-
                          The display order position of the image (lower numbers
                          display first)
                        example: 1
                        type:
                          - integer
                          - 'null'
                      dam_asset_code:
                        type:
                          - string
                          - 'null'
                    required:
                      - id
                      - dam_asset_code
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - product_image
                  - meta
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '404':
          description: Product not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: Invalid parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                image:
                  type: object
                  properties:
                    image_url:
                      type: string
                    position:
                      type: integer
                  required:
                    - image_url
                    - position
              required:
                - image
    get:
      summary: List product images
      tags:
        - Product Images
      operationId: listProductImages
      security:
        - bearer_auth: []
      parameters:
        - name: product_id
          in: path
          required: true
          description: Product ID
          example: 1
          schema:
            type: integer
      responses:
        '200':
          description: Product images retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  images:
                    type: array
                    items:
                      title: Image
                      type: object
                      properties:
                        id:
                          type: integer
                        image_url:
                          description: The URL of the image
                          example: https://example.com/images/product-123.jpg
                          type:
                            - string
                            - 'null'
                        image_path:
                          description: The file path of the image
                          example: uploads/products/images/product-123.jpg
                          type:
                            - string
                            - 'null'
                        position:
                          description: >-
                            The display order position of the image (lower
                            numbers display first)
                          example: 1
                          type:
                            - integer
                            - 'null'
                        dam_asset_code:
                          type:
                            - string
                            - 'null'
                      required:
                        - id
                        - dam_asset_code
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - images
                  - meta
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '404':
          description: Product not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/company/v1/products/{product_id}/images/{id}:
    delete:
      summary: Delete a product image
      tags:
        - Product Images
      operationId: deleteProductImage
      security:
        - bearer_auth: []
      parameters:
        - name: product_id
          in: path
          required: true
          description: Product ID
          example: 1
          schema:
            type: integer
        - name: id
          in: path
          required: true
          description: Image ID
          example: 1
          schema:
            type: integer
      responses:
        '200':
          description: Product image deleted successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Product image deleted
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - message
                  - meta
        '404':
          description: Product image not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: Cannot delete image
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
    patch:
      summary: Update a product image
      tags:
        - Product Images
      operationId: updateProductImage
      security:
        - bearer_auth: []
      parameters:
        - name: product_id
          in: path
          required: true
          description: Product ID
          example: 1
          schema:
            type: integer
        - name: id
          in: path
          required: true
          description: Image ID
          example: 1
          schema:
            type: integer
      responses:
        '200':
          description: Product image updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  product_image:
                    title: Image
                    type: object
                    properties:
                      id:
                        type: integer
                      image_url:
                        description: The URL of the image
                        example: https://example.com/images/product-123.jpg
                        type:
                          - string
                          - 'null'
                      image_path:
                        description: The file path of the image
                        example: uploads/products/images/product-123.jpg
                        type:
                          - string
                          - 'null'
                      position:
                        description: >-
                          The display order position of the image (lower numbers
                          display first)
                        example: 1
                        type:
                          - integer
                          - 'null'
                      dam_asset_code:
                        type:
                          - string
                          - 'null'
                    required:
                      - id
                      - dam_asset_code
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - product_image
                  - meta
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '404':
          description: Product or image not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: Invalid image data
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                image:
                  type: object
                  properties:
                    position:
                      type: integer
                    image_url:
                      type: string
                  required: []
              required:
                - image
  /api/company/products/{product_id}/product_redirects:
    get:
      tags:
        - Product Redirects
      summary: Get Product External Redirects
      description: Retrieves the external product redirects for various countries.
      operationId: getProductRedirects
      parameters:
        - name: product_id
          in: path
          required: true
          schema:
            type: integer
          description: The ID of the product to get redirects for
      responses:
        '200':
          description: ''
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
      deprecated: false
      security:
        - bearer: []
    post:
      tags:
        - Product Redirects
      summary: Create Product Redirect
      description: Creates an external product redirect for a specific country.
      operationId: createProductRedirect
      parameters:
        - name: product_id
          in: path
          required: true
          schema:
            type: string
          description: ID of the product to create redirect for
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/createrequest13'
                - example:
                    product_redirect:
                      country: fin
                      external_url: https://hoas.fi
            example:
              product_redirect:
                country: fin
                external_url: https://hoas.fi
        required: true
      responses:
        '200':
          description: ''
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
      deprecated: false
      security:
        - bearer: []
  /api/company/products/{product_id}/product_redirects/{id}:
    get:
      tags:
        - Product Redirects
      summary: Get Product Redirect
      description: Retrieves the external product redirect with the specified ID.
      operationId: getProductRedirect
      parameters:
        - name: product_id
          in: path
          required: true
          schema:
            type: integer
          description: ID of the product
        - name: id
          in: path
          required: true
          schema:
            type: integer
          description: ID of the product redirect
      responses:
        '200':
          description: ''
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
      deprecated: false
      security:
        - bearer: []
    patch:
      tags:
        - Product Redirects
      summary: Update Product Redirect
      description: Updates an external product redirect for a specific product.
      operationId: updateProductRedirect
      parameters:
        - name: product_id
          in: path
          required: true
          schema:
            type: integer
          description: ID of the product
        - name: id
          in: path
          required: true
          schema:
            type: integer
          description: ID of the product redirect to update
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/updaterequest12'
                - example:
                    product_redirect:
                      external_url: https://space.com
            example:
              product_redirect:
                external_url: https://space.com
        required: true
      responses:
        '200':
          description: ''
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
      deprecated: false
      security:
        - bearer: []
    delete:
      tags:
        - Product Redirects
      summary: Delete Product Redirect
      description: Deletes an external product redirect with the specified ID.
      operationId: deleteProductRedirect
      parameters:
        - name: product_id
          in: path
          required: true
          schema:
            type: integer
          description: ID of the product
        - name: id
          in: path
          required: true
          schema:
            type: integer
          description: ID of the product redirect to delete
      responses:
        '200':
          description: ''
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
      deprecated: false
      security:
        - bearer: []
  /api/company/v1/products/{product_id}/subscription_plans:
    post:
      summary: Add a subscription plan to a product
      tags:
        - Product Subscription Plans
      operationId: addSubscriptionPlanToProduct
      security:
        - bearer_auth: []
      parameters:
        - name: product_id
          in: path
          required: true
          description: Product ID
          example: 1
          schema:
            type: integer
      responses:
        '201':
          description: Subscription plan added
          content:
            application/json:
              schema:
                type: object
                properties:
                  product_subscription_plan:
                    title: ProductSubscriptionPlan
                    type: object
                    properties:
                      id:
                        type: integer
                      active:
                        description: Whether this plan is active
                        type: boolean
                        default: true
                      product_id:
                        description: The product that this plan is for
                        type: integer
                      subscription_plan_id:
                        description: The subscription plan that this plan is for
                        type: integer
                      default:
                        description: Whether this plan is the default for the product
                        type:
                          - boolean
                          - 'null'
                        default: false
                      created_at:
                        type: string
                        format: date-time
                      updated_at:
                        type: string
                        format: date-time
                    required:
                      - id
                      - active
                      - product_id
                      - subscription_plan_id
                      - created_at
                      - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - product_subscription_plan
                  - meta
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '404':
          description: Product not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: Invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                subscription_plan:
                  type: object
                  properties:
                    id:
                      type: integer
                    default:
                      type: boolean
                  required:
                    - id
              required:
                - subscription_plan
  /api/company/v1/products/{product_id}/subscription_plans/{id}:
    delete:
      summary: Delete a product subscription plan association
      tags:
        - Product Subscription Plans
      operationId: deleteProductSubscriptionPlan
      security:
        - bearer_auth: []
      parameters:
        - name: product_id
          in: path
          required: true
          description: Product ID
          example: 1
          schema:
            type: integer
        - name: id
          in: path
          required: true
          description: Subscription Plan ID
          example: 1
          schema:
            type: integer
      responses:
        '200':
          description: Product subscription plan association deleted
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Product subscription plan association deleted
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - message
                  - meta
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '404':
          description: Product subscription plan association not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: Cannot delete association
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
    patch:
      summary: Update a product subscription plan association
      tags:
        - Product Subscription Plans
      operationId: updateProductSubscriptionPlan
      security:
        - bearer_auth: []
      parameters:
        - name: product_id
          in: path
          required: true
          description: Product ID
          example: 1
          schema:
            type: integer
        - name: id
          in: path
          required: true
          description: Subscription Plan ID
          example: 1
          schema:
            type: integer
      responses:
        '200':
          description: Update default to false
          content:
            application/json:
              schema:
                type: object
                properties:
                  product_subscription_plan:
                    title: ProductSubscriptionPlan
                    type: object
                    properties:
                      id:
                        type: integer
                      active:
                        description: Whether this plan is active
                        type: boolean
                        default: true
                      product_id:
                        description: The product that this plan is for
                        type: integer
                      subscription_plan_id:
                        description: The subscription plan that this plan is for
                        type: integer
                      default:
                        description: Whether this plan is the default for the product
                        type:
                          - boolean
                          - 'null'
                        default: false
                      created_at:
                        type: string
                        format: date-time
                      updated_at:
                        type: string
                        format: date-time
                    required:
                      - id
                      - active
                      - product_id
                      - subscription_plan_id
                      - created_at
                      - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - product_subscription_plan
                  - meta
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '404':
          description: Product subscription plan association not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: Missing default parameter
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                subscription_plan:
                  type: object
                  properties:
                    default:
                      type: boolean
                  required:
                    - default
              required:
                - subscription_plan
  /api/company/v1/products:
    get:
      summary: List products
      tags:
        - Products
      security:
        - bearer_auth: []
      operationId: listProducts
      parameters:
        - name: lang
          in: query
          required: false
          description: >
            Determines language to be used to filter products and display
            translations, if applicable.

            - If not specified, the company's default language is used.

            - This is the 2 letter ISO language code. Examples: 'en', 'es', 'fr'

            - It can be upper case or lower case
          schema:
            type: string
        - name: status[]
          in: query
          description: >-
            Filter by status. Supported values: 'active', 'draft', 'archived'.
            If no filter is sent, returns all products regardless of status.
          required: false
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
        - name: availability[]
          in: query
          description: >-
            Filter by availability. Supported values: 'All', 'in_stock',
            'keep_selling'. If no filter is sent, returns all products
            regardless of availability.
          required: false
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
        - name: country_code[]
          in: query
          description: >-
            Filter by country codes. If no country code is selected it returns
            product in all country
          required: false
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
        - name: published_stores[]
          in: query
          description: >-
            Filter by the stores the products are published to. Supported
            values: 'retail', 'rep', 'share'. If no filter is sent, returns all
            products regardless of the stores the products are published to.
          required: false
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
        - name: category_title
          in: query
          required: false
          description: Filter by category title
          schema:
            type: string
        - name: category_id
          in: query
          required: false
          description: Filter by category ID
          schema:
            type: string
        - name: category_ids[]
          in: query
          description: Filter by category IDs
          required: false
          schema:
            type: array
            items:
              type: integer
          style: form
          explode: true
        - name: collection_id
          in: query
          required: false
          description: Filter by collection ID
          schema:
            type: string
        - name: collection_ids[]
          in: query
          description: Filter by collection IDs
          required: false
          schema:
            type: array
            items:
              type: integer
          style: form
          explode: true
        - name: bundle
          in: query
          required: false
          description: Filter by bundle
          schema:
            type: boolean
        - name: order_by[]
          in: query
          description: Sort results by specified field in specified direction.
          required: false
          schema:
            type: array
            items:
              type: string
            minItems: 2
            maxItems: 2
          style: form
          explode: true
        - name: search_query
          in: query
          required: false
          description: Search the products by title
          schema:
            type: string
        - name: by_metadata
          in: query
          schema:
            type: string
            default: '{}'
            format: json
          required: false
          description: Search JSON meta data
        - name: page
          in: query
          schema:
            type: integer
            default: 1
          required: false
          description: Page number for pagination
        - name: per_page
          in: query
          schema:
            type: integer
            default: 10
          required: false
          description: Number of records per page
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  products:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        sku:
                          type:
                            - string
                            - 'null'
                        title:
                          type:
                            - string
                            - 'null'
                        description:
                          type:
                            - string
                            - 'null'
                        image_url:
                          type: string
                        status:
                          type: string
                        price:
                          type: string
                        commission:
                          type: string
                        public:
                          type: boolean
                        slug:
                          type: string
                        custom_slug:
                          type: boolean
                        active:
                          type: boolean
                        introduction:
                          type:
                            - string
                            - 'null'
                        feature_text:
                          type:
                            - string
                            - 'null'
                        stripped:
                          type:
                            - string
                            - 'null'
                        review_count:
                          type: integer
                        views:
                          type: integer
                        leads:
                          type: integer
                        show_reviews:
                          type: boolean
                        upc:
                          type:
                            - string
                            - 'null'
                        hs_code:
                          type:
                            - string
                            - 'null'
                        compressed_image_url:
                          type:
                            - string
                            - 'null'
                        image_path:
                          type:
                            - string
                            - 'null'
                        external_url:
                          type:
                            - string
                            - 'null'
                        display_price:
                          type: string
                        subscription_price:
                          type: string
                        tax_inclusive_price:
                          type: string
                        tax_inclusive_wholesale:
                          type: string
                        tax_inclusive_subscription_price:
                          type: string
                        tax_inclusive_wholesale_subscription_price:
                          type: string
                        currency_code:
                          type: string
                        tax_category_id:
                          type: integer
                        tax_category:
                          title: TaxCategory
                          type: object
                          properties:
                            id:
                              type: integer
                            code:
                              example: SV010020
                              type: string
                            title:
                              example: Tangible personal property (tpp)
                              type: string
                          required:
                            - id
                            - code
                            - title
                        international_tax_type:
                          type:
                            - string
                            - 'null'
                        in_stock:
                          type: boolean
                        keep_selling:
                          type: boolean
                        track_quantity:
                          type: boolean
                        no_index:
                          type: boolean
                        publish_to_retail_store:
                          type: boolean
                        publish_to_rep_store:
                          type: boolean
                        publish_to_share_tab:
                          type: boolean
                        affiliate_commission:
                          type:
                            - string
                            - 'null'
                        integration_id:
                          type:
                            - string
                            - 'null'
                        external_id:
                          type:
                            - string
                            - 'null'
                        application_theme_template_id:
                          type:
                            - string
                            - 'null'
                        last_synced_at:
                          type:
                            - string
                            - 'null'
                        updated_at:
                          type:
                            - string
                            - 'null'
                        option_attrs:
                          type: array
                          items:
                            type: string
                        metadata:
                          type: object
                          description: >-
                            A JSON object that can store any custom data
                            structure.
                        metafields:
                          type: array
                          items:
                            title: LegacyMetafield
                            type: object
                            properties:
                              id:
                                type: integer
                              namespace:
                                description: >-
                                  A container for related metafields. Commonly
                                  used to group metafields by app or
                                  functionality.
                                example: custom
                                type: string
                                maxLength: 20
                                pattern: ^[a-zA-Z0-9_]+$
                              key:
                                description: >-
                                  The unique identifier for the metafield within
                                  its namespace. Must be unique per namespace
                                  and owner.
                                example: material
                                type: string
                                maxLength: 30
                                pattern: ^[a-zA-Z0-9_]+$
                              value:
                                description: >-
                                  The actual data stored in the metafield. Type
                                  depends on value_type.
                                example: cotton
                                type:
                                  - string
                                  - object
                              value_type:
                                description: >-
                                  The data type that defines how the value
                                  should be interpreted and validated.
                                example: single_line_text_field
                                type: string
                              description:
                                description: >-
                                  Optional human-readable description explaining
                                  the purpose of this metafield.
                                example: The primary material used in this product
                                type:
                                  - string
                                  - 'null'
                              owner_type:
                                description: >-
                                  The type of resource that this metafield
                                  belongs to (polymorphic association).
                                example: Product
                                type: string
                              owner_id:
                                description: >-
                                  The ID of the specific resource that this
                                  metafield belongs to.
                                example: 12345
                                type: integer
                              created_at:
                                description: Timestamp when the metafield was created.
                                example: '2021-01-01T00:00:00Z'
                                type: string
                                format: date-time
                              updated_at:
                                description: Timestamp when the metafield was last updated.
                                example: '2021-01-01T00:00:00Z'
                                type: string
                                format: date-time
                              metafield_definition:
                                title: MetafieldDefinition
                                type:
                                  - object
                                  - 'null'
                                properties:
                                  id:
                                    type: integer
                                  company_id:
                                    description: >-
                                      The ID of the company that owns this
                                      metafield definition.
                                    example: 1
                                    type: integer
                                  namespace:
                                    description: >-
                                      A container for related metafield
                                      definitions. Used to group definitions by
                                      app or functionality. Must be unique
                                      within company and owner_resource.
                                    example: product_details
                                    type: string
                                    maxLength: 20
                                    pattern: ^[a-zA-Z0-9_]+$
                                  key:
                                    description: >-
                                      The unique identifier for the metafield
                                      definition within its namespace and
                                      owner_resource. Combined with namespace
                                      and owner_resource, this must be unique
                                      per company.
                                    example: material_type
                                    type: string
                                    maxLength: 30
                                    pattern: ^[a-zA-Z0-9_]+$
                                  name:
                                    description: >-
                                      Human-readable display name for the
                                      metafield definition, shown in admin
                                      interfaces and forms.
                                    example: Material Type
                                    type: string
                                    maxLength: 100
                                  description:
                                    description: >-
                                      Detailed explanation of what this
                                      metafield definition represents, how it
                                      should be used, and any special
                                      instructions for content creators.
                                    example: >-
                                      Specify the primary material composition
                                      of the product (e.g., cotton, polyester,
                                      silk). This will be displayed on the
                                      product detail page.
                                    type:
                                      - string
                                      - 'null'
                                  value_type:
                                    description: >-
                                      The data type that defines how metafield
                                      values should be validated, stored, and
                                      displayed. Determines which validation
                                      rules are available.
                                    example: single_line_text_field
                                    type: string
                                  validation_rules:
                                    description: >-
                                      JSON object containing validation
                                      constraints that will be applied to
                                      metafield values. Available rules depend
                                      on the value_type.
                                    example:
                                      choices:
                                        - cotton
                                        - polyester
                                        - silk
                                        - wool
                                        - linen
                                        - bamboo
                                      max: 50
                                      min: 2
                                    type:
                                      - object
                                      - 'null'
                                  owner_resource:
                                    description: >-
                                      The type of resource (model class name)
                                      that metafields using this definition can
                                      be attached to. Must match the polymorphic
                                      owner_type.
                                    example: Product
                                    type: string
                                  pinned:
                                    description: >-
                                      Whether this definition should be
                                      prominently displayed or prioritized in
                                      admin interfaces and forms.
                                    example: false
                                    type:
                                      - boolean
                                      - 'null'
                                    default: false
                                  position:
                                    default: 0
                                    description: >-
                                      Sort order for displaying this definition
                                      relative to others in the same category
                                      and owner_resource. Lower numbers appear
                                      first.
                                    example: 1
                                    type:
                                      - integer
                                      - 'null'
                                  locked:
                                    description: >-
                                      Whether this metafield definition is
                                      locked, preventing direct updates or
                                      deletions of metafields using this
                                      definition.
                                    example: false
                                    type:
                                      - boolean
                                      - 'null'
                                    default: false
                                  created_at:
                                    description: >-
                                      Timestamp when the metafield definition
                                      was created.
                                    example: '2024-01-15T10:30:00Z'
                                    type: string
                                    format: date-time
                                  updated_at:
                                    description: >-
                                      Timestamp when the metafield definition
                                      was last updated.
                                    example: '2024-02-20T14:45:00Z'
                                    type: string
                                    format: date-time
                                  list_type:
                                    description: >-
                                      Whether this definition is for list-type
                                      metafields that store arrays of values.
                                    example: false
                                    type: boolean
                                  reference_type:
                                    description: >-
                                      Whether this definition is for
                                      reference-type metafields that store
                                      references to other resources.
                                    example: false
                                    type: boolean
                                  supported_validations:
                                    description: >-
                                      Array of validation rule names that are
                                      supported for this value_type.
                                    example:
                                      - min
                                      - max
                                      - choices
                                      - regex
                                    type: array
                                  validation_description:
                                    description: >-
                                      Human-readable description of what the
                                      value_type represents and its constraints.
                                    example: Single line text up to 5000 characters
                                    type: string
                                  category_ids:
                                    description: >-
                                      Array of category IDs that this metafield
                                      definition is associated with for
                                      organizational purposes.
                                    example:
                                      - 1
                                      - 2
                                      - 3
                                    items:
                                      type: integer
                                    type: array
                                required:
                                  - id
                                  - company_id
                                  - namespace
                                  - key
                                  - name
                                  - value_type
                                  - owner_resource
                                  - created_at
                                  - updated_at
                                  - list_type
                                  - reference_type
                                  - supported_validations
                                  - validation_description
                                  - category_ids
                            required:
                              - id
                              - namespace
                              - key
                              - value
                              - value_type
                              - owner_type
                              - owner_id
                              - created_at
                              - updated_at
                        metafields_collection:
                          type: array
                          items:
                            type: object
                            properties:
                              key:
                                type: string
                              value: {}
                        product_subscription_plans:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                              active:
                                type: boolean
                              default:
                                type: boolean
                              products_count:
                                type: integer
                              subscribers_count:
                                type: integer
                              subscription_plan:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                  name:
                                    type: string
                                  active:
                                    type: boolean
                                  allow_max_billing_cycles:
                                    type: boolean
                                  max_billing_cycles:
                                    type:
                                      - integer
                                      - 'null'
                                  billing_frequency_in_words:
                                    type: string
                                  billing_interval:
                                    type: integer
                                  billing_interval_unit:
                                    type: string
                                  volume_interval:
                                    type: integer
                                  volume_interval_unit:
                                    type: string
                                  price_adjustment_amount:
                                    type:
                                      - string
                                      - 'null'
                                  price_adjustment_type:
                                    type:
                                      - string
                                      - 'null'
                                  subscription_price:
                                    type:
                                      - string
                                      - 'null'
                                  wholesale_subscription_price:
                                    type:
                                      - string
                                      - 'null'
                        product_bundles:
                          type: array
                          items:
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                              bundled_variant:
                                type: object
                              quantity:
                                type: integer
                              tax_percentage:
                                type: number
                              display_externally:
                                type: boolean
                                description: >-
                                  Whether this bundle item should be displayed
                                  to customers
                        track_inventory_on_bundle_items:
                          type: boolean
                          description: Whether to track inventory on bundle items
                        collections:
                          type: array
                        tags:
                          type: array
                        label:
                          oneOf:
                            - type: 'null'
                            - type: object
                              properties:
                                id:
                                  type: integer
                                title:
                                  type: string
                                background:
                                  type: string
                                icon:
                                  type: string
                                color:
                                  type: string
                        display_tag:
                          type:
                            - string
                            - 'null'
                        search_engine_optimizer:
                          oneOf:
                            - type: 'null'
                            - type: object
                              properties:
                                id:
                                  type: integer
                                title:
                                  type: string
                                description:
                                  type: string
                                image_url:
                                  type: string
                                image_path:
                                  type: string
                                block_crawler:
                                  type: boolean
                        share_link:
                          type:
                            - string
                            - 'null'
                        category:
                          oneOf:
                            - type: 'null'
                            - type: object
                              properties:
                                id:
                                  type: integer
                                title:
                                  type: string
                                description:
                                  type: string
                                image_url:
                                  type: string
                                image_path:
                                  type: string
                                position:
                                  type: integer
                                public:
                                  type: boolean
                        images:
                          type: array
                        options:
                          type: array
                          items:
                            title: Option
                            type: object
                            properties:
                              id:
                                type: integer
                              title:
                                type: string
                              position:
                                type:
                                  - integer
                                  - 'null'
                                default: 1
                              presentation:
                                type: string
                              external_id:
                                type:
                                  - string
                                  - 'null'
                              created_at:
                                type: string
                                format: date-time
                              updated_at:
                                type: string
                                format: date-time
                              option_values:
                                type: array
                                items:
                                  title: OptionValue
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                    title:
                                      type: string
                                    position:
                                      type:
                                        - integer
                                        - 'null'
                                      default: 1
                                    presentation:
                                      type:
                                        - string
                                        - 'null'
                                    created_at:
                                      type: string
                                      format: date-time
                                    updated_at:
                                      type: string
                                      format: date-time
                                  required:
                                    - id
                                    - title
                                    - created_at
                                    - updated_at
                            required:
                              - id
                              - title
                              - presentation
                              - created_at
                              - updated_at
                        variants:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                              sku:
                                type:
                                  - string
                                  - 'null'
                              is_master:
                                type: boolean
                              title:
                                type:
                                  - string
                                  - 'null'
                              image_url:
                                type:
                                  - string
                                  - 'null'
                              subscription_only:
                                type: boolean
                              shipping_included_in_price:
                                type: boolean
                              images:
                                type: array
                              track_quantity:
                                type: boolean
                              inventory_quantity:
                                type:
                                  - 'null'
                                  - integer
                              bar_code:
                                type:
                                  - string
                                  - 'null'
                              limit_subscription:
                                type: boolean
                              subscription_max_qty:
                                type:
                                  - 'null'
                                  - integer
                              customer_limit:
                                type:
                                  - 'null'
                                  - integer
                              keep_selling:
                                type: boolean
                              limit_quantity_per_customer:
                                type: boolean
                              option_attrs:
                                type: array
                                items:
                                  type: string
                              option_ids:
                                type: array
                                items:
                                  type: integer
                              allow_subscription:
                                type: boolean
                                example: true
                              metafields:
                                type: array
                                description: Variant metafields
                              inventory_levels:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                    available:
                                      type: integer
                                    committed:
                                      type: integer
                                    on_hand:
                                      type: integer
                                    unavailable:
                                      type: integer
                                    warehouse:
                                      type: object
                                      properties:
                                        id:
                                          type: integer
                                        name:
                                          type: string
                                        active:
                                          type: boolean
                                        country_iso:
                                          type: string
                              variant_countries:
                                type: object
                                description: >-
                                  Hash of variant countries keyed by country ISO
                                  code
                                additionalProperties:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                    country_id:
                                      type: integer
                                    country_name:
                                      type: string
                                    active:
                                      type: boolean
                                    currency_code:
                                      type: string
                                    price:
                                      type: string
                                    subscription_price:
                                      type: string
                                    wholesale:
                                      type: string
                                    wholesale_subscription_price:
                                      type: string
                                    shipping:
                                      type: string
                                    shipping_time:
                                      type:
                                        - string
                                        - 'null'
                                    cost_of_goods_sold:
                                      type: string
                                    compare_price:
                                      type: string
                                    cv:
                                      type: integer
                                    qv:
                                      type: integer
                                    pc_cv:
                                      type:
                                        - integer
                                        - 'null'
                                    pc_qv:
                                      type:
                                        - integer
                                        - 'null'
                                    points:
                                      type: integer
                                    display_price:
                                      type: string
                                    display_subscription_price:
                                      type: string
                                    display_wholesale:
                                      type: string
                                    display_wholesale_subscription_price:
                                      type: string
                                    subscription_plans:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          subscription_price_in_currency:
                                            type: string
                                          subscribe_and_save_in_currency:
                                            type: string
                                          subscribe_and_save_for_display:
                                            type: string
                                          wholesale_subscription_price_in_currency:
                                            type: string
                                          wholesale_subscribe_and_save_in_currency:
                                            type: string
                                          wholesale_subscribe_and_save_for_display:
                                            type: string
                                    buyable:
                                      type: boolean
                        bundle:
                          type:
                            - boolean
                            - 'null'
                          description: Whether the product is a bundle
                      required:
                        - id
                        - title
                        - description
                        - image_url
                        - status
                        - price
                        - public
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      pagination:
                        type: object
                        properties:
                          current_page:
                            type: integer
                            example: 1
                          total_pages:
                            type: integer
                            example: 10
                          total_count:
                            type: integer
                            example: 100
                          per_page:
                            type: integer
                            example: 10
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameters
                  errors:
                    type: object
                    example:
                      by_metadata:
                        - >-
                          The value `{referred_by: {user: 'John},}` in parameter
                          `by_metadata` is not a valid JSON
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
    post:
      summary: Create a product
      tags:
        - Products
      operationId: createProduct
      security:
        - bearer_auth: []
      description: Create a new product
      parameters: []
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  product:
                    type: object
                    properties:
                      id:
                        type: integer
                      sku:
                        type:
                          - string
                          - 'null'
                      title:
                        type:
                          - string
                          - 'null'
                      description:
                        type:
                          - string
                          - 'null'
                      image_url:
                        type: string
                      status:
                        type: string
                      price:
                        type: string
                      commission:
                        type: string
                      public:
                        type: boolean
                      slug:
                        type: string
                      custom_slug:
                        type: boolean
                      active:
                        type: boolean
                      introduction:
                        type:
                          - string
                          - 'null'
                      feature_text:
                        type:
                          - string
                          - 'null'
                      stripped:
                        type:
                          - string
                          - 'null'
                      review_count:
                        type: integer
                      views:
                        type: integer
                      leads:
                        type: integer
                      show_reviews:
                        type: boolean
                      upc:
                        type:
                          - string
                          - 'null'
                      hs_code:
                        type:
                          - string
                          - 'null'
                      compressed_image_url:
                        type:
                          - string
                          - 'null'
                      image_path:
                        type:
                          - string
                          - 'null'
                      external_url:
                        type:
                          - string
                          - 'null'
                      display_price:
                        type: string
                      subscription_price:
                        type: string
                      tax_inclusive_price:
                        type: string
                      tax_inclusive_wholesale:
                        type: string
                      tax_inclusive_subscription_price:
                        type: string
                      tax_inclusive_wholesale_subscription_price:
                        type: string
                      currency_code:
                        type: string
                      tax_category_id:
                        type: integer
                      tax_category:
                        title: TaxCategory
                        type: object
                        properties:
                          id:
                            type: integer
                          code:
                            example: SV010020
                            type: string
                          title:
                            example: Tangible personal property (tpp)
                            type: string
                        required:
                          - id
                          - code
                          - title
                      international_tax_type:
                        type:
                          - string
                          - 'null'
                      in_stock:
                        type: boolean
                      keep_selling:
                        type: boolean
                      track_quantity:
                        type: boolean
                      no_index:
                        type: boolean
                      publish_to_retail_store:
                        type: boolean
                      publish_to_rep_store:
                        type: boolean
                      publish_to_share_tab:
                        type: boolean
                      affiliate_commission:
                        type:
                          - string
                          - 'null'
                      integration_id:
                        type:
                          - string
                          - 'null'
                      external_id:
                        type:
                          - string
                          - 'null'
                      application_theme_template_id:
                        type:
                          - string
                          - 'null'
                      last_synced_at:
                        type:
                          - string
                          - 'null'
                      updated_at:
                        type:
                          - string
                          - 'null'
                      option_attrs:
                        type: array
                        items:
                          type: string
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      metafields:
                        type: array
                        items:
                          title: LegacyMetafield
                          type: object
                          properties:
                            id:
                              type: integer
                            namespace:
                              description: >-
                                A container for related metafields. Commonly
                                used to group metafields by app or
                                functionality.
                              example: custom
                              type: string
                              maxLength: 20
                              pattern: ^[a-zA-Z0-9_]+$
                            key:
                              description: >-
                                The unique identifier for the metafield within
                                its namespace. Must be unique per namespace and
                                owner.
                              example: material
                              type: string
                              maxLength: 30
                              pattern: ^[a-zA-Z0-9_]+$
                            value:
                              description: >-
                                The actual data stored in the metafield. Type
                                depends on value_type.
                              example: cotton
                              type:
                                - string
                                - object
                            value_type:
                              description: >-
                                The data type that defines how the value should
                                be interpreted and validated.
                              example: single_line_text_field
                              type: string
                            description:
                              description: >-
                                Optional human-readable description explaining
                                the purpose of this metafield.
                              example: The primary material used in this product
                              type:
                                - string
                                - 'null'
                            owner_type:
                              description: >-
                                The type of resource that this metafield belongs
                                to (polymorphic association).
                              example: Product
                              type: string
                            owner_id:
                              description: >-
                                The ID of the specific resource that this
                                metafield belongs to.
                              example: 12345
                              type: integer
                            created_at:
                              description: Timestamp when the metafield was created.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            updated_at:
                              description: Timestamp when the metafield was last updated.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            metafield_definition:
                              title: MetafieldDefinition
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                company_id:
                                  description: >-
                                    The ID of the company that owns this
                                    metafield definition.
                                  example: 1
                                  type: integer
                                namespace:
                                  description: >-
                                    A container for related metafield
                                    definitions. Used to group definitions by
                                    app or functionality. Must be unique within
                                    company and owner_resource.
                                  example: product_details
                                  type: string
                                  maxLength: 20
                                  pattern: ^[a-zA-Z0-9_]+$
                                key:
                                  description: >-
                                    The unique identifier for the metafield
                                    definition within its namespace and
                                    owner_resource. Combined with namespace and
                                    owner_resource, this must be unique per
                                    company.
                                  example: material_type
                                  type: string
                                  maxLength: 30
                                  pattern: ^[a-zA-Z0-9_]+$
                                name:
                                  description: >-
                                    Human-readable display name for the
                                    metafield definition, shown in admin
                                    interfaces and forms.
                                  example: Material Type
                                  type: string
                                  maxLength: 100
                                description:
                                  description: >-
                                    Detailed explanation of what this metafield
                                    definition represents, how it should be
                                    used, and any special instructions for
                                    content creators.
                                  example: >-
                                    Specify the primary material composition of
                                    the product (e.g., cotton, polyester, silk).
                                    This will be displayed on the product detail
                                    page.
                                  type:
                                    - string
                                    - 'null'
                                value_type:
                                  description: >-
                                    The data type that defines how metafield
                                    values should be validated, stored, and
                                    displayed. Determines which validation rules
                                    are available.
                                  example: single_line_text_field
                                  type: string
                                validation_rules:
                                  description: >-
                                    JSON object containing validation
                                    constraints that will be applied to
                                    metafield values. Available rules depend on
                                    the value_type.
                                  example:
                                    choices:
                                      - cotton
                                      - polyester
                                      - silk
                                      - wool
                                      - linen
                                      - bamboo
                                    max: 50
                                    min: 2
                                  type:
                                    - object
                                    - 'null'
                                owner_resource:
                                  description: >-
                                    The type of resource (model class name) that
                                    metafields using this definition can be
                                    attached to. Must match the polymorphic
                                    owner_type.
                                  example: Product
                                  type: string
                                pinned:
                                  description: >-
                                    Whether this definition should be
                                    prominently displayed or prioritized in
                                    admin interfaces and forms.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                position:
                                  default: 0
                                  description: >-
                                    Sort order for displaying this definition
                                    relative to others in the same category and
                                    owner_resource. Lower numbers appear first.
                                  example: 1
                                  type:
                                    - integer
                                    - 'null'
                                locked:
                                  description: >-
                                    Whether this metafield definition is locked,
                                    preventing direct updates or deletions of
                                    metafields using this definition.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                created_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    created.
                                  example: '2024-01-15T10:30:00Z'
                                  type: string
                                  format: date-time
                                updated_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    last updated.
                                  example: '2024-02-20T14:45:00Z'
                                  type: string
                                  format: date-time
                                list_type:
                                  description: >-
                                    Whether this definition is for list-type
                                    metafields that store arrays of values.
                                  example: false
                                  type: boolean
                                reference_type:
                                  description: >-
                                    Whether this definition is for
                                    reference-type metafields that store
                                    references to other resources.
                                  example: false
                                  type: boolean
                                supported_validations:
                                  description: >-
                                    Array of validation rule names that are
                                    supported for this value_type.
                                  example:
                                    - min
                                    - max
                                    - choices
                                    - regex
                                  type: array
                                validation_description:
                                  description: >-
                                    Human-readable description of what the
                                    value_type represents and its constraints.
                                  example: Single line text up to 5000 characters
                                  type: string
                                category_ids:
                                  description: >-
                                    Array of category IDs that this metafield
                                    definition is associated with for
                                    organizational purposes.
                                  example:
                                    - 1
                                    - 2
                                    - 3
                                  items:
                                    type: integer
                                  type: array
                              required:
                                - id
                                - company_id
                                - namespace
                                - key
                                - name
                                - value_type
                                - owner_resource
                                - created_at
                                - updated_at
                                - list_type
                                - reference_type
                                - supported_validations
                                - validation_description
                                - category_ids
                          required:
                            - id
                            - namespace
                            - key
                            - value
                            - value_type
                            - owner_type
                            - owner_id
                            - created_at
                            - updated_at
                      metafields_collection:
                        type: array
                        items:
                          type: object
                          properties:
                            key:
                              type: string
                            value: {}
                      product_subscription_plans:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            active:
                              type: boolean
                            default:
                              type: boolean
                            products_count:
                              type: integer
                            subscribers_count:
                              type: integer
                            subscription_plan:
                              type: object
                              properties:
                                id:
                                  type: integer
                                name:
                                  type: string
                                active:
                                  type: boolean
                                allow_max_billing_cycles:
                                  type: boolean
                                max_billing_cycles:
                                  type:
                                    - integer
                                    - 'null'
                                billing_frequency_in_words:
                                  type: string
                                billing_interval:
                                  type: integer
                                billing_interval_unit:
                                  type: string
                                volume_interval:
                                  type: integer
                                volume_interval_unit:
                                  type: string
                                price_adjustment_amount:
                                  type:
                                    - string
                                    - 'null'
                                price_adjustment_type:
                                  type:
                                    - string
                                    - 'null'
                                subscription_price:
                                  type:
                                    - string
                                    - 'null'
                                wholesale_subscription_price:
                                  type:
                                    - string
                                    - 'null'
                      product_bundles:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                            bundled_variant:
                              type: object
                            quantity:
                              type: integer
                            tax_percentage:
                              type: number
                            display_externally:
                              type: boolean
                              description: >-
                                Whether this bundle item should be displayed to
                                customers
                      track_inventory_on_bundle_items:
                        type: boolean
                        description: Whether to track inventory on bundle items
                      collections:
                        type: array
                      tags:
                        type: array
                      label:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                              title:
                                type: string
                              background:
                                type: string
                              icon:
                                type: string
                              color:
                                type: string
                      display_tag:
                        type:
                          - string
                          - 'null'
                      search_engine_optimizer:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                              title:
                                type: string
                              description:
                                type: string
                              image_url:
                                type: string
                              image_path:
                                type: string
                              block_crawler:
                                type: boolean
                      share_link:
                        type:
                          - string
                          - 'null'
                      category:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                              title:
                                type: string
                              description:
                                type: string
                              image_url:
                                type: string
                              image_path:
                                type: string
                              position:
                                type: integer
                              public:
                                type: boolean
                      images:
                        type: array
                      options:
                        type: array
                        items:
                          title: Option
                          type: object
                          properties:
                            id:
                              type: integer
                            title:
                              type: string
                            position:
                              type:
                                - integer
                                - 'null'
                              default: 1
                            presentation:
                              type: string
                            external_id:
                              type:
                                - string
                                - 'null'
                            created_at:
                              type: string
                              format: date-time
                            updated_at:
                              type: string
                              format: date-time
                            option_values:
                              type: array
                              items:
                                title: OptionValue
                                type: object
                                properties:
                                  id:
                                    type: integer
                                  title:
                                    type: string
                                  position:
                                    type:
                                      - integer
                                      - 'null'
                                    default: 1
                                  presentation:
                                    type:
                                      - string
                                      - 'null'
                                  created_at:
                                    type: string
                                    format: date-time
                                  updated_at:
                                    type: string
                                    format: date-time
                                required:
                                  - id
                                  - title
                                  - created_at
                                  - updated_at
                          required:
                            - id
                            - title
                            - presentation
                            - created_at
                            - updated_at
                      variants:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            sku:
                              type:
                                - string
                                - 'null'
                            is_master:
                              type: boolean
                            title:
                              type:
                                - string
                                - 'null'
                            image_url:
                              type:
                                - string
                                - 'null'
                            subscription_only:
                              type: boolean
                            shipping_included_in_price:
                              type: boolean
                            images:
                              type: array
                            track_quantity:
                              type: boolean
                            inventory_quantity:
                              type:
                                - 'null'
                                - integer
                            bar_code:
                              type:
                                - string
                                - 'null'
                            limit_subscription:
                              type: boolean
                            subscription_max_qty:
                              type:
                                - 'null'
                                - integer
                            customer_limit:
                              type:
                                - 'null'
                                - integer
                            keep_selling:
                              type: boolean
                            limit_quantity_per_customer:
                              type: boolean
                            option_attrs:
                              type: array
                              items:
                                type: string
                            option_ids:
                              type: array
                              items:
                                type: integer
                            allow_subscription:
                              type: boolean
                              example: true
                            metafields:
                              type: array
                              description: Variant metafields
                            inventory_levels:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                  available:
                                    type: integer
                                  committed:
                                    type: integer
                                  on_hand:
                                    type: integer
                                  unavailable:
                                    type: integer
                                  warehouse:
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        type: string
                                      active:
                                        type: boolean
                                      country_iso:
                                        type: string
                            variant_countries:
                              type: object
                              description: >-
                                Hash of variant countries keyed by country ISO
                                code
                              additionalProperties:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                  country_id:
                                    type: integer
                                  country_name:
                                    type: string
                                  active:
                                    type: boolean
                                  currency_code:
                                    type: string
                                  price:
                                    type: string
                                  subscription_price:
                                    type: string
                                  wholesale:
                                    type: string
                                  wholesale_subscription_price:
                                    type: string
                                  shipping:
                                    type: string
                                  shipping_time:
                                    type:
                                      - string
                                      - 'null'
                                  cost_of_goods_sold:
                                    type: string
                                  compare_price:
                                    type: string
                                  cv:
                                    type: integer
                                  qv:
                                    type: integer
                                  pc_cv:
                                    type:
                                      - integer
                                      - 'null'
                                  pc_qv:
                                    type:
                                      - integer
                                      - 'null'
                                  points:
                                    type: integer
                                  display_price:
                                    type: string
                                  display_subscription_price:
                                    type: string
                                  display_wholesale:
                                    type: string
                                  display_wholesale_subscription_price:
                                    type: string
                                  subscription_plans:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        id:
                                          type: integer
                                        subscription_price_in_currency:
                                          type: string
                                        subscribe_and_save_in_currency:
                                          type: string
                                        subscribe_and_save_for_display:
                                          type: string
                                        wholesale_subscription_price_in_currency:
                                          type: string
                                        wholesale_subscribe_and_save_in_currency:
                                          type: string
                                        wholesale_subscribe_and_save_for_display:
                                          type: string
                                  buyable:
                                    type: boolean
                    required:
                      - id
                      - title
                      - description
                      - image_url
                      - status
                      - price
                      - public
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '422':
          description: validation failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameters
                  errors:
                    type: object
                    description: Hash of field names and error messages
                    example:
                      product:
                        title:
                          - is missing
                        price:
                          - must be a decimal
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                lang:
                  type: string
                product:
                  type: object
                  properties:
                    title:
                      type: string
                      minLength: 1
                    image_url:
                      type: string
                    sku:
                      type: string
                    introduction:
                      type: string
                    feature_text:
                      type: string
                    description:
                      type: string
                    status:
                      type: string
                    commission:
                      type: number
                    public:
                      type: boolean
                    metadata:
                      type: object
                    publish_to_retail_store:
                      type: boolean
                    publish_to_rep_store:
                      type: boolean
                    publish_to_share_tab:
                      type: boolean
                    show_reviews:
                      type: boolean
                    application_theme_template_id:
                      type: integer
                    tax_category_id:
                      type: integer
                    international_tax_type:
                      type: string
                    collection_ids:
                      type: array
                      items:
                        type: integer
                    tag_ids:
                      type: array
                      items:
                        type: integer
                    label_id:
                      type: integer
                    category_id:
                      type: integer
                    keep_selling:
                      type: boolean
                    option_attrs:
                      type: array
                      items:
                        type: string
                    no_index:
                      type: boolean
                    slug:
                      type: string
                    custom_slug:
                      type: boolean
                    search_engine_optimizer_attributes:
                      type: object
                      properties:
                        title:
                          type: string
                        description:
                          type: string
                        image_url:
                          type: string
                        image_path:
                          type: string
                        block_crawler:
                          type: boolean
                      required: []
                    images_attributes:
                      type: array
                      items:
                        type: object
                        properties:
                          position:
                            type: integer
                          image_url:
                            type: string
                        required:
                          - position
                          - image_url
                    product_subscription_plans_attributes:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: integer
                          subscription_plan_id:
                            type: integer
                          default:
                            type: boolean
                          _destroy:
                            type: boolean
                        required: []
                    variants_attributes:
                      type: array
                      items:
                        type: object
                        properties:
                          option_attrs:
                            type: array
                            items:
                              type: string
                          sku:
                            type: string
                          is_master:
                            type: boolean
                          title:
                            type: string
                          track_quantity:
                            type: boolean
                          bar_code:
                            type: string
                          limit_subscription:
                            type: boolean
                          subscription_max_qty:
                            type: integer
                          customer_limit:
                            type: integer
                          keep_selling:
                            type: boolean
                          images_attributes:
                            type: array
                            items:
                              type: object
                              properties:
                                position:
                                  type: integer
                                image_url:
                                  type: string
                              required:
                                - position
                                - image_url
                          inventory_levels_attributes:
                            type: array
                            items:
                              type: object
                              properties:
                                warehouse_id:
                                  type: integer
                                  not:
                                    type: 'null'
                                available:
                                  type: integer
                                  not:
                                    type: 'null'
                                committed:
                                  type: integer
                                  not:
                                    type: 'null'
                                on_hand:
                                  type: integer
                                  not:
                                    type: 'null'
                                unavailable:
                                  type: integer
                                  not:
                                    type: 'null'
                              required: []
                          variant_countries_attributes:
                            type: array
                            items:
                              type: object
                              properties:
                                active:
                                  type: boolean
                                country_id:
                                  type: integer
                                price:
                                  type: number
                                subscription_price:
                                  type: number
                                wholesale:
                                  type: number
                                wholesale_subscription_price:
                                  type: number
                                compare_price:
                                  type: number
                                cv:
                                  type: integer
                                qv:
                                  type: integer
                                pc_cv:
                                  type: integer
                                pc_qv:
                                  type: integer
                                points:
                                  type: integer
                                cost_of_goods_sold:
                                  type: number
                                shipping:
                                  type: number
                                tax:
                                  type: number
                              required:
                                - active
                                - country_id
                                - price
                          metafields_attributes:
                            type: array
                            items:
                              type: object
                              properties:
                                namespace:
                                  type: string
                                key:
                                  type: string
                                value:
                                  not:
                                    type: 'null'
                                value_type:
                                  type: string
                              required:
                                - namespace
                                - key
                                - value
                                - value_type
                        required:
                          - variant_countries_attributes
                    bundle:
                      type: boolean
                    dam_asset_code:
                      type: string
                    dam_asset_id:
                      type:
                        - 'null'
                        - string
                    track_inventory_on_bundle_items:
                      type: boolean
                    product_bundles_attributes:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: integer
                          bundled_variant_id:
                            type: integer
                          quantity:
                            type: integer
                          display_externally:
                            type: boolean
                          _destroy:
                            type: boolean
                        required: []
                    metafields_attributes:
                      type: array
                      items:
                        type: object
                        properties:
                          namespace:
                            type: string
                            minLength: 1
                          key:
                            type: string
                            minLength: 1
                          value:
                            not:
                              type: 'null'
                          value_type:
                            type: string
                            minLength: 1
                        required:
                          - namespace
                          - key
                          - value
                          - value_type
                  required:
                    - title
              required:
                - product
  /api/company/v1/products/{id}:
    get:
      summary: Show a product
      tags:
        - Products
      operationId: showProduct
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Product's Id or slug
          schema:
            type: integer
        - name: lang
          in: query
          required: false
          description: >
            Determines language to be used to display translations, if
            applicable.

            - If not specified, the company's default language is used.

            - This is the 2 letter ISO language code. Examples: 'en', 'es', 'fr'

            - It can be upper case or lower case
          schema:
            type: string
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  product:
                    type: object
                    properties:
                      id:
                        type: integer
                      sku:
                        type:
                          - string
                          - 'null'
                      title:
                        type:
                          - string
                          - 'null'
                      description:
                        type:
                          - string
                          - 'null'
                      image_url:
                        type: string
                      status:
                        type: string
                      price:
                        type: string
                      commission:
                        type: string
                      public:
                        type: boolean
                      slug:
                        type: string
                      custom_slug:
                        type: boolean
                      active:
                        type: boolean
                      introduction:
                        type:
                          - string
                          - 'null'
                      feature_text:
                        type:
                          - string
                          - 'null'
                      stripped:
                        type:
                          - string
                          - 'null'
                      review_count:
                        type: integer
                      views:
                        type: integer
                      leads:
                        type: integer
                      show_reviews:
                        type: boolean
                      upc:
                        type:
                          - string
                          - 'null'
                      hs_code:
                        type:
                          - string
                          - 'null'
                      compressed_image_url:
                        type:
                          - string
                          - 'null'
                      image_path:
                        type:
                          - string
                          - 'null'
                      external_url:
                        type:
                          - string
                          - 'null'
                      display_price:
                        type: string
                      subscription_price:
                        type: string
                      tax_inclusive_price:
                        type: string
                      tax_inclusive_wholesale:
                        type: string
                      tax_inclusive_subscription_price:
                        type: string
                      tax_inclusive_wholesale_subscription_price:
                        type: string
                      currency_code:
                        type: string
                      tax_category_id:
                        type: integer
                      tax_category:
                        title: TaxCategory
                        type: object
                        properties:
                          id:
                            type: integer
                          code:
                            example: SV010020
                            type: string
                          title:
                            example: Tangible personal property (tpp)
                            type: string
                        required:
                          - id
                          - code
                          - title
                      international_tax_type:
                        type:
                          - string
                          - 'null'
                      in_stock:
                        type: boolean
                      keep_selling:
                        type: boolean
                      track_quantity:
                        type: boolean
                      no_index:
                        type: boolean
                      publish_to_retail_store:
                        type: boolean
                      publish_to_rep_store:
                        type: boolean
                      publish_to_share_tab:
                        type: boolean
                      affiliate_commission:
                        type:
                          - string
                          - 'null'
                      integration_id:
                        type:
                          - string
                          - 'null'
                      external_id:
                        type:
                          - string
                          - 'null'
                      application_theme_template_id:
                        type:
                          - string
                          - 'null'
                      last_synced_at:
                        type:
                          - string
                          - 'null'
                      updated_at:
                        type:
                          - string
                          - 'null'
                      option_attrs:
                        type: array
                        items:
                          type: string
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      metafields:
                        type: array
                        items:
                          title: LegacyMetafield
                          type: object
                          properties:
                            id:
                              type: integer
                            namespace:
                              description: >-
                                A container for related metafields. Commonly
                                used to group metafields by app or
                                functionality.
                              example: custom
                              type: string
                              maxLength: 20
                              pattern: ^[a-zA-Z0-9_]+$
                            key:
                              description: >-
                                The unique identifier for the metafield within
                                its namespace. Must be unique per namespace and
                                owner.
                              example: material
                              type: string
                              maxLength: 30
                              pattern: ^[a-zA-Z0-9_]+$
                            value:
                              description: >-
                                The actual data stored in the metafield. Type
                                depends on value_type.
                              example: cotton
                              type:
                                - string
                                - object
                            value_type:
                              description: >-
                                The data type that defines how the value should
                                be interpreted and validated.
                              example: single_line_text_field
                              type: string
                            description:
                              description: >-
                                Optional human-readable description explaining
                                the purpose of this metafield.
                              example: The primary material used in this product
                              type:
                                - string
                                - 'null'
                            owner_type:
                              description: >-
                                The type of resource that this metafield belongs
                                to (polymorphic association).
                              example: Product
                              type: string
                            owner_id:
                              description: >-
                                The ID of the specific resource that this
                                metafield belongs to.
                              example: 12345
                              type: integer
                            created_at:
                              description: Timestamp when the metafield was created.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            updated_at:
                              description: Timestamp when the metafield was last updated.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            metafield_definition:
                              title: MetafieldDefinition
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                company_id:
                                  description: >-
                                    The ID of the company that owns this
                                    metafield definition.
                                  example: 1
                                  type: integer
                                namespace:
                                  description: >-
                                    A container for related metafield
                                    definitions. Used to group definitions by
                                    app or functionality. Must be unique within
                                    company and owner_resource.
                                  example: product_details
                                  type: string
                                  maxLength: 20
                                  pattern: ^[a-zA-Z0-9_]+$
                                key:
                                  description: >-
                                    The unique identifier for the metafield
                                    definition within its namespace and
                                    owner_resource. Combined with namespace and
                                    owner_resource, this must be unique per
                                    company.
                                  example: material_type
                                  type: string
                                  maxLength: 30
                                  pattern: ^[a-zA-Z0-9_]+$
                                name:
                                  description: >-
                                    Human-readable display name for the
                                    metafield definition, shown in admin
                                    interfaces and forms.
                                  example: Material Type
                                  type: string
                                  maxLength: 100
                                description:
                                  description: >-
                                    Detailed explanation of what this metafield
                                    definition represents, how it should be
                                    used, and any special instructions for
                                    content creators.
                                  example: >-
                                    Specify the primary material composition of
                                    the product (e.g., cotton, polyester, silk).
                                    This will be displayed on the product detail
                                    page.
                                  type:
                                    - string
                                    - 'null'
                                value_type:
                                  description: >-
                                    The data type that defines how metafield
                                    values should be validated, stored, and
                                    displayed. Determines which validation rules
                                    are available.
                                  example: single_line_text_field
                                  type: string
                                validation_rules:
                                  description: >-
                                    JSON object containing validation
                                    constraints that will be applied to
                                    metafield values. Available rules depend on
                                    the value_type.
                                  example:
                                    choices:
                                      - cotton
                                      - polyester
                                      - silk
                                      - wool
                                      - linen
                                      - bamboo
                                    max: 50
                                    min: 2
                                  type:
                                    - object
                                    - 'null'
                                owner_resource:
                                  description: >-
                                    The type of resource (model class name) that
                                    metafields using this definition can be
                                    attached to. Must match the polymorphic
                                    owner_type.
                                  example: Product
                                  type: string
                                pinned:
                                  description: >-
                                    Whether this definition should be
                                    prominently displayed or prioritized in
                                    admin interfaces and forms.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                position:
                                  default: 0
                                  description: >-
                                    Sort order for displaying this definition
                                    relative to others in the same category and
                                    owner_resource. Lower numbers appear first.
                                  example: 1
                                  type:
                                    - integer
                                    - 'null'
                                locked:
                                  description: >-
                                    Whether this metafield definition is locked,
                                    preventing direct updates or deletions of
                                    metafields using this definition.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                created_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    created.
                                  example: '2024-01-15T10:30:00Z'
                                  type: string
                                  format: date-time
                                updated_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    last updated.
                                  example: '2024-02-20T14:45:00Z'
                                  type: string
                                  format: date-time
                                list_type:
                                  description: >-
                                    Whether this definition is for list-type
                                    metafields that store arrays of values.
                                  example: false
                                  type: boolean
                                reference_type:
                                  description: >-
                                    Whether this definition is for
                                    reference-type metafields that store
                                    references to other resources.
                                  example: false
                                  type: boolean
                                supported_validations:
                                  description: >-
                                    Array of validation rule names that are
                                    supported for this value_type.
                                  example:
                                    - min
                                    - max
                                    - choices
                                    - regex
                                  type: array
                                validation_description:
                                  description: >-
                                    Human-readable description of what the
                                    value_type represents and its constraints.
                                  example: Single line text up to 5000 characters
                                  type: string
                                category_ids:
                                  description: >-
                                    Array of category IDs that this metafield
                                    definition is associated with for
                                    organizational purposes.
                                  example:
                                    - 1
                                    - 2
                                    - 3
                                  items:
                                    type: integer
                                  type: array
                              required:
                                - id
                                - company_id
                                - namespace
                                - key
                                - name
                                - value_type
                                - owner_resource
                                - created_at
                                - updated_at
                                - list_type
                                - reference_type
                                - supported_validations
                                - validation_description
                                - category_ids
                          required:
                            - id
                            - namespace
                            - key
                            - value
                            - value_type
                            - owner_type
                            - owner_id
                            - created_at
                            - updated_at
                      metafields_collection:
                        type: array
                        items:
                          type: object
                          properties:
                            key:
                              type: string
                            value: {}
                      product_subscription_plans:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            active:
                              type: boolean
                            default:
                              type: boolean
                            products_count:
                              type: integer
                            subscribers_count:
                              type: integer
                            subscription_plan:
                              type: object
                              properties:
                                id:
                                  type: integer
                                name:
                                  type: string
                                active:
                                  type: boolean
                                allow_max_billing_cycles:
                                  type: boolean
                                max_billing_cycles:
                                  type:
                                    - integer
                                    - 'null'
                                billing_frequency_in_words:
                                  type: string
                                billing_interval:
                                  type: integer
                                billing_interval_unit:
                                  type: string
                                volume_interval:
                                  type: integer
                                volume_interval_unit:
                                  type: string
                                price_adjustment_amount:
                                  type:
                                    - string
                                    - 'null'
                                price_adjustment_type:
                                  type:
                                    - string
                                    - 'null'
                                subscription_price:
                                  type:
                                    - string
                                    - 'null'
                                wholesale_subscription_price:
                                  type:
                                    - string
                                    - 'null'
                      product_bundles:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                            bundled_variant:
                              type: object
                            quantity:
                              type: integer
                            tax_percentage:
                              type: number
                            display_externally:
                              type: boolean
                              description: >-
                                Whether this bundle item should be displayed to
                                customers
                      track_inventory_on_bundle_items:
                        type: boolean
                        description: Whether to track inventory on bundle items
                      collections:
                        type: array
                      tags:
                        type: array
                      label:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                              title:
                                type: string
                              background:
                                type: string
                              icon:
                                type: string
                              color:
                                type: string
                      display_tag:
                        type:
                          - string
                          - 'null'
                      search_engine_optimizer:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                              title:
                                type: string
                              description:
                                type: string
                              image_url:
                                type: string
                              image_path:
                                type: string
                              block_crawler:
                                type: boolean
                      share_link:
                        type:
                          - string
                          - 'null'
                      category:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                              title:
                                type: string
                              description:
                                type: string
                              image_url:
                                type: string
                              image_path:
                                type: string
                              position:
                                type: integer
                              public:
                                type: boolean
                      images:
                        type: array
                      options:
                        type: array
                        items:
                          title: Option
                          type: object
                          properties:
                            id:
                              type: integer
                            title:
                              type: string
                            position:
                              type:
                                - integer
                                - 'null'
                              default: 1
                            presentation:
                              type: string
                            external_id:
                              type:
                                - string
                                - 'null'
                            created_at:
                              type: string
                              format: date-time
                            updated_at:
                              type: string
                              format: date-time
                            option_values:
                              type: array
                              items:
                                title: OptionValue
                                type: object
                                properties:
                                  id:
                                    type: integer
                                  title:
                                    type: string
                                  position:
                                    type:
                                      - integer
                                      - 'null'
                                    default: 1
                                  presentation:
                                    type:
                                      - string
                                      - 'null'
                                  created_at:
                                    type: string
                                    format: date-time
                                  updated_at:
                                    type: string
                                    format: date-time
                                required:
                                  - id
                                  - title
                                  - created_at
                                  - updated_at
                          required:
                            - id
                            - title
                            - presentation
                            - created_at
                            - updated_at
                      variants:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            sku:
                              type:
                                - string
                                - 'null'
                            is_master:
                              type: boolean
                            title:
                              type:
                                - string
                                - 'null'
                            image_url:
                              type:
                                - string
                                - 'null'
                            subscription_only:
                              type: boolean
                            shipping_included_in_price:
                              type: boolean
                            images:
                              type: array
                            track_quantity:
                              type: boolean
                            inventory_quantity:
                              type:
                                - 'null'
                                - integer
                            bar_code:
                              type:
                                - string
                                - 'null'
                            limit_subscription:
                              type: boolean
                            subscription_max_qty:
                              type:
                                - 'null'
                                - integer
                            customer_limit:
                              type:
                                - 'null'
                                - integer
                            keep_selling:
                              type: boolean
                            limit_quantity_per_customer:
                              type: boolean
                            option_attrs:
                              type: array
                              items:
                                type: string
                            option_ids:
                              type: array
                              items:
                                type: integer
                            allow_subscription:
                              type: boolean
                              example: true
                            metafields:
                              type: array
                              description: Variant metafields
                            inventory_levels:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                  available:
                                    type: integer
                                  committed:
                                    type: integer
                                  on_hand:
                                    type: integer
                                  unavailable:
                                    type: integer
                                  warehouse:
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        type: string
                                      active:
                                        type: boolean
                                      country_iso:
                                        type: string
                            variant_countries:
                              type: object
                              description: >-
                                Hash of variant countries keyed by country ISO
                                code
                              additionalProperties:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                  country_id:
                                    type: integer
                                  country_name:
                                    type: string
                                  active:
                                    type: boolean
                                  currency_code:
                                    type: string
                                  price:
                                    type: string
                                  subscription_price:
                                    type: string
                                  wholesale:
                                    type: string
                                  wholesale_subscription_price:
                                    type: string
                                  shipping:
                                    type: string
                                  shipping_time:
                                    type:
                                      - string
                                      - 'null'
                                  cost_of_goods_sold:
                                    type: string
                                  compare_price:
                                    type: string
                                  cv:
                                    type: integer
                                  qv:
                                    type: integer
                                  pc_cv:
                                    type:
                                      - integer
                                      - 'null'
                                  pc_qv:
                                    type:
                                      - integer
                                      - 'null'
                                  points:
                                    type: integer
                                  display_price:
                                    type: string
                                  display_subscription_price:
                                    type: string
                                  display_wholesale:
                                    type: string
                                  display_wholesale_subscription_price:
                                    type: string
                                  subscription_plans:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        id:
                                          type: integer
                                        subscription_price_in_currency:
                                          type: string
                                        subscribe_and_save_in_currency:
                                          type: string
                                        subscribe_and_save_for_display:
                                          type: string
                                        wholesale_subscription_price_in_currency:
                                          type: string
                                        wholesale_subscribe_and_save_in_currency:
                                          type: string
                                        wholesale_subscribe_and_save_for_display:
                                          type: string
                                  buyable:
                                    type: boolean
                      bundle:
                        type:
                          - boolean
                          - 'null'
                        description: Whether the product is a bundle
                    required:
                      - id
                      - title
                      - description
                      - image_url
                      - status
                      - price
                      - public
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                        example:
                          - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
    patch:
      summary: Update a product
      tags:
        - Products
      operationId: updateProduct
      security:
        - bearer_auth: []
      description: Update an existing product
      parameters:
        - name: id
          in: path
          required: true
          description: 'Product''s Id '
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  product:
                    type: object
                    properties:
                      id:
                        type: integer
                      sku:
                        type:
                          - string
                          - 'null'
                      title:
                        type:
                          - string
                          - 'null'
                      description:
                        type:
                          - string
                          - 'null'
                      image_url:
                        type: string
                      status:
                        type: string
                      price:
                        type: string
                      commission:
                        type: string
                      public:
                        type: boolean
                      slug:
                        type: string
                      custom_slug:
                        type: boolean
                      active:
                        type: boolean
                      introduction:
                        type:
                          - string
                          - 'null'
                      feature_text:
                        type:
                          - string
                          - 'null'
                      stripped:
                        type:
                          - string
                          - 'null'
                      review_count:
                        type: integer
                      views:
                        type: integer
                      leads:
                        type: integer
                      show_reviews:
                        type: boolean
                      upc:
                        type:
                          - string
                          - 'null'
                      hs_code:
                        type:
                          - string
                          - 'null'
                      compressed_image_url:
                        type:
                          - string
                          - 'null'
                      image_path:
                        type:
                          - string
                          - 'null'
                      external_url:
                        type:
                          - string
                          - 'null'
                      display_price:
                        type: string
                      subscription_price:
                        type: string
                      tax_inclusive_price:
                        type: string
                      tax_inclusive_wholesale:
                        type: string
                      tax_inclusive_subscription_price:
                        type: string
                      tax_inclusive_wholesale_subscription_price:
                        type: string
                      currency_code:
                        type: string
                      tax_category_id:
                        type: integer
                      tax_category:
                        title: TaxCategory
                        type: object
                        properties:
                          id:
                            type: integer
                          code:
                            example: SV010020
                            type: string
                          title:
                            example: Tangible personal property (tpp)
                            type: string
                        required:
                          - id
                          - code
                          - title
                      international_tax_type:
                        type:
                          - string
                          - 'null'
                      in_stock:
                        type: boolean
                      keep_selling:
                        type: boolean
                      track_quantity:
                        type: boolean
                      no_index:
                        type: boolean
                      publish_to_retail_store:
                        type: boolean
                      publish_to_rep_store:
                        type: boolean
                      publish_to_share_tab:
                        type: boolean
                      affiliate_commission:
                        type:
                          - string
                          - 'null'
                      integration_id:
                        type:
                          - string
                          - 'null'
                      external_id:
                        type:
                          - string
                          - 'null'
                      application_theme_template_id:
                        type:
                          - string
                          - 'null'
                      last_synced_at:
                        type:
                          - string
                          - 'null'
                      updated_at:
                        type:
                          - string
                          - 'null'
                      option_attrs:
                        type: array
                        items:
                          type: string
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      metafields:
                        type: array
                        items:
                          title: LegacyMetafield
                          type: object
                          properties:
                            id:
                              type: integer
                            namespace:
                              description: >-
                                A container for related metafields. Commonly
                                used to group metafields by app or
                                functionality.
                              example: custom
                              type: string
                              maxLength: 20
                              pattern: ^[a-zA-Z0-9_]+$
                            key:
                              description: >-
                                The unique identifier for the metafield within
                                its namespace. Must be unique per namespace and
                                owner.
                              example: material
                              type: string
                              maxLength: 30
                              pattern: ^[a-zA-Z0-9_]+$
                            value:
                              description: >-
                                The actual data stored in the metafield. Type
                                depends on value_type.
                              example: cotton
                              type:
                                - string
                                - object
                            value_type:
                              description: >-
                                The data type that defines how the value should
                                be interpreted and validated.
                              example: single_line_text_field
                              type: string
                            description:
                              description: >-
                                Optional human-readable description explaining
                                the purpose of this metafield.
                              example: The primary material used in this product
                              type:
                                - string
                                - 'null'
                            owner_type:
                              description: >-
                                The type of resource that this metafield belongs
                                to (polymorphic association).
                              example: Product
                              type: string
                            owner_id:
                              description: >-
                                The ID of the specific resource that this
                                metafield belongs to.
                              example: 12345
                              type: integer
                            created_at:
                              description: Timestamp when the metafield was created.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            updated_at:
                              description: Timestamp when the metafield was last updated.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            metafield_definition:
                              title: MetafieldDefinition
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                company_id:
                                  description: >-
                                    The ID of the company that owns this
                                    metafield definition.
                                  example: 1
                                  type: integer
                                namespace:
                                  description: >-
                                    A container for related metafield
                                    definitions. Used to group definitions by
                                    app or functionality. Must be unique within
                                    company and owner_resource.
                                  example: product_details
                                  type: string
                                  maxLength: 20
                                  pattern: ^[a-zA-Z0-9_]+$
                                key:
                                  description: >-
                                    The unique identifier for the metafield
                                    definition within its namespace and
                                    owner_resource. Combined with namespace and
                                    owner_resource, this must be unique per
                                    company.
                                  example: material_type
                                  type: string
                                  maxLength: 30
                                  pattern: ^[a-zA-Z0-9_]+$
                                name:
                                  description: >-
                                    Human-readable display name for the
                                    metafield definition, shown in admin
                                    interfaces and forms.
                                  example: Material Type
                                  type: string
                                  maxLength: 100
                                description:
                                  description: >-
                                    Detailed explanation of what this metafield
                                    definition represents, how it should be
                                    used, and any special instructions for
                                    content creators.
                                  example: >-
                                    Specify the primary material composition of
                                    the product (e.g., cotton, polyester, silk).
                                    This will be displayed on the product detail
                                    page.
                                  type:
                                    - string
                                    - 'null'
                                value_type:
                                  description: >-
                                    The data type that defines how metafield
                                    values should be validated, stored, and
                                    displayed. Determines which validation rules
                                    are available.
                                  example: single_line_text_field
                                  type: string
                                validation_rules:
                                  description: >-
                                    JSON object containing validation
                                    constraints that will be applied to
                                    metafield values. Available rules depend on
                                    the value_type.
                                  example:
                                    choices:
                                      - cotton
                                      - polyester
                                      - silk
                                      - wool
                                      - linen
                                      - bamboo
                                    max: 50
                                    min: 2
                                  type:
                                    - object
                                    - 'null'
                                owner_resource:
                                  description: >-
                                    The type of resource (model class name) that
                                    metafields using this definition can be
                                    attached to. Must match the polymorphic
                                    owner_type.
                                  example: Product
                                  type: string
                                pinned:
                                  description: >-
                                    Whether this definition should be
                                    prominently displayed or prioritized in
                                    admin interfaces and forms.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                position:
                                  default: 0
                                  description: >-
                                    Sort order for displaying this definition
                                    relative to others in the same category and
                                    owner_resource. Lower numbers appear first.
                                  example: 1
                                  type:
                                    - integer
                                    - 'null'
                                locked:
                                  description: >-
                                    Whether this metafield definition is locked,
                                    preventing direct updates or deletions of
                                    metafields using this definition.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                created_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    created.
                                  example: '2024-01-15T10:30:00Z'
                                  type: string
                                  format: date-time
                                updated_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    last updated.
                                  example: '2024-02-20T14:45:00Z'
                                  type: string
                                  format: date-time
                                list_type:
                                  description: >-
                                    Whether this definition is for list-type
                                    metafields that store arrays of values.
                                  example: false
                                  type: boolean
                                reference_type:
                                  description: >-
                                    Whether this definition is for
                                    reference-type metafields that store
                                    references to other resources.
                                  example: false
                                  type: boolean
                                supported_validations:
                                  description: >-
                                    Array of validation rule names that are
                                    supported for this value_type.
                                  example:
                                    - min
                                    - max
                                    - choices
                                    - regex
                                  type: array
                                validation_description:
                                  description: >-
                                    Human-readable description of what the
                                    value_type represents and its constraints.
                                  example: Single line text up to 5000 characters
                                  type: string
                                category_ids:
                                  description: >-
                                    Array of category IDs that this metafield
                                    definition is associated with for
                                    organizational purposes.
                                  example:
                                    - 1
                                    - 2
                                    - 3
                                  items:
                                    type: integer
                                  type: array
                              required:
                                - id
                                - company_id
                                - namespace
                                - key
                                - name
                                - value_type
                                - owner_resource
                                - created_at
                                - updated_at
                                - list_type
                                - reference_type
                                - supported_validations
                                - validation_description
                                - category_ids
                          required:
                            - id
                            - namespace
                            - key
                            - value
                            - value_type
                            - owner_type
                            - owner_id
                            - created_at
                            - updated_at
                      metafields_collection:
                        type: array
                        items:
                          type: object
                          properties:
                            key:
                              type: string
                            value: {}
                      product_subscription_plans:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            active:
                              type: boolean
                            default:
                              type: boolean
                            products_count:
                              type: integer
                            subscribers_count:
                              type: integer
                            subscription_plan:
                              type: object
                              properties:
                                id:
                                  type: integer
                                name:
                                  type: string
                                active:
                                  type: boolean
                                allow_max_billing_cycles:
                                  type: boolean
                                max_billing_cycles:
                                  type:
                                    - integer
                                    - 'null'
                                billing_frequency_in_words:
                                  type: string
                                billing_interval:
                                  type: integer
                                billing_interval_unit:
                                  type: string
                                volume_interval:
                                  type: integer
                                volume_interval_unit:
                                  type: string
                                price_adjustment_amount:
                                  type:
                                    - string
                                    - 'null'
                                price_adjustment_type:
                                  type:
                                    - string
                                    - 'null'
                                subscription_price:
                                  type:
                                    - string
                                    - 'null'
                                wholesale_subscription_price:
                                  type:
                                    - string
                                    - 'null'
                      product_bundles:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                            bundled_variant:
                              type: object
                            quantity:
                              type: integer
                            tax_percentage:
                              type: number
                            display_externally:
                              type: boolean
                              description: >-
                                Whether this bundle item should be displayed to
                                customers
                      track_inventory_on_bundle_items:
                        type: boolean
                        description: Whether to track inventory on bundle items
                      collections:
                        type: array
                      tags:
                        type: array
                      label:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                              title:
                                type: string
                              background:
                                type: string
                              icon:
                                type: string
                              color:
                                type: string
                      display_tag:
                        type:
                          - string
                          - 'null'
                      search_engine_optimizer:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                              title:
                                type: string
                              description:
                                type: string
                              image_url:
                                type: string
                              image_path:
                                type: string
                              block_crawler:
                                type: boolean
                      share_link:
                        type:
                          - string
                          - 'null'
                      category:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                              title:
                                type: string
                              description:
                                type: string
                              image_url:
                                type: string
                              image_path:
                                type: string
                              position:
                                type: integer
                              public:
                                type: boolean
                      images:
                        type: array
                      options:
                        type: array
                        items:
                          title: Option
                          type: object
                          properties:
                            id:
                              type: integer
                            title:
                              type: string
                            position:
                              type:
                                - integer
                                - 'null'
                              default: 1
                            presentation:
                              type: string
                            external_id:
                              type:
                                - string
                                - 'null'
                            created_at:
                              type: string
                              format: date-time
                            updated_at:
                              type: string
                              format: date-time
                            option_values:
                              type: array
                              items:
                                title: OptionValue
                                type: object
                                properties:
                                  id:
                                    type: integer
                                  title:
                                    type: string
                                  position:
                                    type:
                                      - integer
                                      - 'null'
                                    default: 1
                                  presentation:
                                    type:
                                      - string
                                      - 'null'
                                  created_at:
                                    type: string
                                    format: date-time
                                  updated_at:
                                    type: string
                                    format: date-time
                                required:
                                  - id
                                  - title
                                  - created_at
                                  - updated_at
                          required:
                            - id
                            - title
                            - presentation
                            - created_at
                            - updated_at
                      variants:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            sku:
                              type:
                                - string
                                - 'null'
                            is_master:
                              type: boolean
                            title:
                              type:
                                - string
                                - 'null'
                            image_url:
                              type:
                                - string
                                - 'null'
                            subscription_only:
                              type: boolean
                            shipping_included_in_price:
                              type: boolean
                            images:
                              type: array
                            track_quantity:
                              type: boolean
                            inventory_quantity:
                              type:
                                - 'null'
                                - integer
                            bar_code:
                              type:
                                - string
                                - 'null'
                            limit_subscription:
                              type: boolean
                            subscription_max_qty:
                              type:
                                - 'null'
                                - integer
                            customer_limit:
                              type:
                                - 'null'
                                - integer
                            keep_selling:
                              type: boolean
                            limit_quantity_per_customer:
                              type: boolean
                            option_attrs:
                              type: array
                              items:
                                type: string
                            option_ids:
                              type: array
                              items:
                                type: integer
                            allow_subscription:
                              type: boolean
                              example: true
                            metafields:
                              type: array
                              description: Variant metafields
                            inventory_levels:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                  available:
                                    type: integer
                                  committed:
                                    type: integer
                                  on_hand:
                                    type: integer
                                  unavailable:
                                    type: integer
                                  warehouse:
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        type: string
                                      active:
                                        type: boolean
                                      country_iso:
                                        type: string
                            variant_countries:
                              type: object
                              description: >-
                                Hash of variant countries keyed by country ISO
                                code
                              additionalProperties:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                  country_id:
                                    type: integer
                                  country_name:
                                    type: string
                                  active:
                                    type: boolean
                                  currency_code:
                                    type: string
                                  price:
                                    type: string
                                  subscription_price:
                                    type: string
                                  wholesale:
                                    type: string
                                  wholesale_subscription_price:
                                    type: string
                                  shipping:
                                    type: string
                                  shipping_time:
                                    type:
                                      - string
                                      - 'null'
                                  cost_of_goods_sold:
                                    type: string
                                  compare_price:
                                    type: string
                                  cv:
                                    type: integer
                                  qv:
                                    type: integer
                                  pc_cv:
                                    type:
                                      - integer
                                      - 'null'
                                  pc_qv:
                                    type:
                                      - integer
                                      - 'null'
                                  points:
                                    type: integer
                                  display_price:
                                    type: string
                                  display_subscription_price:
                                    type: string
                                  display_wholesale:
                                    type: string
                                  display_wholesale_subscription_price:
                                    type: string
                                  subscription_plans:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        id:
                                          type: integer
                                        subscription_price_in_currency:
                                          type: string
                                        subscribe_and_save_in_currency:
                                          type: string
                                        subscribe_and_save_for_display:
                                          type: string
                                        wholesale_subscription_price_in_currency:
                                          type: string
                                        wholesale_subscribe_and_save_in_currency:
                                          type: string
                                        wholesale_subscribe_and_save_for_display:
                                          type: string
                                  buyable:
                                    type: boolean
                    required:
                      - id
                      - title
                      - description
                      - image_url
                      - status
                      - price
                      - public
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                        example:
                          - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    description: Hash of field names and error messages
                    example:
                      product:
                        title:
                          - is missing
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                  minLength: 1
                lang:
                  type: string
                dam_asset_codes:
                  type: array
                  items:
                    type: string
                product:
                  type: object
                  properties:
                    title:
                      type: string
                      minLength: 1
                    slug:
                      type: string
                    image_url:
                      type: string
                    image_path:
                      type: string
                    sku:
                      type: string
                    introduction:
                      type: string
                    feature_text:
                      type: string
                    description:
                      type: string
                    status:
                      type: string
                    commission:
                      type: number
                    public:
                      type: boolean
                    metadata:
                      type: object
                    publish_to_retail_store:
                      type: boolean
                    publish_to_rep_store:
                      type: boolean
                    publish_to_share_tab:
                      type: boolean
                    show_reviews:
                      type: boolean
                    application_theme_template_id:
                      type: integer
                    tax_category_id:
                      type: integer
                    international_tax_type:
                      type: string
                    collection_ids:
                      type: array
                      items:
                        type: integer
                    tag_ids:
                      type: array
                      items:
                        type: integer
                    label_id:
                      type: integer
                    category_id:
                      type: integer
                    keep_selling:
                      type: boolean
                    option_attrs:
                      type: array
                      items:
                        type: string
                    no_index:
                      type: boolean
                    custom_slug:
                      type: boolean
                    search_engine_optimizer_attributes:
                      type: object
                      properties:
                        id:
                          type: integer
                        title:
                          type: string
                        description:
                          type: string
                        image_url:
                          type: string
                        image_path:
                          type: string
                        block_crawler:
                          type: boolean
                      required: []
                    images_attributes:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: integer
                          position:
                            type: integer
                          image_url:
                            type: string
                          _destroy:
                            type: boolean
                        required:
                          - position
                          - image_url
                    product_subscription_plans_attributes:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: integer
                          subscription_plan_id:
                            type: integer
                          default:
                            type: boolean
                          active:
                            type: boolean
                        required: []
                    variants_attributes:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: integer
                          option_attrs:
                            type: array
                            items:
                              type: string
                          sku:
                            type: string
                          is_master:
                            type: boolean
                          title:
                            type: string
                          _destroy:
                            type: boolean
                          track_quantity:
                            type: boolean
                          bar_code:
                            type: string
                          limit_subscription:
                            type: boolean
                          subscription_max_qty:
                            type: integer
                          customer_limit:
                            type: integer
                          keep_selling:
                            type: boolean
                          images_attributes:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                position:
                                  type: integer
                                image_url:
                                  type: string
                                _destroy:
                                  type: boolean
                              required:
                                - position
                                - image_url
                          inventory_levels_attributes:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                warehouse_id:
                                  type: integer
                                  not:
                                    type: 'null'
                                available:
                                  type: integer
                                  not:
                                    type: 'null'
                                committed:
                                  type: integer
                                  not:
                                    type: 'null'
                                on_hand:
                                  type: integer
                                  not:
                                    type: 'null'
                                unavailable:
                                  type: integer
                                  not:
                                    type: 'null'
                                _destroy:
                                  type: boolean
                              required: []
                          variant_countries_attributes:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                active:
                                  type: boolean
                                country_id:
                                  type: integer
                                price:
                                  type: number
                                subscription_price:
                                  type: number
                                wholesale:
                                  type: number
                                wholesale_subscription_price:
                                  type: number
                                compare_price:
                                  type: number
                                cv:
                                  type: integer
                                qv:
                                  type: integer
                                pc_cv:
                                  type: integer
                                pc_qv:
                                  type: integer
                                points:
                                  type: integer
                                cost_of_goods_sold:
                                  type: number
                                shipping:
                                  type: number
                                tax:
                                  type: number
                                _destroy:
                                  type: boolean
                              required: []
                          metafields_attributes:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                namespace:
                                  type: string
                                key:
                                  type: string
                                value:
                                  not:
                                    type: 'null'
                                value_type:
                                  type: string
                                _destroy:
                                  type: boolean
                              required: []
                        required: []
                    bundle:
                      type: boolean
                    track_inventory_on_bundle_items:
                      type: boolean
                    product_bundles_attributes:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: integer
                          bundled_variant_id:
                            type: integer
                          quantity:
                            type: integer
                          display_externally:
                            type: boolean
                          _destroy:
                            type: boolean
                        required: []
                    metafields_attributes:
                      type: array
                      items:
                        type: object
                        properties:
                          id:
                            type: integer
                          namespace:
                            type: string
                          key:
                            type: string
                          value:
                            not:
                              type: 'null'
                          value_type:
                            type: string
                          _destroy:
                            type: boolean
                        required: []
                  required:
                    - title
              required:
                - id
                - product
    delete:
      summary: Delete a product
      tags:
        - Products
      operationId: deleteProduct
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Product's Id or slug
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                    description: Product ID
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                        example:
                          - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    description: Hash of field names and error messages
                    example:
                      errors:
                        product:
                          - >-
                            with orders cannot be deleted. You can set it as
                            draft instead.
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
  /api/company/v1/products/{id}/add_to_collection:
    post:
      summary: Add product to collection
      tags:
        - Products
      operationId: addProductToCollection
      security:
        - bearer_auth: []
      description: Add a Product to a Collection
      parameters:
        - name: id
          in: path
          required: true
          description: Product's Id or slug
          schema:
            type: integer
        - name: collection_id
          in: query
          required: true
          description: Collection's Id
          schema:
            type: string
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Product (1373) added to Collection (2402)
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                        example:
                          - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    description: Hash of field names and error messages
                    example:
                      collection_id:
                        - is already taken
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
  /api/company/v1/products/{id}/remove_from_collection:
    delete:
      summary: Remove product from collection
      tags:
        - Products
      operationId: removeProductFromCollection
      security:
        - bearer_auth: []
      description: Remove a Product from a Collection
      parameters:
        - name: id
          in: path
          required: true
          description: Product's Id or slug
          schema:
            type: integer
        - name: collection_id
          in: query
          required: true
          description: Collection's Id
          schema:
            type: string
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Product (1373) removed from Collection (2402)
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: product collection not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Product Collection not found
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                        example:
                          - not found
                    description: Hash of field names and error messages
                    example:
                      base:
                        - Product Collection not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
  /api/company/v1/products/{id}/duplicate:
    post:
      summary: Duplicate a product
      tags:
        - Products
      operationId: duplicateProduct
      security:
        - bearer_auth: []
      description: Create a duplicate copy of an existing product
      parameters:
        - name: id
          in: path
          required: true
          description: Product's Id or slug
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  product:
                    type: object
                    properties:
                      id:
                        type: integer
                      sku:
                        type:
                          - string
                          - 'null'
                      title:
                        type:
                          - string
                          - 'null'
                      description:
                        type:
                          - string
                          - 'null'
                      image_url:
                        type: string
                      status:
                        type: string
                      price:
                        type: string
                      commission:
                        type: string
                      public:
                        type: boolean
                      slug:
                        type: string
                      custom_slug:
                        type: boolean
                      active:
                        type: boolean
                      introduction:
                        type:
                          - string
                          - 'null'
                      feature_text:
                        type:
                          - string
                          - 'null'
                      stripped:
                        type:
                          - string
                          - 'null'
                      review_count:
                        type: integer
                      views:
                        type: integer
                      leads:
                        type: integer
                      show_reviews:
                        type: boolean
                      upc:
                        type:
                          - string
                          - 'null'
                      hs_code:
                        type:
                          - string
                          - 'null'
                      compressed_image_url:
                        type:
                          - string
                          - 'null'
                      image_path:
                        type:
                          - string
                          - 'null'
                      external_url:
                        type:
                          - string
                          - 'null'
                      display_price:
                        type: string
                      subscription_price:
                        type: string
                      tax_inclusive_price:
                        type: string
                      tax_inclusive_wholesale:
                        type: string
                      tax_inclusive_subscription_price:
                        type: string
                      tax_inclusive_wholesale_subscription_price:
                        type: string
                      currency_code:
                        type: string
                      tax_category_id:
                        type: integer
                      tax_category:
                        title: TaxCategory
                        type: object
                        properties:
                          id:
                            type: integer
                          code:
                            example: SV010020
                            type: string
                          title:
                            example: Tangible personal property (tpp)
                            type: string
                        required:
                          - id
                          - code
                          - title
                      international_tax_type:
                        type:
                          - string
                          - 'null'
                      in_stock:
                        type: boolean
                      keep_selling:
                        type: boolean
                      track_quantity:
                        type: boolean
                      no_index:
                        type: boolean
                      publish_to_retail_store:
                        type: boolean
                      publish_to_rep_store:
                        type: boolean
                      publish_to_share_tab:
                        type: boolean
                      affiliate_commission:
                        type:
                          - string
                          - 'null'
                      integration_id:
                        type:
                          - string
                          - 'null'
                      external_id:
                        type:
                          - string
                          - 'null'
                      application_theme_template_id:
                        type:
                          - string
                          - 'null'
                      last_synced_at:
                        type:
                          - string
                          - 'null'
                      updated_at:
                        type:
                          - string
                          - 'null'
                      option_attrs:
                        type: array
                        items:
                          type: string
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      metafields:
                        type: array
                        items:
                          title: LegacyMetafield
                          type: object
                          properties:
                            id:
                              type: integer
                            namespace:
                              description: >-
                                A container for related metafields. Commonly
                                used to group metafields by app or
                                functionality.
                              example: custom
                              type: string
                              maxLength: 20
                              pattern: ^[a-zA-Z0-9_]+$
                            key:
                              description: >-
                                The unique identifier for the metafield within
                                its namespace. Must be unique per namespace and
                                owner.
                              example: material
                              type: string
                              maxLength: 30
                              pattern: ^[a-zA-Z0-9_]+$
                            value:
                              description: >-
                                The actual data stored in the metafield. Type
                                depends on value_type.
                              example: cotton
                              type:
                                - string
                                - object
                            value_type:
                              description: >-
                                The data type that defines how the value should
                                be interpreted and validated.
                              example: single_line_text_field
                              type: string
                            description:
                              description: >-
                                Optional human-readable description explaining
                                the purpose of this metafield.
                              example: The primary material used in this product
                              type:
                                - string
                                - 'null'
                            owner_type:
                              description: >-
                                The type of resource that this metafield belongs
                                to (polymorphic association).
                              example: Product
                              type: string
                            owner_id:
                              description: >-
                                The ID of the specific resource that this
                                metafield belongs to.
                              example: 12345
                              type: integer
                            created_at:
                              description: Timestamp when the metafield was created.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            updated_at:
                              description: Timestamp when the metafield was last updated.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            metafield_definition:
                              title: MetafieldDefinition
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                company_id:
                                  description: >-
                                    The ID of the company that owns this
                                    metafield definition.
                                  example: 1
                                  type: integer
                                namespace:
                                  description: >-
                                    A container for related metafield
                                    definitions. Used to group definitions by
                                    app or functionality. Must be unique within
                                    company and owner_resource.
                                  example: product_details
                                  type: string
                                  maxLength: 20
                                  pattern: ^[a-zA-Z0-9_]+$
                                key:
                                  description: >-
                                    The unique identifier for the metafield
                                    definition within its namespace and
                                    owner_resource. Combined with namespace and
                                    owner_resource, this must be unique per
                                    company.
                                  example: material_type
                                  type: string
                                  maxLength: 30
                                  pattern: ^[a-zA-Z0-9_]+$
                                name:
                                  description: >-
                                    Human-readable display name for the
                                    metafield definition, shown in admin
                                    interfaces and forms.
                                  example: Material Type
                                  type: string
                                  maxLength: 100
                                description:
                                  description: >-
                                    Detailed explanation of what this metafield
                                    definition represents, how it should be
                                    used, and any special instructions for
                                    content creators.
                                  example: >-
                                    Specify the primary material composition of
                                    the product (e.g., cotton, polyester, silk).
                                    This will be displayed on the product detail
                                    page.
                                  type:
                                    - string
                                    - 'null'
                                value_type:
                                  description: >-
                                    The data type that defines how metafield
                                    values should be validated, stored, and
                                    displayed. Determines which validation rules
                                    are available.
                                  example: single_line_text_field
                                  type: string
                                validation_rules:
                                  description: >-
                                    JSON object containing validation
                                    constraints that will be applied to
                                    metafield values. Available rules depend on
                                    the value_type.
                                  example:
                                    choices:
                                      - cotton
                                      - polyester
                                      - silk
                                      - wool
                                      - linen
                                      - bamboo
                                    max: 50
                                    min: 2
                                  type:
                                    - object
                                    - 'null'
                                owner_resource:
                                  description: >-
                                    The type of resource (model class name) that
                                    metafields using this definition can be
                                    attached to. Must match the polymorphic
                                    owner_type.
                                  example: Product
                                  type: string
                                pinned:
                                  description: >-
                                    Whether this definition should be
                                    prominently displayed or prioritized in
                                    admin interfaces and forms.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                position:
                                  default: 0
                                  description: >-
                                    Sort order for displaying this definition
                                    relative to others in the same category and
                                    owner_resource. Lower numbers appear first.
                                  example: 1
                                  type:
                                    - integer
                                    - 'null'
                                locked:
                                  description: >-
                                    Whether this metafield definition is locked,
                                    preventing direct updates or deletions of
                                    metafields using this definition.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                created_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    created.
                                  example: '2024-01-15T10:30:00Z'
                                  type: string
                                  format: date-time
                                updated_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    last updated.
                                  example: '2024-02-20T14:45:00Z'
                                  type: string
                                  format: date-time
                                list_type:
                                  description: >-
                                    Whether this definition is for list-type
                                    metafields that store arrays of values.
                                  example: false
                                  type: boolean
                                reference_type:
                                  description: >-
                                    Whether this definition is for
                                    reference-type metafields that store
                                    references to other resources.
                                  example: false
                                  type: boolean
                                supported_validations:
                                  description: >-
                                    Array of validation rule names that are
                                    supported for this value_type.
                                  example:
                                    - min
                                    - max
                                    - choices
                                    - regex
                                  type: array
                                validation_description:
                                  description: >-
                                    Human-readable description of what the
                                    value_type represents and its constraints.
                                  example: Single line text up to 5000 characters
                                  type: string
                                category_ids:
                                  description: >-
                                    Array of category IDs that this metafield
                                    definition is associated with for
                                    organizational purposes.
                                  example:
                                    - 1
                                    - 2
                                    - 3
                                  items:
                                    type: integer
                                  type: array
                              required:
                                - id
                                - company_id
                                - namespace
                                - key
                                - name
                                - value_type
                                - owner_resource
                                - created_at
                                - updated_at
                                - list_type
                                - reference_type
                                - supported_validations
                                - validation_description
                                - category_ids
                          required:
                            - id
                            - namespace
                            - key
                            - value
                            - value_type
                            - owner_type
                            - owner_id
                            - created_at
                            - updated_at
                      metafields_collection:
                        type: array
                        items:
                          type: object
                          properties:
                            key:
                              type: string
                            value: {}
                      product_subscription_plans:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            active:
                              type: boolean
                            default:
                              type: boolean
                            products_count:
                              type: integer
                            subscribers_count:
                              type: integer
                            subscription_plan:
                              type: object
                              properties:
                                id:
                                  type: integer
                                name:
                                  type: string
                                active:
                                  type: boolean
                                allow_max_billing_cycles:
                                  type: boolean
                                max_billing_cycles:
                                  type:
                                    - integer
                                    - 'null'
                                billing_frequency_in_words:
                                  type: string
                                billing_interval:
                                  type: integer
                                billing_interval_unit:
                                  type: string
                                volume_interval:
                                  type: integer
                                volume_interval_unit:
                                  type: string
                                price_adjustment_amount:
                                  type:
                                    - string
                                    - 'null'
                                price_adjustment_type:
                                  type:
                                    - string
                                    - 'null'
                                subscription_price:
                                  type:
                                    - string
                                    - 'null'
                                wholesale_subscription_price:
                                  type:
                                    - string
                                    - 'null'
                      product_bundles:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                            bundled_variant:
                              type: object
                            quantity:
                              type: integer
                            tax_percentage:
                              type: number
                            display_externally:
                              type: boolean
                              description: >-
                                Whether this bundle item should be displayed to
                                customers
                      track_inventory_on_bundle_items:
                        type: boolean
                        description: Whether to track inventory on bundle items
                      collections:
                        type: array
                      tags:
                        type: array
                      label:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                              title:
                                type: string
                              background:
                                type: string
                              icon:
                                type: string
                              color:
                                type: string
                      display_tag:
                        type:
                          - string
                          - 'null'
                      search_engine_optimizer:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                              title:
                                type: string
                              description:
                                type: string
                              image_url:
                                type: string
                              image_path:
                                type: string
                              block_crawler:
                                type: boolean
                      share_link:
                        type:
                          - string
                          - 'null'
                      category:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                              title:
                                type: string
                              description:
                                type: string
                              image_url:
                                type: string
                              image_path:
                                type: string
                              position:
                                type: integer
                              public:
                                type: boolean
                      images:
                        type: array
                      options:
                        type: array
                        items:
                          title: Option
                          type: object
                          properties:
                            id:
                              type: integer
                            title:
                              type: string
                            position:
                              type:
                                - integer
                                - 'null'
                              default: 1
                            presentation:
                              type: string
                            external_id:
                              type:
                                - string
                                - 'null'
                            created_at:
                              type: string
                              format: date-time
                            updated_at:
                              type: string
                              format: date-time
                            option_values:
                              type: array
                              items:
                                title: OptionValue
                                type: object
                                properties:
                                  id:
                                    type: integer
                                  title:
                                    type: string
                                  position:
                                    type:
                                      - integer
                                      - 'null'
                                    default: 1
                                  presentation:
                                    type:
                                      - string
                                      - 'null'
                                  created_at:
                                    type: string
                                    format: date-time
                                  updated_at:
                                    type: string
                                    format: date-time
                                required:
                                  - id
                                  - title
                                  - created_at
                                  - updated_at
                          required:
                            - id
                            - title
                            - presentation
                            - created_at
                            - updated_at
                      variants:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            sku:
                              type:
                                - string
                                - 'null'
                            is_master:
                              type: boolean
                            title:
                              type:
                                - string
                                - 'null'
                            image_url:
                              type:
                                - string
                                - 'null'
                            subscription_only:
                              type: boolean
                            shipping_included_in_price:
                              type: boolean
                            images:
                              type: array
                            track_quantity:
                              type: boolean
                            inventory_quantity:
                              type:
                                - 'null'
                                - integer
                            bar_code:
                              type:
                                - string
                                - 'null'
                            limit_subscription:
                              type: boolean
                            subscription_max_qty:
                              type:
                                - 'null'
                                - integer
                            customer_limit:
                              type:
                                - 'null'
                                - integer
                            keep_selling:
                              type: boolean
                            limit_quantity_per_customer:
                              type: boolean
                            option_attrs:
                              type: array
                              items:
                                type: string
                            option_ids:
                              type: array
                              items:
                                type: integer
                            allow_subscription:
                              type: boolean
                              example: true
                            metafields:
                              type: array
                              description: Variant metafields
                            inventory_levels:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                  available:
                                    type: integer
                                  committed:
                                    type: integer
                                  on_hand:
                                    type: integer
                                  unavailable:
                                    type: integer
                                  warehouse:
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        type: string
                                      active:
                                        type: boolean
                                      country_iso:
                                        type: string
                            variant_countries:
                              type: object
                              description: >-
                                Hash of variant countries keyed by country ISO
                                code
                              additionalProperties:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                  country_id:
                                    type: integer
                                  country_name:
                                    type: string
                                  active:
                                    type: boolean
                                  currency_code:
                                    type: string
                                  price:
                                    type: string
                                  subscription_price:
                                    type: string
                                  wholesale:
                                    type: string
                                  wholesale_subscription_price:
                                    type: string
                                  shipping:
                                    type: string
                                  shipping_time:
                                    type:
                                      - string
                                      - 'null'
                                  cost_of_goods_sold:
                                    type: string
                                  compare_price:
                                    type: string
                                  cv:
                                    type: integer
                                  qv:
                                    type: integer
                                  pc_cv:
                                    type:
                                      - integer
                                      - 'null'
                                  pc_qv:
                                    type:
                                      - integer
                                      - 'null'
                                  points:
                                    type: integer
                                  display_price:
                                    type: string
                                  display_subscription_price:
                                    type: string
                                  display_wholesale:
                                    type: string
                                  display_wholesale_subscription_price:
                                    type: string
                                  subscription_plans:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        id:
                                          type: integer
                                        subscription_price_in_currency:
                                          type: string
                                        subscribe_and_save_in_currency:
                                          type: string
                                        subscribe_and_save_for_display:
                                          type: string
                                        wholesale_subscription_price_in_currency:
                                          type: string
                                        wholesale_subscribe_and_save_in_currency:
                                          type: string
                                        wholesale_subscribe_and_save_for_display:
                                          type: string
                                  buyable:
                                    type: boolean
                    required:
                      - id
                      - title
                      - description
                      - image_url
                      - status
                      - price
                      - public
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                        example:
                          - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    description: Hash of field names and error messages
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
  /api/company/v1/products/{id}/send_to_top:
    patch:
      summary: Send product to top
      tags:
        - Products
      operationId: sendProductToTop
      security:
        - bearer_auth: []
      description: >-
        Change the priority attribute of a product to the highest priority. This
        will move the product to the top of the default order in the index API
      parameters:
        - name: id
          in: path
          required: true
          description: Product's Id or slug
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: priority set to 1000
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                        example:
                          - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    description: Hash of field names and error messages
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
  /api/company/v1/products/{product_id}/find_by_shop_id:
    post:
      summary: Find product by external shop ID
      tags:
        - Products
      operationId: findProductByShopId
      security:
        - bearer_auth: []
      description: >-
        Find or optionally sync a product using external shop ID. Currently,
        support is limited to Shopify Integrations only.
      parameters:
        - name: product_id
          in: path
          required: true
          description: External ID of the product
          schema:
            type: string
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  product:
                    type: object
                    properties:
                      id:
                        type: integer
                      sku:
                        type:
                          - string
                          - 'null'
                      title:
                        type:
                          - string
                          - 'null'
                      description:
                        type:
                          - string
                          - 'null'
                      image_url:
                        type: string
                      status:
                        type: string
                      price:
                        type: string
                      commission:
                        type: string
                      public:
                        type: boolean
                      slug:
                        type: string
                      custom_slug:
                        type: boolean
                      active:
                        type: boolean
                      introduction:
                        type:
                          - string
                          - 'null'
                      feature_text:
                        type:
                          - string
                          - 'null'
                      stripped:
                        type:
                          - string
                          - 'null'
                      review_count:
                        type: integer
                      views:
                        type: integer
                      leads:
                        type: integer
                      show_reviews:
                        type: boolean
                      upc:
                        type:
                          - string
                          - 'null'
                      hs_code:
                        type:
                          - string
                          - 'null'
                      compressed_image_url:
                        type:
                          - string
                          - 'null'
                      image_path:
                        type:
                          - string
                          - 'null'
                      external_url:
                        type:
                          - string
                          - 'null'
                      display_price:
                        type: string
                      subscription_price:
                        type: string
                      tax_inclusive_price:
                        type: string
                      tax_inclusive_wholesale:
                        type: string
                      tax_inclusive_subscription_price:
                        type: string
                      tax_inclusive_wholesale_subscription_price:
                        type: string
                      currency_code:
                        type: string
                      tax_category_id:
                        type: integer
                      tax_category:
                        title: TaxCategory
                        type: object
                        properties:
                          id:
                            type: integer
                          code:
                            example: SV010020
                            type: string
                          title:
                            example: Tangible personal property (tpp)
                            type: string
                        required:
                          - id
                          - code
                          - title
                      international_tax_type:
                        type:
                          - string
                          - 'null'
                      in_stock:
                        type: boolean
                      keep_selling:
                        type: boolean
                      track_quantity:
                        type: boolean
                      no_index:
                        type: boolean
                      publish_to_retail_store:
                        type: boolean
                      publish_to_rep_store:
                        type: boolean
                      publish_to_share_tab:
                        type: boolean
                      affiliate_commission:
                        type:
                          - string
                          - 'null'
                      integration_id:
                        type:
                          - string
                          - 'null'
                      external_id:
                        type:
                          - string
                          - 'null'
                      application_theme_template_id:
                        type:
                          - string
                          - 'null'
                      last_synced_at:
                        type:
                          - string
                          - 'null'
                      updated_at:
                        type:
                          - string
                          - 'null'
                      option_attrs:
                        type: array
                        items:
                          type: string
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      metafields:
                        type: array
                        items:
                          title: LegacyMetafield
                          type: object
                          properties:
                            id:
                              type: integer
                            namespace:
                              description: >-
                                A container for related metafields. Commonly
                                used to group metafields by app or
                                functionality.
                              example: custom
                              type: string
                              maxLength: 20
                              pattern: ^[a-zA-Z0-9_]+$
                            key:
                              description: >-
                                The unique identifier for the metafield within
                                its namespace. Must be unique per namespace and
                                owner.
                              example: material
                              type: string
                              maxLength: 30
                              pattern: ^[a-zA-Z0-9_]+$
                            value:
                              description: >-
                                The actual data stored in the metafield. Type
                                depends on value_type.
                              example: cotton
                              type:
                                - string
                                - object
                            value_type:
                              description: >-
                                The data type that defines how the value should
                                be interpreted and validated.
                              example: single_line_text_field
                              type: string
                            description:
                              description: >-
                                Optional human-readable description explaining
                                the purpose of this metafield.
                              example: The primary material used in this product
                              type:
                                - string
                                - 'null'
                            owner_type:
                              description: >-
                                The type of resource that this metafield belongs
                                to (polymorphic association).
                              example: Product
                              type: string
                            owner_id:
                              description: >-
                                The ID of the specific resource that this
                                metafield belongs to.
                              example: 12345
                              type: integer
                            created_at:
                              description: Timestamp when the metafield was created.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            updated_at:
                              description: Timestamp when the metafield was last updated.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            metafield_definition:
                              title: MetafieldDefinition
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                company_id:
                                  description: >-
                                    The ID of the company that owns this
                                    metafield definition.
                                  example: 1
                                  type: integer
                                namespace:
                                  description: >-
                                    A container for related metafield
                                    definitions. Used to group definitions by
                                    app or functionality. Must be unique within
                                    company and owner_resource.
                                  example: product_details
                                  type: string
                                  maxLength: 20
                                  pattern: ^[a-zA-Z0-9_]+$
                                key:
                                  description: >-
                                    The unique identifier for the metafield
                                    definition within its namespace and
                                    owner_resource. Combined with namespace and
                                    owner_resource, this must be unique per
                                    company.
                                  example: material_type
                                  type: string
                                  maxLength: 30
                                  pattern: ^[a-zA-Z0-9_]+$
                                name:
                                  description: >-
                                    Human-readable display name for the
                                    metafield definition, shown in admin
                                    interfaces and forms.
                                  example: Material Type
                                  type: string
                                  maxLength: 100
                                description:
                                  description: >-
                                    Detailed explanation of what this metafield
                                    definition represents, how it should be
                                    used, and any special instructions for
                                    content creators.
                                  example: >-
                                    Specify the primary material composition of
                                    the product (e.g., cotton, polyester, silk).
                                    This will be displayed on the product detail
                                    page.
                                  type:
                                    - string
                                    - 'null'
                                value_type:
                                  description: >-
                                    The data type that defines how metafield
                                    values should be validated, stored, and
                                    displayed. Determines which validation rules
                                    are available.
                                  example: single_line_text_field
                                  type: string
                                validation_rules:
                                  description: >-
                                    JSON object containing validation
                                    constraints that will be applied to
                                    metafield values. Available rules depend on
                                    the value_type.
                                  example:
                                    choices:
                                      - cotton
                                      - polyester
                                      - silk
                                      - wool
                                      - linen
                                      - bamboo
                                    max: 50
                                    min: 2
                                  type:
                                    - object
                                    - 'null'
                                owner_resource:
                                  description: >-
                                    The type of resource (model class name) that
                                    metafields using this definition can be
                                    attached to. Must match the polymorphic
                                    owner_type.
                                  example: Product
                                  type: string
                                pinned:
                                  description: >-
                                    Whether this definition should be
                                    prominently displayed or prioritized in
                                    admin interfaces and forms.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                position:
                                  default: 0
                                  description: >-
                                    Sort order for displaying this definition
                                    relative to others in the same category and
                                    owner_resource. Lower numbers appear first.
                                  example: 1
                                  type:
                                    - integer
                                    - 'null'
                                locked:
                                  description: >-
                                    Whether this metafield definition is locked,
                                    preventing direct updates or deletions of
                                    metafields using this definition.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                created_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    created.
                                  example: '2024-01-15T10:30:00Z'
                                  type: string
                                  format: date-time
                                updated_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    last updated.
                                  example: '2024-02-20T14:45:00Z'
                                  type: string
                                  format: date-time
                                list_type:
                                  description: >-
                                    Whether this definition is for list-type
                                    metafields that store arrays of values.
                                  example: false
                                  type: boolean
                                reference_type:
                                  description: >-
                                    Whether this definition is for
                                    reference-type metafields that store
                                    references to other resources.
                                  example: false
                                  type: boolean
                                supported_validations:
                                  description: >-
                                    Array of validation rule names that are
                                    supported for this value_type.
                                  example:
                                    - min
                                    - max
                                    - choices
                                    - regex
                                  type: array
                                validation_description:
                                  description: >-
                                    Human-readable description of what the
                                    value_type represents and its constraints.
                                  example: Single line text up to 5000 characters
                                  type: string
                                category_ids:
                                  description: >-
                                    Array of category IDs that this metafield
                                    definition is associated with for
                                    organizational purposes.
                                  example:
                                    - 1
                                    - 2
                                    - 3
                                  items:
                                    type: integer
                                  type: array
                              required:
                                - id
                                - company_id
                                - namespace
                                - key
                                - name
                                - value_type
                                - owner_resource
                                - created_at
                                - updated_at
                                - list_type
                                - reference_type
                                - supported_validations
                                - validation_description
                                - category_ids
                          required:
                            - id
                            - namespace
                            - key
                            - value
                            - value_type
                            - owner_type
                            - owner_id
                            - created_at
                            - updated_at
                      metafields_collection:
                        type: array
                        items:
                          type: object
                          properties:
                            key:
                              type: string
                            value: {}
                      product_subscription_plans:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            active:
                              type: boolean
                            default:
                              type: boolean
                            products_count:
                              type: integer
                            subscribers_count:
                              type: integer
                            subscription_plan:
                              type: object
                              properties:
                                id:
                                  type: integer
                                name:
                                  type: string
                                active:
                                  type: boolean
                                allow_max_billing_cycles:
                                  type: boolean
                                max_billing_cycles:
                                  type:
                                    - integer
                                    - 'null'
                                billing_frequency_in_words:
                                  type: string
                                billing_interval:
                                  type: integer
                                billing_interval_unit:
                                  type: string
                                volume_interval:
                                  type: integer
                                volume_interval_unit:
                                  type: string
                                price_adjustment_amount:
                                  type:
                                    - string
                                    - 'null'
                                price_adjustment_type:
                                  type:
                                    - string
                                    - 'null'
                                subscription_price:
                                  type:
                                    - string
                                    - 'null'
                                wholesale_subscription_price:
                                  type:
                                    - string
                                    - 'null'
                      product_bundles:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                            bundled_variant:
                              type: object
                            quantity:
                              type: integer
                            tax_percentage:
                              type: number
                            display_externally:
                              type: boolean
                              description: >-
                                Whether this bundle item should be displayed to
                                customers
                      track_inventory_on_bundle_items:
                        type: boolean
                        description: Whether to track inventory on bundle items
                      collections:
                        type: array
                      tags:
                        type: array
                      label:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                              title:
                                type: string
                              background:
                                type: string
                              icon:
                                type: string
                              color:
                                type: string
                      display_tag:
                        type:
                          - string
                          - 'null'
                      search_engine_optimizer:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                              title:
                                type: string
                              description:
                                type: string
                              image_url:
                                type: string
                              image_path:
                                type: string
                              block_crawler:
                                type: boolean
                      share_link:
                        type:
                          - string
                          - 'null'
                      category:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                              title:
                                type: string
                              description:
                                type: string
                              image_url:
                                type: string
                              image_path:
                                type: string
                              position:
                                type: integer
                              public:
                                type: boolean
                      images:
                        type: array
                      options:
                        type: array
                        items:
                          title: Option
                          type: object
                          properties:
                            id:
                              type: integer
                            title:
                              type: string
                            position:
                              type:
                                - integer
                                - 'null'
                              default: 1
                            presentation:
                              type: string
                            external_id:
                              type:
                                - string
                                - 'null'
                            created_at:
                              type: string
                              format: date-time
                            updated_at:
                              type: string
                              format: date-time
                            option_values:
                              type: array
                              items:
                                title: OptionValue
                                type: object
                                properties:
                                  id:
                                    type: integer
                                  title:
                                    type: string
                                  position:
                                    type:
                                      - integer
                                      - 'null'
                                    default: 1
                                  presentation:
                                    type:
                                      - string
                                      - 'null'
                                  created_at:
                                    type: string
                                    format: date-time
                                  updated_at:
                                    type: string
                                    format: date-time
                                required:
                                  - id
                                  - title
                                  - created_at
                                  - updated_at
                          required:
                            - id
                            - title
                            - presentation
                            - created_at
                            - updated_at
                      variants:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            sku:
                              type:
                                - string
                                - 'null'
                            is_master:
                              type: boolean
                            title:
                              type:
                                - string
                                - 'null'
                            image_url:
                              type:
                                - string
                                - 'null'
                            subscription_only:
                              type: boolean
                            shipping_included_in_price:
                              type: boolean
                            images:
                              type: array
                            track_quantity:
                              type: boolean
                            inventory_quantity:
                              type:
                                - 'null'
                                - integer
                            bar_code:
                              type:
                                - string
                                - 'null'
                            limit_subscription:
                              type: boolean
                            subscription_max_qty:
                              type:
                                - 'null'
                                - integer
                            customer_limit:
                              type:
                                - 'null'
                                - integer
                            keep_selling:
                              type: boolean
                            limit_quantity_per_customer:
                              type: boolean
                            option_attrs:
                              type: array
                              items:
                                type: string
                            option_ids:
                              type: array
                              items:
                                type: integer
                            allow_subscription:
                              type: boolean
                              example: true
                            metafields:
                              type: array
                              description: Variant metafields
                            inventory_levels:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                  available:
                                    type: integer
                                  committed:
                                    type: integer
                                  on_hand:
                                    type: integer
                                  unavailable:
                                    type: integer
                                  warehouse:
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        type: string
                                      active:
                                        type: boolean
                                      country_iso:
                                        type: string
                            variant_countries:
                              type: object
                              description: >-
                                Hash of variant countries keyed by country ISO
                                code
                              additionalProperties:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                  country_id:
                                    type: integer
                                  country_name:
                                    type: string
                                  active:
                                    type: boolean
                                  currency_code:
                                    type: string
                                  price:
                                    type: string
                                  subscription_price:
                                    type: string
                                  wholesale:
                                    type: string
                                  wholesale_subscription_price:
                                    type: string
                                  shipping:
                                    type: string
                                  shipping_time:
                                    type:
                                      - string
                                      - 'null'
                                  cost_of_goods_sold:
                                    type: string
                                  compare_price:
                                    type: string
                                  cv:
                                    type: integer
                                  qv:
                                    type: integer
                                  pc_cv:
                                    type:
                                      - integer
                                      - 'null'
                                  pc_qv:
                                    type:
                                      - integer
                                      - 'null'
                                  points:
                                    type: integer
                                  display_price:
                                    type: string
                                  display_subscription_price:
                                    type: string
                                  display_wholesale:
                                    type: string
                                  display_wholesale_subscription_price:
                                    type: string
                                  subscription_plans:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        id:
                                          type: integer
                                        subscription_price_in_currency:
                                          type: string
                                        subscribe_and_save_in_currency:
                                          type: string
                                        subscribe_and_save_for_display:
                                          type: string
                                        wholesale_subscription_price_in_currency:
                                          type: string
                                        wholesale_subscribe_and_save_in_currency:
                                          type: string
                                        wholesale_subscribe_and_save_for_display:
                                          type: string
                                  buyable:
                                    type: boolean
                    required:
                      - id
                      - title
                      - description
                      - image_url
                      - status
                      - price
                      - public
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '400':
          description: shopify integration not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Shopify integration not found
                  errors:
                    type: object
                    description: Hash of field names and error messages
                    example:
                      base:
                        - shopify integration not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: product not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Product not found
                  errors:
                    type: object
                    description: Hash of field names and error messages
                    example:
                      base:
                        - product could not be found with external_id 1233423423
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
  /api/company/v1/products/{product_id}/shop_update:
    patch:
      summary: Update product by shop ID
      tags:
        - Products
      operationId: shopUpdateProduct
      security:
        - bearer_auth: []
      description: >-
        Update a product using external shop ID. Currently, support is limited
        to Shopify Integrations only.
      parameters:
        - name: product_id
          in: path
          required: true
          description: External ID of the product
          schema:
            type: string
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  product:
                    type: object
                    properties:
                      id:
                        type: integer
                      sku:
                        type:
                          - string
                          - 'null'
                      title:
                        type:
                          - string
                          - 'null'
                      description:
                        type:
                          - string
                          - 'null'
                      image_url:
                        type: string
                      status:
                        type: string
                      price:
                        type: string
                      commission:
                        type: string
                      public:
                        type: boolean
                      slug:
                        type: string
                      custom_slug:
                        type: boolean
                      active:
                        type: boolean
                      introduction:
                        type:
                          - string
                          - 'null'
                      feature_text:
                        type:
                          - string
                          - 'null'
                      stripped:
                        type:
                          - string
                          - 'null'
                      review_count:
                        type: integer
                      views:
                        type: integer
                      leads:
                        type: integer
                      show_reviews:
                        type: boolean
                      upc:
                        type:
                          - string
                          - 'null'
                      hs_code:
                        type:
                          - string
                          - 'null'
                      compressed_image_url:
                        type:
                          - string
                          - 'null'
                      image_path:
                        type:
                          - string
                          - 'null'
                      external_url:
                        type:
                          - string
                          - 'null'
                      display_price:
                        type: string
                      subscription_price:
                        type: string
                      tax_inclusive_price:
                        type: string
                      tax_inclusive_wholesale:
                        type: string
                      tax_inclusive_subscription_price:
                        type: string
                      tax_inclusive_wholesale_subscription_price:
                        type: string
                      currency_code:
                        type: string
                      tax_category_id:
                        type: integer
                      tax_category:
                        title: TaxCategory
                        type: object
                        properties:
                          id:
                            type: integer
                          code:
                            example: SV010020
                            type: string
                          title:
                            example: Tangible personal property (tpp)
                            type: string
                        required:
                          - id
                          - code
                          - title
                      international_tax_type:
                        type:
                          - string
                          - 'null'
                      in_stock:
                        type: boolean
                      keep_selling:
                        type: boolean
                      track_quantity:
                        type: boolean
                      no_index:
                        type: boolean
                      publish_to_retail_store:
                        type: boolean
                      publish_to_rep_store:
                        type: boolean
                      publish_to_share_tab:
                        type: boolean
                      affiliate_commission:
                        type:
                          - string
                          - 'null'
                      integration_id:
                        type:
                          - string
                          - 'null'
                      external_id:
                        type:
                          - string
                          - 'null'
                      application_theme_template_id:
                        type:
                          - string
                          - 'null'
                      last_synced_at:
                        type:
                          - string
                          - 'null'
                      updated_at:
                        type:
                          - string
                          - 'null'
                      option_attrs:
                        type: array
                        items:
                          type: string
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      metafields:
                        type: array
                        items:
                          title: LegacyMetafield
                          type: object
                          properties:
                            id:
                              type: integer
                            namespace:
                              description: >-
                                A container for related metafields. Commonly
                                used to group metafields by app or
                                functionality.
                              example: custom
                              type: string
                              maxLength: 20
                              pattern: ^[a-zA-Z0-9_]+$
                            key:
                              description: >-
                                The unique identifier for the metafield within
                                its namespace. Must be unique per namespace and
                                owner.
                              example: material
                              type: string
                              maxLength: 30
                              pattern: ^[a-zA-Z0-9_]+$
                            value:
                              description: >-
                                The actual data stored in the metafield. Type
                                depends on value_type.
                              example: cotton
                              type:
                                - string
                                - object
                            value_type:
                              description: >-
                                The data type that defines how the value should
                                be interpreted and validated.
                              example: single_line_text_field
                              type: string
                            description:
                              description: >-
                                Optional human-readable description explaining
                                the purpose of this metafield.
                              example: The primary material used in this product
                              type:
                                - string
                                - 'null'
                            owner_type:
                              description: >-
                                The type of resource that this metafield belongs
                                to (polymorphic association).
                              example: Product
                              type: string
                            owner_id:
                              description: >-
                                The ID of the specific resource that this
                                metafield belongs to.
                              example: 12345
                              type: integer
                            created_at:
                              description: Timestamp when the metafield was created.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            updated_at:
                              description: Timestamp when the metafield was last updated.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            metafield_definition:
                              title: MetafieldDefinition
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                company_id:
                                  description: >-
                                    The ID of the company that owns this
                                    metafield definition.
                                  example: 1
                                  type: integer
                                namespace:
                                  description: >-
                                    A container for related metafield
                                    definitions. Used to group definitions by
                                    app or functionality. Must be unique within
                                    company and owner_resource.
                                  example: product_details
                                  type: string
                                  maxLength: 20
                                  pattern: ^[a-zA-Z0-9_]+$
                                key:
                                  description: >-
                                    The unique identifier for the metafield
                                    definition within its namespace and
                                    owner_resource. Combined with namespace and
                                    owner_resource, this must be unique per
                                    company.
                                  example: material_type
                                  type: string
                                  maxLength: 30
                                  pattern: ^[a-zA-Z0-9_]+$
                                name:
                                  description: >-
                                    Human-readable display name for the
                                    metafield definition, shown in admin
                                    interfaces and forms.
                                  example: Material Type
                                  type: string
                                  maxLength: 100
                                description:
                                  description: >-
                                    Detailed explanation of what this metafield
                                    definition represents, how it should be
                                    used, and any special instructions for
                                    content creators.
                                  example: >-
                                    Specify the primary material composition of
                                    the product (e.g., cotton, polyester, silk).
                                    This will be displayed on the product detail
                                    page.
                                  type:
                                    - string
                                    - 'null'
                                value_type:
                                  description: >-
                                    The data type that defines how metafield
                                    values should be validated, stored, and
                                    displayed. Determines which validation rules
                                    are available.
                                  example: single_line_text_field
                                  type: string
                                validation_rules:
                                  description: >-
                                    JSON object containing validation
                                    constraints that will be applied to
                                    metafield values. Available rules depend on
                                    the value_type.
                                  example:
                                    choices:
                                      - cotton
                                      - polyester
                                      - silk
                                      - wool
                                      - linen
                                      - bamboo
                                    max: 50
                                    min: 2
                                  type:
                                    - object
                                    - 'null'
                                owner_resource:
                                  description: >-
                                    The type of resource (model class name) that
                                    metafields using this definition can be
                                    attached to. Must match the polymorphic
                                    owner_type.
                                  example: Product
                                  type: string
                                pinned:
                                  description: >-
                                    Whether this definition should be
                                    prominently displayed or prioritized in
                                    admin interfaces and forms.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                position:
                                  default: 0
                                  description: >-
                                    Sort order for displaying this definition
                                    relative to others in the same category and
                                    owner_resource. Lower numbers appear first.
                                  example: 1
                                  type:
                                    - integer
                                    - 'null'
                                locked:
                                  description: >-
                                    Whether this metafield definition is locked,
                                    preventing direct updates or deletions of
                                    metafields using this definition.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                created_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    created.
                                  example: '2024-01-15T10:30:00Z'
                                  type: string
                                  format: date-time
                                updated_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    last updated.
                                  example: '2024-02-20T14:45:00Z'
                                  type: string
                                  format: date-time
                                list_type:
                                  description: >-
                                    Whether this definition is for list-type
                                    metafields that store arrays of values.
                                  example: false
                                  type: boolean
                                reference_type:
                                  description: >-
                                    Whether this definition is for
                                    reference-type metafields that store
                                    references to other resources.
                                  example: false
                                  type: boolean
                                supported_validations:
                                  description: >-
                                    Array of validation rule names that are
                                    supported for this value_type.
                                  example:
                                    - min
                                    - max
                                    - choices
                                    - regex
                                  type: array
                                validation_description:
                                  description: >-
                                    Human-readable description of what the
                                    value_type represents and its constraints.
                                  example: Single line text up to 5000 characters
                                  type: string
                                category_ids:
                                  description: >-
                                    Array of category IDs that this metafield
                                    definition is associated with for
                                    organizational purposes.
                                  example:
                                    - 1
                                    - 2
                                    - 3
                                  items:
                                    type: integer
                                  type: array
                              required:
                                - id
                                - company_id
                                - namespace
                                - key
                                - name
                                - value_type
                                - owner_resource
                                - created_at
                                - updated_at
                                - list_type
                                - reference_type
                                - supported_validations
                                - validation_description
                                - category_ids
                          required:
                            - id
                            - namespace
                            - key
                            - value
                            - value_type
                            - owner_type
                            - owner_id
                            - created_at
                            - updated_at
                      metafields_collection:
                        type: array
                        items:
                          type: object
                          properties:
                            key:
                              type: string
                            value: {}
                      product_subscription_plans:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            active:
                              type: boolean
                            default:
                              type: boolean
                            products_count:
                              type: integer
                            subscribers_count:
                              type: integer
                            subscription_plan:
                              type: object
                              properties:
                                id:
                                  type: integer
                                name:
                                  type: string
                                active:
                                  type: boolean
                                allow_max_billing_cycles:
                                  type: boolean
                                max_billing_cycles:
                                  type:
                                    - integer
                                    - 'null'
                                billing_frequency_in_words:
                                  type: string
                                billing_interval:
                                  type: integer
                                billing_interval_unit:
                                  type: string
                                volume_interval:
                                  type: integer
                                volume_interval_unit:
                                  type: string
                                price_adjustment_amount:
                                  type:
                                    - string
                                    - 'null'
                                price_adjustment_type:
                                  type:
                                    - string
                                    - 'null'
                                subscription_price:
                                  type:
                                    - string
                                    - 'null'
                                wholesale_subscription_price:
                                  type:
                                    - string
                                    - 'null'
                      product_bundles:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                            bundled_variant:
                              type: object
                            quantity:
                              type: integer
                            tax_percentage:
                              type: number
                            display_externally:
                              type: boolean
                              description: >-
                                Whether this bundle item should be displayed to
                                customers
                      track_inventory_on_bundle_items:
                        type: boolean
                        description: Whether to track inventory on bundle items
                      collections:
                        type: array
                      tags:
                        type: array
                      label:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                              title:
                                type: string
                              background:
                                type: string
                              icon:
                                type: string
                              color:
                                type: string
                      display_tag:
                        type:
                          - string
                          - 'null'
                      search_engine_optimizer:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                              title:
                                type: string
                              description:
                                type: string
                              image_url:
                                type: string
                              image_path:
                                type: string
                              block_crawler:
                                type: boolean
                      share_link:
                        type:
                          - string
                          - 'null'
                      category:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                              title:
                                type: string
                              description:
                                type: string
                              image_url:
                                type: string
                              image_path:
                                type: string
                              position:
                                type: integer
                              public:
                                type: boolean
                      images:
                        type: array
                      options:
                        type: array
                        items:
                          title: Option
                          type: object
                          properties:
                            id:
                              type: integer
                            title:
                              type: string
                            position:
                              type:
                                - integer
                                - 'null'
                              default: 1
                            presentation:
                              type: string
                            external_id:
                              type:
                                - string
                                - 'null'
                            created_at:
                              type: string
                              format: date-time
                            updated_at:
                              type: string
                              format: date-time
                            option_values:
                              type: array
                              items:
                                title: OptionValue
                                type: object
                                properties:
                                  id:
                                    type: integer
                                  title:
                                    type: string
                                  position:
                                    type:
                                      - integer
                                      - 'null'
                                    default: 1
                                  presentation:
                                    type:
                                      - string
                                      - 'null'
                                  created_at:
                                    type: string
                                    format: date-time
                                  updated_at:
                                    type: string
                                    format: date-time
                                required:
                                  - id
                                  - title
                                  - created_at
                                  - updated_at
                          required:
                            - id
                            - title
                            - presentation
                            - created_at
                            - updated_at
                      variants:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            sku:
                              type:
                                - string
                                - 'null'
                            is_master:
                              type: boolean
                            title:
                              type:
                                - string
                                - 'null'
                            image_url:
                              type:
                                - string
                                - 'null'
                            subscription_only:
                              type: boolean
                            shipping_included_in_price:
                              type: boolean
                            images:
                              type: array
                            track_quantity:
                              type: boolean
                            inventory_quantity:
                              type:
                                - 'null'
                                - integer
                            bar_code:
                              type:
                                - string
                                - 'null'
                            limit_subscription:
                              type: boolean
                            subscription_max_qty:
                              type:
                                - 'null'
                                - integer
                            customer_limit:
                              type:
                                - 'null'
                                - integer
                            keep_selling:
                              type: boolean
                            limit_quantity_per_customer:
                              type: boolean
                            option_attrs:
                              type: array
                              items:
                                type: string
                            option_ids:
                              type: array
                              items:
                                type: integer
                            allow_subscription:
                              type: boolean
                              example: true
                            metafields:
                              type: array
                              description: Variant metafields
                            inventory_levels:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                  available:
                                    type: integer
                                  committed:
                                    type: integer
                                  on_hand:
                                    type: integer
                                  unavailable:
                                    type: integer
                                  warehouse:
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        type: string
                                      active:
                                        type: boolean
                                      country_iso:
                                        type: string
                            variant_countries:
                              type: object
                              description: >-
                                Hash of variant countries keyed by country ISO
                                code
                              additionalProperties:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                  country_id:
                                    type: integer
                                  country_name:
                                    type: string
                                  active:
                                    type: boolean
                                  currency_code:
                                    type: string
                                  price:
                                    type: string
                                  subscription_price:
                                    type: string
                                  wholesale:
                                    type: string
                                  wholesale_subscription_price:
                                    type: string
                                  shipping:
                                    type: string
                                  shipping_time:
                                    type:
                                      - string
                                      - 'null'
                                  cost_of_goods_sold:
                                    type: string
                                  compare_price:
                                    type: string
                                  cv:
                                    type: integer
                                  qv:
                                    type: integer
                                  pc_cv:
                                    type:
                                      - integer
                                      - 'null'
                                  pc_qv:
                                    type:
                                      - integer
                                      - 'null'
                                  points:
                                    type: integer
                                  display_price:
                                    type: string
                                  display_subscription_price:
                                    type: string
                                  display_wholesale:
                                    type: string
                                  display_wholesale_subscription_price:
                                    type: string
                                  subscription_plans:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        id:
                                          type: integer
                                        subscription_price_in_currency:
                                          type: string
                                        subscribe_and_save_in_currency:
                                          type: string
                                        subscribe_and_save_for_display:
                                          type: string
                                        wholesale_subscription_price_in_currency:
                                          type: string
                                        wholesale_subscribe_and_save_in_currency:
                                          type: string
                                        wholesale_subscribe_and_save_for_display:
                                          type: string
                                  buyable:
                                    type: boolean
                    required:
                      - id
                      - title
                      - description
                      - image_url
                      - status
                      - price
                      - public
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '400':
          description: shopify integration not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      base:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: product not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      base:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '422':
          description: validation failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameters
                  errors:
                    type: object
                    description: Hash of field names and error messages
                    example:
                      product:
                        price:
                          - must be a decimal
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                product:
                  type: object
                  properties:
                    sku:
                      type: string
                      description: Product SKU
                    title:
                      type: string
                      description: Product title
                    image_url:
                      type: string
                      description: URL of the product image
                    price:
                      type:
                        - number
                        - string
                      description: Product price
                    shipping:
                      type:
                        - number
                        - string
                      description: Shipping cost
                    country_code:
                      type: string
                      description: Two-letter ISO country code
                    description:
                      type: string
                      description: Product description
                    status:
                      type: string
                      description: Product status
                      enum:
                        - active
                        - draft
                        - archived
                    commission:
                      type:
                        - number
                        - string
                      description: Commission rate
                    public:
                      type: boolean
                      description: Product visibility
                    metadata:
                      type: object
                      description: Custom metadata key-value pairs
              required:
                - product
  /api/company/v1/products/search_by_external_id:
    get:
      summary: Search products by external ID
      tags:
        - Products
      operationId: searchProductsByExternalId
      security:
        - bearer_auth: []
      description: >-
        Search for products using an external ID. Searches through
        variant_countries, variants, and products in that order.
      parameters:
        - name: external_id
          in: query
          required: true
          description: External ID to search for
          schema:
            type: string
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  products:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        sku:
                          type:
                            - string
                            - 'null'
                        title:
                          type:
                            - string
                            - 'null'
                        description:
                          type:
                            - string
                            - 'null'
                        image_url:
                          type: string
                        status:
                          type: string
                        price:
                          type: string
                        commission:
                          type: string
                        public:
                          type: boolean
                        slug:
                          type: string
                        custom_slug:
                          type: boolean
                        active:
                          type: boolean
                        introduction:
                          type:
                            - string
                            - 'null'
                        feature_text:
                          type:
                            - string
                            - 'null'
                        stripped:
                          type:
                            - string
                            - 'null'
                        review_count:
                          type: integer
                        views:
                          type: integer
                        leads:
                          type: integer
                        show_reviews:
                          type: boolean
                        upc:
                          type:
                            - string
                            - 'null'
                        hs_code:
                          type:
                            - string
                            - 'null'
                        compressed_image_url:
                          type:
                            - string
                            - 'null'
                        image_path:
                          type:
                            - string
                            - 'null'
                        external_url:
                          type:
                            - string
                            - 'null'
                        display_price:
                          type: string
                        subscription_price:
                          type: string
                        tax_inclusive_price:
                          type: string
                        tax_inclusive_wholesale:
                          type: string
                        tax_inclusive_subscription_price:
                          type: string
                        tax_inclusive_wholesale_subscription_price:
                          type: string
                        currency_code:
                          type: string
                        tax_category_id:
                          type: integer
                        tax_category:
                          title: TaxCategory
                          type: object
                          properties:
                            id:
                              type: integer
                            code:
                              example: SV010020
                              type: string
                            title:
                              example: Tangible personal property (tpp)
                              type: string
                          required:
                            - id
                            - code
                            - title
                        international_tax_type:
                          type:
                            - string
                            - 'null'
                        in_stock:
                          type: boolean
                        keep_selling:
                          type: boolean
                        track_quantity:
                          type: boolean
                        no_index:
                          type: boolean
                        publish_to_retail_store:
                          type: boolean
                        publish_to_rep_store:
                          type: boolean
                        publish_to_share_tab:
                          type: boolean
                        affiliate_commission:
                          type:
                            - string
                            - 'null'
                        integration_id:
                          type:
                            - string
                            - 'null'
                        external_id:
                          type:
                            - string
                            - 'null'
                        application_theme_template_id:
                          type:
                            - string
                            - 'null'
                        last_synced_at:
                          type:
                            - string
                            - 'null'
                        updated_at:
                          type:
                            - string
                            - 'null'
                        option_attrs:
                          type: array
                          items:
                            type: string
                        metadata:
                          type: object
                          description: >-
                            A JSON object that can store any custom data
                            structure.
                        metafields:
                          type: array
                          items:
                            title: LegacyMetafield
                            type: object
                            properties:
                              id:
                                type: integer
                              namespace:
                                description: >-
                                  A container for related metafields. Commonly
                                  used to group metafields by app or
                                  functionality.
                                example: custom
                                type: string
                                maxLength: 20
                                pattern: ^[a-zA-Z0-9_]+$
                              key:
                                description: >-
                                  The unique identifier for the metafield within
                                  its namespace. Must be unique per namespace
                                  and owner.
                                example: material
                                type: string
                                maxLength: 30
                                pattern: ^[a-zA-Z0-9_]+$
                              value:
                                description: >-
                                  The actual data stored in the metafield. Type
                                  depends on value_type.
                                example: cotton
                                type:
                                  - string
                                  - object
                              value_type:
                                description: >-
                                  The data type that defines how the value
                                  should be interpreted and validated.
                                example: single_line_text_field
                                type: string
                              description:
                                description: >-
                                  Optional human-readable description explaining
                                  the purpose of this metafield.
                                example: The primary material used in this product
                                type:
                                  - string
                                  - 'null'
                              owner_type:
                                description: >-
                                  The type of resource that this metafield
                                  belongs to (polymorphic association).
                                example: Product
                                type: string
                              owner_id:
                                description: >-
                                  The ID of the specific resource that this
                                  metafield belongs to.
                                example: 12345
                                type: integer
                              created_at:
                                description: Timestamp when the metafield was created.
                                example: '2021-01-01T00:00:00Z'
                                type: string
                                format: date-time
                              updated_at:
                                description: Timestamp when the metafield was last updated.
                                example: '2021-01-01T00:00:00Z'
                                type: string
                                format: date-time
                              metafield_definition:
                                title: MetafieldDefinition
                                type:
                                  - object
                                  - 'null'
                                properties:
                                  id:
                                    type: integer
                                  company_id:
                                    description: >-
                                      The ID of the company that owns this
                                      metafield definition.
                                    example: 1
                                    type: integer
                                  namespace:
                                    description: >-
                                      A container for related metafield
                                      definitions. Used to group definitions by
                                      app or functionality. Must be unique
                                      within company and owner_resource.
                                    example: product_details
                                    type: string
                                    maxLength: 20
                                    pattern: ^[a-zA-Z0-9_]+$
                                  key:
                                    description: >-
                                      The unique identifier for the metafield
                                      definition within its namespace and
                                      owner_resource. Combined with namespace
                                      and owner_resource, this must be unique
                                      per company.
                                    example: material_type
                                    type: string
                                    maxLength: 30
                                    pattern: ^[a-zA-Z0-9_]+$
                                  name:
                                    description: >-
                                      Human-readable display name for the
                                      metafield definition, shown in admin
                                      interfaces and forms.
                                    example: Material Type
                                    type: string
                                    maxLength: 100
                                  description:
                                    description: >-
                                      Detailed explanation of what this
                                      metafield definition represents, how it
                                      should be used, and any special
                                      instructions for content creators.
                                    example: >-
                                      Specify the primary material composition
                                      of the product (e.g., cotton, polyester,
                                      silk). This will be displayed on the
                                      product detail page.
                                    type:
                                      - string
                                      - 'null'
                                  value_type:
                                    description: >-
                                      The data type that defines how metafield
                                      values should be validated, stored, and
                                      displayed. Determines which validation
                                      rules are available.
                                    example: single_line_text_field
                                    type: string
                                  validation_rules:
                                    description: >-
                                      JSON object containing validation
                                      constraints that will be applied to
                                      metafield values. Available rules depend
                                      on the value_type.
                                    example:
                                      choices:
                                        - cotton
                                        - polyester
                                        - silk
                                        - wool
                                        - linen
                                        - bamboo
                                      max: 50
                                      min: 2
                                    type:
                                      - object
                                      - 'null'
                                  owner_resource:
                                    description: >-
                                      The type of resource (model class name)
                                      that metafields using this definition can
                                      be attached to. Must match the polymorphic
                                      owner_type.
                                    example: Product
                                    type: string
                                  pinned:
                                    description: >-
                                      Whether this definition should be
                                      prominently displayed or prioritized in
                                      admin interfaces and forms.
                                    example: false
                                    type:
                                      - boolean
                                      - 'null'
                                    default: false
                                  position:
                                    default: 0
                                    description: >-
                                      Sort order for displaying this definition
                                      relative to others in the same category
                                      and owner_resource. Lower numbers appear
                                      first.
                                    example: 1
                                    type:
                                      - integer
                                      - 'null'
                                  locked:
                                    description: >-
                                      Whether this metafield definition is
                                      locked, preventing direct updates or
                                      deletions of metafields using this
                                      definition.
                                    example: false
                                    type:
                                      - boolean
                                      - 'null'
                                    default: false
                                  created_at:
                                    description: >-
                                      Timestamp when the metafield definition
                                      was created.
                                    example: '2024-01-15T10:30:00Z'
                                    type: string
                                    format: date-time
                                  updated_at:
                                    description: >-
                                      Timestamp when the metafield definition
                                      was last updated.
                                    example: '2024-02-20T14:45:00Z'
                                    type: string
                                    format: date-time
                                  list_type:
                                    description: >-
                                      Whether this definition is for list-type
                                      metafields that store arrays of values.
                                    example: false
                                    type: boolean
                                  reference_type:
                                    description: >-
                                      Whether this definition is for
                                      reference-type metafields that store
                                      references to other resources.
                                    example: false
                                    type: boolean
                                  supported_validations:
                                    description: >-
                                      Array of validation rule names that are
                                      supported for this value_type.
                                    example:
                                      - min
                                      - max
                                      - choices
                                      - regex
                                    type: array
                                  validation_description:
                                    description: >-
                                      Human-readable description of what the
                                      value_type represents and its constraints.
                                    example: Single line text up to 5000 characters
                                    type: string
                                  category_ids:
                                    description: >-
                                      Array of category IDs that this metafield
                                      definition is associated with for
                                      organizational purposes.
                                    example:
                                      - 1
                                      - 2
                                      - 3
                                    items:
                                      type: integer
                                    type: array
                                required:
                                  - id
                                  - company_id
                                  - namespace
                                  - key
                                  - name
                                  - value_type
                                  - owner_resource
                                  - created_at
                                  - updated_at
                                  - list_type
                                  - reference_type
                                  - supported_validations
                                  - validation_description
                                  - category_ids
                            required:
                              - id
                              - namespace
                              - key
                              - value
                              - value_type
                              - owner_type
                              - owner_id
                              - created_at
                              - updated_at
                        metafields_collection:
                          type: array
                          items:
                            type: object
                            properties:
                              key:
                                type: string
                              value: {}
                        product_subscription_plans:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                              active:
                                type: boolean
                              default:
                                type: boolean
                              products_count:
                                type: integer
                              subscribers_count:
                                type: integer
                              subscription_plan:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                  name:
                                    type: string
                                  active:
                                    type: boolean
                                  allow_max_billing_cycles:
                                    type: boolean
                                  max_billing_cycles:
                                    type:
                                      - integer
                                      - 'null'
                                  billing_frequency_in_words:
                                    type: string
                                  billing_interval:
                                    type: integer
                                  billing_interval_unit:
                                    type: string
                                  volume_interval:
                                    type: integer
                                  volume_interval_unit:
                                    type: string
                                  price_adjustment_amount:
                                    type:
                                      - string
                                      - 'null'
                                  price_adjustment_type:
                                    type:
                                      - string
                                      - 'null'
                                  subscription_price:
                                    type:
                                      - string
                                      - 'null'
                                  wholesale_subscription_price:
                                    type:
                                      - string
                                      - 'null'
                        product_bundles:
                          type: array
                          items:
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                              bundled_variant:
                                type: object
                              quantity:
                                type: integer
                              tax_percentage:
                                type: number
                              display_externally:
                                type: boolean
                                description: >-
                                  Whether this bundle item should be displayed
                                  to customers
                        track_inventory_on_bundle_items:
                          type: boolean
                          description: Whether to track inventory on bundle items
                        collections:
                          type: array
                        tags:
                          type: array
                        label:
                          oneOf:
                            - type: 'null'
                            - type: object
                              properties:
                                id:
                                  type: integer
                                title:
                                  type: string
                                background:
                                  type: string
                                icon:
                                  type: string
                                color:
                                  type: string
                        display_tag:
                          type:
                            - string
                            - 'null'
                        search_engine_optimizer:
                          oneOf:
                            - type: 'null'
                            - type: object
                              properties:
                                id:
                                  type: integer
                                title:
                                  type: string
                                description:
                                  type: string
                                image_url:
                                  type: string
                                image_path:
                                  type: string
                                block_crawler:
                                  type: boolean
                        share_link:
                          type:
                            - string
                            - 'null'
                        category:
                          oneOf:
                            - type: 'null'
                            - type: object
                              properties:
                                id:
                                  type: integer
                                title:
                                  type: string
                                description:
                                  type: string
                                image_url:
                                  type: string
                                image_path:
                                  type: string
                                position:
                                  type: integer
                                public:
                                  type: boolean
                        images:
                          type: array
                        options:
                          type: array
                          items:
                            title: Option
                            type: object
                            properties:
                              id:
                                type: integer
                              title:
                                type: string
                              position:
                                type:
                                  - integer
                                  - 'null'
                                default: 1
                              presentation:
                                type: string
                              external_id:
                                type:
                                  - string
                                  - 'null'
                              created_at:
                                type: string
                                format: date-time
                              updated_at:
                                type: string
                                format: date-time
                              option_values:
                                type: array
                                items:
                                  title: OptionValue
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                    title:
                                      type: string
                                    position:
                                      type:
                                        - integer
                                        - 'null'
                                      default: 1
                                    presentation:
                                      type:
                                        - string
                                        - 'null'
                                    created_at:
                                      type: string
                                      format: date-time
                                    updated_at:
                                      type: string
                                      format: date-time
                                  required:
                                    - id
                                    - title
                                    - created_at
                                    - updated_at
                            required:
                              - id
                              - title
                              - presentation
                              - created_at
                              - updated_at
                        variants:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                              sku:
                                type:
                                  - string
                                  - 'null'
                              is_master:
                                type: boolean
                              title:
                                type:
                                  - string
                                  - 'null'
                              image_url:
                                type:
                                  - string
                                  - 'null'
                              subscription_only:
                                type: boolean
                              shipping_included_in_price:
                                type: boolean
                              images:
                                type: array
                              track_quantity:
                                type: boolean
                              inventory_quantity:
                                type:
                                  - 'null'
                                  - integer
                              bar_code:
                                type:
                                  - string
                                  - 'null'
                              limit_subscription:
                                type: boolean
                              subscription_max_qty:
                                type:
                                  - 'null'
                                  - integer
                              customer_limit:
                                type:
                                  - 'null'
                                  - integer
                              keep_selling:
                                type: boolean
                              limit_quantity_per_customer:
                                type: boolean
                              option_attrs:
                                type: array
                                items:
                                  type: string
                              option_ids:
                                type: array
                                items:
                                  type: integer
                              allow_subscription:
                                type: boolean
                                example: true
                              metafields:
                                type: array
                                description: Variant metafields
                              inventory_levels:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                    available:
                                      type: integer
                                    committed:
                                      type: integer
                                    on_hand:
                                      type: integer
                                    unavailable:
                                      type: integer
                                    warehouse:
                                      type: object
                                      properties:
                                        id:
                                          type: integer
                                        name:
                                          type: string
                                        active:
                                          type: boolean
                                        country_iso:
                                          type: string
                              variant_countries:
                                type: object
                                description: >-
                                  Hash of variant countries keyed by country ISO
                                  code
                                additionalProperties:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                    country_id:
                                      type: integer
                                    country_name:
                                      type: string
                                    active:
                                      type: boolean
                                    currency_code:
                                      type: string
                                    price:
                                      type: string
                                    subscription_price:
                                      type: string
                                    wholesale:
                                      type: string
                                    wholesale_subscription_price:
                                      type: string
                                    shipping:
                                      type: string
                                    shipping_time:
                                      type:
                                        - string
                                        - 'null'
                                    cost_of_goods_sold:
                                      type: string
                                    compare_price:
                                      type: string
                                    cv:
                                      type: integer
                                    qv:
                                      type: integer
                                    pc_cv:
                                      type:
                                        - integer
                                        - 'null'
                                    pc_qv:
                                      type:
                                        - integer
                                        - 'null'
                                    points:
                                      type: integer
                                    display_price:
                                      type: string
                                    display_subscription_price:
                                      type: string
                                    display_wholesale:
                                      type: string
                                    display_wholesale_subscription_price:
                                      type: string
                                    subscription_plans:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          id:
                                            type: integer
                                          subscription_price_in_currency:
                                            type: string
                                          subscribe_and_save_in_currency:
                                            type: string
                                          subscribe_and_save_for_display:
                                            type: string
                                          wholesale_subscription_price_in_currency:
                                            type: string
                                          wholesale_subscribe_and_save_in_currency:
                                            type: string
                                          wholesale_subscribe_and_save_for_display:
                                            type: string
                                    buyable:
                                      type: boolean
                      required:
                        - id
                        - title
                        - description
                        - image_url
                        - status
                        - price
                        - public
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '404':
          description: products not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Products not found
                  errors:
                    type: object
                    description: Hash of field names and error messages
                    example:
                      base:
                        - 'Products not found. external_id: nonexistent-id'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
  /api/company/v1/products/{id}/append_metadata:
    patch:
      summary: Append metadata field
      tags:
        - Products
      operationId: productAppendMetadataField
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Product's Id or SKU
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  product:
                    type: object
                    properties:
                      id:
                        type: integer
                      sku:
                        type:
                          - string
                          - 'null'
                      title:
                        type:
                          - string
                          - 'null'
                      description:
                        type:
                          - string
                          - 'null'
                      image_url:
                        type: string
                      status:
                        type: string
                      price:
                        type: string
                      commission:
                        type: string
                      public:
                        type: boolean
                      slug:
                        type: string
                      custom_slug:
                        type: boolean
                      active:
                        type: boolean
                      introduction:
                        type:
                          - string
                          - 'null'
                      feature_text:
                        type:
                          - string
                          - 'null'
                      stripped:
                        type:
                          - string
                          - 'null'
                      review_count:
                        type: integer
                      views:
                        type: integer
                      leads:
                        type: integer
                      show_reviews:
                        type: boolean
                      upc:
                        type:
                          - string
                          - 'null'
                      hs_code:
                        type:
                          - string
                          - 'null'
                      compressed_image_url:
                        type:
                          - string
                          - 'null'
                      image_path:
                        type:
                          - string
                          - 'null'
                      external_url:
                        type:
                          - string
                          - 'null'
                      display_price:
                        type: string
                      subscription_price:
                        type: string
                      tax_inclusive_price:
                        type: string
                      tax_inclusive_wholesale:
                        type: string
                      tax_inclusive_subscription_price:
                        type: string
                      tax_inclusive_wholesale_subscription_price:
                        type: string
                      currency_code:
                        type: string
                      tax_category_id:
                        type: integer
                      tax_category:
                        title: TaxCategory
                        type: object
                        properties:
                          id:
                            type: integer
                          code:
                            example: SV010020
                            type: string
                          title:
                            example: Tangible personal property (tpp)
                            type: string
                        required:
                          - id
                          - code
                          - title
                      international_tax_type:
                        type:
                          - string
                          - 'null'
                      in_stock:
                        type: boolean
                      keep_selling:
                        type: boolean
                      track_quantity:
                        type: boolean
                      no_index:
                        type: boolean
                      publish_to_retail_store:
                        type: boolean
                      publish_to_rep_store:
                        type: boolean
                      publish_to_share_tab:
                        type: boolean
                      affiliate_commission:
                        type:
                          - string
                          - 'null'
                      integration_id:
                        type:
                          - string
                          - 'null'
                      external_id:
                        type:
                          - string
                          - 'null'
                      application_theme_template_id:
                        type:
                          - string
                          - 'null'
                      last_synced_at:
                        type:
                          - string
                          - 'null'
                      updated_at:
                        type:
                          - string
                          - 'null'
                      option_attrs:
                        type: array
                        items:
                          type: string
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      metafields:
                        type: array
                        items:
                          title: LegacyMetafield
                          type: object
                          properties:
                            id:
                              type: integer
                            namespace:
                              description: >-
                                A container for related metafields. Commonly
                                used to group metafields by app or
                                functionality.
                              example: custom
                              type: string
                              maxLength: 20
                              pattern: ^[a-zA-Z0-9_]+$
                            key:
                              description: >-
                                The unique identifier for the metafield within
                                its namespace. Must be unique per namespace and
                                owner.
                              example: material
                              type: string
                              maxLength: 30
                              pattern: ^[a-zA-Z0-9_]+$
                            value:
                              description: >-
                                The actual data stored in the metafield. Type
                                depends on value_type.
                              example: cotton
                              type:
                                - string
                                - object
                            value_type:
                              description: >-
                                The data type that defines how the value should
                                be interpreted and validated.
                              example: single_line_text_field
                              type: string
                            description:
                              description: >-
                                Optional human-readable description explaining
                                the purpose of this metafield.
                              example: The primary material used in this product
                              type:
                                - string
                                - 'null'
                            owner_type:
                              description: >-
                                The type of resource that this metafield belongs
                                to (polymorphic association).
                              example: Product
                              type: string
                            owner_id:
                              description: >-
                                The ID of the specific resource that this
                                metafield belongs to.
                              example: 12345
                              type: integer
                            created_at:
                              description: Timestamp when the metafield was created.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            updated_at:
                              description: Timestamp when the metafield was last updated.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            metafield_definition:
                              title: MetafieldDefinition
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                company_id:
                                  description: >-
                                    The ID of the company that owns this
                                    metafield definition.
                                  example: 1
                                  type: integer
                                namespace:
                                  description: >-
                                    A container for related metafield
                                    definitions. Used to group definitions by
                                    app or functionality. Must be unique within
                                    company and owner_resource.
                                  example: product_details
                                  type: string
                                  maxLength: 20
                                  pattern: ^[a-zA-Z0-9_]+$
                                key:
                                  description: >-
                                    The unique identifier for the metafield
                                    definition within its namespace and
                                    owner_resource. Combined with namespace and
                                    owner_resource, this must be unique per
                                    company.
                                  example: material_type
                                  type: string
                                  maxLength: 30
                                  pattern: ^[a-zA-Z0-9_]+$
                                name:
                                  description: >-
                                    Human-readable display name for the
                                    metafield definition, shown in admin
                                    interfaces and forms.
                                  example: Material Type
                                  type: string
                                  maxLength: 100
                                description:
                                  description: >-
                                    Detailed explanation of what this metafield
                                    definition represents, how it should be
                                    used, and any special instructions for
                                    content creators.
                                  example: >-
                                    Specify the primary material composition of
                                    the product (e.g., cotton, polyester, silk).
                                    This will be displayed on the product detail
                                    page.
                                  type:
                                    - string
                                    - 'null'
                                value_type:
                                  description: >-
                                    The data type that defines how metafield
                                    values should be validated, stored, and
                                    displayed. Determines which validation rules
                                    are available.
                                  example: single_line_text_field
                                  type: string
                                validation_rules:
                                  description: >-
                                    JSON object containing validation
                                    constraints that will be applied to
                                    metafield values. Available rules depend on
                                    the value_type.
                                  example:
                                    choices:
                                      - cotton
                                      - polyester
                                      - silk
                                      - wool
                                      - linen
                                      - bamboo
                                    max: 50
                                    min: 2
                                  type:
                                    - object
                                    - 'null'
                                owner_resource:
                                  description: >-
                                    The type of resource (model class name) that
                                    metafields using this definition can be
                                    attached to. Must match the polymorphic
                                    owner_type.
                                  example: Product
                                  type: string
                                pinned:
                                  description: >-
                                    Whether this definition should be
                                    prominently displayed or prioritized in
                                    admin interfaces and forms.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                position:
                                  default: 0
                                  description: >-
                                    Sort order for displaying this definition
                                    relative to others in the same category and
                                    owner_resource. Lower numbers appear first.
                                  example: 1
                                  type:
                                    - integer
                                    - 'null'
                                locked:
                                  description: >-
                                    Whether this metafield definition is locked,
                                    preventing direct updates or deletions of
                                    metafields using this definition.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                created_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    created.
                                  example: '2024-01-15T10:30:00Z'
                                  type: string
                                  format: date-time
                                updated_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    last updated.
                                  example: '2024-02-20T14:45:00Z'
                                  type: string
                                  format: date-time
                                list_type:
                                  description: >-
                                    Whether this definition is for list-type
                                    metafields that store arrays of values.
                                  example: false
                                  type: boolean
                                reference_type:
                                  description: >-
                                    Whether this definition is for
                                    reference-type metafields that store
                                    references to other resources.
                                  example: false
                                  type: boolean
                                supported_validations:
                                  description: >-
                                    Array of validation rule names that are
                                    supported for this value_type.
                                  example:
                                    - min
                                    - max
                                    - choices
                                    - regex
                                  type: array
                                validation_description:
                                  description: >-
                                    Human-readable description of what the
                                    value_type represents and its constraints.
                                  example: Single line text up to 5000 characters
                                  type: string
                                category_ids:
                                  description: >-
                                    Array of category IDs that this metafield
                                    definition is associated with for
                                    organizational purposes.
                                  example:
                                    - 1
                                    - 2
                                    - 3
                                  items:
                                    type: integer
                                  type: array
                              required:
                                - id
                                - company_id
                                - namespace
                                - key
                                - name
                                - value_type
                                - owner_resource
                                - created_at
                                - updated_at
                                - list_type
                                - reference_type
                                - supported_validations
                                - validation_description
                                - category_ids
                          required:
                            - id
                            - namespace
                            - key
                            - value
                            - value_type
                            - owner_type
                            - owner_id
                            - created_at
                            - updated_at
                      metafields_collection:
                        type: array
                        items:
                          type: object
                          properties:
                            key:
                              type: string
                            value: {}
                      product_subscription_plans:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            active:
                              type: boolean
                            default:
                              type: boolean
                            products_count:
                              type: integer
                            subscribers_count:
                              type: integer
                            subscription_plan:
                              type: object
                              properties:
                                id:
                                  type: integer
                                name:
                                  type: string
                                active:
                                  type: boolean
                                allow_max_billing_cycles:
                                  type: boolean
                                max_billing_cycles:
                                  type:
                                    - integer
                                    - 'null'
                                billing_frequency_in_words:
                                  type: string
                                billing_interval:
                                  type: integer
                                billing_interval_unit:
                                  type: string
                                volume_interval:
                                  type: integer
                                volume_interval_unit:
                                  type: string
                                price_adjustment_amount:
                                  type:
                                    - string
                                    - 'null'
                                price_adjustment_type:
                                  type:
                                    - string
                                    - 'null'
                                subscription_price:
                                  type:
                                    - string
                                    - 'null'
                                wholesale_subscription_price:
                                  type:
                                    - string
                                    - 'null'
                      product_bundles:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                            bundled_variant:
                              type: object
                            quantity:
                              type: integer
                            tax_percentage:
                              type: number
                            display_externally:
                              type: boolean
                              description: >-
                                Whether this bundle item should be displayed to
                                customers
                      track_inventory_on_bundle_items:
                        type: boolean
                        description: Whether to track inventory on bundle items
                      collections:
                        type: array
                      tags:
                        type: array
                      label:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                              title:
                                type: string
                              background:
                                type: string
                              icon:
                                type: string
                              color:
                                type: string
                      display_tag:
                        type:
                          - string
                          - 'null'
                      search_engine_optimizer:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                              title:
                                type: string
                              description:
                                type: string
                              image_url:
                                type: string
                              image_path:
                                type: string
                              block_crawler:
                                type: boolean
                      share_link:
                        type:
                          - string
                          - 'null'
                      category:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                              title:
                                type: string
                              description:
                                type: string
                              image_url:
                                type: string
                              image_path:
                                type: string
                              position:
                                type: integer
                              public:
                                type: boolean
                      images:
                        type: array
                      options:
                        type: array
                        items:
                          title: Option
                          type: object
                          properties:
                            id:
                              type: integer
                            title:
                              type: string
                            position:
                              type:
                                - integer
                                - 'null'
                              default: 1
                            presentation:
                              type: string
                            external_id:
                              type:
                                - string
                                - 'null'
                            created_at:
                              type: string
                              format: date-time
                            updated_at:
                              type: string
                              format: date-time
                            option_values:
                              type: array
                              items:
                                title: OptionValue
                                type: object
                                properties:
                                  id:
                                    type: integer
                                  title:
                                    type: string
                                  position:
                                    type:
                                      - integer
                                      - 'null'
                                    default: 1
                                  presentation:
                                    type:
                                      - string
                                      - 'null'
                                  created_at:
                                    type: string
                                    format: date-time
                                  updated_at:
                                    type: string
                                    format: date-time
                                required:
                                  - id
                                  - title
                                  - created_at
                                  - updated_at
                          required:
                            - id
                            - title
                            - presentation
                            - created_at
                            - updated_at
                      variants:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            sku:
                              type:
                                - string
                                - 'null'
                            is_master:
                              type: boolean
                            title:
                              type:
                                - string
                                - 'null'
                            image_url:
                              type:
                                - string
                                - 'null'
                            subscription_only:
                              type: boolean
                            shipping_included_in_price:
                              type: boolean
                            images:
                              type: array
                            track_quantity:
                              type: boolean
                            inventory_quantity:
                              type:
                                - 'null'
                                - integer
                            bar_code:
                              type:
                                - string
                                - 'null'
                            limit_subscription:
                              type: boolean
                            subscription_max_qty:
                              type:
                                - 'null'
                                - integer
                            customer_limit:
                              type:
                                - 'null'
                                - integer
                            keep_selling:
                              type: boolean
                            limit_quantity_per_customer:
                              type: boolean
                            option_attrs:
                              type: array
                              items:
                                type: string
                            option_ids:
                              type: array
                              items:
                                type: integer
                            allow_subscription:
                              type: boolean
                              example: true
                            metafields:
                              type: array
                              description: Variant metafields
                            inventory_levels:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                  available:
                                    type: integer
                                  committed:
                                    type: integer
                                  on_hand:
                                    type: integer
                                  unavailable:
                                    type: integer
                                  warehouse:
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        type: string
                                      active:
                                        type: boolean
                                      country_iso:
                                        type: string
                            variant_countries:
                              type: object
                              description: >-
                                Hash of variant countries keyed by country ISO
                                code
                              additionalProperties:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                  country_id:
                                    type: integer
                                  country_name:
                                    type: string
                                  active:
                                    type: boolean
                                  currency_code:
                                    type: string
                                  price:
                                    type: string
                                  subscription_price:
                                    type: string
                                  wholesale:
                                    type: string
                                  wholesale_subscription_price:
                                    type: string
                                  shipping:
                                    type: string
                                  shipping_time:
                                    type:
                                      - string
                                      - 'null'
                                  cost_of_goods_sold:
                                    type: string
                                  compare_price:
                                    type: string
                                  cv:
                                    type: integer
                                  qv:
                                    type: integer
                                  pc_cv:
                                    type:
                                      - integer
                                      - 'null'
                                  pc_qv:
                                    type:
                                      - integer
                                      - 'null'
                                  points:
                                    type: integer
                                  display_price:
                                    type: string
                                  display_subscription_price:
                                    type: string
                                  display_wholesale:
                                    type: string
                                  display_wholesale_subscription_price:
                                    type: string
                                  subscription_plans:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        id:
                                          type: integer
                                        subscription_price_in_currency:
                                          type: string
                                        subscribe_and_save_in_currency:
                                          type: string
                                        subscribe_and_save_for_display:
                                          type: string
                                        wholesale_subscription_price_in_currency:
                                          type: string
                                        wholesale_subscribe_and_save_in_currency:
                                          type: string
                                        wholesale_subscribe_and_save_for_display:
                                          type: string
                                  buyable:
                                    type: boolean
                    required:
                      - id
                      - title
                      - description
                      - image_url
                      - status
                      - price
                      - public
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                        example:
                          - Product not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                metada:
                  type: object
                  description: A JSON object that can store any custom data structure.
                  example:
                    brand: CoffeePro
                    warranty_months: 24
                    features:
                      - built-in-grinder
                      - timer
                      - auto-shutoff
              required:
                - metadata
  /api/company/v1/products/{id}/remove_metadata:
    patch:
      summary: Remove metadata fields
      tags:
        - Products
      operationId: productRemoveMetadataFields
      security:
        - bearer_auth: []
      description: Remove specific metadata fields from a product
      parameters:
        - name: id
          in: path
          required: true
          description: Product's Id or slug
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  product:
                    type: object
                    properties:
                      id:
                        type: integer
                      sku:
                        type:
                          - string
                          - 'null'
                      title:
                        type:
                          - string
                          - 'null'
                      description:
                        type:
                          - string
                          - 'null'
                      image_url:
                        type: string
                      status:
                        type: string
                      price:
                        type: string
                      commission:
                        type: string
                      public:
                        type: boolean
                      slug:
                        type: string
                      custom_slug:
                        type: boolean
                      active:
                        type: boolean
                      introduction:
                        type:
                          - string
                          - 'null'
                      feature_text:
                        type:
                          - string
                          - 'null'
                      stripped:
                        type:
                          - string
                          - 'null'
                      review_count:
                        type: integer
                      views:
                        type: integer
                      leads:
                        type: integer
                      show_reviews:
                        type: boolean
                      upc:
                        type:
                          - string
                          - 'null'
                      hs_code:
                        type:
                          - string
                          - 'null'
                      compressed_image_url:
                        type:
                          - string
                          - 'null'
                      image_path:
                        type:
                          - string
                          - 'null'
                      external_url:
                        type:
                          - string
                          - 'null'
                      display_price:
                        type: string
                      subscription_price:
                        type: string
                      tax_inclusive_price:
                        type: string
                      tax_inclusive_wholesale:
                        type: string
                      tax_inclusive_subscription_price:
                        type: string
                      tax_inclusive_wholesale_subscription_price:
                        type: string
                      currency_code:
                        type: string
                      tax_category_id:
                        type: integer
                      tax_category:
                        title: TaxCategory
                        type: object
                        properties:
                          id:
                            type: integer
                          code:
                            example: SV010020
                            type: string
                          title:
                            example: Tangible personal property (tpp)
                            type: string
                        required:
                          - id
                          - code
                          - title
                      international_tax_type:
                        type:
                          - string
                          - 'null'
                      in_stock:
                        type: boolean
                      keep_selling:
                        type: boolean
                      track_quantity:
                        type: boolean
                      no_index:
                        type: boolean
                      publish_to_retail_store:
                        type: boolean
                      publish_to_rep_store:
                        type: boolean
                      publish_to_share_tab:
                        type: boolean
                      affiliate_commission:
                        type:
                          - string
                          - 'null'
                      integration_id:
                        type:
                          - string
                          - 'null'
                      external_id:
                        type:
                          - string
                          - 'null'
                      application_theme_template_id:
                        type:
                          - string
                          - 'null'
                      last_synced_at:
                        type:
                          - string
                          - 'null'
                      updated_at:
                        type:
                          - string
                          - 'null'
                      option_attrs:
                        type: array
                        items:
                          type: string
                      metadata:
                        type: object
                        description: >-
                          A JSON object that can store any custom data
                          structure.
                      metafields:
                        type: array
                        items:
                          title: LegacyMetafield
                          type: object
                          properties:
                            id:
                              type: integer
                            namespace:
                              description: >-
                                A container for related metafields. Commonly
                                used to group metafields by app or
                                functionality.
                              example: custom
                              type: string
                              maxLength: 20
                              pattern: ^[a-zA-Z0-9_]+$
                            key:
                              description: >-
                                The unique identifier for the metafield within
                                its namespace. Must be unique per namespace and
                                owner.
                              example: material
                              type: string
                              maxLength: 30
                              pattern: ^[a-zA-Z0-9_]+$
                            value:
                              description: >-
                                The actual data stored in the metafield. Type
                                depends on value_type.
                              example: cotton
                              type:
                                - string
                                - object
                            value_type:
                              description: >-
                                The data type that defines how the value should
                                be interpreted and validated.
                              example: single_line_text_field
                              type: string
                            description:
                              description: >-
                                Optional human-readable description explaining
                                the purpose of this metafield.
                              example: The primary material used in this product
                              type:
                                - string
                                - 'null'
                            owner_type:
                              description: >-
                                The type of resource that this metafield belongs
                                to (polymorphic association).
                              example: Product
                              type: string
                            owner_id:
                              description: >-
                                The ID of the specific resource that this
                                metafield belongs to.
                              example: 12345
                              type: integer
                            created_at:
                              description: Timestamp when the metafield was created.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            updated_at:
                              description: Timestamp when the metafield was last updated.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            metafield_definition:
                              title: MetafieldDefinition
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                company_id:
                                  description: >-
                                    The ID of the company that owns this
                                    metafield definition.
                                  example: 1
                                  type: integer
                                namespace:
                                  description: >-
                                    A container for related metafield
                                    definitions. Used to group definitions by
                                    app or functionality. Must be unique within
                                    company and owner_resource.
                                  example: product_details
                                  type: string
                                  maxLength: 20
                                  pattern: ^[a-zA-Z0-9_]+$
                                key:
                                  description: >-
                                    The unique identifier for the metafield
                                    definition within its namespace and
                                    owner_resource. Combined with namespace and
                                    owner_resource, this must be unique per
                                    company.
                                  example: material_type
                                  type: string
                                  maxLength: 30
                                  pattern: ^[a-zA-Z0-9_]+$
                                name:
                                  description: >-
                                    Human-readable display name for the
                                    metafield definition, shown in admin
                                    interfaces and forms.
                                  example: Material Type
                                  type: string
                                  maxLength: 100
                                description:
                                  description: >-
                                    Detailed explanation of what this metafield
                                    definition represents, how it should be
                                    used, and any special instructions for
                                    content creators.
                                  example: >-
                                    Specify the primary material composition of
                                    the product (e.g., cotton, polyester, silk).
                                    This will be displayed on the product detail
                                    page.
                                  type:
                                    - string
                                    - 'null'
                                value_type:
                                  description: >-
                                    The data type that defines how metafield
                                    values should be validated, stored, and
                                    displayed. Determines which validation rules
                                    are available.
                                  example: single_line_text_field
                                  type: string
                                validation_rules:
                                  description: >-
                                    JSON object containing validation
                                    constraints that will be applied to
                                    metafield values. Available rules depend on
                                    the value_type.
                                  example:
                                    choices:
                                      - cotton
                                      - polyester
                                      - silk
                                      - wool
                                      - linen
                                      - bamboo
                                    max: 50
                                    min: 2
                                  type:
                                    - object
                                    - 'null'
                                owner_resource:
                                  description: >-
                                    The type of resource (model class name) that
                                    metafields using this definition can be
                                    attached to. Must match the polymorphic
                                    owner_type.
                                  example: Product
                                  type: string
                                pinned:
                                  description: >-
                                    Whether this definition should be
                                    prominently displayed or prioritized in
                                    admin interfaces and forms.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                position:
                                  default: 0
                                  description: >-
                                    Sort order for displaying this definition
                                    relative to others in the same category and
                                    owner_resource. Lower numbers appear first.
                                  example: 1
                                  type:
                                    - integer
                                    - 'null'
                                locked:
                                  description: >-
                                    Whether this metafield definition is locked,
                                    preventing direct updates or deletions of
                                    metafields using this definition.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                created_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    created.
                                  example: '2024-01-15T10:30:00Z'
                                  type: string
                                  format: date-time
                                updated_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    last updated.
                                  example: '2024-02-20T14:45:00Z'
                                  type: string
                                  format: date-time
                                list_type:
                                  description: >-
                                    Whether this definition is for list-type
                                    metafields that store arrays of values.
                                  example: false
                                  type: boolean
                                reference_type:
                                  description: >-
                                    Whether this definition is for
                                    reference-type metafields that store
                                    references to other resources.
                                  example: false
                                  type: boolean
                                supported_validations:
                                  description: >-
                                    Array of validation rule names that are
                                    supported for this value_type.
                                  example:
                                    - min
                                    - max
                                    - choices
                                    - regex
                                  type: array
                                validation_description:
                                  description: >-
                                    Human-readable description of what the
                                    value_type represents and its constraints.
                                  example: Single line text up to 5000 characters
                                  type: string
                                category_ids:
                                  description: >-
                                    Array of category IDs that this metafield
                                    definition is associated with for
                                    organizational purposes.
                                  example:
                                    - 1
                                    - 2
                                    - 3
                                  items:
                                    type: integer
                                  type: array
                              required:
                                - id
                                - company_id
                                - namespace
                                - key
                                - name
                                - value_type
                                - owner_resource
                                - created_at
                                - updated_at
                                - list_type
                                - reference_type
                                - supported_validations
                                - validation_description
                                - category_ids
                          required:
                            - id
                            - namespace
                            - key
                            - value
                            - value_type
                            - owner_type
                            - owner_id
                            - created_at
                            - updated_at
                      metafields_collection:
                        type: array
                        items:
                          type: object
                          properties:
                            key:
                              type: string
                            value: {}
                      product_subscription_plans:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            active:
                              type: boolean
                            default:
                              type: boolean
                            products_count:
                              type: integer
                            subscribers_count:
                              type: integer
                            subscription_plan:
                              type: object
                              properties:
                                id:
                                  type: integer
                                name:
                                  type: string
                                active:
                                  type: boolean
                                allow_max_billing_cycles:
                                  type: boolean
                                max_billing_cycles:
                                  type:
                                    - integer
                                    - 'null'
                                billing_frequency_in_words:
                                  type: string
                                billing_interval:
                                  type: integer
                                billing_interval_unit:
                                  type: string
                                volume_interval:
                                  type: integer
                                volume_interval_unit:
                                  type: string
                                price_adjustment_amount:
                                  type:
                                    - string
                                    - 'null'
                                price_adjustment_type:
                                  type:
                                    - string
                                    - 'null'
                                subscription_price:
                                  type:
                                    - string
                                    - 'null'
                                wholesale_subscription_price:
                                  type:
                                    - string
                                    - 'null'
                      product_bundles:
                        type: array
                        items:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                            bundled_variant:
                              type: object
                            quantity:
                              type: integer
                            tax_percentage:
                              type: number
                            display_externally:
                              type: boolean
                              description: >-
                                Whether this bundle item should be displayed to
                                customers
                      track_inventory_on_bundle_items:
                        type: boolean
                        description: Whether to track inventory on bundle items
                      collections:
                        type: array
                      tags:
                        type: array
                      label:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                              title:
                                type: string
                              background:
                                type: string
                              icon:
                                type: string
                              color:
                                type: string
                      display_tag:
                        type:
                          - string
                          - 'null'
                      search_engine_optimizer:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                              title:
                                type: string
                              description:
                                type: string
                              image_url:
                                type: string
                              image_path:
                                type: string
                              block_crawler:
                                type: boolean
                      share_link:
                        type:
                          - string
                          - 'null'
                      category:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                              title:
                                type: string
                              description:
                                type: string
                              image_url:
                                type: string
                              image_path:
                                type: string
                              position:
                                type: integer
                              public:
                                type: boolean
                      images:
                        type: array
                      options:
                        type: array
                        items:
                          title: Option
                          type: object
                          properties:
                            id:
                              type: integer
                            title:
                              type: string
                            position:
                              type:
                                - integer
                                - 'null'
                              default: 1
                            presentation:
                              type: string
                            external_id:
                              type:
                                - string
                                - 'null'
                            created_at:
                              type: string
                              format: date-time
                            updated_at:
                              type: string
                              format: date-time
                            option_values:
                              type: array
                              items:
                                title: OptionValue
                                type: object
                                properties:
                                  id:
                                    type: integer
                                  title:
                                    type: string
                                  position:
                                    type:
                                      - integer
                                      - 'null'
                                    default: 1
                                  presentation:
                                    type:
                                      - string
                                      - 'null'
                                  created_at:
                                    type: string
                                    format: date-time
                                  updated_at:
                                    type: string
                                    format: date-time
                                required:
                                  - id
                                  - title
                                  - created_at
                                  - updated_at
                          required:
                            - id
                            - title
                            - presentation
                            - created_at
                            - updated_at
                      variants:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                            sku:
                              type:
                                - string
                                - 'null'
                            is_master:
                              type: boolean
                            title:
                              type:
                                - string
                                - 'null'
                            image_url:
                              type:
                                - string
                                - 'null'
                            subscription_only:
                              type: boolean
                            shipping_included_in_price:
                              type: boolean
                            images:
                              type: array
                            track_quantity:
                              type: boolean
                            inventory_quantity:
                              type:
                                - 'null'
                                - integer
                            bar_code:
                              type:
                                - string
                                - 'null'
                            limit_subscription:
                              type: boolean
                            subscription_max_qty:
                              type:
                                - 'null'
                                - integer
                            customer_limit:
                              type:
                                - 'null'
                                - integer
                            keep_selling:
                              type: boolean
                            limit_quantity_per_customer:
                              type: boolean
                            option_attrs:
                              type: array
                              items:
                                type: string
                            option_ids:
                              type: array
                              items:
                                type: integer
                            allow_subscription:
                              type: boolean
                              example: true
                            metafields:
                              type: array
                              description: Variant metafields
                            inventory_levels:
                              type: array
                              items:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                  available:
                                    type: integer
                                  committed:
                                    type: integer
                                  on_hand:
                                    type: integer
                                  unavailable:
                                    type: integer
                                  warehouse:
                                    type: object
                                    properties:
                                      id:
                                        type: integer
                                      name:
                                        type: string
                                      active:
                                        type: boolean
                                      country_iso:
                                        type: string
                            variant_countries:
                              type: object
                              description: >-
                                Hash of variant countries keyed by country ISO
                                code
                              additionalProperties:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                  country_id:
                                    type: integer
                                  country_name:
                                    type: string
                                  active:
                                    type: boolean
                                  currency_code:
                                    type: string
                                  price:
                                    type: string
                                  subscription_price:
                                    type: string
                                  wholesale:
                                    type: string
                                  wholesale_subscription_price:
                                    type: string
                                  shipping:
                                    type: string
                                  shipping_time:
                                    type:
                                      - string
                                      - 'null'
                                  cost_of_goods_sold:
                                    type: string
                                  compare_price:
                                    type: string
                                  cv:
                                    type: integer
                                  qv:
                                    type: integer
                                  pc_cv:
                                    type:
                                      - integer
                                      - 'null'
                                  pc_qv:
                                    type:
                                      - integer
                                      - 'null'
                                  points:
                                    type: integer
                                  display_price:
                                    type: string
                                  display_subscription_price:
                                    type: string
                                  display_wholesale:
                                    type: string
                                  display_wholesale_subscription_price:
                                    type: string
                                  subscription_plans:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        id:
                                          type: integer
                                        subscription_price_in_currency:
                                          type: string
                                        subscribe_and_save_in_currency:
                                          type: string
                                        subscribe_and_save_for_display:
                                          type: string
                                        wholesale_subscription_price_in_currency:
                                          type: string
                                        wholesale_subscribe_and_save_in_currency:
                                          type: string
                                        wholesale_subscribe_and_save_for_display:
                                          type: string
                                  buyable:
                                    type: boolean
                    required:
                      - id
                      - title
                      - description
                      - image_url
                      - status
                      - price
                      - public
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: product not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                product:
                  type: object
                  properties:
                    metadata:
                      type: array
                      items:
                        type: string
                      description: Array of metadata field keys to remove
                      example:
                        - brand
                        - warranty_months
                  required:
                    - metadata
              required:
                - product
  /api/company/v1/products/options:
    get:
      summary: Retrieve product options
      tags:
        - Products
      description: >-
        Returns all available product options with their values for the
        authenticated company
      operationId: getProductOptions
      security:
        - bearer_auth: []
      responses:
        '200':
          description: returns a list of product options available
          content:
            application/json:
              schema:
                type: object
                properties:
                  options:
                    type: array
                    items:
                      title: Option
                      type: object
                      properties:
                        id:
                          type: integer
                        title:
                          type: string
                        position:
                          type:
                            - integer
                            - 'null'
                          default: 1
                        presentation:
                          type: string
                        external_id:
                          type:
                            - string
                            - 'null'
                        created_at:
                          type: string
                          format: date-time
                        updated_at:
                          type: string
                          format: date-time
                        option_values:
                          type: array
                          items:
                            title: OptionValue
                            type: object
                            properties:
                              id:
                                type: integer
                              title:
                                type: string
                              position:
                                type:
                                  - integer
                                  - 'null'
                                default: 1
                              presentation:
                                type:
                                  - string
                                  - 'null'
                              created_at:
                                type: string
                                format: date-time
                              updated_at:
                                type: string
                                format: date-time
                            required:
                              - id
                              - title
                              - created_at
                              - updated_at
                      required:
                        - id
                        - title
                        - presentation
                        - created_at
                        - updated_at
                        - option_values
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - options
                  - meta
  /api/company/v1/products/tax_categories:
    get:
      summary: Get tax categories
      tags:
        - Products
      operationId: getProductTaxCategories
      security:
        - bearer_auth: []
      description: Get the tax categories
      parameters:
        - name: parent_id
          in: query
          required: false
          description: Children of this Category id
          schema:
            type: integer
        - name: search
          in: query
          required: false
          description: Search Keyword
          example: 'Tangible personal property '
          schema:
            type: string
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  tax_categories:
                    type: array
                    items:
                      title: TaxCategory
                      type: object
                      properties:
                        id:
                          type: integer
                        code:
                          example: SV010020
                          type: string
                        title:
                          example: Tangible personal property (tpp)
                          type: string
                        has_children:
                          description: >-
                            Indicates whether the tax category has any
                            sub-categories
                          example: true
                          type: boolean
                        selectable:
                          description: >-
                            Indicates whether the tax category can be
                            selected.          Only categories with tax codes
                            are selectable
                          example: true
                          type: boolean
                        parent_id:
                          description: >-
                            ID of the parent tax category, null for root
                            categories
                          example: 123
                          type:
                            - integer
                            - 'null'
                        parent_title:
                          description: >-
                            Title of the parent tax category, null for root
                            categories
                          example: Parent Category
                          type:
                            - string
                            - 'null'
                      required:
                        - id
                        - code
                        - title
                        - has_children
                        - selectable
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
  /api/company/v1/products/international_tax_types:
    get:
      summary: Get international tax types
      tags:
        - Products
      operationId: getInternationalTaxTypes
      security:
        - bearer_auth: []
      description: Get international tax types
      parameters:
        - name: search
          in: query
          required: false
          description: Search Keyword
          example: pharmaceuticals
          schema:
            type: string
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  international_tax_types:
                    type: array
                    items:
                      type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
  /api/company/v1/products/export_as_csv:
    post:
      summary: Export products as CSV
      tags:
        - Products
      operationId: exportProductsAsCsv
      security:
        - bearer_auth: []
      description: Export products as CSV file
      parameters: []
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                oneOf:
                  - type: object
                    properties:
                      url:
                        type: string
                        description: Download URL for synchronous export
                      meta:
                        type: object
                        properties:
                          request_id:
                            type: string
                            example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                          timestamp:
                            type: string
                            example: '2024-12-10T08:04:10Z'
                    required:
                      - url
                      - meta
                  - type: object
                    properties:
                      job_id:
                        type: string
                        description: Job ID for asynchronous export
                      message:
                        type: string
                        description: Status message for asynchronous export
                      meta:
                        type: object
                        properties:
                          request_id:
                            type: string
                            example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                          timestamp:
                            type: string
                            example: '2024-12-10T08:04:10Z'
                    required:
                      - job_id
                      - message
                      - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                export_scope:
                  type: string
                  enum:
                    - all
                    - selected
                    - current_page
                  description: Scope of products to export
                product_ids:
                  type: array
                  items:
                    type: integer
                  description: >-
                    Array of product IDs (required for selected and current_page
                    scopes)
                export_format:
                  type: string
                  enum:
                    - csv_for_excel
                    - plain
                  description: Export format (defaults to 'plain' if not provided)
                  default: plain
                async:
                  type: boolean
                  description: Whether to process export asynchronously
              required:
                - export_scope
                - async
  /api/v2025-06/products:
    get:
      summary: List products
      tags:
        - Products
      security:
        - bearer_auth: []
      operationId: listProductsv202506
      parameters:
        - name: lang
          in: query
          required: false
          description: >
            Determines language to be used to filter products and display
            translations, if applicable.

            - If not specified, the company's default language is used.

            - This is the 2 letter ISO language code. Examples: 'en', 'es', 'fr'

            - It can be upper case or lower case
          schema:
            type: string
        - name: status[]
          in: query
          description: >-
            Filter by status. Supported values: 'active', 'draft', 'archived'.
            If no filter is sent, returns all products regardless of status.
          required: false
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
        - name: availability[]
          in: query
          description: >-
            Filter by availability. Supported values: 'All', 'in_stock',
            'keep_selling'. If no filter is sent, returns all products
            regardless of availability.
          required: false
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
        - name: bundle
          in: query
          required: false
          description: >-
            Filter by bundle status. true returns only bundle products, false
            returns only non-bundle products. If not specified, returns all
            products.
          schema:
            type: boolean
        - name: country_code[]
          in: query
          description: >-
            Filter by country codes. If no country code is selected it returns
            product in all country
          required: false
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
        - name: category_title
          in: query
          required: false
          description: Filter by category title
          schema:
            type: string
        - name: category_id
          in: query
          required: false
          description: Filter by category ID
          schema:
            type: string
        - name: category_ids[]
          in: query
          description: Filter by category IDs
          required: false
          schema:
            type: array
            items:
              type: integer
          style: form
          explode: true
        - name: collection_ids[]
          in: query
          description: Filter by collection IDs
          required: false
          schema:
            type: array
            items:
              type: integer
          style: form
          explode: true
        - name: order_by[]
          in: query
          description: Sort results by specified field in specified direction.
          required: false
          schema:
            type: array
            items:
              type: string
            minItems: 2
            maxItems: 2
          style: form
          explode: true
        - name: search_query
          in: query
          required: false
          description: Search the products by title, and variant SKU
          schema:
            type: string
        - name: page
          in: query
          schema:
            type: integer
            default: 1
          required: false
          description: Page number for pagination
        - name: per_page
          in: query
          schema:
            type: integer
            default: 10
          required: false
          description: Number of records per page
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  products:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        title:
                          type: string
                        inventory_quantity:
                          type: integer
                        image_url:
                          type: string
                        status:
                          type: string
                        price:
                          type: string
                        updated_at:
                          type: string
                          format: date_time
                          example: '2023-06-01T00:00:00Z'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      pagination:
                        type: object
                        properties:
                          current_page:
                            type: integer
                            example: 1
                          total_pages:
                            type: integer
                            example: 10
                          total_count:
                            type: integer
                            example: 100
                          per_page:
                            type: integer
                            example: 10
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '422':
          description: unprocessable_entity
  /api/company/v1/products/find_by_external_id:
    get:
      tags:
        - Products
      summary: Find Products by External ID
      description: Retrieves product details by searching with an external ID.
      operationId: findProductsByExternalId
      parameters:
        - name: external_id
          in: query
          required: true
          schema:
            type: integer
          description: External identifier of the product to find
      responses:
        '200':
          description: ''
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
      deprecated: false
      security:
        - bearer: []
  /api/prompts:
    get:
      summary: List all prompts for a relateable object
      description: Get a list of prompts for a specific Page, Medium, Product, or Promotion
      tags:
        - Prompts
      operationId: listPrompts
      security:
        - bearer_auth: []
      parameters:
        - name: relateable_type
          in: query
          required: true
          description: >-
            Type of the relateable object. Can be 'Page', 'Medium', 'Product',
            or 'Promotion'.
          schema:
            type: string
            enum:
              - Page
              - Medium
              - Product
              - Promotion
        - name: relateable_id
          in: query
          required: true
          description: ID of the relateable object
          schema:
            type: integer
        - name: page
          in: query
          schema:
            type: integer
            default: 1
          required: false
          description: Page number for pagination
        - name: per_page
          in: query
          schema:
            type: integer
            default: 20
          required: false
          description: Number of records per page
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  prompts:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 1
                          description: Unique identifier for the prompt
                        title:
                          type: string
                          example: Social Media
                          description: Title of the prompt
                        content:
                          type: string
                          example: Check out this product
                          description: Content of the prompt
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                      total_count:
                        type: integer
                        example: 42
                      total_pages:
                        type: integer
                        example: 3
                      current_page:
                        type: integer
                        example: 1
    post:
      summary: Create a prompt
      description: >-
        Create a new prompt associated with a Page, Medium, Product, or
        Promotion
      tags:
        - Prompts
      operationId: createPrompt
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: prompt created
          content:
            application/json:
              schema:
                type: object
                properties:
                  prompt:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                        description: Unique identifier for the prompt
                      title:
                        type: string
                        example: Social Media
                        description: Title of the prompt
                      content:
                        type: string
                        example: Check out this product
                        description: Content of the prompt
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: relateable not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Resource not found
                    description: Human-readable error message
                  errors:
                    type: object
                    example:
                      id:
                        - Resource not found
                    description: Detailed error information by field
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                description: Error response schema
        '422':
          description: prompts not enabled for page
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Resource not found
                    description: Human-readable error message
                  errors:
                    type: object
                    example:
                      id:
                        - Resource not found
                    description: Detailed error information by field
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                description: Error response schema
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                relateable_type:
                  type: string
                  example: Page
                  description: >-
                    Type of entity this prompt is related to. Can be 'Page',
                    'Medium', 'Product', or 'Promotion'
                  enum:
                    - Page
                    - Medium
                    - Product
                    - Promotion
                relateable_id:
                  type: integer
                  example: 1
                  description: ID of the entity this prompt is related to
                prompt:
                  type: object
                  properties:
                    title:
                      type: string
                      example: Social Media
                      description: Title of the prompt
                    content:
                      type: string
                      example: Check out this product
                      description: Content of the prompt
                  required:
                    - title
                    - content
              required:
                - relateable_type
                - relateable_id
                - prompt
        required: true
        description: >-
          Prompt details with relateable info. A prompt must be associated with
          a Page, Medium, Product, or Promotion.
  /api/prompts/{id}:
    patch:
      summary: Update a prompt
      description: Update an existing prompt's title and content
      tags:
        - Prompts
      operationId: updatePrompt
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: ID of the prompt
          schema:
            type: integer
      responses:
        '200':
          description: prompt updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  prompt:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                        description: Unique identifier for the prompt
                      title:
                        type: string
                        example: Social Media
                        description: Title of the prompt
                      content:
                        type: string
                        example: Check out this product
                        description: Content of the prompt
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: prompt not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Resource not found
                    description: Human-readable error message
                  errors:
                    type: object
                    example:
                      id:
                        - Resource not found
                    description: Detailed error information by field
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                description: Error response schema
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                prompt:
                  type: object
                  properties:
                    title:
                      type: string
                    content:
                      type: string
                  required:
                    - title
                    - content
              required:
                - prompt
        required: true
        description: Prompt details to update
    delete:
      summary: Delete a prompt
      description: Delete an existing prompt
      tags:
        - Prompts
      operationId: deletePrompt
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: ID of the prompt
          schema:
            type: integer
      responses:
        '200':
          description: prompt deleted
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                    description: Indicates whether the operation was successful
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: prompt not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Resource not found
                    description: Human-readable error message
                  errors:
                    type: object
                    example:
                      id:
                        - Resource not found
                    description: Detailed error information by field
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                description: Error response schema
  /assets/{asset_path}/{asset_name}:
    get:
      summary: Serve public DAM asset content directly
      tags:
        - Public Assets
      description: >-
        Serves public asset content directly for use in HTML (CSS, JS, images,
        etc). SECURITY: Only serves assets with paths starting with 'public.'.
        Returns content inline for text/data assets, streams from URL for media
        assets. No authentication required.
      operationId: servePublicAsset
      parameters:
        - name: asset_path
          in: path
          required: true
          description: >-
            Ltree path to the asset. Must start with 'public.' (e.g.,
            'public.themes.nova')
          example: public.themes.nova
          schema:
            type: string
        - name: asset_name
          in: path
          required: true
          description: Asset name (e.g., 'main.css')
          example: main.css
          schema:
            type: string
        - name: variant
          in: query
          required: false
          description: >-
            Optional tag filter for variant selection (e.g., 'version-2',
            'en,en-us;latest')
          example: en-us
          schema:
            type: string
      responses:
        '200':
          description: Public data asset with JSON content
        '302':
          description: Public media asset redirects to URL
        '404':
          description: Variant with specified tags not found
  /api/company:
    post:
      summary: Create a company
      tags:
        - Public Companies
      description: >-
        Create a company, user, and user company. Additional information can be
        added in the onboarding_info field.
      operationId: createCompany
      parameters: []
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  company:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1321
                      name:
                        type: string
                        example: Acme, Inc.
                      subdomain:
                        type: string
                        example: acme
                      fluid_shop:
                        type: string
                        example: acme.fluid.app
                  user_company:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1321
                      email:
                        type: string
                        example: john@fluid.app
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2025-01-28T12:00:00Z'
        '422':
          description: validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: unprocessable entity
                  errors:
                    type: object
                    properties:
                      company:
                        type: object
                        properties:
                          subdomain:
                            type: array
                            items:
                              type: string
                              example: is taken
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2025-01-28T12:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                user:
                  type: object
                  properties:
                    first_name:
                      type: string
                      minLength: 1
                    last_name:
                      type: string
                      minLength: 1
                    email:
                      type: string
                      minLength: 1
                  required:
                    - first_name
                    - last_name
                    - email
                company:
                  type: object
                  properties:
                    name:
                      type: string
                      minLength: 1
                    subdomain:
                      type: string
                      minLength: 1
                    domain:
                      type: string
                      minLength: 1
                    color:
                      type: string
                      minLength: 1
                    onboarding_info:
                      type: object
                      not:
                        type: 'null'
                  required:
                    - name
                    - subdomain
              required:
                - user
                - company
  /api/public/drop_zones:
    get:
      summary: >-
        An array of available checkout and order confirmation drop zones
        (public)
      tags:
        - Public Drop Zones
      operationId: indexPublicDropZones
      parameters:
        - name: fluid_shop
          in: query
          required: true
          description: Company subdomain
          schema:
            type: string
        - name: page
          in: query
          required: false
          schema:
            type: integer
        - name: per_page
          in: query
          required: false
          schema:
            type: integer
      responses:
        '200':
          description: returns a list of checkout and order confirmation drop zones
          content:
            application/json:
              schema:
                type: object
                properties:
                  drop_zones:
                    type: array
                    items:
                      title: DropZone
                      type: object
                      properties:
                        uuid:
                          type: string
                        name:
                          type: string
                        active:
                          type:
                            - boolean
                            - 'null'
                          default: false
                        settings:
                          type:
                            - object
                            - 'null'
                          default: '{}'
                        embed_url:
                          type: string
                      required:
                        - uuid
                        - name
                        - embed_url
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      pagination:
                        type: object
                        properties:
                          current_page:
                            type: integer
                            example: 1
                          total_pages:
                            type: integer
                            example: 10
                          total_count:
                            type: integer
                            example: 100
                          per_page:
                            type: integer
                            example: 10
                required:
                  - drop_zones
                  - meta
        '404':
          description: company not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: array
                    items:
                      type: string
                  meta:
                    type: object
                required:
                  - error_message
                  - errors
                  - meta
  /api/v202506/ranks:
    get:
      summary: Lists all ranks for the current company
      tags:
        - Ranks
      operationId: listRanks
      security:
        - bearer_auth: []
      responses:
        '200':
          description: successfully returns list of ranks
          content:
            application/json:
              schema:
                type: object
                properties:
                  ranks:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        name:
                          type: string
                        external_id:
                          type: string
                        created_at:
                          type: string
                        updated_at:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
        '401':
          description: unauthorized
    post:
      summary: Creates a rank for a company
      tags:
        - Ranks
      operationId: createRank
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: successfully creates the rank
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  name:
                    type: string
                  external_id:
                    type:
                      - string
                      - 'null'
                  created_at:
                    type: string
                    format: date-time
                  updated_at:
                    type: string
                    format: date-time
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - id
                  - name
                  - created_at
                  - updated_at
                  - meta
        '400':
          description: rank with external_id already exists
        '401':
          description: unauthorized
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                external_id:
                  type: string
                name:
                  type: string
              required:
                - external_id
                - name
  /api/v202506/ranks/{id}:
    patch:
      summary: Updates a rank
      tags:
        - Ranks
      operationId: updateRank
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: updates rank with new external_id and name
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  name:
                    type: string
                  external_id:
                    type:
                      - string
                      - 'null'
                  created_at:
                    type: string
                    format: date-time
                  updated_at:
                    type: string
                    format: date-time
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - id
                  - name
                  - created_at
                  - updated_at
                  - meta
        '401':
          description: unauthorized
        '404':
          description: rank not found
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                external_id:
                  type: string
                name:
                  type: string
              required:
                - external_id
                - name
  /api/company/recipients/{recipientId}:
    get:
      tags:
        - Recipients
      summary: Get Company Recipient Details
      description: Retrieves recipient's information for a specific company recipient.
      operationId: getCompanyRecipient
      parameters:
        - name: recipientId
          in: path
          required: true
          schema:
            type: string
          description: The unique identifier of the company recipient
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/show4'
                  - example:
                      id: 3470
                      external_id: null
                      username: null
                      active: true
                      affiliate: {}
                      user:
                        email: pralishkayastha@gmail.com
                        first_name: Yucatán
                        last_name: résumé
                        avatar: null
                        phone: null
                        google_id: null
                        bio: null
                        facebook: null
                        instagram: null
                        twitter: null
                        linkedin: null
                        whatsapp: null
                        wechat: null
                        youtube: null
                        zip_code: null
                        dob: null
                        gender: null
                        time_zone: null
                        language:
                          name: English
                          iso: en
                        country:
                          name: United States
                          iso: US
              example:
                id: 3470
                external_id: null
                username: null
                active: true
                affiliate: {}
                user:
                  email: pralishkayastha@gmail.com
                  first_name: Yucatán
                  last_name: résumé
                  avatar: null
                  phone: null
                  google_id: null
                  bio: null
                  facebook: null
                  instagram: null
                  twitter: null
                  linkedin: null
                  whatsapp: null
                  wechat: null
                  youtube: null
                  zip_code: null
                  dob: null
                  gender: null
                  time_zone: null
                  language:
                    name: English
                    iso: en
                  country:
                    name: United States
                    iso: US
      deprecated: false
      security:
        - bearer: []
  /api/company/messaging/recipients/search.json:
    get:
      tags:
        - Recipients
      summary: Search Recipients
      description: Search for recipients using a search query
      operationId: searchRecipients
      parameters:
        - name: filters[search_query]
          in: query
          required: true
          schema:
            type: string
          description: The search query to filter recipients
        - name: filters[sort_by]
          in: query
          required: false
          schema:
            type: string
            default: first_name
          description: Field to sort results by
        - name: kind
          in: query
          required: false
          schema:
            type: string
            enum:
              - sms
              - email
          description: >-
            Filter by recipient type - sms for SMS enabled recipients, email for
            email enabled recipients
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/search'
                description: ''
                example:
                  - pagination:
                      current: 1
                      previous: null
                      next: 2
                      per_page: 20
                      pages: 3
                      count: 60
                  - items:
                      - id: 12
                        first_name: Ada
                        last_name: Stracke
                        avatar_url: null
                        image_url: null
                        receivable_id: 12
                        receivable_type: UserCompany
                        discarded_at: null
                        left_conversation_at: null
                        blocked: null
                        status: offline
                        last_online: null
                        country_name: null
                      - id: 45
                        first_name: Agripina
                        last_name: Gutkowski
                        avatar_url: null
                        image_url: null
                        receivable_id: 45
                        receivable_type: UserCompany
                        discarded_at: null
                        left_conversation_at: null
                        blocked: null
                        status: offline
                        last_online: null
                        country_name: null
                      - id: 39
                        first_name: Alfonzo
                        last_name: Rosenbaum
                        avatar_url: null
                        image_url: null
                        receivable_id: 39
                        receivable_type: UserCompany
                        discarded_at: null
                        left_conversation_at: null
                        blocked: null
                        status: offline
                        last_online: null
                        country_name: null
                      - id: 14
                        first_name: Bart
                        last_name: Macejkovic
                        avatar_url: null
                        image_url: null
                        receivable_id: 14
                        receivable_type: UserCompany
                        discarded_at: null
                        left_conversation_at: null
                        blocked: null
                        status: offline
                        last_online: null
                        country_name: null
                      - id: 3
                        first_name: Berry
                        last_name: Schaefer
                        avatar_url: null
                        image_url: null
                        receivable_id: 3
                        receivable_type: UserCompany
                        discarded_at: null
                        left_conversation_at: null
                        blocked: null
                        status: offline
                        last_online: null
                        country_name: null
                      - id: 25
                        first_name: Bessie
                        last_name: Howell
                        avatar_url: null
                        image_url: null
                        receivable_id: 25
                        receivable_type: UserCompany
                        discarded_at: null
                        left_conversation_at: null
                        blocked: null
                        status: offline
                        last_online: null
                        country_name: null
                      - id: 26
                        first_name: Bobbi
                        last_name: Bosco
                        avatar_url: null
                        image_url: null
                        receivable_id: 26
                        receivable_type: UserCompany
                        discarded_at: null
                        left_conversation_at: null
                        blocked: null
                        status: offline
                        last_online: null
                        country_name: null
                      - id: 34
                        first_name: Britta
                        last_name: Padberg
                        avatar_url: null
                        image_url: null
                        receivable_id: 34
                        receivable_type: UserCompany
                        discarded_at: null
                        left_conversation_at: null
                        blocked: null
                        status: online
                        last_online: '2024-08-19T15:02:44.873Z'
                        country_name: null
                      - id: 8
                        first_name: Carlo
                        last_name: Jacobi
                        avatar_url: null
                        image_url: null
                        receivable_id: 8
                        receivable_type: UserCompany
                        discarded_at: null
                        left_conversation_at: null
                        blocked: null
                        status: offline
                        last_online: null
                        country_name: null
                      - id: 19
                        first_name: Carolin
                        last_name: Reichert
                        avatar_url: null
                        image_url: null
                        receivable_id: 19
                        receivable_type: UserCompany
                        discarded_at: null
                        left_conversation_at: null
                        blocked: null
                        status: offline
                        last_online: null
                        country_name: null
                      - id: 21
                        first_name: Cathryn
                        last_name: Adams
                        avatar_url: null
                        image_url: null
                        receivable_id: 21
                        receivable_type: UserCompany
                        discarded_at: null
                        left_conversation_at: null
                        blocked: null
                        status: offline
                        last_online: null
                        country_name: null
                      - id: 47
                        first_name: China
                        last_name: Jacobson
                        avatar_url: null
                        image_url: null
                        receivable_id: 47
                        receivable_type: UserCompany
                        discarded_at: null
                        left_conversation_at: null
                        blocked: null
                        status: offline
                        last_online: null
                        country_name: null
                      - id: 15
                        first_name: Ching
                        last_name: Lueilwitz
                        avatar_url: null
                        image_url: null
                        receivable_id: 15
                        receivable_type: UserCompany
                        discarded_at: null
                        left_conversation_at: null
                        blocked: null
                        status: offline
                        last_online: null
                        country_name: null
                      - id: 30
                        first_name: Chong
                        last_name: Jacobson
                        avatar_url: null
                        image_url: null
                        receivable_id: 30
                        receivable_type: UserCompany
                        discarded_at: null
                        left_conversation_at: null
                        blocked: null
                        status: offline
                        last_online: null
                        country_name: null
                      - id: 54
                        first_name: Contessa
                        last_name: Raynor
                        avatar_url: null
                        image_url: null
                        receivable_id: 54
                        receivable_type: UserCompany
                        discarded_at: null
                        left_conversation_at: null
                        blocked: null
                        status: offline
                        last_online: null
                        country_name: null
                      - id: 33
                        first_name: Dallas
                        last_name: Hahn
                        avatar_url: null
                        image_url: null
                        receivable_id: 33
                        receivable_type: UserCompany
                        discarded_at: null
                        left_conversation_at: null
                        blocked: null
                        status: offline
                        last_online: null
                        country_name: null
                      - id: 24
                        first_name: Damian
                        last_name: Stiedemann
                        avatar_url: null
                        image_url: null
                        receivable_id: 24
                        receivable_type: UserCompany
                        discarded_at: null
                        left_conversation_at: null
                        blocked: null
                        status: offline
                        last_online: null
                        country_name: null
                      - id: 35
                        first_name: Deb
                        last_name: Ankunding
                        avatar_url: null
                        image_url: null
                        receivable_id: 35
                        receivable_type: UserCompany
                        discarded_at: null
                        left_conversation_at: null
                        blocked: null
                        status: offline
                        last_online: null
                        country_name: null
                      - id: 4
                        first_name: Debbra
                        last_name: Parker
                        avatar_url: null
                        image_url: null
                        receivable_id: 4
                        receivable_type: UserCompany
                        discarded_at: null
                        left_conversation_at: null
                        blocked: null
                        status: offline
                        last_online: null
                        country_name: null
                      - id: 28
                        first_name: Delena
                        last_name: Ullrich
                        avatar_url: null
                        image_url: null
                        receivable_id: 28
                        receivable_type: UserCompany
                        discarded_at: null
                        left_conversation_at: null
                        blocked: null
                        status: offline
                        last_online: null
                        country_name: null
              example:
                - pagination:
                    current: 1
                    previous: null
                    next: 2
                    per_page: 20
                    pages: 3
                    count: 60
                - items:
                    - id: 12
                      first_name: Ada
                      last_name: Stracke
                      avatar_url: null
                      image_url: null
                      receivable_id: 12
                      receivable_type: UserCompany
                      discarded_at: null
                      left_conversation_at: null
                      blocked: null
                      status: offline
                      last_online: null
                      country_name: null
                    - id: 45
                      first_name: Agripina
                      last_name: Gutkowski
                      avatar_url: null
                      image_url: null
                      receivable_id: 45
                      receivable_type: UserCompany
                      discarded_at: null
                      left_conversation_at: null
                      blocked: null
                      status: offline
                      last_online: null
                      country_name: null
                    - id: 39
                      first_name: Alfonzo
                      last_name: Rosenbaum
                      avatar_url: null
                      image_url: null
                      receivable_id: 39
                      receivable_type: UserCompany
                      discarded_at: null
                      left_conversation_at: null
                      blocked: null
                      status: offline
                      last_online: null
                      country_name: null
                    - id: 14
                      first_name: Bart
                      last_name: Macejkovic
                      avatar_url: null
                      image_url: null
                      receivable_id: 14
                      receivable_type: UserCompany
                      discarded_at: null
                      left_conversation_at: null
                      blocked: null
                      status: offline
                      last_online: null
                      country_name: null
                    - id: 3
                      first_name: Berry
                      last_name: Schaefer
                      avatar_url: null
                      image_url: null
                      receivable_id: 3
                      receivable_type: UserCompany
                      discarded_at: null
                      left_conversation_at: null
                      blocked: null
                      status: offline
                      last_online: null
                      country_name: null
                    - id: 25
                      first_name: Bessie
                      last_name: Howell
                      avatar_url: null
                      image_url: null
                      receivable_id: 25
                      receivable_type: UserCompany
                      discarded_at: null
                      left_conversation_at: null
                      blocked: null
                      status: offline
                      last_online: null
                      country_name: null
                    - id: 26
                      first_name: Bobbi
                      last_name: Bosco
                      avatar_url: null
                      image_url: null
                      receivable_id: 26
                      receivable_type: UserCompany
                      discarded_at: null
                      left_conversation_at: null
                      blocked: null
                      status: offline
                      last_online: null
                      country_name: null
                    - id: 34
                      first_name: Britta
                      last_name: Padberg
                      avatar_url: null
                      image_url: null
                      receivable_id: 34
                      receivable_type: UserCompany
                      discarded_at: null
                      left_conversation_at: null
                      blocked: null
                      status: online
                      last_online: '2024-08-19T15:02:44.873Z'
                      country_name: null
                    - id: 8
                      first_name: Carlo
                      last_name: Jacobi
                      avatar_url: null
                      image_url: null
                      receivable_id: 8
                      receivable_type: UserCompany
                      discarded_at: null
                      left_conversation_at: null
                      blocked: null
                      status: offline
                      last_online: null
                      country_name: null
                    - id: 19
                      first_name: Carolin
                      last_name: Reichert
                      avatar_url: null
                      image_url: null
                      receivable_id: 19
                      receivable_type: UserCompany
                      discarded_at: null
                      left_conversation_at: null
                      blocked: null
                      status: offline
                      last_online: null
                      country_name: null
                    - id: 21
                      first_name: Cathryn
                      last_name: Adams
                      avatar_url: null
                      image_url: null
                      receivable_id: 21
                      receivable_type: UserCompany
                      discarded_at: null
                      left_conversation_at: null
                      blocked: null
                      status: offline
                      last_online: null
                      country_name: null
                    - id: 47
                      first_name: China
                      last_name: Jacobson
                      avatar_url: null
                      image_url: null
                      receivable_id: 47
                      receivable_type: UserCompany
                      discarded_at: null
                      left_conversation_at: null
                      blocked: null
                      status: offline
                      last_online: null
                      country_name: null
                    - id: 15
                      first_name: Ching
                      last_name: Lueilwitz
                      avatar_url: null
                      image_url: null
                      receivable_id: 15
                      receivable_type: UserCompany
                      discarded_at: null
                      left_conversation_at: null
                      blocked: null
                      status: offline
                      last_online: null
                      country_name: null
                    - id: 30
                      first_name: Chong
                      last_name: Jacobson
                      avatar_url: null
                      image_url: null
                      receivable_id: 30
                      receivable_type: UserCompany
                      discarded_at: null
                      left_conversation_at: null
                      blocked: null
                      status: offline
                      last_online: null
                      country_name: null
                    - id: 54
                      first_name: Contessa
                      last_name: Raynor
                      avatar_url: null
                      image_url: null
                      receivable_id: 54
                      receivable_type: UserCompany
                      discarded_at: null
                      left_conversation_at: null
                      blocked: null
                      status: offline
                      last_online: null
                      country_name: null
                    - id: 33
                      first_name: Dallas
                      last_name: Hahn
                      avatar_url: null
                      image_url: null
                      receivable_id: 33
                      receivable_type: UserCompany
                      discarded_at: null
                      left_conversation_at: null
                      blocked: null
                      status: offline
                      last_online: null
                      country_name: null
                    - id: 24
                      first_name: Damian
                      last_name: Stiedemann
                      avatar_url: null
                      image_url: null
                      receivable_id: 24
                      receivable_type: UserCompany
                      discarded_at: null
                      left_conversation_at: null
                      blocked: null
                      status: offline
                      last_online: null
                      country_name: null
                    - id: 35
                      first_name: Deb
                      last_name: Ankunding
                      avatar_url: null
                      image_url: null
                      receivable_id: 35
                      receivable_type: UserCompany
                      discarded_at: null
                      left_conversation_at: null
                      blocked: null
                      status: offline
                      last_online: null
                      country_name: null
                    - id: 4
                      first_name: Debbra
                      last_name: Parker
                      avatar_url: null
                      image_url: null
                      receivable_id: 4
                      receivable_type: UserCompany
                      discarded_at: null
                      left_conversation_at: null
                      blocked: null
                      status: offline
                      last_online: null
                      country_name: null
                    - id: 28
                      first_name: Delena
                      last_name: Ullrich
                      avatar_url: null
                      image_url: null
                      receivable_id: 28
                      receivable_type: UserCompany
                      discarded_at: null
                      left_conversation_at: null
                      blocked: null
                      status: offline
                      last_online: null
                      country_name: null
      deprecated: false
  /api/v2.0/messaging/conversations/8/recipients.json:
    get:
      tags:
        - Recipients
      summary: Search Recipients in Conversation
      description: >-
        Search for recipients within a specific conversation using a search
        query.
      operationId: searchConversationRecipients
      parameters:
        - name: filters[search_query]
          in: query
          required: true
          schema:
            type: string
          description: The search query to filter recipients
        - name: filters[sort_by]
          in: query
          required: false
          schema:
            type: string
            default: first_name
          description: Field to sort the recipients by
        - name: kind
          in: query
          required: false
          schema:
            type: string
            enum:
              - sms
              - email
          description: Filter recipients by communication type (sms or email enabled)
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Index13'
                description: ''
                example:
                  - pagination:
                      current: 1
                      previous: null
                      next: null
                      per_page: 20
                      pages: 1
                      count: 2
                  - items:
                      - id: 12
                        first_name: Ada
                        last_name: Stracke
                        avatar_url: null
                        image_url: null
                        receivable_id: 12
                        receivable_type: UserCompany
                        discarded_at: null
                        left_conversation_at: null
                        blocked: null
                        status: offline
                        last_online: null
                        country_name: null
                      - id: 1
                        first_name: John
                        last_name: Admin
                        avatar_url: null
                        image_url: null
                        receivable_id: 1
                        receivable_type: UserCompany
                        discarded_at: null
                        left_conversation_at: null
                        blocked: null
                        status: offline
                        last_online: '2024-08-19T17:06:25.243Z'
                        country_name: United States
              example:
                - pagination:
                    current: 1
                    previous: null
                    next: null
                    per_page: 20
                    pages: 1
                    count: 2
                - items:
                    - id: 12
                      first_name: Ada
                      last_name: Stracke
                      avatar_url: null
                      image_url: null
                      receivable_id: 12
                      receivable_type: UserCompany
                      discarded_at: null
                      left_conversation_at: null
                      blocked: null
                      status: offline
                      last_online: null
                      country_name: null
                    - id: 1
                      first_name: John
                      last_name: Admin
                      avatar_url: null
                      image_url: null
                      receivable_id: 1
                      receivable_type: UserCompany
                      discarded_at: null
                      left_conversation_at: null
                      blocked: null
                      status: offline
                      last_online: '2024-08-19T17:06:25.243Z'
                      country_name: United States
      deprecated: false
  /api/redirects:
    get:
      summary: Lists redirects
      tags:
        - Redirects
      operationId: listRedirects
      security:
        - bearer_auth: []
      parameters:
        - name: search_query
          in: query
          required: false
          description: Search by (`path` or `target`)
          schema:
            type: string
        - name: sorted_by
          in: query
          required: false
          description: >-
            Sort by field (`created_at_desc`, `updated_at_desc`, `path_asc`,
            `target_desc`, etc.)
          schema:
            type: string
        - name: page
          in: query
          schema:
            type: integer
            default: 1
          required: false
          description: Page number for pagination
        - name: per_page
          in: query
          schema:
            type: integer
            default: 10
          required: false
          description: Number of records per page
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  redirects:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 101
                        path:
                          type: string
                          example: /old-path-1
                        target:
                          type: string
                          example: https://example.com/new-1
                        domain:
                          oneOf:
                            - type: 'null'
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 201
                                hostname:
                                  type: string
                                  example: http://fluid.lvh.me
                                verification_status:
                                  type: string
                                  example: unknown
                                created_at:
                                  type: string
                                  example: '2024-04-20T12:34:56.000Z'
                                updated_at:
                                  type: string
                                  example: '2024-08-20T12:34:56.000Z'
                        created_at:
                          type: string
                          example: '2024-04-20T12:34:56.000Z'
                        updated_at:
                          type: string
                          example: '2024-08-20T12:34:56.000Z'
                  meta:
                    type: object
                    properties:
                      total_count:
                        type: integer
                        example: 20
                      total_pages:
                        type: integer
                        example: 2
                      current_page:
                        type: integer
                        example: 1
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
    post:
      summary: Create Redirect
      description: Create a new redirect
      tags:
        - Redirects
      operationId: createRedirect
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  redirect:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 101
                      path:
                        type: string
                        example: /old-path
                      target:
                        type: string
                        example: https://example.com/new-path
                      domain:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              name:
                                type: string
                                example: example.com
                      created_at:
                        type: string
                        example: '2024-04-20T12:34:56.000Z'
                      updated_at:
                        type: string
                        example: '2024-08-20T12:34:56.000Z'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameters
                  errors:
                    type: object
                    properties:
                      redirect:
                        type: object
                        properties:
                          path:
                            type: array
                            items:
                              type: string
                            example:
                              - must be filled
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                redirect:
                  type: object
                  properties:
                    path:
                      type: string
                      example: /old-path
                    target:
                      type: string
                      example: /home/new-path
                    domain_id:
                      oneOf:
                        - type: 'null'
                        - type: integer
                          example: 1
                      description: >-
                        The ID of the associated domain, or null to remove the
                        association
              required:
                - path
                - target
  /api/redirects/{id}:
    get:
      summary: Retrieves a redirect
      tags:
        - Redirects
      operationId: getRedirect
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  redirect:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 101
                      path:
                        type: string
                        example: /old-path
                      target:
                        type: string
                        example: https://example.com/new-path
                      domain:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              name:
                                type: string
                                example: example.com
                      created_at:
                        type: string
                        example: '2024-04-20T12:34:56.000Z'
                      updated_at:
                        type: string
                        example: '2024-08-20T12:34:56.000Z'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                        example:
                          - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
    put:
      summary: Updates a redirect
      tags:
        - Redirects
      operationId: updateRedirect
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  redirect:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 101
                      path:
                        type: string
                        example: /updated-path
                      target:
                        type: string
                        example: https://example.com/updated
                      domain:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 201
                              hostname:
                                type: string
                                example: http://fluid.lvh.me
                              verification_status:
                                type: string
                                example: unknown
                              created_at:
                                type: string
                                example: '2024-04-20T12:34:56.000Z'
                              updated_at:
                                type: string
                                example: '2024-08-20T12:34:56.000Z'
                      created_at:
                        type: string
                        example: '2024-04-20T12:34:56.000Z'
                      updated_at:
                        type: string
                        example: '2024-08-20T12:34:56.000Z'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Redirect not found
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                        example:
                          - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: unprocessable entity
                  errors:
                    type: object
                    properties:
                      redirect:
                        type: object
                        properties:
                          target:
                            type: array
                            items:
                              type: string
                            example:
                              - Target can't be blank
                              - >-
                                Target must be either a path starting with / or
                                a valid http(s) URL
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                redirect:
                  type: object
                  properties:
                    path:
                      type: string
                      example: /updated-path
                    target:
                      type: string
                      example: https://example.com/updated-path
                    domain_id:
                      oneOf:
                        - type: 'null'
                        - type: integer
                          example: 1
                      description: >-
                        The ID of the associated domain, or null to remove the
                        association
    delete:
      summary: Deletes a redirect
      tags:
        - Redirects
      operationId: deleteRedirect
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  redirect:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: '101'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Redirect not found
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                        example:
                          - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
  /api/redirects/presigned_csv_url:
    post:
      summary: Generate a signed URL to upload csv for bulk importing redirects
      description: >-
        Generate signed URL to allow users without credentials to perform upload
        (time-limited access to Cloud Storage)
      tags:
        - Redirects
      operationId: getPresignedCsvUrlForRedirectsImport
      security:
        - bearer_auth: []
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  url:
                    type: string
                    example: https://path/to/file/sth.csv
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                required:
                  - url
        '400':
          description: error
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: fail
                  data:
                    type: object
                    properties:
                      error:
                        type: string
                required:
                  - status
  /api/redirects/import_csv:
    post:
      summary: Import redirects via csv file in the url
      tags:
        - Redirects
      operationId: importRedirectsViaCSV
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  created:
                    type: integer
                    example: 10
                  failed:
                    type: integer
                    example: 2
                  invalid_rows:
                    type: integer
                    example: 1
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                required:
                  - created
                  - failed
                  - invalid_rows
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: unprocessable_entity
                  errors:
                    type: object
                    properties:
                      import:
                        type: string
                        example: Bad Request
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  example: https://example.com/path/to/csv
              required:
                - url
  /api/redirects/export_csv:
    post:
      summary: Export redirects data in a CSV file
      description: Export redirects data in a CSV file
      tags:
        - Redirects
      operationId: exportRedirectsinCSV
      security:
        - bearer_auth: []
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  url:
                    type: string
                    example: https://fake-url.com/file.csv
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                required:
                  - url
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: unprocessable_entity
                  errors:
                    type: object
                    properties:
                      export:
                        type: string
                        example: Bad Request
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                required:
                  - error_message
                  - errors
                  - meta
  /api/refunds:
    post:
      summary: >-
        Create refund with restock_all_items accounting for existing partial
        refunds
      tags:
        - Refunds
      operationId: createRefundWithRestockAllItemsPartialRefunds
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: Refund created with restock_all_items accounting for partial refunds
          content:
            application/json:
              schema:
                type: object
                properties:
                  refund:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 100
                      order_id:
                        type: integer
                        example: 1111
                      amount:
                        type:
                          - number
                          - string
                        example: 10.5
                      reason:
                        type: string
                        example: Complete refund after partial refund
                      refund_type:
                        type: string
                        example: all
                      order:
                        title: Commerce::Order
                        type: object
                        properties:
                          id:
                            type: integer
                          first_name:
                            type:
                              - string
                              - 'null'
                          last_name:
                            type:
                              - string
                              - 'null'
                          email:
                            type:
                              - string
                              - 'null'
                          phone:
                            type:
                              - string
                              - 'null'
                          order_number:
                            type:
                              - string
                              - 'null'
                          status:
                            type: string
                            enum:
                              - awaiting_payment
                              - awaiting_shipment
                              - shipped
                              - delivered
                              - archived
                              - cancelled
                              - failed_payment
                              - draft
                          order_type:
                            type: string
                            enum:
                              - requested
                              - purchased
                              - imported
                              - abandoned
                          source:
                            type: string
                            enum:
                              - mobile
                              - web
                              - admin
                              - backoffice
                              - subscription
                              - enrollment
                          amount:
                            type:
                              - number
                              - string
                              - 'null'
                            default: '0.0'
                          amount_in_base:
                            type:
                              - number
                              - string
                              - 'null'
                            default: '0.0'
                          base_to_currency_rate:
                            type:
                              - number
                              - string
                              - 'null'
                          note:
                            type:
                              - string
                              - 'null'
                          currency_code:
                            type:
                              - string
                              - 'null'
                          created_at:
                            type: string
                            format: date-time
                          updated_at:
                            type: string
                            format: date-time
                          metadata:
                            type:
                              - object
                              - 'null'
                            default: '{}'
                          token:
                            type: string
                          refundable_amount:
                            type: string
                          order_status:
                            type: string
                            enum:
                              - draft
                              - pending
                              - processing
                              - completed
                              - cancelled
                              - archived
                          fulfillment_status:
                            type: string
                            enum:
                              - unfulfilled
                              - in_progress
                              - on_hold
                              - partially_fulfilled
                              - scheduled
                              - fulfilled
                          financial_status:
                            type: string
                            enum:
                              - pending
                              - authorized
                              - partially_paid
                              - paid
                              - partially_refunded
                              - refunded
                              - voided
                              - marked_free
                              - marked_paid
                          warehouse_id:
                            type:
                              - integer
                              - 'null'
                          split_payment:
                            type:
                              - object
                              - 'null'
                          points_applied:
                            default: 0
                            type: integer
                          points_applied_amount_in_currency:
                            type: number
                          order_total_after_points_redemption:
                            type: number
                          free_shipping:
                            description: Whether the order has free shipping
                            type: boolean
                          discount_codes:
                            default: []
                            description: Discount codes applied to the order
                            type: array
                        required:
                          - id
                          - status
                          - order_type
                          - source
                          - created_at
                          - updated_at
                          - token
                          - refundable_amount
                          - order_status
                          - fulfillment_status
                          - financial_status
                          - points_applied
                          - points_applied_amount_in_currency
                          - order_total_after_points_redemption
                          - free_shipping
                          - discount_codes
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: Order not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Couldn't find Commerce::Order with id 100
                  errors:
                    type: object
                    example:
                      order_id:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '422':
          description: Refund error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Unable to create refund.
                  errors:
                    type: object
                    example:
                      payment:
                        - Transaction declined
                      details:
                        error_code: DECLINED
                      type:
                        - is missing
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                order_id:
                  type: integer
                  example: 1
                type:
                  type: string
                  example: all
                  enum:
                    - all
                    - tax
                    - shipping
                    - product_price
                    - cv
                    - qv
                    - partial
                amount:
                  type: number
                  example: 10
                reason:
                  type: string
                  example: Complete refund after partial refund
                restock_all_items:
                  type: boolean
                  example: true
              required:
                - order_id
  /api/refunds/items:
    post:
      summary: Create refund for items
      tags:
        - Refunds
      operationId: createRefundForItems
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: Refund created
          content:
            application/json:
              schema:
                type: object
                properties:
                  refund:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 100
                      order_id:
                        type: integer
                        example: 1111
                      amount:
                        type:
                          - number
                          - string
                        example: 10.5
                      reason:
                        type: string
                        example: Damaged product
                      refund_type:
                        type: string
                        example: all
                      order:
                        title: Commerce::Order
                        type: object
                        properties:
                          id:
                            type: integer
                          first_name:
                            type:
                              - string
                              - 'null'
                          last_name:
                            type:
                              - string
                              - 'null'
                          email:
                            type:
                              - string
                              - 'null'
                          phone:
                            type:
                              - string
                              - 'null'
                          order_number:
                            type:
                              - string
                              - 'null'
                          status:
                            type: string
                            enum:
                              - awaiting_payment
                              - awaiting_shipment
                              - shipped
                              - delivered
                              - archived
                              - cancelled
                              - failed_payment
                              - draft
                          order_type:
                            type: string
                            enum:
                              - requested
                              - purchased
                              - imported
                              - abandoned
                          source:
                            type: string
                            enum:
                              - mobile
                              - web
                              - admin
                              - backoffice
                              - subscription
                              - enrollment
                          amount:
                            type:
                              - number
                              - string
                              - 'null'
                            default: '0.0'
                          amount_in_base:
                            type:
                              - number
                              - string
                              - 'null'
                            default: '0.0'
                          base_to_currency_rate:
                            type:
                              - number
                              - string
                              - 'null'
                          note:
                            type:
                              - string
                              - 'null'
                          currency_code:
                            type:
                              - string
                              - 'null'
                          created_at:
                            type: string
                            format: date-time
                          updated_at:
                            type: string
                            format: date-time
                          metadata:
                            type:
                              - object
                              - 'null'
                            default: '{}'
                          token:
                            type: string
                          refundable_amount:
                            type: string
                          order_status:
                            type: string
                            enum:
                              - draft
                              - pending
                              - processing
                              - completed
                              - cancelled
                              - archived
                          fulfillment_status:
                            type: string
                            enum:
                              - unfulfilled
                              - in_progress
                              - on_hold
                              - partially_fulfilled
                              - scheduled
                              - fulfilled
                          financial_status:
                            type: string
                            enum:
                              - pending
                              - authorized
                              - partially_paid
                              - paid
                              - partially_refunded
                              - refunded
                              - voided
                              - marked_free
                              - marked_paid
                          warehouse_id:
                            type:
                              - integer
                              - 'null'
                          split_payment:
                            type:
                              - object
                              - 'null'
                          points_applied:
                            default: 0
                            type: integer
                          points_applied_amount_in_currency:
                            type: number
                          order_total_after_points_redemption:
                            type: number
                          free_shipping:
                            description: Whether the order has free shipping
                            type: boolean
                          discount_codes:
                            default: []
                            description: Discount codes applied to the order
                            type: array
                        required:
                          - id
                          - status
                          - order_type
                          - source
                          - created_at
                          - updated_at
                          - token
                          - refundable_amount
                          - order_status
                          - fulfillment_status
                          - financial_status
                          - points_applied
                          - points_applied_amount_in_currency
                          - order_total_after_points_redemption
                          - free_shipping
                          - discount_codes
                      order_item_refunds:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type:
                                - integer
                                - string
                              example: 1
                            quantity:
                              type:
                                - integer
                                - 'null'
                              example: 2
                            item:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 101
                                price:
                                  type:
                                    - number
                                    - string
                                  example: 43.41
                                price_in_currency:
                                  type: string
                                  example: $43.41
                                tax:
                                  type: string
                                  example: '2.99'
                                tax_in_currency:
                                  type: string
                                  example: $2.99
                                cv:
                                  type: integer
                                  example: 5
                                cv_in_currency:
                                  type: string
                                  example: $5.00
                                qv:
                                  type: integer
                                  example: 7
                                qv_in_currency:
                                  type: string
                                  example: $7.00
                                product_title:
                                  type: string
                                  example: Sample Product
                                variant_title:
                                  type:
                                    - string
                                    - 'null'
                                  example: Sample Variant
                                variant_image:
                                  type:
                                    - string
                                    - 'null'
                                  example: https://example.com/image.png
                                variant_id:
                                  type: integer
                                  example: 202
                                quantity:
                                  type: integer
                                  example: 3
                                title:
                                  type: string
                                total:
                                  type:
                                    - number
                                    - string
                                image_url:
                                  type:
                                    - string
                                    - 'null'
                                sku:
                                  type:
                                    - string
                                    - 'null'
                                display_price:
                                  type: string
                                display_total:
                                  type: string
                                refundable_amount:
                                  type:
                                    - number
                                    - string
                                  format: float
                                  example: 10.5
                                enrollment_pack_id:
                                  type:
                                    - integer
                                    - 'null'
                                display_to_customer:
                                  type:
                                    - boolean
                                    - 'null'
                                  example: true
                                bundled_items:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      variant_id:
                                        type: integer
                                      product_id:
                                        type: integer
                                      product_title:
                                        type: string
                                      variant_title:
                                        type: string
                                      option_titles:
                                        type: array
                                        items:
                                          type: string
                                      quantity:
                                        type: integer
                                      display_to_customer:
                                        type: boolean
                                ordered_variant:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      option_type:
                                        type: string
                                      value:
                                        type: string
                                product:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type: string
                                      example: Sample Product
                                    introduction:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Short Description
                                    cv:
                                      type: integer
                                      example: 10
                                    cv_in_currency:
                                      type: string
                                      example: $10.00
                                    external_id:
                                      type:
                                        - string
                                        - 'null'
                                      example: ext-prod-123
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/product.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/product.png
                                    price:
                                      type: string
                                      example: '29.99'
                                    price_in_currency:
                                      type: string
                                      example: $29.99
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    tax:
                                      type: string
                                      example: '2.99'
                                    tax_in_currency:
                                      type: string
                                      example: $2.99
                                    metadata:
                                      type: object
                                      example:
                                        shopify_product_id: 9876054868270
                                    metafields:
                                      type: array
                                      items:
                                        title: LegacyMetafield
                                        type: object
                                        properties:
                                          namespace:
                                            description: >-
                                              A container for related metafields.
                                              Commonly used to group metafields by app
                                              or functionality.
                                            example: custom
                                            type: string
                                            maxLength: 20
                                            pattern: ^[a-zA-Z0-9_]+$
                                          key:
                                            description: >-
                                              The unique identifier for the metafield
                                              within its namespace. Must be unique per
                                              namespace and owner.
                                            example: material
                                            type: string
                                            maxLength: 30
                                            pattern: ^[a-zA-Z0-9_]+$
                                          value:
                                            description: >-
                                              The actual data stored in the metafield.
                                              Type depends on value_type.
                                            example: cotton
                                            type:
                                              - string
                                              - integer
                                              - object
                                              - boolean
                                              - number
                                          value_type:
                                            description: >-
                                              The data type that defines how the value
                                              should be interpreted and validated.
                                            example: single_line_text_field
                                            type: string
                                          description:
                                            description: >-
                                              Optional human-readable description
                                              explaining the purpose of this
                                              metafield.
                                            example: >-
                                              The primary material used in this
                                              product
                                            type:
                                              - string
                                              - 'null'
                                          created_at:
                                            description: >-
                                              Timestamp when the metafield was
                                              created.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          updated_at:
                                            description: >-
                                              Timestamp when the metafield was last
                                              updated.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          locked:
                                            description: >-
                                              Whether this metafield is locked and
                                              cannot be updated or deleted directly.
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                              - 'null'
                                          metafield_definition:
                                            description: >-
                                              The definition that defines validation
                                              rules and structure for this metafield
                                            type:
                                              - 'null'
                                              - object
                                        required:
                                          - namespace
                                          - key
                                          - value
                                          - value_type
                                          - description
                                          - created_at
                                          - updated_at
                                          - metafield_definition
                                variant:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Variant
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/sample.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/sample.png
                                    primary_image:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/primary.png
                                    price:
                                      type:
                                        - string
                                        - 'null'
                                      example: '34.44'
                                    price_in_currency:
                                      type:
                                        - string
                                        - 'null'
                                      example: $34.44
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    options:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          title:
                                            type: string
                                            example: Size
                                          value:
                                            type: string
                                            example: XL
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: Order not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Couldn't find Commerce::Order with id 100
                  errors:
                    type: object
                    example:
                      order_id:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '422':
          description: Refund error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Unable to create refund.
                  errors:
                    type: object
                    example:
                      payment:
                        - Transaction declined
                      details:
                        error_code: DECLINED
                      order_items:
                        - can't be blank
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                order_id:
                  type: integer
                  example: 1
                order_items:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 101
                      amount:
                        type: number
                        example: 100.5
                      quantity:
                        type: integer
                        example: 2
                      cv:
                        type: integer
                        example: 10
                      qv:
                        type: integer
                        example: 10
                      restock:
                        type: boolean
                        example: true
                    required:
                      - id
                reason:
                  type: string
                  example: Damaged product
              required:
                - order_id
                - order_items
  /api/v2/reps:
    get:
      summary: List all reps
      tags:
        - Reps
      security:
        - bearer_auth: []
      parameters:
        - name: search_query
          in: query
          required: false
          description: >-
            Filter reps with search query that matches with their email, first
            name, last name, share guid or external id
          schema:
            type: string
        - name: sorted_by
          in: query
          required: false
          example: email_asc
          description: >
            Sort the records by one of the supported attributes:

              - first_name (or 'name' as alias)
              - last_name
              - email
              - created_at
              - share_guid
              - active

            The sort attribute should be followed by one of the order
            directives: '_asc', '_desc'
          schema:
            type: string
        - name: active
          in: query
          required: false
          description: Filter reps by `active` status
          schema:
            type: boolean
        - name: page
          in: query
          schema:
            type: integer
            exclusiveMinimum: 0
          required: false
          description: Page number for pagination
        - name: per_page
          in: query
          schema:
            type: integer
            exclusiveMinimum: 0
            maximum: 100
          required: false
          description: Number of records per page
      responses:
        '200':
          description: reps found
          content:
            application/json:
              schema:
                type: object
                properties:
                  reps:
                    type: array
                    items:
                      title: UserCompany
                      type: object
                      properties:
                        id:
                          type: integer
                        active:
                          type:
                            - boolean
                            - 'null'
                          default: true
                        external_id:
                          type:
                            - string
                            - 'null'
                        username:
                          type:
                            - string
                            - 'null'
                        first_name:
                          type: string
                        last_name:
                          type: string
                        created_at:
                          type: string
                          format: date-time
                        image_url:
                          type:
                            - string
                            - 'null'
                        roles:
                          type:
                            - string
                            - 'null'
                          default: user
                        share_guid:
                          type: string
                          pattern: ^[a-z0-9\-_]+$
                          minLength: 2
                        country_code:
                          type: string
                        language_code:
                          type: string
                        computed_full_name:
                          type:
                            - string
                            - 'null'
                        computed_email:
                          type:
                            - string
                            - 'null'
                        phone:
                          type:
                            - string
                            - 'null'
                      required:
                        - id
                        - first_name
                        - last_name
                        - created_at
                        - share_guid
                        - country_code
                        - language_code
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      pagination:
                        type: object
                        properties:
                          current_page:
                            type: integer
                            example: 1
                          total_pages:
                            type: integer
                            example: 10
                          total_count:
                            type: integer
                            example: 100
                          per_page:
                            type: integer
                            example: 10
                required:
                  - reps
                  - meta
    post:
      summary: Create a rep
      tags:
        - Reps
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: rep created with custom share_guid
          content:
            application/json:
              schema:
                type: object
                properties:
                  rep:
                    title: UserCompany
                    type: object
                    properties:
                      id:
                        type: integer
                      active:
                        type:
                          - boolean
                          - 'null'
                        default: true
                      external_id:
                        type:
                          - string
                          - 'null'
                      username:
                        type:
                          - string
                          - 'null'
                      first_name:
                        type: string
                      last_name:
                        type: string
                      created_at:
                        type: string
                        format: date-time
                      image_url:
                        type:
                          - string
                          - 'null'
                      roles:
                        type:
                          - string
                          - 'null'
                        default: user
                      share_guid:
                        type: string
                        pattern: ^[a-z0-9\-_]+$
                        minLength: 2
                      country_code:
                        type: string
                      language_code:
                        type: string
                      computed_full_name:
                        type:
                          - string
                          - 'null'
                      computed_email:
                        type:
                          - string
                          - 'null'
                      phone:
                        type:
                          - string
                          - 'null'
                    required:
                      - id
                      - first_name
                      - last_name
                      - created_at
                      - share_guid
                      - country_code
                      - language_code
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - rep
                  - meta
        '422':
          description: invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                rep:
                  type: object
                  properties:
                    first_name:
                      type:
                        - 'null'
                        - string
                    last_name:
                      type:
                        - 'null'
                        - string
                    email:
                      type:
                        - 'null'
                        - string
                    phone:
                      type:
                        - 'null'
                        - string
                    active:
                      type:
                        - 'null'
                        - boolean
                    external_id:
                      type:
                        - 'null'
                        - string
                    username:
                      type:
                        - 'null'
                        - string
                    share_guid:
                      type:
                        - 'null'
                        - string
                    language_code:
                      type:
                        - 'null'
                        - string
                    country_code:
                      type:
                        - 'null'
                        - string
                  required:
                    - email
              required:
                - rep
  /api/v2/reps/{id}:
    get:
      summary: Retrieve a rep
      tags:
        - Reps
      security:
        - bearer_auth: []
      responses:
        '200':
          description: rep found
          content:
            application/json:
              schema:
                type: object
                properties:
                  rep:
                    title: UserCompany
                    type: object
                    properties:
                      id:
                        type: integer
                      active:
                        type:
                          - boolean
                          - 'null'
                        default: true
                      external_id:
                        type:
                          - string
                          - 'null'
                      username:
                        type:
                          - string
                          - 'null'
                      first_name:
                        type: string
                      last_name:
                        type: string
                      created_at:
                        type: string
                        format: date-time
                      image_url:
                        type:
                          - string
                          - 'null'
                      roles:
                        type:
                          - string
                          - 'null'
                        default: user
                      share_guid:
                        type: string
                        pattern: ^[a-z0-9\-_]+$
                        minLength: 2
                      country_code:
                        type: string
                      language_code:
                        type: string
                      computed_full_name:
                        type:
                          - string
                          - 'null'
                      computed_email:
                        type:
                          - string
                          - 'null'
                      phone:
                        type:
                          - string
                          - 'null'
                      rank:
                        type:
                          - string
                          - 'null'
                      joined_date:
                        type: string
                      customer_id:
                        type:
                          - integer
                          - 'null'
                      enroller:
                        type:
                          - object
                          - 'null'
                    required:
                      - id
                      - first_name
                      - last_name
                      - created_at
                      - share_guid
                      - country_code
                      - language_code
                      - joined_date
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - rep
                  - meta
        '404':
          description: rep not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
    patch:
      summary: Update a rep
      tags:
        - Reps
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: rep updated with same username
          content:
            application/json:
              schema:
                type: object
                properties:
                  rep:
                    title: UserCompany
                    type: object
                    properties:
                      id:
                        type: integer
                      active:
                        type:
                          - boolean
                          - 'null'
                        default: true
                      external_id:
                        type:
                          - string
                          - 'null'
                      username:
                        type:
                          - string
                          - 'null'
                      first_name:
                        type: string
                      last_name:
                        type: string
                      created_at:
                        type: string
                        format: date-time
                      image_url:
                        type:
                          - string
                          - 'null'
                      roles:
                        type:
                          - string
                          - 'null'
                        default: user
                      share_guid:
                        type: string
                        pattern: ^[a-z0-9\-_]+$
                        minLength: 2
                      country_code:
                        type: string
                      language_code:
                        type: string
                      computed_full_name:
                        type:
                          - string
                          - 'null'
                      computed_email:
                        type:
                          - string
                          - 'null'
                      phone:
                        type:
                          - string
                          - 'null'
                      rank:
                        type:
                          - string
                          - 'null'
                      joined_date:
                        type: string
                      customer_id:
                        type:
                          - integer
                          - 'null'
                      enroller:
                        type:
                          - object
                          - 'null'
                    required:
                      - id
                      - first_name
                      - last_name
                      - created_at
                      - share_guid
                      - country_code
                      - language_code
                      - joined_date
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - rep
                  - meta
        '404':
          description: rep not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: 'rep update rejected: language_code not available in company'
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: integer
                rep:
                  type: object
                  properties:
                    first_name:
                      type:
                        - 'null'
                        - string
                    last_name:
                      type:
                        - 'null'
                        - string
                    email:
                      type:
                        - 'null'
                        - string
                    phone:
                      type:
                        - 'null'
                        - string
                    active:
                      type:
                        - 'null'
                        - boolean
                    external_id:
                      type:
                        - 'null'
                        - string
                    username:
                      type:
                        - 'null'
                        - string
                    share_guid:
                      type:
                        - 'null'
                        - string
                    language_code:
                      type:
                        - 'null'
                        - string
                    country_code:
                      type:
                        - 'null'
                        - string
                  required: []
              required:
                - id
                - rep
    delete:
      summary: Delete a rep
      tags:
        - Reps
      security:
        - bearer_auth: []
      responses:
        '200':
          description: rep deleted
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - id
                  - meta
        '404':
          description: rep not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
  /api/v2/reps/{id}/update_enroller:
    patch:
      summary: Update enroller for a rep
      tags:
        - Reps
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Rep ID
          schema:
            type: integer
      responses:
        '202':
          description: enroller update queued with transfer_points
          content:
            application/json:
              schema:
                type: object
                properties:
                  enroller_update:
                    type: object
                    properties:
                      rep_id:
                        type: integer
                      enroller_id:
                        type: integer
                      transfer_points:
                        type: boolean
                      message:
                        type: string
                    required:
                      - rep_id
                      - enroller_id
                      - transfer_points
                      - message
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - enroller_update
                  - meta
        '404':
          description: enroller not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: cannot enroll under yourself
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: integer
                  not:
                    type: 'null'
                enroller_id:
                  type: integer
                  not:
                    type: 'null'
                transfer_points:
                  type:
                    - 'null'
                    - boolean
              required:
                - id
                - enroller_id
  /api/company/roles:
    get:
      summary: Lists roles for a company
      tags:
        - Roles
      security:
        - bearer_auth: []
      parameters:
        - name: page
          in: query
          required: false
          description: Page number for pagination
          schema:
            type: integer
        - name: per_page
          in: query
          required: false
          description: Number of items per page (max 25)
          schema:
            type: integer
        - name: sorted_by
          in: query
          required: false
          description: >-
            Sort field and direction (e.g., 'name_asc', 'created_at_desc',
            'users_asc', 'permissions_desc')
          schema:
            type: string
        - name: search_query
          in: query
          required: false
          description: Search term to filter roles by name
          schema:
            type: string
        - name: max_user_count
          in: query
          required: false
          description: Maximum number of users assigned to roles (inclusive)
          schema:
            type: integer
        - name: min_user_count
          in: query
          required: false
          description: Minimum number of users assigned to roles (inclusive)
          schema:
            type: integer
      responses:
        '200':
          description: returns roles successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  roles:
                    type: array
                    description: List of roles
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        name:
                          type: string
                        createdAt:
                          type: string
                          format: date-time
                        user_count:
                          type: integer
                        permissions:
                          type: object
                          additionalProperties: true
                      required:
                        - id
                        - name
                      additionalProperties: true
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                      pagination:
                        type: object
                        properties:
                          current_page:
                            type: integer
                          total_pages:
                            type: integer
                          total_count:
                            type: integer
                          per_page:
                            type: integer
                      count:
                        type: integer
                    required:
                      - request_id
                      - timestamp
                    additionalProperties: true
                required:
                  - roles
                  - meta
        '403':
          description: returns forbidden for users without role view permissions
    post:
      summary: Creates a new role for a company
      tags:
        - Roles
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: role created successfully
        '401':
          description: unauthorized when token is invalid
        '403':
          description: forbidden when user lacks required permissions
        '422':
          description: unprocessable entity when validation fails
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                role:
                  type: object
                  properties:
                    name:
                      type: string
                    permissions:
                      type: object
                      additionalProperties: true
                  required:
                    - name
              required:
                - role
  /api/company/roles/{id}:
    put:
      summary: Updates a role
      tags:
        - Roles
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: successfully updates role permissions
        '401':
          description: unauthorized when token is invalid
        '403':
          description: forbidden when user lacks required permissions
        '404':
          description: role not found
        '422':
          description: unprocessable entity when validation fails
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                role:
                  type: object
                  properties:
                    permissions:
                      type: object
                      additionalProperties: true
    delete:
      summary: Deletes a role
      tags:
        - Roles
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: role successfully deleted
        '401':
          description: unauthorized when token is invalid
        '403':
          description: cannot delete role
        '404':
          description: role not found
        '422':
          description: unprocessable entity when deletion fails
  /api/company/roles/structure:
    get:
      summary: Get roles structure for the company
      tags:
        - Roles
      security:
        - bearer_auth: []
      operationId: getRolesStructure
      description: >-
        Get the structure of roles including available actions and categories
        for permission management
      responses:
        '200':
          description: structure retrieved successfully for admin user
          content:
            application/json:
              schema:
                type: object
                properties:
                  headers:
                    type: array
                    items:
                      type: string
                  categories:
                    type: array
                    items:
                      type: object
                      properties:
                        key:
                          type: string
                        label:
                          type: string
                        resources:
                          type: array
                          items:
                            type: object
                            properties:
                              key:
                                type: string
                              label:
                                type: string
                              actions:
                                type: array
                                items:
                                  type: string
                            required:
                              - key
                              - label
                              - actions
                      required:
                        - key
                        - label
                        - resources
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                required:
                  - headers
                  - categories
        '401':
          description: unauthorized when token is invalid
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '403':
          description: forbidden when role permission isn't granted
  /api/company/roles/{id}/duplicate:
    post:
      summary: Duplicates a role
      tags:
        - Roles
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '201':
          description: role duplicated successfully
        '401':
          description: unauthorized when token is invalid
        '403':
          description: forbidden when user lacks required permissions
        '404':
          description: role not found
        '422':
          description: unprocessable entity when duplication fails
  /api/company/roles/my_permissions:
    get:
      summary: Get current user's permissions
      tags:
        - Roles
      security:
        - bearer_auth: []
      operationId: getMyPermissions
      description: Get the current user's permissions and roles for the current company
      responses:
        '200':
          description: boolean type casting works correctly for permission values
          content:
            application/json:
              schema:
                type: object
                properties:
                  permissions:
                    type: object
                    additionalProperties: true
                    description: Hash of resource permissions with their actions
                    example:
                      roles:
                        create: true
                        view: true
                        update: true
                        delete: true
                  roles:
                    type: array
                    items:
                      type: string
                    description: List of role names assigned to the user
                    example:
                      - admin
                      - developer
                  is_super_admin:
                    type: boolean
                    description: Whether the user is a super admin
                  meta:
                    type: object
                    description: Metadata about the request
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                required:
                  - permissions
                  - roles
                  - is_super_admin
                  - meta
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
  /api/root_themes:
    get:
      summary: List root themes
      description: Get all root themes with optional filters
      tags:
        - Root Themes
      operationId: listRootThemes
      security:
        - bearer_auth: []
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            default: 1
          required: false
          description: Page number for pagination
        - name: per_page
          in: query
          schema:
            type: integer
            default: 10
          required: false
          description: Number of records per page
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  root_themes:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 1
                        name:
                          type: string
                          example: Modern Theme
                        description:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            name:
                              type: string
                              example: description
                            body:
                              type: string
                              example: >-
                                This is a sample description for an application
                                theme.
                            record_type:
                              type: string
                              example: ApplicationTheme
                            record_id:
                              type: integer
                              example: 1
                            created_at:
                              type: string
                              format: date_time
                              example: '2023-07-24T10:00:00.000Z'
                            updated_at:
                              type: string
                              format: date_time
                              example: '2023-07-24T10:00:00.000Z'
                            locale:
                              type:
                                - string
                                - 'null'
                              example: null
                          example:
                            id:
                              type: integer
                              example: 1
                            name:
                              type: string
                              example: description
                            body:
                              type: string
                              example: >-
                                This is a sample description for an application
                                theme.
                            record_type:
                              type: string
                              example: ApplicationTheme
                            record_id:
                              type: integer
                              example: 1
                            created_at:
                              type: string
                              format: date_time
                              example: '2023-07-24T10:00:00.000Z'
                            updated_at:
                              type: string
                              format: date_time
                              example: '2023-07-24T10:00:00.000Z'
                            locale:
                              type:
                                - string
                                - 'null'
                              example: null
                        cover_image:
                          type:
                            - string
                            - 'null'
                          example: >-
                            https://ik.imagekit.io/fluid/s3/83yozdmzQ1qLeKn89ffS_unnamed_file
                        created_at:
                          type: string
                          format: date_time
                          example: '2023-07-24T10:00:00.000Z'
                        updated_at:
                          type:
                            - string
                            - 'null'
                          format: date_time
                          example: '2023-07-24T10:00:00.000Z'
                        version:
                          type: string
                          example: '1.0'
                        images:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              url:
                                type: string
                                example: >-
                                  https://ik.imagekit.io/fluid/s3/83yozdmzQ1qLeKn89ffS_image_file
                              position:
                                type: integer
                                example: 1
                          example: []
                        theme_versions:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              version:
                                type: string
                                example: '1.0'
                              zip_file_url:
                                type: string
                                example: https://example.com/updated-zip-file.zip
                              released_at:
                                type: string
                                format: date_time
                                example: '2023-07-24T10:00:00.000Z'
                              changelog:
                                type: string
                                example: Initial release.
                          example: []
                      required:
                        - id
                        - name
                        - created_at
                        - updated_at
                      additionalProperties: true
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                      total_count:
                        type: integer
                        example: 42
                      total_pages:
                        type: integer
                        example: 3
                      current_page:
                        type: integer
                        example: 1
                      per_page:
                        type: integer
                        example: 10
    post:
      summary: Create a root theme
      tags:
        - Root Themes
      operationId: createRootTheme
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: created
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Import started.
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: ApplicationTheme not found.
                  errors:
                    type: object
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                zip_file_url:
                  type: string
                  example: https://example.com/updated-zip-file.zip
                  description: URL for the updated zip file
                name:
                  type: string
                  example: Modern Theme
                  description: Name of the application theme
                changelog:
                  type: string
                  example: Initial release.
                  description: Changelog for the application theme
              required:
                - zip_file_url
  /api/root_themes/{id}:
    patch:
      summary: Update a root theme
      tags:
        - Root Themes
      operationId: updateRootTheme
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Root Theme ID
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Import started.
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: ApplicationTheme not found.
                  errors:
                    type: object
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                zip_file_url:
                  type: string
                  example: https://example.com/updated-zip-file.zip
                  description: URL for the updated zip file
                changelog:
                  type: string
                  example: Bug fixes and improvements.
                  description: Changelog for the application theme
              required:
                - zip_file_url
    delete:
      summary: Delete a root theme
      tags:
        - Root Themes
      operationId: deleteRootTheme
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Root Theme ID
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Theme was successfully destroyed.
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: ApplicationTheme not found.
                  errors:
                    type: object
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
                  - meta
  /api/root_themes/my:
    get:
      summary: List company root themes
      description: Get all company root themes with optional filters
      tags:
        - Root Themes
      operationId: listCompanyRootThemes
      security:
        - bearer_auth: []
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            default: 1
          required: false
          description: Page number for pagination
        - name: per_page
          in: query
          schema:
            type: integer
            default: 10
          required: false
          description: Number of records per page
        - name: status
          in: query
          schema:
            type: string
            enum:
              - draft
              - publishing
              - rejected
              - published
              - active
            example: draft
          required: false
          description: >-
            Filter themes by status of their versions (draft, publishing,
            rejected, published, active)
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  root_themes:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 1
                        name:
                          type: string
                          example: Modern Theme
                        description:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            name:
                              type: string
                              example: description
                            body:
                              type: string
                              example: >-
                                This is a sample description for an application
                                theme.
                            record_type:
                              type: string
                              example: ApplicationTheme
                            record_id:
                              type: integer
                              example: 1
                            created_at:
                              type: string
                              format: date_time
                              example: '2023-07-24T10:00:00.000Z'
                            updated_at:
                              type: string
                              format: date_time
                              example: '2023-07-24T10:00:00.000Z'
                            locale:
                              type:
                                - string
                                - 'null'
                              example: null
                          example:
                            id:
                              type: integer
                              example: 1
                            name:
                              type: string
                              example: description
                            body:
                              type: string
                              example: >-
                                This is a sample description for an application
                                theme.
                            record_type:
                              type: string
                              example: ApplicationTheme
                            record_id:
                              type: integer
                              example: 1
                            created_at:
                              type: string
                              format: date_time
                              example: '2023-07-24T10:00:00.000Z'
                            updated_at:
                              type: string
                              format: date_time
                              example: '2023-07-24T10:00:00.000Z'
                            locale:
                              type:
                                - string
                                - 'null'
                              example: null
                        cover_image:
                          type:
                            - string
                            - 'null'
                          example: >-
                            https://ik.imagekit.io/fluid/s3/83yozdmzQ1qLeKn89ffS_unnamed_file
                        created_at:
                          type: string
                          format: date_time
                          example: '2023-07-24T10:00:00.000Z'
                        updated_at:
                          type:
                            - string
                            - 'null'
                          format: date_time
                          example: '2023-07-24T10:00:00.000Z'
                        version:
                          type: string
                          example: '1.0'
                        demo_url:
                          type:
                            - string
                            - 'null'
                          example: https://demo.example.com/modern-theme
                        status:
                          type: string
                          example: published
                        images:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              url:
                                type: string
                                example: >-
                                  https://ik.imagekit.io/fluid/s3/83yozdmzQ1qLeKn89ffS_image_file
                              position:
                                type: integer
                                example: 1
                          example: []
                        theme_versions:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              version:
                                type: string
                                example: '1.0'
                              zip_file_url:
                                type: string
                                example: https://example.com/updated-zip-file.zip
                              released_at:
                                type:
                                  - string
                                  - 'null'
                                format: date_time
                                example: '2023-07-24T10:00:00.000Z'
                              changelog:
                                type: string
                                example: Initial release.
                              status:
                                type: string
                                example: published
                          example: []
                        creator:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: integer
                              example: 1
                            name:
                              type: string
                              example: Jane Doe
                      required:
                        - id
                        - name
                        - created_at
                        - updated_at
                      additionalProperties: true
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                      total_count:
                        type: integer
                        example: 42
                      total_pages:
                        type: integer
                        example: 3
                      current_page:
                        type: integer
                        example: 1
                      per_page:
                        type: integer
                        example: 10
  /api/root_themes/{id}/status:
    post:
      summary: Update a root theme status
      tags:
        - Root Themes
      operationId: updateRootThemeStatus
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Root Theme ID
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Import started.
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: ApplicationTheme not found.
                  errors:
                    type: object
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                theme_version_id:
                  type: integer
                  example: 1
                  description: ID of the theme version to set status for
                approved:
                  type: boolean
                  example: true
                  description: Approval status to set for the theme version
              required:
                - theme_version_id
                - approved
  /api/search:
    post:
      summary: Global search across all searchable models
      tags:
        - Search
      description: >-
        Perform global search across enabled models using Searchkick. Results
        are always filtered by company_id for data security. Supports model
        boosting, faceted search, and pagination.
      operationId: globalSearch
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: Empty search results
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 123
                          description: Unique identifier for the result
                        search_type:
                          type: string
                          example: commerce/order
                          description: Type of the search result
                        search_title:
                          type: string
                          example: 'Order #12345'
                          description: Display title for the result
                        search_description:
                          type:
                            - string
                            - 'null'
                          example: awaiting_payment • $100.00
                          description: Brief description of the result
                        search_url:
                          type:
                            - string
                            - 'null'
                          example: /orders/123
                          description: URL path to view the result
                        resource:
                          type: object
                          description: Model-specific data
                          additionalProperties: true
                        created_at:
                          type: string
                          format: date-time
                          example: '2025-01-28T12:00:00Z'
                          description: When result was created
                        updated_at:
                          type: string
                          format: date-time
                          example: '2025-01-28T12:00:00Z'
                          description: When result was last updated
                      required:
                        - id
                        - search_type
                        - search_title
                        - created_at
                        - updated_at
                        - resource
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-01-28T12:00:00Z'
                      total_count:
                        type: integer
                        example: 25
                        description: Total number of matching results
                      current_page:
                        type: integer
                        example: 1
                        description: Current page number
                      per_page:
                        type: integer
                        example: 20
                        description: Results per page
                      total_pages:
                        type: integer
                        example: 2
                        description: Total number of pages
                required:
                  - results
                  - meta
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '422':
          description: Validation error - invalid pagination parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameters
                  errors:
                    type: object
                    example:
                      q:
                        - is missing
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-01-28T12:00:00Z'
                required:
                  - error_message
                  - errors
                additionalProperties: false
        '500':
          description: Search service unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Search service is currently unavailable
                  errors:
                    type: object
                    properties:
                      search:
                        type: array
                        items:
                          type: string
                        example:
                          - >-
                            An error occurred while searching. Please try again
                            later.
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        format: date-time
                        example: '2025-01-28T12:00:00Z'
                required:
                  - error_message
                  - errors
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                q:
                  type: string
                  description: Search query string (required)
                models:
                  type: array
                  items:
                    type: string
                  description: >-
                    Array of model types to search. Available: order. Default:
                    all available models
                page:
                  type: integer
                  description: 'Page number for pagination (default: 1)'
                per_page:
                  type: integer
                  description: 'Number of results per page (default: 20, max: 100)'
                filters:
                  type: object
                  properties:
                    status:
                      type: string
                      description: Filter results by status
                    active:
                      type: boolean
                      description: Filter results by active status
              required:
                - q
  /api/v2025-06/media/{id}/share_stats:
    get:
      summary: Get share statistics for media
      tags:
        - Share Statistics
      operationId: getMediaShareStats
      description: >-
        Returns share statistics for a specific media item including total
        shares, recent activity, and engagement metrics
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
            example: 1
          description: Media ID
      responses:
        '200':
          description: Share statistics retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  share_stats:
                    $ref: '#/components/schemas/ShareStats'
                  meta:
                    $ref: '#/components/schemas/Meta'
        '404':
          description: Media not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                  meta:
                    $ref: '#/components/schemas/Meta'
  /api/v2025-06/products/{id}/share_stats:
    get:
      summary: Get share statistics for product
      tags:
        - Share Statistics
      operationId: getProductShareStats
      description: >-
        Returns share statistics for a specific product including total shares,
        recent activity, and engagement metrics
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
            example: 1
          description: Product ID
      responses:
        '200':
          description: Share statistics retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  share_stats:
                    $ref: '#/components/schemas/ShareStats'
                  meta:
                    $ref: '#/components/schemas/Meta'
        '404':
          description: Product not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                  meta:
                    $ref: '#/components/schemas/Meta'
  /api/v2025-06/playlists/{id}/share_stats:
    get:
      summary: Get share statistics for playlist
      tags:
        - Share Statistics
      operationId: getPlaylistShareStats
      description: >-
        Returns share statistics for a specific playlist including total shares,
        recent activity, and engagement metrics
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
            example: 1
          description: Playlist ID
      responses:
        '200':
          description: Share statistics retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  share_stats:
                    $ref: '#/components/schemas/ShareStats'
                  meta:
                    $ref: '#/components/schemas/Meta'
        '404':
          description: Playlist not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                  meta:
                    $ref: '#/components/schemas/Meta'
  /api/v2025-06/categories/{id}/share_stats:
    get:
      summary: Get share statistics for category
      tags:
        - Share Statistics
      operationId: getCategoryShareStats
      description: >-
        Returns share statistics for a specific category including total shares,
        recent activity, and engagement metrics
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
            example: 1
          description: Category ID
      responses:
        '200':
          description: Share statistics retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  share_stats:
                    $ref: '#/components/schemas/ShareStats'
                  meta:
                    $ref: '#/components/schemas/Meta'
        '404':
          description: Category not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                  meta:
                    $ref: '#/components/schemas/Meta'
  /api/v2025-06/collections/{id}/share_stats:
    get:
      summary: Get share statistics for collection
      tags:
        - Share Statistics
      operationId: getCollectionShareStats
      description: >-
        Returns share statistics for a specific collection including total
        shares, recent activity, and engagement metrics
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
            example: 1
          description: Collection ID
      responses:
        '200':
          description: Share statistics retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  share_stats:
                    $ref: '#/components/schemas/ShareStats'
                  meta:
                    $ref: '#/components/schemas/Meta'
        '404':
          description: Collection not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                  meta:
                    $ref: '#/components/schemas/Meta'
  /api/v2025-06/posts/{id}/share_stats:
    get:
      summary: Get share statistics for post
      tags:
        - Share Statistics
      operationId: getPostShareStats
      description: >-
        Returns share statistics for a specific post including total shares,
        recent activity, and engagement metrics
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
            example: 1
          description: Post ID
      responses:
        '200':
          description: Share statistics retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  share_stats:
                    $ref: '#/components/schemas/ShareStats'
                  meta:
                    $ref: '#/components/schemas/Meta'
        '404':
          description: Post not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                  meta:
                    $ref: '#/components/schemas/Meta'
  /api/v2025-06/pages/{id}/share_stats:
    get:
      summary: Get share statistics for page
      tags:
        - Share Statistics
      operationId: getPageShareStats
      description: >-
        Returns share statistics for a specific page including total shares,
        recent activity, and engagement metrics
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
            example: 1
          description: Page ID
      responses:
        '200':
          description: Share statistics retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  share_stats:
                    $ref: '#/components/schemas/ShareStats'
                  meta:
                    $ref: '#/components/schemas/Meta'
        '404':
          description: Page not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                  meta:
                    $ref: '#/components/schemas/Meta'
  /api/v2025-06/enrollment_packs/{id}/share_stats:
    get:
      summary: Get share statistics for enrollment pack
      tags:
        - Share Statistics
      operationId: getEnrollmentPackShareStats
      description: >-
        Returns share statistics for a specific enrollment pack including total
        shares, recent activity, and engagement metrics
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
            example: 1
          description: Enrollment Pack ID
      responses:
        '200':
          description: Share statistics retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  share_stats:
                    $ref: '#/components/schemas/ShareStats'
                  meta:
                    $ref: '#/components/schemas/Meta'
        '404':
          description: Enrollment pack not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                  meta:
                    $ref: '#/components/schemas/Meta'
  /api/company/shares:
    get:
      summary: Get shares
      tags:
        - Shares
      security:
        - bearer_auth: []
      parameters:
        - name: start_date
          in: query
          required: false
          description: 'Filter shares by start date (format: YYYY-MM-DD)'
          schema:
            type: string
        - name: end_date
          in: query
          required: false
          description: 'Filter shares by end date (format: YYYY-MM-DD)'
          schema:
            type: string
        - name: page
          in: query
          schema:
            type: integer
            default: 1
          required: false
          description: Page number for pagination
        - name: per_page
          in: query
          schema:
            type: integer
            default: 20
          required: false
          description: 'Number of records per page (max: 1000)'
      responses:
        '200':
          description: shares found
          content:
            application/json:
              schema:
                type: object
                properties:
                  shares:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        views:
                          type: integer
                        email:
                          type: string
                        share_type:
                          type: string
                        shareable_type:
                          type: string
                        shareable_id:
                          type: integer
                        shareable:
                          type: object
                          properties:
                            id:
                              type: integer
                          additionalProperties: true
                        created_at:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                      pagination:
                        type: object
                        properties:
                          current_page:
                            type: integer
                          next_page:
                            type:
                              - integer
                              - 'null'
                          prev_page:
                            type:
                              - integer
                              - 'null'
                          total_pages:
                            type: integer
                          total_count:
                            type: integer
                          per_page:
                            type: integer
        '422':
          description: invalid per_page
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/shares:
    get:
      summary: List Shares
      description: Get all shares with pagination
      tags:
        - Shares
      security:
        - bearer_auth: []
      parameters:
        - name: start_date
          in: query
          required: false
          description: 'Filter shares by start date (format: YYYY-MM-DD)'
          schema:
            type: string
        - name: end_date
          in: query
          required: false
          description: 'Filter shares by end date (format: YYYY-MM-DD)'
          schema:
            type: string
        - name: page
          in: query
          schema:
            type: integer
            default: 1
          required: false
          description: Page number for pagination
        - name: per_page
          in: query
          schema:
            type: integer
            default: 20
          required: false
          description: 'Number of records per page (max: 1000)'
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  shares:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        views:
                          type: integer
                        created_at:
                          type: string
                          format: date_time
                        email:
                          type: string
                        share_type:
                          type: string
                        shareable_type:
                          type: string
                        shareable_id:
                          type: integer
                        shareable:
                          type:
                            - object
                            - 'null'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                      pagination:
                        type: object
                        properties:
                          current_page:
                            type: integer
                          next_page:
                            type:
                              - integer
                              - 'null'
                          prev_page:
                            type:
                              - integer
                              - 'null'
                          total_pages:
                            type: integer
                          total_count:
                            type: integer
                          per_page:
                            type: integer
        '422':
          description: invalid per_page
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /shop.json:
    get:
      summary: Retrieve shop products with filtering and pagination
      tags:
        - Shop
      operationId: getShopProducts
      description: >
        Returns a paginated list of products from the shop with filtering and
        sorting capabilities.


        **Pagination:**

        - **page**: Page number for pagination (default: 1)

        - **count**: Number of products per page (default: 10, minimum: 10)


        **Country Context Options:**

        - **country_id**: Filter by country ID for pricing information (numeric
        ID)

        - **country_code**: Filter by country ISO code for pricing information
        (e.g., "US", "PH", "CA")


        **Filtering Options:**

        - **search_query**: Text search across product titles, SKUs, and
        descriptions

        - **with_country_id**: Filter by country ID for pricing information
        (alternative to country_id param)

        - **with_category_id**: Filter by specific category ID

        - **by_collection**: Filter by collection ID or collection title

        - **with_prices**: Filter by price range (format: "min-max", e.g.,
        "10.00-100.00")

        - **by_stock_available**: Filter by stock availability (true/false)

        - **by_language**: Filter by language code (e.g., "en")


        **Sorting Options:**

        - **sorted_by**: Sort order for products
          - `created_at_desc`: Sort by creation date (newest first)
          - `created_at_asc`: Sort by creation date (oldest first)
          - `title_asc`: Sort alphabetically by title (A-Z)
          - `title_desc`: Sort alphabetically by title (Z-A)
          - `price_asc`: Sort by price (lowest first)
          - `price_desc`: Sort by price (highest first)

        **Examples:**

        - `/shop.json?page=1&count=20&filterrific[sorted_by]=created_at_desc`

        -
        `/shop.json?filterrific[search_query]=shirt&filterrific[with_prices]=10.00-50.00`

        -
        `/shop.json?filterrific[with_category_id]=1&filterrific[by_stock_available]=true`

        - `/shop.json?country_code=PH&filterrific[search_query]=DY-ENQ-50419-PH`

        - `/shop.json?country_id=1&filterrific[by_language]=en`

        -
        `/shop.json?filterrific[with_country_id]=1&filterrific[by_language]=en`
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            default: 1
          required: false
          description: Page number for pagination
        - name: count
          in: query
          schema:
            type: integer
            default: 10
          required: false
          description: Number of products per page (minimum 10)
        - name: country_id
          in: query
          schema:
            type: integer
          required: false
          description: Filter by country ID for pricing information
          example: 1
        - name: country_code
          in: query
          schema:
            type: string
            pattern: ^[A-Z]{2,3}$
          required: false
          description: >-
            Filter by country ISO code for pricing information (2 or 3 letter
            code)
          example: PH
        - name: filterrific[sorted_by]
          in: query
          required: false
          schema:
            type: string
            enum:
              - created_at_desc
              - created_at_asc
              - title_asc
              - title_desc
              - price_asc
              - price_desc
          description: Sort order for products
        - name: filterrific[search_query]
          in: query
          schema:
            type: string
          required: false
          description: General search query by title, sku, and description
        - name: filterrific[with_country_id]
          in: query
          schema:
            type: integer
          required: false
          description: Filter by country ID for pricing
          example: 1
        - name: filterrific[with_category_id]
          in: query
          schema:
            type: integer
          required: false
          description: Filter by category ID
          example: 1
        - name: filterrific[by_collection]
          in: query
          schema:
            type: integer
          required: false
          description: Filter by collection ID or collection title
          example: 1
        - name: filterrific[with_prices]
          in: query
          schema:
            type: string
          required: false
          description: 'Filter by price range (format: min-max)'
          example: 10.00-100.00
        - name: filterrific[by_stock_available]
          in: query
          schema:
            type: boolean
          required: false
          description: Filter by stock availability
          example: true
        - name: filterrific[by_language]
          in: query
          schema:
            type: string
          required: false
          description: Filter by language code
          example: en
      responses:
        '200':
          description: successful with country_code filter
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: integer
                      description: Product ID
                      example: 1
                    slug:
                      type:
                        - string
                        - 'null'
                      description: Product slug
                      example: ph-product
                    custom_slug:
                      type: boolean
                      description: Whether product uses a custom slug
                      example: false
                    status:
                      type: string
                      description: Product status
                      example: active
                    sku:
                      type:
                        - string
                        - 'null'
                      description: Product SKU
                      example: PH-SKU-123
                    upc:
                      type:
                        - string
                        - 'null'
                      description: UPC code
                      example: '123456789012'
                    hs_code:
                      type:
                        - string
                        - 'null'
                      description: HS code
                      example: '1234.56'
                    image_url:
                      type:
                        - string
                        - 'null'
                      description: Product image URL
                      example: https://example.com/image.jpg
                    compressed_image_url:
                      type:
                        - string
                        - 'null'
                      description: Compressed image URL
                      example: https://example.com/compressed.jpg
                    image_path:
                      type:
                        - string
                        - 'null'
                      description: Image path
                      example: /images/product.jpg
                    external_url:
                      type:
                        - string
                        - 'null'
                      description: External URL
                      example: https://external.com
                    tax_category_id:
                      type:
                        - integer
                        - 'null'
                      description: Tax category ID
                      example: 1
                    public:
                      type: boolean
                      description: Is product public
                      example: true
                    in_stock:
                      type: boolean
                      description: Is product in stock
                      example: true
                    keep_selling:
                      type: boolean
                      description: Continue selling when out of stock
                      example: false
                    track_quantity:
                      type: boolean
                      description: Track product quantity
                      example: true
                    no_index:
                      type: boolean
                      description: Exclude from search indexing
                      example: false
                    commission:
                      type:
                        - string
                        - 'null'
                      description: Commission amount
                      example: '5.00'
                    affiliate_commission:
                      type:
                        - string
                        - 'null'
                      description: Affiliate commission
                      example: '2.50'
                    integration_id:
                      type:
                        - string
                        - 'null'
                      description: Integration ID
                      example: ext-123
                    external_id:
                      type:
                        - string
                        - 'null'
                      description: External ID
                      example: external-456
                    last_synced_at:
                      type:
                        - string
                        - 'null'
                      format: date-time
                      description: Last sync timestamp
                    metadata:
                      type:
                        - object
                        - 'null'
                      description: Additional metadata
                    publish_to_retail_store:
                      type: boolean
                      description: Publish to retail store
                      example: true
                    publish_to_rep_store:
                      type: boolean
                      description: Publish to rep store
                      example: true
                    publish_to_share_tab:
                      type: boolean
                      description: Publish to share tab
                      example: true
                    show_reviews:
                      type: boolean
                      description: Show product reviews
                      example: true
                    international_tax_type:
                      type:
                        - string
                        - 'null'
                      description: International tax type
                    application_theme_template_id:
                      type:
                        - integer
                        - 'null'
                      description: Theme template ID
                    updated_at:
                      type: string
                      format: date-time
                      description: Last updated timestamp
                    option_attrs:
                      type: array
                      description: Option attributes
                    track_inventory_on_bundle_items:
                      type: boolean
                      description: Whether to track inventory on bundle items
                    active:
                      type: boolean
                      description: Is product active
                      example: true
                    title:
                      type: string
                      description: Product title
                      example: PH Product
                    description:
                      type:
                        - string
                        - 'null'
                      description: Product description
                      example: A great PH product
                    introduction:
                      type:
                        - string
                        - 'null'
                      description: Product introduction
                    feature_text:
                      type:
                        - string
                        - 'null'
                      description: Feature text
                    stripped:
                      type:
                        - string
                        - 'null'
                      description: Plain text description
                    review_count:
                      type: integer
                      description: Number of reviews
                      example: 0
                    views:
                      type: integer
                      description: Number of views
                      example: 0
                    leads:
                      type: integer
                      description: Number of leads
                      example: 0
                    price:
                      type:
                        - string
                        - 'null'
                      description: Product price
                      example: '1999.99'
                    share_link:
                      type:
                        - string
                        - 'null'
                      description: Share link URL
                    display_price:
                      type:
                        - string
                        - 'null'
                      description: Formatted display price
                      example: ₱1,999.99 (PHP)
                    subscription_price:
                      type:
                        - string
                        - 'null'
                      description: Subscription price
                    tax_inclusive_price:
                      type:
                        - string
                        - 'null'
                      description: Tax inclusive price
                    tax_inclusive_wholesale:
                      type:
                        - string
                        - 'null'
                      description: Tax inclusive wholesale price
                    tax_inclusive_subscription_price:
                      type:
                        - string
                        - 'null'
                      description: Tax inclusive subscription price
                    tax_inclusive_wholesale_subscription_price:
                      type:
                        - string
                        - 'null'
                      description: Tax inclusive wholesale subscription price
                    currency_code:
                      type:
                        - string
                        - 'null'
                      description: Currency code
                      example: PHP
                    category:
                      type:
                        - object
                        - 'null'
                      description: Product category
                      properties:
                        id:
                          type: integer
                          example: 1
                        title:
                          type: string
                          example: Electronics
                        description:
                          type:
                            - string
                            - 'null'
                        image_url:
                          type:
                            - string
                            - 'null'
                        image_path:
                          type:
                            - string
                            - 'null'
                        position:
                          type:
                            - integer
                            - 'null'
                        public:
                          type: boolean
                    collections:
                      type: array
                      description: Product collections
                      items:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          title:
                            type: string
                            example: Featured
                          description:
                            type:
                              - string
                              - 'null'
                          image_url:
                            type:
                              - string
                              - 'null'
                          image_path:
                            type:
                              - string
                              - 'null'
                          position:
                            type:
                              - integer
                              - 'null'
                          public:
                            type: boolean
                    tags:
                      type: array
                      description: Product tags
                      items:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type: string
                            example: trending
                    label:
                      type:
                        - object
                        - 'null'
                      description: Product label
                    display_tag:
                      type:
                        - string
                        - 'null'
                      description: Display tag
                      example: new
                    images:
                      type: array
                      description: Product images
                      items:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          image_url:
                            type:
                              - string
                              - 'null'
                          image_path:
                            type:
                              - string
                              - 'null'
                          position:
                            type:
                              - integer
                              - 'null'
                    options:
                      type: array
                      description: Product options
                      items:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          name:
                            type: string
                            example: Color
                          option_values:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1
                                name:
                                  type: string
                                  example: Red
                    variants:
                      type: array
                      description: Product variants
                      items:
                        type: object
                        description: >-
                          Variant object with pricing and availability
                          information
                    search_engine_optimizer:
                      type:
                        - object
                        - 'null'
                      description: SEO metadata
                      properties:
                        id:
                          type: integer
                          example: 1
                        title:
                          type:
                            - string
                            - 'null'
                        description:
                          type:
                            - string
                            - 'null'
                        image_url:
                          type:
                            - string
                            - 'null'
                        image_path:
                          type:
                            - string
                            - 'null'
                        block_crawler:
                          type: boolean
                    product_subscription_plans:
                      type: array
                      description: Available subscription plans
                      items:
                        type: object
                        properties:
                          id:
                            type: integer
                            example: 1
                          default:
                            type: boolean
                          active:
                            type: boolean
                          subscription_plan:
                            type: object
                          products_count:
                            type: integer
                          subscribers_count:
                            type: integer
                    product_bundles:
                      type: array
                      description: Product bundles
                    tax_category:
                      type:
                        - object
                        - 'null'
                      description: Tax category information
                    metafields:
                      type: array
                      description: Product metafields
                    metafields_collection:
                      type: array
                      description: Product metafields collection with key and value
                      items:
                        type: object
                        properties:
                          key:
                            type: string
                          value: {}
                  required:
                    - id
                    - active
                    - title
                    - review_count
                    - views
                    - leads
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Company not found
        '500':
          description: internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Internal server error
  /api/v2025-06/sitemap:
    get:
      summary: Get sitemap URLs
      tags:
        - Sitemap
      description: Retrieves paginated sitemap URLs for the current company
      security:
        - bearer_auth: []
      parameters:
        - name: page
          in: query
          required: false
          description: 'Page number (default: 1)'
          schema:
            type: integer
        - name: per_page
          in: query
          required: false
          description: 'Number of URLs per page (default: 50, max: 100)'
          schema:
            type: integer
      responses:
        '200':
          description: Sitemap URLs retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  urls:
                    type: array
                    items:
                      type: object
                      properties:
                        url:
                          type: string
                          example: https://example.com/about
                        default_resource:
                          oneOf:
                            - type: object
                              properties:
                                title:
                                  type: string
                                image_url:
                                  type: string
                            - type: string
                        country_routes:
                          type: array
                          items:
                            type: string
                        active:
                          type: boolean
                          example: true
                  disabled:
                    type: boolean
                    example: false
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: req_123456789
                      timestamp:
                        type: string
                        example: '2024-01-15T10:30:00Z'
                      pagination:
                        type: object
                        properties:
                          current_page:
                            type: integer
                            example: 1
                          total_pages:
                            type: integer
                            example: 5
                          total_count:
                            type: integer
                            example: 100
                          per_page:
                            type: integer
                            example: 50
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
    patch:
      summary: Update sitemap URL visibility
      tags:
        - Sitemap
      description: Updates the visibility of a single URL in the company sitemap
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: Sitemap URL updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  sitemap:
                    type: object
                    properties:
                      hidden_urls:
                        type: array
                        items:
                          type: string
                        example:
                          - products/123
                        description: Array of all hidden URL paths in the sitemap
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: req_123456789
                      timestamp:
                        type: string
                        example: '2024-01-15T10:30:00Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '422':
          description: Unprocessable Entity - Invalid parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameters
                  errors:
                    type: object
                    properties:
                      url:
                        type: array
                        items:
                          type: string
                      active:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  example: products/123
                  description: URL path to update in the sitemap
                active:
                  type: boolean
                  example: true
                  description: >-
                    Whether the URL should be active (visible) in the sitemap.
                    Set to false to hide, true to show.
              required:
                - url
                - active
  /api/settings/social_media:
    get:
      summary: Retrieves social media settings
      tags:
        - Social Media
      description: Retrieve the social media settings for the company.
      security:
        - bearer_auth: []
      parameters:
        - name: Authorization
          in: header
          schema:
            type: string
      responses:
        '200':
          description: Social media settings found
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                    example: 123
                  name:
                    type: string
                    example: Acme, Inc.
                  facebook:
                    type:
                      - string
                      - 'null'
                    example: https://facebook.com/company
                  instagram:
                    type:
                      - string
                      - 'null'
                    example: https://instagram.com/company
                  linkedin:
                    type:
                      - string
                      - 'null'
                    example: https://linkedin.com/company
                  pinterest:
                    type:
                      - string
                      - 'null'
                    example: https://pinterest.com/company
                  tiktok:
                    type:
                      - string
                      - 'null'
                    example: https://tiktok.com/@company
                  twitter:
                    type:
                      - string
                      - 'null'
                    example: https://twitter.com/company
                  youtube:
                    type:
                      - string
                      - 'null'
                    example: https://youtube.com/company
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date_time
                required:
                  - id
    put:
      summary: Updates social media settings
      tags:
        - Social Media
      parameters:
        - name: Authorization
          in: header
          schema:
            type: string
      responses:
        '200':
          description: Social media settings updated with a new social media account
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  name:
                    type: string
                  facebook:
                    type:
                      - string
                      - 'null'
                  twitter:
                    type:
                      - string
                      - 'null'
                  instagram:
                    type:
                      - string
                      - 'null'
                  linkedin:
                    type:
                      - string
                      - 'null'
                  pinterest:
                    type:
                      - string
                      - 'null'
                  tiktok:
                    type:
                      - string
                      - 'null'
                  youtube:
                    type:
                      - string
                      - 'null'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date_time
                required:
                  - id
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                social_media:
                  type: object
                  properties:
                    name:
                      type: string
                      example: Acme, Inc.
                    facebook:
                      type:
                        - string
                        - 'null'
                      example: https://facebook.com/updated
                    twitter:
                      type:
                        - string
                        - 'null'
                      example: https://twitter.com/updated
                    instagram:
                      type:
                        - string
                        - 'null'
                      example: https://instagram.com/new
                    linkedin:
                      type:
                        - string
                        - 'null'
                      example: https://linkedin.com/updated
                    pinterest:
                      type:
                        - string
                        - 'null'
                      example: https://pinterest.com/updated
                    tiktok:
                      type:
                        - string
                        - 'null'
                      example: https://tiktok.com/@updated
                    youtube:
                      type:
                        - string
                        - 'null'
                      example: https://youtube.com/updated
              required:
                - social_media
  /api/domains/{domain_id}/subdomains:
    get:
      summary: Lists subdomains
      tags:
        - Subdomains
      operationId: listSubdomains
      security:
        - bearer_auth: []
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  subdomains:
                    type: array
                    items:
                      type: object
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Domain not found
                  errors:
                    type: object
                    example:
                      domain_id:
                        - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
    post:
      summary: Create subdomain
      description: Create a new subdomain
      tags:
        - Subdomains
      operationId: createSubdomain
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: created
          content:
            application/json:
              schema:
                type: object
                properties:
                  subdomain:
                    type: object
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '422':
          description: unprocessable entity - apex domain mismatch
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: unprocessable entity
                  errors:
                    type: object
                    example:
                      domain:
                        hostname:
                          - must be a subdomain of acme.test
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                domain:
                  type: object
                  properties:
                    hostname:
                      type: string
                      example: beta.acme.test
                  required:
                    - hostname
              required:
                - domain
    parameters:
      - name: domain_id
        in: path
        required: true
        schema:
          type: integer
  /api/subscription_plans:
    get:
      summary: List of subscription plans
      description: List all subscription plans
      tags:
        - Subscription Plans
      operationId: listSubscriptionPlans
      security:
        - bearer_auth: []
      parameters:
        - name: pagination
          in: query
          schema:
            type: object
            properties:
              page:
                type: integer
                exclusiveMinimum: 0
              per_page:
                type: integer
                exclusiveMinimum: 0
                maximum: 100
              active:
                type: boolean
              search_query:
                type: string
              sorted_by:
                type: string
              sort_direction:
                type: string
              product:
                type: integer
            required: []
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription_plans:
                    type: array
                    items:
                      title: Commerce::SubscriptionPlan
                      type: object
                      properties:
                        id:
                          type: integer
                        name:
                          example: Test Subscription Plan
                          type: string
                        billing_interval:
                          example: 1
                          type: integer
                          default: 1
                          minimum: 1
                          maximum: 29
                        billing_interval_unit:
                          description: 'Possible values: `day`, `week`, `month`, `year`'
                          example: day
                          type: string
                          default: month
                        billing_frequency_in_words:
                          example: 2 Months
                          type: string
                        shipping_interval:
                          example: 1
                          type: integer
                          default: 1
                          minimum: 1
                          maximum: 29
                        shipping_interval_unit:
                          description: 'Possible values: `day`, `week`, `month`, `year`'
                          example: day
                          type: string
                          default: month
                        volume_interval:
                          example: 1
                          type: integer
                          default: 1
                          minimum: 1
                          maximum: 29
                        volume_interval_unit:
                          description: 'Possible values: `day`, `week`, `month`, `year`'
                          example: day
                          type: string
                          default: month
                        trial_period:
                          example: 1
                          type:
                            - integer
                            - 'null'
                          minimum: 1
                        trial_period_unit:
                          description: 'Possible values: `day`, `week`, `month`, `year`'
                          example: day
                          type:
                            - string
                            - 'null'
                        split_volume:
                          example: true
                          type: boolean
                          default: false
                        allow_skipping:
                          example: true
                          type:
                            - boolean
                            - 'null'
                          default: true
                        max_skips:
                          example: 1
                          type:
                            - integer
                            - 'null'
                          minimum: 1
                        allow_max_billing_cycles:
                          example: true
                          type: boolean
                          default: false
                        max_billing_cycles:
                          example: 3
                          type:
                            - integer
                            - 'null'
                        price_adjustment_type:
                          example: percentage or fixed_amount
                          type:
                            - string
                            - 'null'
                        price_adjustment_amount:
                          example: 10
                          type:
                            - number
                            - 'null'
                        active:
                          example: true
                          type:
                            - boolean
                            - 'null'
                          default: true
                        company_default:
                          example: false
                          type:
                            - boolean
                            - 'null'
                          default: false
                        created_at:
                          example: '2025-03-10T00:00:00Z'
                          type: string
                          format: date-time
                        updated_at:
                          example: '2025-03-10T00:00:00Z'
                          type: string
                          format: date-time
                        products_count:
                          example: 10
                          type:
                            - integer
                            - 'null'
                        subscribers_count:
                          example: 10
                          type:
                            - integer
                            - 'null'
                        company:
                          title: Company
                          type: object
                          properties:
                            id:
                              type: integer
                            name:
                              example: Acme, Inc.
                              type: string
                          required:
                            - id
                            - name
                        subscriptions:
                          type: array
                          items:
                            title: Commerce::Subscription
                            type: object
                            properties:
                              id:
                                type: integer
                            required:
                              - id
                        products:
                          type: array
                          items:
                            title: Product
                            type: object
                            properties:
                              id:
                                type: integer
                            required:
                              - id
                      required:
                        - id
                        - name
                        - billing_interval
                        - billing_interval_unit
                        - billing_frequency_in_words
                        - shipping_interval
                        - shipping_interval_unit
                        - volume_interval
                        - volume_interval_unit
                        - split_volume
                        - allow_max_billing_cycles
                        - created_at
                        - updated_at
                        - company
                        - subscriptions
                        - products
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      pagination:
                        type: object
                        properties:
                          current_page:
                            type: integer
                            example: 1
                          total_pages:
                            type: integer
                            example: 10
                          total_count:
                            type: integer
                            example: 100
                          per_page:
                            type: integer
                            example: 10
                      bundle_subscriptions_for_company:
                        type: boolean
                        example: true
                required:
                  - subscription_plans
    post:
      summary: Create a subscription plan
      description: Create a subscription plan
      tags:
        - Subscription Plans
      operationId: createSubscriptionPlan
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription_plan:
                    title: Commerce::SubscriptionPlan
                    type: object
                    properties:
                      id:
                        type: integer
                      name:
                        example: Test Subscription Plan
                        type: string
                      billing_interval:
                        example: 1
                        type: integer
                        default: 1
                        minimum: 1
                        maximum: 29
                      billing_interval_unit:
                        description: 'Possible values: `day`, `week`, `month`, `year`'
                        example: day
                        type: string
                        default: month
                      billing_frequency_in_words:
                        example: 2 Months
                        type: string
                      shipping_interval:
                        example: 1
                        type: integer
                        default: 1
                        minimum: 1
                        maximum: 29
                      shipping_interval_unit:
                        description: 'Possible values: `day`, `week`, `month`, `year`'
                        example: day
                        type: string
                        default: month
                      volume_interval:
                        example: 1
                        type: integer
                        default: 1
                        minimum: 1
                        maximum: 29
                      volume_interval_unit:
                        description: 'Possible values: `day`, `week`, `month`, `year`'
                        example: day
                        type: string
                        default: month
                      trial_period:
                        example: 1
                        type:
                          - integer
                          - 'null'
                        minimum: 1
                      trial_period_unit:
                        description: 'Possible values: `day`, `week`, `month`, `year`'
                        example: day
                        type:
                          - string
                          - 'null'
                      split_volume:
                        example: true
                        type: boolean
                        default: false
                      allow_skipping:
                        example: true
                        type:
                          - boolean
                          - 'null'
                        default: true
                      max_skips:
                        example: 1
                        type:
                          - integer
                          - 'null'
                        minimum: 1
                      allow_max_billing_cycles:
                        example: true
                        type: boolean
                        default: false
                      max_billing_cycles:
                        example: 3
                        type:
                          - integer
                          - 'null'
                      price_adjustment_type:
                        example: percentage or fixed_amount
                        type:
                          - string
                          - 'null'
                      price_adjustment_amount:
                        example: 10
                        type:
                          - number
                          - 'null'
                      active:
                        example: true
                        type:
                          - boolean
                          - 'null'
                        default: true
                      company_default:
                        example: false
                        type:
                          - boolean
                          - 'null'
                        default: false
                      created_at:
                        example: '2025-03-10T00:00:00Z'
                        type: string
                        format: date-time
                      updated_at:
                        example: '2025-03-10T00:00:00Z'
                        type: string
                        format: date-time
                      products_count:
                        example: 10
                        type:
                          - integer
                          - 'null'
                      subscribers_count:
                        example: 10
                        type:
                          - integer
                          - 'null'
                      company:
                        title: Company
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: Acme, Inc.
                            type: string
                        required:
                          - id
                          - name
                      subscriptions:
                        type: array
                        items:
                          title: Commerce::Subscription
                          type: object
                          properties:
                            id:
                              type: integer
                          required:
                            - id
                      products:
                        type: array
                        items:
                          title: Product
                          type: object
                          properties:
                            id:
                              type: integer
                          required:
                            - id
                    required:
                      - id
                      - name
                      - billing_interval
                      - billing_interval_unit
                      - billing_frequency_in_words
                      - shipping_interval
                      - shipping_interval_unit
                      - volume_interval
                      - volume_interval_unit
                      - split_volume
                      - allow_max_billing_cycles
                      - created_at
                      - updated_at
                      - company
                      - subscriptions
                      - products
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - subscription_plan
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                subscription_plan:
                  type: object
                  properties:
                    name:
                      type: string
                    billing_interval:
                      type: integer
                    billing_interval_unit:
                      type: string
                      enum:
                        - day
                        - week
                        - month
                        - year
                    shipping_interval:
                      type: integer
                    shipping_interval_unit:
                      type: string
                      enum:
                        - day
                        - week
                        - month
                        - year
                    volume_interval:
                      type: integer
                    volume_interval_unit:
                      type: string
                      enum:
                        - day
                        - week
                        - month
                        - year
                    trial_period:
                      type: integer
                    trial_period_unit:
                      type: string
                      enum:
                        - day
                        - week
                        - month
                        - year
                    allow_skipping:
                      type: boolean
                    max_skips:
                      type: integer
                    allow_max_billing_cycles:
                      type: boolean
                    max_billing_cycles:
                      type: integer
                    split_volume:
                      type: boolean
                    price_adjustment_type:
                      type: string
                    price_adjustment_amount:
                      type: number
                    active:
                      type: boolean
                    company_default:
                      type: boolean
                  required:
                    - name
                    - billing_interval
                    - billing_interval_unit
                    - shipping_interval
                    - shipping_interval_unit
                    - volume_interval
                    - volume_interval_unit
                product_subscription_plans:
                  type: object
                  properties:
                    product_id:
                      type: integer
                    default:
                      type: boolean
                  required: []
              required:
                - subscription_plan
  /api/subscription_plans/{id}:
    get:
      summary: Show a subscription plan
      description: Show a subscription plan
      tags:
        - Subscription Plans
      operationId: showSubscriptionPlan
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription_plan:
                    title: Commerce::SubscriptionPlan
                    type: object
                    properties:
                      id:
                        type: integer
                      name:
                        example: Test Subscription Plan
                        type: string
                      billing_interval:
                        example: 1
                        type: integer
                        default: 1
                        minimum: 1
                        maximum: 29
                      billing_interval_unit:
                        description: 'Possible values: `day`, `week`, `month`, `year`'
                        example: day
                        type: string
                        default: month
                      billing_frequency_in_words:
                        example: 2 Months
                        type: string
                      shipping_interval:
                        example: 1
                        type: integer
                        default: 1
                        minimum: 1
                        maximum: 29
                      shipping_interval_unit:
                        description: 'Possible values: `day`, `week`, `month`, `year`'
                        example: day
                        type: string
                        default: month
                      volume_interval:
                        example: 1
                        type: integer
                        default: 1
                        minimum: 1
                        maximum: 29
                      volume_interval_unit:
                        description: 'Possible values: `day`, `week`, `month`, `year`'
                        example: day
                        type: string
                        default: month
                      trial_period:
                        example: 1
                        type:
                          - integer
                          - 'null'
                        minimum: 1
                      trial_period_unit:
                        description: 'Possible values: `day`, `week`, `month`, `year`'
                        example: day
                        type:
                          - string
                          - 'null'
                      split_volume:
                        example: true
                        type: boolean
                        default: false
                      allow_skipping:
                        example: true
                        type:
                          - boolean
                          - 'null'
                        default: true
                      max_skips:
                        example: 1
                        type:
                          - integer
                          - 'null'
                        minimum: 1
                      allow_max_billing_cycles:
                        example: true
                        type: boolean
                        default: false
                      max_billing_cycles:
                        example: 3
                        type:
                          - integer
                          - 'null'
                      price_adjustment_type:
                        example: percentage or fixed_amount
                        type:
                          - string
                          - 'null'
                      price_adjustment_amount:
                        example: 10
                        type:
                          - number
                          - 'null'
                      active:
                        example: true
                        type:
                          - boolean
                          - 'null'
                        default: true
                      company_default:
                        example: false
                        type:
                          - boolean
                          - 'null'
                        default: false
                      created_at:
                        example: '2025-03-10T00:00:00Z'
                        type: string
                        format: date-time
                      updated_at:
                        example: '2025-03-10T00:00:00Z'
                        type: string
                        format: date-time
                      products_count:
                        example: 10
                        type:
                          - integer
                          - 'null'
                      subscribers_count:
                        example: 10
                        type:
                          - integer
                          - 'null'
                      company:
                        title: Company
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: Acme, Inc.
                            type: string
                        required:
                          - id
                          - name
                      subscriptions:
                        type: array
                        items:
                          title: Commerce::Subscription
                          type: object
                          properties:
                            id:
                              type: integer
                          required:
                            - id
                      products:
                        type: array
                        items:
                          title: Product
                          type: object
                          properties:
                            id:
                              type: integer
                          required:
                            - id
                    required:
                      - id
                      - name
                      - billing_interval
                      - billing_interval_unit
                      - billing_frequency_in_words
                      - shipping_interval
                      - shipping_interval_unit
                      - volume_interval
                      - volume_interval_unit
                      - split_volume
                      - allow_max_billing_cycles
                      - created_at
                      - updated_at
                      - company
                      - subscriptions
                      - products
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - subscription_plan
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
    put:
      summary: Update a subscription plan
      description: Update a subscription plan
      tags:
        - Subscription Plans
      operationId: updateSubscriptionPlan
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription_plan:
                    title: Commerce::SubscriptionPlan
                    type: object
                    properties:
                      id:
                        type: integer
                      name:
                        example: Test Subscription Plan
                        type: string
                      billing_interval:
                        example: 1
                        type: integer
                        default: 1
                        minimum: 1
                        maximum: 29
                      billing_interval_unit:
                        description: 'Possible values: `day`, `week`, `month`, `year`'
                        example: day
                        type: string
                        default: month
                      billing_frequency_in_words:
                        example: 2 Months
                        type: string
                      shipping_interval:
                        example: 1
                        type: integer
                        default: 1
                        minimum: 1
                        maximum: 29
                      shipping_interval_unit:
                        description: 'Possible values: `day`, `week`, `month`, `year`'
                        example: day
                        type: string
                        default: month
                      volume_interval:
                        example: 1
                        type: integer
                        default: 1
                        minimum: 1
                        maximum: 29
                      volume_interval_unit:
                        description: 'Possible values: `day`, `week`, `month`, `year`'
                        example: day
                        type: string
                        default: month
                      trial_period:
                        example: 1
                        type:
                          - integer
                          - 'null'
                        minimum: 1
                      trial_period_unit:
                        description: 'Possible values: `day`, `week`, `month`, `year`'
                        example: day
                        type:
                          - string
                          - 'null'
                      split_volume:
                        example: true
                        type: boolean
                        default: false
                      allow_skipping:
                        example: true
                        type:
                          - boolean
                          - 'null'
                        default: true
                      max_skips:
                        example: 1
                        type:
                          - integer
                          - 'null'
                        minimum: 1
                      allow_max_billing_cycles:
                        example: true
                        type: boolean
                        default: false
                      max_billing_cycles:
                        example: 3
                        type:
                          - integer
                          - 'null'
                      price_adjustment_type:
                        example: percentage or fixed_amount
                        type:
                          - string
                          - 'null'
                      price_adjustment_amount:
                        example: 10
                        type:
                          - number
                          - 'null'
                      active:
                        example: true
                        type:
                          - boolean
                          - 'null'
                        default: true
                      company_default:
                        example: false
                        type:
                          - boolean
                          - 'null'
                        default: false
                      created_at:
                        example: '2025-03-10T00:00:00Z'
                        type: string
                        format: date-time
                      updated_at:
                        example: '2025-03-10T00:00:00Z'
                        type: string
                        format: date-time
                      products_count:
                        example: 10
                        type:
                          - integer
                          - 'null'
                      subscribers_count:
                        example: 10
                        type:
                          - integer
                          - 'null'
                      company:
                        title: Company
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: Acme, Inc.
                            type: string
                        required:
                          - id
                          - name
                      subscriptions:
                        type: array
                        items:
                          title: Commerce::Subscription
                          type: object
                          properties:
                            id:
                              type: integer
                          required:
                            - id
                      products:
                        type: array
                        items:
                          title: Product
                          type: object
                          properties:
                            id:
                              type: integer
                          required:
                            - id
                    required:
                      - id
                      - name
                      - billing_interval
                      - billing_interval_unit
                      - billing_frequency_in_words
                      - shipping_interval
                      - shipping_interval_unit
                      - volume_interval
                      - volume_interval_unit
                      - split_volume
                      - allow_max_billing_cycles
                      - created_at
                      - updated_at
                      - company
                      - subscriptions
                      - products
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - subscription_plan
        '403':
          description: forbidden - has active subscriptions
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                subscription_plan:
                  type: object
                  properties:
                    name:
                      type: string
                    billing_interval:
                      type: integer
                    billing_interval_unit:
                      type: string
                      enum:
                        - day
                        - week
                        - month
                        - year
                    shipping_interval:
                      type: integer
                    shipping_interval_unit:
                      type: string
                      enum:
                        - day
                        - week
                        - month
                        - year
                    volume_interval:
                      type: integer
                    volume_interval_unit:
                      type: string
                      enum:
                        - day
                        - week
                        - month
                        - year
                    trial_period:
                      type: integer
                    trial_period_unit:
                      type: string
                      enum:
                        - day
                        - week
                        - month
                        - year
                    allow_skipping:
                      type: boolean
                    max_skips:
                      type: integer
                    allow_max_billing_cycles:
                      type: boolean
                    max_billing_cycles:
                      type: integer
                    split_volume:
                      type: boolean
                    price_adjustment_type:
                      type: string
                    price_adjustment_amount:
                      type: number
                    active:
                      type: boolean
                    company_default:
                      type: boolean
                  required:
                    - name
                    - billing_interval
                    - billing_interval_unit
                    - shipping_interval
                    - shipping_interval_unit
                    - volume_interval
                    - volume_interval_unit
                product_subscription_plans:
                  type: object
                  properties:
                    id:
                      type: integer
                    product_id:
                      type: integer
                    default:
                      type: boolean
                    company_default:
                      type: boolean
                  required: []
                id:
                  type: integer
              required:
                - subscription_plan
                - id
    delete:
      summary: Delete a subscription plan
      description: Delete a subscription plan
      tags:
        - Subscription Plans
      operationId: destroySubscriptionPlan
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription_plan:
                    title: Commerce::SubscriptionPlan
                    type: object
                    properties:
                      id:
                        type: integer
                      name:
                        example: Test Subscription Plan
                        type: string
                      billing_interval:
                        example: 1
                        type: integer
                        default: 1
                        minimum: 1
                        maximum: 29
                      billing_interval_unit:
                        description: 'Possible values: `day`, `week`, `month`, `year`'
                        example: day
                        type: string
                        default: month
                      billing_frequency_in_words:
                        example: 2 Months
                        type: string
                      shipping_interval:
                        example: 1
                        type: integer
                        default: 1
                        minimum: 1
                        maximum: 29
                      shipping_interval_unit:
                        description: 'Possible values: `day`, `week`, `month`, `year`'
                        example: day
                        type: string
                        default: month
                      volume_interval:
                        example: 1
                        type: integer
                        default: 1
                        minimum: 1
                        maximum: 29
                      volume_interval_unit:
                        description: 'Possible values: `day`, `week`, `month`, `year`'
                        example: day
                        type: string
                        default: month
                      trial_period:
                        example: 1
                        type:
                          - integer
                          - 'null'
                        minimum: 1
                      trial_period_unit:
                        description: 'Possible values: `day`, `week`, `month`, `year`'
                        example: day
                        type:
                          - string
                          - 'null'
                      split_volume:
                        example: true
                        type: boolean
                        default: false
                      allow_skipping:
                        example: true
                        type:
                          - boolean
                          - 'null'
                        default: true
                      max_skips:
                        example: 1
                        type:
                          - integer
                          - 'null'
                        minimum: 1
                      allow_max_billing_cycles:
                        example: true
                        type: boolean
                        default: false
                      max_billing_cycles:
                        example: 3
                        type:
                          - integer
                          - 'null'
                      price_adjustment_type:
                        example: percentage or fixed_amount
                        type:
                          - string
                          - 'null'
                      price_adjustment_amount:
                        example: 10
                        type:
                          - number
                          - 'null'
                      active:
                        example: true
                        type:
                          - boolean
                          - 'null'
                        default: true
                      company_default:
                        example: false
                        type:
                          - boolean
                          - 'null'
                        default: false
                      created_at:
                        example: '2025-03-10T00:00:00Z'
                        type: string
                        format: date-time
                      updated_at:
                        example: '2025-03-10T00:00:00Z'
                        type: string
                        format: date-time
                      products_count:
                        example: 10
                        type:
                          - integer
                          - 'null'
                      subscribers_count:
                        example: 10
                        type:
                          - integer
                          - 'null'
                    required:
                      - id
                      - name
                      - billing_interval
                      - billing_interval_unit
                      - billing_frequency_in_words
                      - shipping_interval
                      - shipping_interval_unit
                      - volume_interval
                      - volume_interval_unit
                      - split_volume
                      - allow_max_billing_cycles
                      - created_at
                      - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - subscription_plan
        '403':
          description: forbidden - has active subscriptions
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/subscription_plans/{id}/remove_product:
    post:
      summary: Delete a product from subscription plan
      description: Delete a product from subscription plan
      tags:
        - Subscription Plans
      operationId: destroyProductFromSubscriptionPlan
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
        - name: product_id
          in: query
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription_plan:
                    title: Commerce::SubscriptionPlan
                    type: object
                    properties:
                      id:
                        type: integer
                      name:
                        example: Test Subscription Plan
                        type: string
                      billing_interval:
                        example: 1
                        type: integer
                        default: 1
                        minimum: 1
                        maximum: 29
                      billing_interval_unit:
                        description: 'Possible values: `day`, `week`, `month`, `year`'
                        example: day
                        type: string
                        default: month
                      billing_frequency_in_words:
                        example: 2 Months
                        type: string
                      shipping_interval:
                        example: 1
                        type: integer
                        default: 1
                        minimum: 1
                        maximum: 29
                      shipping_interval_unit:
                        description: 'Possible values: `day`, `week`, `month`, `year`'
                        example: day
                        type: string
                        default: month
                      volume_interval:
                        example: 1
                        type: integer
                        default: 1
                        minimum: 1
                        maximum: 29
                      volume_interval_unit:
                        description: 'Possible values: `day`, `week`, `month`, `year`'
                        example: day
                        type: string
                        default: month
                      trial_period:
                        example: 1
                        type:
                          - integer
                          - 'null'
                        minimum: 1
                      trial_period_unit:
                        description: 'Possible values: `day`, `week`, `month`, `year`'
                        example: day
                        type:
                          - string
                          - 'null'
                      split_volume:
                        example: true
                        type: boolean
                        default: false
                      allow_skipping:
                        example: true
                        type:
                          - boolean
                          - 'null'
                        default: true
                      max_skips:
                        example: 1
                        type:
                          - integer
                          - 'null'
                        minimum: 1
                      allow_max_billing_cycles:
                        example: true
                        type: boolean
                        default: false
                      max_billing_cycles:
                        example: 3
                        type:
                          - integer
                          - 'null'
                      price_adjustment_type:
                        example: percentage or fixed_amount
                        type:
                          - string
                          - 'null'
                      price_adjustment_amount:
                        example: 10
                        type:
                          - number
                          - 'null'
                      active:
                        example: true
                        type:
                          - boolean
                          - 'null'
                        default: true
                      company_default:
                        example: false
                        type:
                          - boolean
                          - 'null'
                        default: false
                      created_at:
                        example: '2025-03-10T00:00:00Z'
                        type: string
                        format: date-time
                      updated_at:
                        example: '2025-03-10T00:00:00Z'
                        type: string
                        format: date-time
                      products_count:
                        example: 10
                        type:
                          - integer
                          - 'null'
                      subscribers_count:
                        example: 10
                        type:
                          - integer
                          - 'null'
                    required:
                      - id
                      - name
                      - billing_interval
                      - billing_interval_unit
                      - billing_frequency_in_words
                      - shipping_interval
                      - shipping_interval_unit
                      - volume_interval
                      - volume_interval_unit
                      - split_volume
                      - allow_max_billing_cycles
                      - created_at
                      - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - subscription_plan
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/subscriptions:
    get:
      summary: List of subscriptions
      description: List all subscriptions
      tags:
        - Subscriptions
      operationId: listSubscriptions
      security:
        - bearer_auth: []
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
            default: 1
          description: Page number for pagination
        - name: per_page
          in: query
          required: false
          schema:
            type: integer
            default: 25
          description: Number of records per page
        - name: status
          in: query
          required: false
          description: >-
            Filter subscriptions by status (can be comma-separated for multiple
            values)
          schema:
            type: string
            enum:
              - pending
              - active
              - paused
              - past_due
              - cancelled
          example: active,cancelled
        - name: subscription_plan_id
          in: query
          required: false
          schema:
            type: integer
          description: Filter subscriptions by subscription plan ID
        - name: customer_id
          in: query
          required: false
          schema:
            type: integer
          description: Filter subscriptions by customer ID
        - name: within_days
          in: query
          required: false
          schema:
            type: integer
          description: Filter subscriptions within number of days (e.g., last 7 days)
        - name: frequency
          in: query
          required: false
          description: >-
            Filter subscriptions by billing frequency. Supported values: day,
            week, month, year
          schema:
            type: string
            enum:
              - day
              - week
              - month
              - year
        - name: subscription_number_min
          in: query
          required: false
          schema:
            type: integer
          description: Minimum subscription number for filtering
        - name: subscription_number_max
          in: query
          required: false
          schema:
            type: integer
          description: Maximum subscription number for filtering
        - name: amount_min
          in: query
          required: false
          schema:
            type: number
          description: Minimum amount for filtering
        - name: amount_max
          in: query
          required: false
          schema:
            type: number
          description: Maximum amount for filtering
        - name: created_start
          in: query
          required: false
          schema:
            type: string
            format: date
          description: 'Start date for created date range filter (format: YYYY-MM-DD)'
        - name: created_end
          in: query
          required: false
          schema:
            type: string
            format: date
          description: 'End date for created date range filter (format: YYYY-MM-DD)'
        - name: next_bill_start
          in: query
          required: false
          schema:
            type: string
            format: date
          description: 'Start date for next bill date range filter (format: YYYY-MM-DD)'
        - name: next_bill_end
          in: query
          required: false
          schema:
            type: string
            format: date
          description: 'End date for next bill date range filter (format: YYYY-MM-DD)'
        - name: last_bill_start
          in: query
          required: false
          schema:
            type: string
            format: date
          description: 'Start date for last bill date range filter (format: YYYY-MM-DD)'
        - name: last_bill_end
          in: query
          required: false
          schema:
            type: string
            format: date
          description: 'End date for last bill date range filter (format: YYYY-MM-DD)'
        - name: next_ship_start
          in: query
          required: false
          schema:
            type: string
            format: date
          description: 'Start date for next ship date range filter (format: YYYY-MM-DD)'
        - name: next_ship_end
          in: query
          required: false
          schema:
            type: string
            format: date
          description: 'End date for next ship date range filter (format: YYYY-MM-DD)'
        - name: last_ship_start
          in: query
          required: false
          schema:
            type: string
            format: date
          description: 'Start date for last ship date range filter (format: YYYY-MM-DD)'
        - name: last_ship_end
          in: query
          required: false
          schema:
            type: string
            format: date
          description: 'End date for last ship date range filter (format: YYYY-MM-DD)'
        - name: last_failed_start
          in: query
          required: false
          schema:
            type: string
            format: date
          description: 'Start date for last failed date range filter (format: YYYY-MM-DD)'
        - name: last_failed_end
          in: query
          required: false
          schema:
            type: string
            format: date
          description: 'End date for last failed date range filter (format: YYYY-MM-DD)'
        - name: cancelled_start
          in: query
          required: false
          schema:
            type: string
            format: date
          description: 'Start date for cancelled date range filter (format: YYYY-MM-DD)'
        - name: cancelled_end
          in: query
          required: false
          schema:
            type: string
            format: date
          description: 'End date for cancelled date range filter (format: YYYY-MM-DD)'
        - name: sort_by
          in: query
          required: false
          description: Sort field for subscriptions
          schema:
            type: string
            enum:
              - created_at
              - id
              - next_bill_date
              - customer
              - last_bill_date
              - product
              - amount
              - status
              - frequency
        - name: sort_direction
          in: query
          required: false
          description: Sort direction
          schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
        - name: search
          in: query
          required: false
          schema:
            type: string
          description: >-
            Search term for subscriptions(searches across subscription plan
            names, customer details, and product titles)
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscriptions:
                    type: array
                    items:
                      title: Commerce::Subscription
                      type: object
                      properties:
                        id:
                          type: integer
                        subscription_token:
                          example: sb_1234567890
                          type: string
                        next_bill_date:
                          example: '2025-03-10T00:00:00Z'
                          type:
                            - string
                            - 'null'
                        last_bill_date:
                          example: '2025-03-10T00:00:00Z'
                          type:
                            - string
                            - 'null'
                          format: date-time
                        next_ship_date:
                          example: '2025-03-10T00:00:00Z'
                          type:
                            - string
                            - 'null'
                          format: date-time
                        last_ship_date:
                          example: '2025-03-10T00:00:00Z'
                          type:
                            - string
                            - 'null'
                          format: date-time
                        status:
                          example: active
                          type: string
                          enum:
                            - pending
                            - active
                            - paused
                            - past_due
                            - cancelled
                        disabled:
                          example: false
                          type:
                            - boolean
                            - 'null'
                          default: false
                        quantity:
                          example: 1
                          type: integer
                          default: 1
                          minimum: 1
                        price:
                          example: 100
                          type: number
                        original_price:
                          example: 100
                          type: number
                        attempts:
                          example: 1
                          type:
                            - integer
                            - 'null'
                          default: 0
                        last_failed_at:
                          example: '2025-03-10T00:00:00Z'
                          type:
                            - string
                            - 'null'
                          format: date-time
                        next_retry_at:
                          example: '2025-03-10T00:00:00Z'
                          type:
                            - string
                            - 'null'
                          format: date-time
                        skipped_count:
                          example: 1
                          type:
                            - integer
                            - 'null'
                          default: 0
                        max_skips:
                          example: 1
                          type:
                            - integer
                            - 'null'
                        cancelled_at:
                          example: '2025-03-10T00:00:00Z'
                          type:
                            - string
                            - 'null'
                          format: date-time
                        created_at:
                          example: '2025-03-10T00:00:00Z'
                          type: string
                          format: date-time
                        updated_at:
                          example: '2025-03-10T00:00:00Z'
                          type: string
                          format: date-time
                        notes:
                          example: This is a sample commerce subscription
                          type:
                            - string
                            - 'null'
                        cv_total:
                          example: 100
                          type: integer
                        qv_total:
                          example: 50
                          type: integer
                        subscription_plan:
                          title: Commerce::SubscriptionPlan
                          type: object
                          properties:
                            id:
                              type: integer
                            name:
                              example: Test Subscription Plan
                              type: string
                            billing_interval:
                              example: 1
                              type: integer
                              default: 1
                              minimum: 1
                              maximum: 29
                            billing_interval_unit:
                              description: 'Possible values: `day`, `week`, `month`, `year`'
                              example: day
                              type: string
                              default: month
                            billing_frequency_in_words:
                              example: 2 Months
                              type: string
                            shipping_interval:
                              example: 1
                              type: integer
                              default: 1
                              minimum: 1
                              maximum: 29
                            shipping_interval_unit:
                              description: 'Possible values: `day`, `week`, `month`, `year`'
                              example: day
                              type: string
                              default: month
                            volume_interval:
                              example: 1
                              type: integer
                              default: 1
                              minimum: 1
                              maximum: 29
                            volume_interval_unit:
                              description: 'Possible values: `day`, `week`, `month`, `year`'
                              example: day
                              type: string
                              default: month
                            trial_period:
                              example: 1
                              type:
                                - integer
                                - 'null'
                              minimum: 1
                            trial_period_unit:
                              description: 'Possible values: `day`, `week`, `month`, `year`'
                              example: day
                              type:
                                - string
                                - 'null'
                            split_volume:
                              example: true
                              type: boolean
                              default: false
                            allow_skipping:
                              example: true
                              type:
                                - boolean
                                - 'null'
                              default: true
                            max_skips:
                              example: 1
                              type:
                                - integer
                                - 'null'
                              minimum: 1
                            allow_max_billing_cycles:
                              example: true
                              type: boolean
                              default: false
                            max_billing_cycles:
                              example: 3
                              type:
                                - integer
                                - 'null'
                            price_adjustment_type:
                              example: percentage or fixed_amount
                              type:
                                - string
                                - 'null'
                            price_adjustment_amount:
                              example: 10
                              type:
                                - number
                                - 'null'
                            active:
                              example: true
                              type:
                                - boolean
                                - 'null'
                              default: true
                            company_default:
                              example: false
                              type:
                                - boolean
                                - 'null'
                              default: false
                            created_at:
                              example: '2025-03-10T00:00:00Z'
                              type: string
                              format: date-time
                            updated_at:
                              example: '2025-03-10T00:00:00Z'
                              type: string
                              format: date-time
                            products_count:
                              example: 10
                              type:
                                - integer
                                - 'null'
                            subscribers_count:
                              example: 10
                              type:
                                - integer
                                - 'null'
                          required:
                            - id
                            - name
                            - billing_interval
                            - billing_interval_unit
                            - billing_frequency_in_words
                            - shipping_interval
                            - shipping_interval_unit
                            - volume_interval
                            - volume_interval_unit
                            - split_volume
                            - allow_max_billing_cycles
                            - created_at
                            - updated_at
                        variant:
                          oneOf:
                            - type: 'null'
                            - type: object
                              properties:
                                id:
                                  type: integer
                                  example: 1
                                title:
                                  type:
                                    - string
                                    - 'null'
                                  example: Sample Variant
                                image_path:
                                  type:
                                    - string
                                    - 'null'
                                  example: /images/sample.png
                                image_url:
                                  type:
                                    - string
                                    - 'null'
                                  example: https://example.com/images/sample.png
                                primary_image:
                                  type:
                                    - string
                                    - 'null'
                                  example: https://example.com/images/primary.png
                                price:
                                  type:
                                    - string
                                    - 'null'
                                  example: '34.44'
                                price_in_currency:
                                  type:
                                    - string
                                    - 'null'
                                  example: $34.44
                                sku:
                                  type:
                                    - string
                                    - 'null'
                                  example: SKU12345
                                options:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      title:
                                        type: string
                                        example: Size
                                      value:
                                        type: string
                                        example: XL
                                product:
                                  type: object
                                  properties:
                                    id:
                                      type: integer
                                      example: 1
                                    title:
                                      type: string
                                      example: Sample Product
                                    introduction:
                                      type:
                                        - string
                                        - 'null'
                                      example: Sample Short Description
                                    cv:
                                      type: integer
                                      example: 10
                                    cv_in_currency:
                                      type: string
                                      example: $10.00
                                    external_id:
                                      type:
                                        - string
                                        - 'null'
                                      example: ext-prod-123
                                    image_path:
                                      type:
                                        - string
                                        - 'null'
                                      example: /images/product.png
                                    image_url:
                                      type:
                                        - string
                                        - 'null'
                                      example: https://example.com/images/product.png
                                    price:
                                      type: string
                                      example: '29.99'
                                    price_in_currency:
                                      type: string
                                      example: $29.99
                                    sku:
                                      type:
                                        - string
                                        - 'null'
                                      example: SKU12345
                                    tax:
                                      type: string
                                      example: '2.99'
                                    tax_in_currency:
                                      type: string
                                      example: $2.99
                                    metadata:
                                      type: object
                                      example:
                                        shopify_product_id: 9876054868270
                                    metafields:
                                      type: array
                                      items:
                                        title: LegacyMetafield
                                        type: object
                                        properties:
                                          namespace:
                                            description: >-
                                              A container for related metafields.
                                              Commonly used to group metafields by app
                                              or functionality.
                                            example: custom
                                            type: string
                                            maxLength: 20
                                            pattern: ^[a-zA-Z0-9_]+$
                                          key:
                                            description: >-
                                              The unique identifier for the metafield
                                              within its namespace. Must be unique per
                                              namespace and owner.
                                            example: material
                                            type: string
                                            maxLength: 30
                                            pattern: ^[a-zA-Z0-9_]+$
                                          value:
                                            description: >-
                                              The actual data stored in the metafield.
                                              Type depends on value_type.
                                            example: cotton
                                            type:
                                              - string
                                              - integer
                                              - object
                                              - boolean
                                              - number
                                          value_type:
                                            description: >-
                                              The data type that defines how the value
                                              should be interpreted and validated.
                                            example: single_line_text_field
                                            type: string
                                          description:
                                            description: >-
                                              Optional human-readable description
                                              explaining the purpose of this
                                              metafield.
                                            example: >-
                                              The primary material used in this
                                              product
                                            type:
                                              - string
                                              - 'null'
                                          created_at:
                                            description: >-
                                              Timestamp when the metafield was
                                              created.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          updated_at:
                                            description: >-
                                              Timestamp when the metafield was last
                                              updated.
                                            example: '2021-01-01T00:00:00Z'
                                            type: string
                                            format: date-time
                                          locked:
                                            description: >-
                                              Whether this metafield is locked and
                                              cannot be updated or deleted directly.
                                            example: false
                                            type:
                                              - boolean
                                              - 'null'
                                              - 'null'
                                          metafield_definition:
                                            description: >-
                                              The definition that defines validation
                                              rules and structure for this metafield
                                            type:
                                              - 'null'
                                              - object
                                        required:
                                          - namespace
                                          - key
                                          - value
                                          - value_type
                                          - description
                                          - created_at
                                          - updated_at
                                          - metafield_definition
                        customer:
                          title: Customer
                          type: object
                          properties:
                            id:
                              type: integer
                            account_id:
                              type:
                                - string
                                - 'null'
                            first_name:
                              type:
                                - string
                                - 'null'
                            last_name:
                              type:
                                - string
                                - 'null'
                            full_name:
                              type: string
                            email:
                              type: string
                              pattern: >-
                                ^[a-zA-Z0-9.!\#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$
                            verified_email:
                              type:
                                - boolean
                                - 'null'
                              default: false
                            phone:
                              type:
                                - string
                                - 'null'
                            orders_count:
                              type:
                                - integer
                                - 'null'
                              default: 0
                            created_at:
                              type: string
                              format: date-time
                            display_total_spent:
                              type: string
                            metadata:
                              type: object
                              default: '{}'
                            user_company_id:
                              type:
                                - integer
                                - 'null'
                            external_id:
                              type:
                                - string
                                - 'null'
                            role:
                              type: string
                              enum:
                                - customer
                                - preferred_customer
                                - rep
                            last_order_id:
                              example: 101
                              type:
                                - integer
                                - 'null'
                            notes:
                              example: This is a note
                              type:
                                - string
                                - 'null'
                            active:
                              type: boolean
                            total_spent:
                              example: 100
                              type:
                                - number
                                - string
                            customer_notes:
                              type: array
                              items:
                                title: CustomerNote
                                type: object
                                properties:
                                  id:
                                    type: integer
                                  note:
                                    type: string
                                  user_company_id:
                                    type:
                                      - integer
                                      - 'null'
                                  customer_id:
                                    type: integer
                                  resource_id:
                                    type:
                                      - integer
                                      - 'null'
                                  resource_type:
                                    type:
                                      - string
                                      - 'null'
                                  created_at:
                                    type: string
                                    format: date-time
                                required:
                                  - id
                                  - note
                                  - customer_id
                                  - created_at
                            default_address:
                              title: Address
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                name:
                                  example: John Doe
                                  type: string
                                address1:
                                  example: 123 Main St
                                  type: string
                                address2:
                                  example: Apt 4B
                                  type:
                                    - string
                                    - 'null'
                                address3:
                                  example: Building 5
                                  type:
                                    - string
                                    - 'null'
                                city:
                                  example: New York
                                  type: string
                                state:
                                  example: NY
                                  type: string
                                subdivision_code:
                                  example: NY
                                  type:
                                    - string
                                    - 'null'
                                postal_code:
                                  example: '10001'
                                  type: string
                                country_code:
                                  example: US
                                  type:
                                    - string
                                    - 'null'
                                default:
                                  description: >-
                                    Use this address by default when there are
                                    multiple addresses
                                  example: true
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                first_name:
                                  example: John
                                  type: string
                                last_name:
                                  example: Doe
                                  type: string
                              required:
                                - id
                                - name
                                - address1
                                - city
                                - state
                                - postal_code
                                - first_name
                                - last_name
                            addresses:
                              type: array
                            payment_methods:
                              type: array
                            is_rep:
                              example: true
                              type: boolean
                            is_discarded:
                              example: false
                              type: boolean
                          required:
                            - id
                            - full_name
                            - email
                            - created_at
                            - display_total_spent
                            - metadata
                            - role
                            - active
                            - total_spent
                            - customer_notes
                            - addresses
                            - payment_methods
                            - is_rep
                            - is_discarded
                        currency:
                          title: Currency
                          type: object
                          properties:
                            id:
                              type: integer
                            name:
                              example: United States Dollar
                              type:
                                - string
                                - 'null'
                            code:
                              example: USD
                              type: string
                            rate:
                              example: 1
                              type:
                                - number
                                - string
                                - 'null'
                            active:
                              example: true
                              type:
                                - boolean
                                - 'null'
                              default: false
                            symbol:
                              example: $
                              type:
                                - string
                                - 'null'
                          required:
                            - id
                            - code
                      required:
                        - id
                        - subscription_token
                        - next_bill_date
                        - status
                        - quantity
                        - price
                        - original_price
                        - created_at
                        - updated_at
                        - cv_total
                        - qv_total
                        - subscription_plan
                        - variant
                        - customer
                        - currency
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      pagination:
                        type: object
                        properties:
                          current_page:
                            type: integer
                            example: 1
                          total_pages:
                            type: integer
                            example: 10
                          total_count:
                            type: integer
                            example: 100
                          per_page:
                            type: integer
                            example: 10
                      stats:
                        type: object
                        properties:
                          total_count:
                            type: integer
                            example: 100
                          active_count:
                            type: integer
                            example: 80
                          average_order_value:
                            type: number
                            example: 150
                          churn_rate:
                            type: number
                            example: 5.5
                required:
                  - subscriptions
    post:
      summary: Create a subscription
      description: Create a subscription
      tags:
        - Subscriptions
      operationId: createSubscription
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription:
                    title: Commerce::Subscription
                    type: object
                    properties:
                      id:
                        type: integer
                      subscription_token:
                        example: sb_1234567890
                        type: string
                      next_bill_date:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                      last_bill_date:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      next_ship_date:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      last_ship_date:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      status:
                        example: active
                        type: string
                        enum:
                          - pending
                          - active
                          - paused
                          - past_due
                          - cancelled
                      disabled:
                        example: false
                        type:
                          - boolean
                          - 'null'
                        default: false
                      quantity:
                        example: 1
                        type: integer
                        default: 1
                        minimum: 1
                      price:
                        example: 100
                        type: number
                      original_price:
                        example: 100
                        type: number
                      attempts:
                        example: 1
                        type:
                          - integer
                          - 'null'
                        default: 0
                      last_failed_at:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      next_retry_at:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      skipped_count:
                        example: 1
                        type:
                          - integer
                          - 'null'
                        default: 0
                      max_skips:
                        example: 1
                        type:
                          - integer
                          - 'null'
                      cancelled_at:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      created_at:
                        example: '2025-03-10T00:00:00Z'
                        type: string
                        format: date-time
                      updated_at:
                        example: '2025-03-10T00:00:00Z'
                        type: string
                        format: date-time
                      notes:
                        example: This is a sample commerce subscription
                        type:
                          - string
                          - 'null'
                      cv_total:
                        example: 100
                        type: integer
                      qv_total:
                        example: 50
                        type: integer
                      subscription_plan:
                        title: Commerce::SubscriptionPlan
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: Test Subscription Plan
                            type: string
                          billing_interval:
                            example: 1
                            type: integer
                            default: 1
                            minimum: 1
                            maximum: 29
                          billing_interval_unit:
                            description: 'Possible values: `day`, `week`, `month`, `year`'
                            example: day
                            type: string
                            default: month
                          billing_frequency_in_words:
                            example: 2 Months
                            type: string
                          shipping_interval:
                            example: 1
                            type: integer
                            default: 1
                            minimum: 1
                            maximum: 29
                          shipping_interval_unit:
                            description: 'Possible values: `day`, `week`, `month`, `year`'
                            example: day
                            type: string
                            default: month
                          volume_interval:
                            example: 1
                            type: integer
                            default: 1
                            minimum: 1
                            maximum: 29
                          volume_interval_unit:
                            description: 'Possible values: `day`, `week`, `month`, `year`'
                            example: day
                            type: string
                            default: month
                          trial_period:
                            example: 1
                            type:
                              - integer
                              - 'null'
                            minimum: 1
                          trial_period_unit:
                            description: 'Possible values: `day`, `week`, `month`, `year`'
                            example: day
                            type:
                              - string
                              - 'null'
                          split_volume:
                            example: true
                            type: boolean
                            default: false
                          allow_skipping:
                            example: true
                            type:
                              - boolean
                              - 'null'
                            default: true
                          max_skips:
                            example: 1
                            type:
                              - integer
                              - 'null'
                            minimum: 1
                          allow_max_billing_cycles:
                            example: true
                            type: boolean
                            default: false
                          max_billing_cycles:
                            example: 3
                            type:
                              - integer
                              - 'null'
                          price_adjustment_type:
                            example: percentage or fixed_amount
                            type:
                              - string
                              - 'null'
                          price_adjustment_amount:
                            example: 10
                            type:
                              - number
                              - 'null'
                          active:
                            example: true
                            type:
                              - boolean
                              - 'null'
                            default: true
                          company_default:
                            example: false
                            type:
                              - boolean
                              - 'null'
                            default: false
                          created_at:
                            example: '2025-03-10T00:00:00Z'
                            type: string
                            format: date-time
                          updated_at:
                            example: '2025-03-10T00:00:00Z'
                            type: string
                            format: date-time
                          products_count:
                            example: 10
                            type:
                              - integer
                              - 'null'
                          subscribers_count:
                            example: 10
                            type:
                              - integer
                              - 'null'
                        required:
                          - id
                          - name
                          - billing_interval
                          - billing_interval_unit
                          - billing_frequency_in_words
                          - shipping_interval
                          - shipping_interval_unit
                          - volume_interval
                          - volume_interval_unit
                          - split_volume
                          - allow_max_billing_cycles
                          - created_at
                          - updated_at
                      variant:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              title:
                                type:
                                  - string
                                  - 'null'
                                example: Sample Variant
                              image_path:
                                type:
                                  - string
                                  - 'null'
                                example: /images/sample.png
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/images/sample.png
                              primary_image:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/images/primary.png
                              price:
                                type:
                                  - string
                                  - 'null'
                                example: '34.44'
                              price_in_currency:
                                type:
                                  - string
                                  - 'null'
                                example: $34.44
                              sku:
                                type:
                                  - string
                                  - 'null'
                                example: SKU12345
                              options:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    title:
                                      type: string
                                      example: Size
                                    value:
                                      type: string
                                      example: XL
                              product:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  title:
                                    type: string
                                    example: Sample Product
                                  introduction:
                                    type:
                                      - string
                                      - 'null'
                                    example: Sample Short Description
                                  cv:
                                    type: integer
                                    example: 10
                                  cv_in_currency:
                                    type: string
                                    example: $10.00
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: ext-prod-123
                                  image_path:
                                    type:
                                      - string
                                      - 'null'
                                    example: /images/product.png
                                  image_url:
                                    type:
                                      - string
                                      - 'null'
                                    example: https://example.com/images/product.png
                                  price:
                                    type: string
                                    example: '29.99'
                                  price_in_currency:
                                    type: string
                                    example: $29.99
                                  sku:
                                    type:
                                      - string
                                      - 'null'
                                    example: SKU12345
                                  tax:
                                    type: string
                                    example: '2.99'
                                  tax_in_currency:
                                    type: string
                                    example: $2.99
                                  metadata:
                                    type: object
                                    example:
                                      shopify_product_id: 9876054868270
                                  metafields:
                                    type: array
                                    items:
                                      title: LegacyMetafield
                                      type: object
                                      properties:
                                        namespace:
                                          description: >-
                                            A container for related metafields.
                                            Commonly used to group metafields by app
                                            or functionality.
                                          example: custom
                                          type: string
                                          maxLength: 20
                                          pattern: ^[a-zA-Z0-9_]+$
                                        key:
                                          description: >-
                                            The unique identifier for the metafield
                                            within its namespace. Must be unique per
                                            namespace and owner.
                                          example: material
                                          type: string
                                          maxLength: 30
                                          pattern: ^[a-zA-Z0-9_]+$
                                        value:
                                          description: >-
                                            The actual data stored in the metafield.
                                            Type depends on value_type.
                                          example: cotton
                                          type:
                                            - string
                                            - integer
                                            - object
                                            - boolean
                                            - number
                                        value_type:
                                          description: >-
                                            The data type that defines how the value
                                            should be interpreted and validated.
                                          example: single_line_text_field
                                          type: string
                                        description:
                                          description: >-
                                            Optional human-readable description
                                            explaining the purpose of this
                                            metafield.
                                          example: >-
                                            The primary material used in this
                                            product
                                          type:
                                            - string
                                            - 'null'
                                        created_at:
                                          description: >-
                                            Timestamp when the metafield was
                                            created.
                                          example: '2021-01-01T00:00:00Z'
                                          type: string
                                          format: date-time
                                        updated_at:
                                          description: >-
                                            Timestamp when the metafield was last
                                            updated.
                                          example: '2021-01-01T00:00:00Z'
                                          type: string
                                          format: date-time
                                        locked:
                                          description: >-
                                            Whether this metafield is locked and
                                            cannot be updated or deleted directly.
                                          example: false
                                          type:
                                            - boolean
                                            - 'null'
                                            - 'null'
                                        metafield_definition:
                                          description: >-
                                            The definition that defines validation
                                            rules and structure for this metafield
                                          type:
                                            - 'null'
                                            - object
                                      required:
                                        - namespace
                                        - key
                                        - value
                                        - value_type
                                        - description
                                        - created_at
                                        - updated_at
                                        - metafield_definition
                      customer:
                        title: Customer
                        type: object
                        properties:
                          id:
                            type: integer
                          account_id:
                            type:
                              - string
                              - 'null'
                          first_name:
                            type:
                              - string
                              - 'null'
                          last_name:
                            type:
                              - string
                              - 'null'
                          full_name:
                            type: string
                          email:
                            type: string
                            pattern: >-
                              ^[a-zA-Z0-9.!\#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$
                          verified_email:
                            type:
                              - boolean
                              - 'null'
                            default: false
                          phone:
                            type:
                              - string
                              - 'null'
                          orders_count:
                            type:
                              - integer
                              - 'null'
                            default: 0
                          created_at:
                            type: string
                            format: date-time
                          display_total_spent:
                            type: string
                          metadata:
                            type: object
                            default: '{}'
                          user_company_id:
                            type:
                              - integer
                              - 'null'
                          external_id:
                            type:
                              - string
                              - 'null'
                          role:
                            type: string
                            enum:
                              - customer
                              - preferred_customer
                              - rep
                          last_order_id:
                            example: 101
                            type:
                              - integer
                              - 'null'
                          notes:
                            example: This is a note
                            type:
                              - string
                              - 'null'
                          active:
                            type: boolean
                          total_spent:
                            example: 100
                            type:
                              - number
                              - string
                          customer_notes:
                            type: array
                            items:
                              title: CustomerNote
                              type: object
                              properties:
                                id:
                                  type: integer
                                note:
                                  type: string
                                user_company_id:
                                  type:
                                    - integer
                                    - 'null'
                                customer_id:
                                  type: integer
                                resource_id:
                                  type:
                                    - integer
                                    - 'null'
                                resource_type:
                                  type:
                                    - string
                                    - 'null'
                                created_at:
                                  type: string
                                  format: date-time
                              required:
                                - id
                                - note
                                - customer_id
                                - created_at
                          default_address:
                            title: Address
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                              name:
                                example: John Doe
                                type: string
                              address1:
                                example: 123 Main St
                                type: string
                              address2:
                                example: Apt 4B
                                type:
                                  - string
                                  - 'null'
                              address3:
                                example: Building 5
                                type:
                                  - string
                                  - 'null'
                              city:
                                example: New York
                                type: string
                              state:
                                example: NY
                                type: string
                              subdivision_code:
                                example: NY
                                type:
                                  - string
                                  - 'null'
                              postal_code:
                                example: '10001'
                                type: string
                              country_code:
                                example: US
                                type:
                                  - string
                                  - 'null'
                              default:
                                description: >-
                                  Use this address by default when there are
                                  multiple addresses
                                example: true
                                type:
                                  - boolean
                                  - 'null'
                                default: false
                              first_name:
                                example: John
                                type: string
                              last_name:
                                example: Doe
                                type: string
                            required:
                              - id
                              - name
                              - address1
                              - city
                              - state
                              - postal_code
                              - first_name
                              - last_name
                          addresses:
                            type: array
                          payment_methods:
                            type: array
                          is_rep:
                            example: true
                            type: boolean
                          is_discarded:
                            example: false
                            type: boolean
                        required:
                          - id
                          - full_name
                          - email
                          - created_at
                          - display_total_spent
                          - metadata
                          - role
                          - active
                          - total_spent
                          - customer_notes
                          - addresses
                          - payment_methods
                          - is_rep
                          - is_discarded
                      customer_notes:
                        type: array
                      address:
                        title: Address
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: John Doe
                            type: string
                          address1:
                            example: 123 Main St
                            type: string
                          address2:
                            example: Apt 4B
                            type:
                              - string
                              - 'null'
                          address3:
                            example: Building 5
                            type:
                              - string
                              - 'null'
                          city:
                            example: New York
                            type: string
                          state:
                            example: NY
                            type: string
                          subdivision_code:
                            example: NY
                            type:
                              - string
                              - 'null'
                          postal_code:
                            example: '10001'
                            type: string
                          country_code:
                            example: US
                            type:
                              - string
                              - 'null'
                          default:
                            description: >-
                              Use this address by default when there are
                              multiple addresses
                            example: true
                            type:
                              - boolean
                              - 'null'
                            default: false
                          first_name:
                            example: John
                            type: string
                          last_name:
                            example: Doe
                            type: string
                        required:
                          - id
                          - name
                          - address1
                          - city
                          - state
                          - postal_code
                          - first_name
                          - last_name
                      payment_method:
                        title: Commerce::PaymentMethod
                        type: object
                        properties:
                          id:
                            type: integer
                          source:
                            type: string
                            enum:
                              - apple_pay
                              - paypal
                              - card
                              - iap
                              - bread
                              - affirm
                              - google_pay
                              - klarna
                              - droplet
                              - citcon
                              - ppro
                          payload:
                            type:
                              - object
                              - 'null'
                          created_at:
                            type: string
                            format: date-time
                          updated_at:
                            type: string
                            format: date-time
                          default:
                            type: boolean
                          payment_type:
                            example: Credit Card
                            type: string
                          details:
                            type: object
                        required:
                          - id
                          - source
                          - created_at
                          - updated_at
                          - default
                          - payment_type
                          - details
                      currency:
                        title: Currency
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: United States Dollar
                            type:
                              - string
                              - 'null'
                          code:
                            example: USD
                            type: string
                          rate:
                            example: 1
                            type:
                              - number
                              - string
                              - 'null'
                          active:
                            example: true
                            type:
                              - boolean
                              - 'null'
                            default: false
                          symbol:
                            example: $
                            type:
                              - string
                              - 'null'
                        required:
                          - id
                          - code
                      country:
                        title: Country
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: United States
                            type: string
                          iso:
                            description: 2-letter country code (ISO 3166-1 alpha-2)
                            example: US
                            type: string
                        required:
                          - id
                          - name
                          - iso
                      company:
                        title: Company
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: Acme, Inc.
                            type: string
                        required:
                          - id
                          - name
                      subscription_skips:
                        type: array
                        items:
                          title: Commerce::SubscriptionSkip
                          type: object
                          properties:
                            id:
                              type: integer
                            skipped_date:
                              example: '2025-01-01T00:00:00Z'
                              type: string
                              format: date
                            reason:
                              example: Customer requested to skip next billing
                              type:
                                - 'null'
                            created_at:
                              example: '2025-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            updated_at:
                              example: '2025-01-01T00:00:00Z'
                              type: string
                              format: date-time
                          required:
                            - id
                            - skipped_date
                            - created_at
                            - updated_at
                      orders:
                        type: array
                        items:
                          title: Commerce::Order
                          type: object
                          properties:
                            id:
                              type: integer
                            first_name:
                              type:
                                - string
                                - 'null'
                            last_name:
                              type:
                                - string
                                - 'null'
                            email:
                              type:
                                - string
                                - 'null'
                            phone:
                              type:
                                - string
                                - 'null'
                            order_number:
                              type:
                                - string
                                - 'null'
                            status:
                              type: string
                              enum:
                                - awaiting_payment
                                - awaiting_shipment
                                - shipped
                                - delivered
                                - archived
                                - cancelled
                                - failed_payment
                                - draft
                            order_type:
                              type: string
                              enum:
                                - requested
                                - purchased
                                - imported
                                - abandoned
                            source:
                              type: string
                              enum:
                                - mobile
                                - web
                                - admin
                                - backoffice
                                - subscription
                                - enrollment
                            amount:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                            amount_in_base:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                            base_to_currency_rate:
                              type:
                                - number
                                - string
                                - 'null'
                            note:
                              type:
                                - string
                                - 'null'
                            currency_code:
                              type:
                                - string
                                - 'null'
                            created_at:
                              type: string
                              format: date-time
                            updated_at:
                              type: string
                              format: date-time
                            metadata:
                              type:
                                - object
                                - 'null'
                              default: '{}'
                            token:
                              type: string
                            refundable_amount:
                              type: string
                            order_status:
                              type: string
                              enum:
                                - draft
                                - pending
                                - processing
                                - completed
                                - cancelled
                                - archived
                            fulfillment_status:
                              type: string
                              enum:
                                - unfulfilled
                                - in_progress
                                - on_hold
                                - partially_fulfilled
                                - scheduled
                                - fulfilled
                            financial_status:
                              type: string
                              enum:
                                - pending
                                - authorized
                                - partially_paid
                                - paid
                                - partially_refunded
                                - refunded
                                - voided
                                - marked_free
                                - marked_paid
                            warehouse_id:
                              type:
                                - integer
                                - 'null'
                            split_payment:
                              type:
                                - object
                                - 'null'
                            points_applied:
                              default: 0
                              type: integer
                            points_applied_amount_in_currency:
                              type: number
                            order_total_after_points_redemption:
                              type: number
                            free_shipping:
                              description: Whether the order has free shipping
                              type: boolean
                            discount_codes:
                              default: []
                              description: Discount codes applied to the order
                              type: array
                            shipping_method:
                              type: object
                            items_quantity:
                              example: 5
                              type: integer
                          required:
                            - id
                            - status
                            - order_type
                            - source
                            - created_at
                            - updated_at
                            - token
                            - refundable_amount
                            - order_status
                            - fulfillment_status
                            - financial_status
                            - points_applied
                            - points_applied_amount_in_currency
                            - order_total_after_points_redemption
                            - free_shipping
                            - discount_codes
                            - shipping_method
                            - items_quantity
                      bundled_subscriptions:
                        type: array
                    required:
                      - id
                      - subscription_token
                      - next_bill_date
                      - status
                      - quantity
                      - price
                      - original_price
                      - created_at
                      - updated_at
                      - cv_total
                      - qv_total
                      - subscription_plan
                      - variant
                      - customer
                      - customer_notes
                      - address
                      - payment_method
                      - currency
                      - country
                      - company
                      - subscription_skips
                      - orders
                      - bundled_subscriptions
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - subscription
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                subscription:
                  type: object
                  properties:
                    subscription_plan_id:
                      type: integer
                    customer_id:
                      type: integer
                    variant_id:
                      type: integer
                    address_id:
                      type: integer
                    payment_method_id:
                      type: integer
                    cart_token:
                      type: string
                    order_item_id:
                      type: integer
                    status:
                      type: string
                    disabled:
                      type: boolean
                    quantity:
                      type: integer
                    metadata:
                      type: object
                    notes:
                      type: string
                    next_bill_date:
                      type: string
                      format: date-time
                  required:
                    - subscription_plan_id
                    - customer_id
                    - variant_id
                    - address_id
                    - payment_method_id
                    - cart_token
              required:
                - subscription
        description: >-
          Subscription params. next_bill_date (YYYY-MM-DD) calculated internally
          if not provided.
  /api/subscriptions/{token}:
    get:
      summary: Show a subscription
      description: >-
        Show a subscription by token or ID, with optional shipping fee
        calculation
      tags:
        - Subscriptions
      operationId: showSubscription
      security:
        - bearer_auth: []
      parameters:
        - name: token
          in: path
          required: true
          schema:
            type: string
        - name: customer_id
          in: query
          required: false
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription:
                    title: Commerce::Subscription
                    type: object
                    properties:
                      id:
                        type: integer
                      next_order:
                        type: object
                      subscription_token:
                        example: sb_1234567890
                        type: string
                      next_bill_date:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                      last_bill_date:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      next_ship_date:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      last_ship_date:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      status:
                        example: active
                        type: string
                        enum:
                          - pending
                          - active
                          - paused
                          - past_due
                          - cancelled
                      disabled:
                        example: false
                        type:
                          - boolean
                          - 'null'
                        default: false
                      quantity:
                        example: 1
                        type: integer
                        default: 1
                        minimum: 1
                      price:
                        example: 100
                        type: number
                      original_price:
                        example: 100
                        type: number
                      attempts:
                        example: 1
                        type:
                          - integer
                          - 'null'
                        default: 0
                      last_failed_at:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      next_retry_at:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      skipped_count:
                        example: 1
                        type:
                          - integer
                          - 'null'
                        default: 0
                      max_skips:
                        example: 1
                        type:
                          - integer
                          - 'null'
                      cancelled_at:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      created_at:
                        example: '2025-03-10T00:00:00Z'
                        type: string
                        format: date-time
                      updated_at:
                        example: '2025-03-10T00:00:00Z'
                        type: string
                        format: date-time
                      notes:
                        example: This is a sample commerce subscription
                        type:
                          - string
                          - 'null'
                      cv_total:
                        example: 100
                        type: integer
                      qv_total:
                        example: 50
                        type: integer
                      subscription_plan:
                        title: Commerce::SubscriptionPlan
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: Test Subscription Plan
                            type: string
                          billing_interval:
                            example: 1
                            type: integer
                            default: 1
                            minimum: 1
                            maximum: 29
                          billing_interval_unit:
                            description: 'Possible values: `day`, `week`, `month`, `year`'
                            example: day
                            type: string
                            default: month
                          billing_frequency_in_words:
                            example: 2 Months
                            type: string
                          shipping_interval:
                            example: 1
                            type: integer
                            default: 1
                            minimum: 1
                            maximum: 29
                          shipping_interval_unit:
                            description: 'Possible values: `day`, `week`, `month`, `year`'
                            example: day
                            type: string
                            default: month
                          volume_interval:
                            example: 1
                            type: integer
                            default: 1
                            minimum: 1
                            maximum: 29
                          volume_interval_unit:
                            description: 'Possible values: `day`, `week`, `month`, `year`'
                            example: day
                            type: string
                            default: month
                          trial_period:
                            example: 1
                            type:
                              - integer
                              - 'null'
                            minimum: 1
                          trial_period_unit:
                            description: 'Possible values: `day`, `week`, `month`, `year`'
                            example: day
                            type:
                              - string
                              - 'null'
                          split_volume:
                            example: true
                            type: boolean
                            default: false
                          allow_skipping:
                            example: true
                            type:
                              - boolean
                              - 'null'
                            default: true
                          max_skips:
                            example: 1
                            type:
                              - integer
                              - 'null'
                            minimum: 1
                          allow_max_billing_cycles:
                            example: true
                            type: boolean
                            default: false
                          max_billing_cycles:
                            example: 3
                            type:
                              - integer
                              - 'null'
                          price_adjustment_type:
                            example: percentage or fixed_amount
                            type:
                              - string
                              - 'null'
                          price_adjustment_amount:
                            example: 10
                            type:
                              - number
                              - 'null'
                          active:
                            example: true
                            type:
                              - boolean
                              - 'null'
                            default: true
                          company_default:
                            example: false
                            type:
                              - boolean
                              - 'null'
                            default: false
                          created_at:
                            example: '2025-03-10T00:00:00Z'
                            type: string
                            format: date-time
                          updated_at:
                            example: '2025-03-10T00:00:00Z'
                            type: string
                            format: date-time
                          products_count:
                            example: 10
                            type:
                              - integer
                              - 'null'
                          subscribers_count:
                            example: 10
                            type:
                              - integer
                              - 'null'
                        required:
                          - id
                          - name
                          - billing_interval
                          - billing_interval_unit
                          - billing_frequency_in_words
                          - shipping_interval
                          - shipping_interval_unit
                          - volume_interval
                          - volume_interval_unit
                          - split_volume
                          - allow_max_billing_cycles
                          - created_at
                          - updated_at
                      variant:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              title:
                                type:
                                  - string
                                  - 'null'
                                example: Sample Variant
                              image_path:
                                type:
                                  - string
                                  - 'null'
                                example: /images/sample.png
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/images/sample.png
                              primary_image:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/images/primary.png
                              price:
                                type:
                                  - string
                                  - 'null'
                                example: '34.44'
                              price_in_currency:
                                type:
                                  - string
                                  - 'null'
                                example: $34.44
                              sku:
                                type:
                                  - string
                                  - 'null'
                                example: SKU12345
                              options:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    title:
                                      type: string
                                      example: Size
                                    value:
                                      type: string
                                      example: XL
                              product:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  title:
                                    type: string
                                    example: Sample Product
                                  introduction:
                                    type:
                                      - string
                                      - 'null'
                                    example: Sample Short Description
                                  cv:
                                    type: integer
                                    example: 10
                                  cv_in_currency:
                                    type: string
                                    example: $10.00
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: ext-prod-123
                                  image_path:
                                    type:
                                      - string
                                      - 'null'
                                    example: /images/product.png
                                  image_url:
                                    type:
                                      - string
                                      - 'null'
                                    example: https://example.com/images/product.png
                                  price:
                                    type: string
                                    example: '29.99'
                                  price_in_currency:
                                    type: string
                                    example: $29.99
                                  sku:
                                    type:
                                      - string
                                      - 'null'
                                    example: SKU12345
                                  tax:
                                    type: string
                                    example: '2.99'
                                  tax_in_currency:
                                    type: string
                                    example: $2.99
                                  metadata:
                                    type: object
                                    example:
                                      shopify_product_id: 9876054868270
                                  metafields:
                                    type: array
                                    items:
                                      title: LegacyMetafield
                                      type: object
                                      properties:
                                        namespace:
                                          description: >-
                                            A container for related metafields.
                                            Commonly used to group metafields by app
                                            or functionality.
                                          example: custom
                                          type: string
                                          maxLength: 20
                                          pattern: ^[a-zA-Z0-9_]+$
                                        key:
                                          description: >-
                                            The unique identifier for the metafield
                                            within its namespace. Must be unique per
                                            namespace and owner.
                                          example: material
                                          type: string
                                          maxLength: 30
                                          pattern: ^[a-zA-Z0-9_]+$
                                        value:
                                          description: >-
                                            The actual data stored in the metafield.
                                            Type depends on value_type.
                                          example: cotton
                                          type:
                                            - string
                                            - integer
                                            - object
                                            - boolean
                                            - number
                                        value_type:
                                          description: >-
                                            The data type that defines how the value
                                            should be interpreted and validated.
                                          example: single_line_text_field
                                          type: string
                                        description:
                                          description: >-
                                            Optional human-readable description
                                            explaining the purpose of this
                                            metafield.
                                          example: >-
                                            The primary material used in this
                                            product
                                          type:
                                            - string
                                            - 'null'
                                        created_at:
                                          description: >-
                                            Timestamp when the metafield was
                                            created.
                                          example: '2021-01-01T00:00:00Z'
                                          type: string
                                          format: date-time
                                        updated_at:
                                          description: >-
                                            Timestamp when the metafield was last
                                            updated.
                                          example: '2021-01-01T00:00:00Z'
                                          type: string
                                          format: date-time
                                        locked:
                                          description: >-
                                            Whether this metafield is locked and
                                            cannot be updated or deleted directly.
                                          example: false
                                          type:
                                            - boolean
                                            - 'null'
                                            - 'null'
                                        metafield_definition:
                                          description: >-
                                            The definition that defines validation
                                            rules and structure for this metafield
                                          type:
                                            - 'null'
                                            - object
                                      required:
                                        - namespace
                                        - key
                                        - value
                                        - value_type
                                        - description
                                        - created_at
                                        - updated_at
                                        - metafield_definition
                      customer:
                        title: Customer
                        type: object
                        properties:
                          id:
                            type: integer
                          account_id:
                            type:
                              - string
                              - 'null'
                          first_name:
                            type:
                              - string
                              - 'null'
                          last_name:
                            type:
                              - string
                              - 'null'
                          full_name:
                            type: string
                          email:
                            type: string
                            pattern: >-
                              ^[a-zA-Z0-9.!\#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$
                          verified_email:
                            type:
                              - boolean
                              - 'null'
                            default: false
                          phone:
                            type:
                              - string
                              - 'null'
                          orders_count:
                            type:
                              - integer
                              - 'null'
                            default: 0
                          created_at:
                            type: string
                            format: date-time
                          display_total_spent:
                            type: string
                          metadata:
                            type: object
                            default: '{}'
                          user_company_id:
                            type:
                              - integer
                              - 'null'
                          external_id:
                            type:
                              - string
                              - 'null'
                          role:
                            type: string
                            enum:
                              - customer
                              - preferred_customer
                              - rep
                          last_order_id:
                            example: 101
                            type:
                              - integer
                              - 'null'
                          notes:
                            example: This is a note
                            type:
                              - string
                              - 'null'
                          active:
                            type: boolean
                          total_spent:
                            example: 100
                            type:
                              - number
                              - string
                          customer_notes:
                            type: array
                            items:
                              title: CustomerNote
                              type: object
                              properties:
                                id:
                                  type: integer
                                note:
                                  type: string
                                user_company_id:
                                  type:
                                    - integer
                                    - 'null'
                                customer_id:
                                  type: integer
                                resource_id:
                                  type:
                                    - integer
                                    - 'null'
                                resource_type:
                                  type:
                                    - string
                                    - 'null'
                                created_at:
                                  type: string
                                  format: date-time
                              required:
                                - id
                                - note
                                - customer_id
                                - created_at
                          default_address:
                            title: Address
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                              name:
                                example: John Doe
                                type: string
                              address1:
                                example: 123 Main St
                                type: string
                              address2:
                                example: Apt 4B
                                type:
                                  - string
                                  - 'null'
                              address3:
                                example: Building 5
                                type:
                                  - string
                                  - 'null'
                              city:
                                example: New York
                                type: string
                              state:
                                example: NY
                                type: string
                              subdivision_code:
                                example: NY
                                type:
                                  - string
                                  - 'null'
                              postal_code:
                                example: '10001'
                                type: string
                              country_code:
                                example: US
                                type:
                                  - string
                                  - 'null'
                              default:
                                description: >-
                                  Use this address by default when there are
                                  multiple addresses
                                example: true
                                type:
                                  - boolean
                                  - 'null'
                                default: false
                              first_name:
                                example: John
                                type: string
                              last_name:
                                example: Doe
                                type: string
                            required:
                              - id
                              - name
                              - address1
                              - city
                              - state
                              - postal_code
                              - first_name
                              - last_name
                          addresses:
                            type: array
                            items:
                              title: Address
                              type: object
                              properties:
                                id:
                                  type: integer
                                name:
                                  example: John Doe
                                  type: string
                                address1:
                                  example: 123 Main St
                                  type: string
                                address2:
                                  example: Apt 4B
                                  type:
                                    - string
                                    - 'null'
                                address3:
                                  example: Building 5
                                  type:
                                    - string
                                    - 'null'
                                city:
                                  example: New York
                                  type: string
                                state:
                                  example: NY
                                  type: string
                                subdivision_code:
                                  example: NY
                                  type:
                                    - string
                                    - 'null'
                                postal_code:
                                  example: '10001'
                                  type: string
                                country_code:
                                  example: US
                                  type:
                                    - string
                                    - 'null'
                                default:
                                  description: >-
                                    Use this address by default when there are
                                    multiple addresses
                                  example: true
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                first_name:
                                  example: John
                                  type: string
                                last_name:
                                  example: Doe
                                  type: string
                              required:
                                - id
                                - name
                                - address1
                                - city
                                - state
                                - postal_code
                                - first_name
                                - last_name
                          payment_methods:
                            type: array
                            items:
                              title: Commerce::PaymentMethod
                              type: object
                              properties:
                                id:
                                  type: integer
                                source:
                                  type: string
                                  enum:
                                    - apple_pay
                                    - paypal
                                    - card
                                    - iap
                                    - bread
                                    - affirm
                                    - google_pay
                                    - klarna
                                    - droplet
                                    - citcon
                                    - ppro
                                payload:
                                  type:
                                    - object
                                    - 'null'
                                company_id:
                                  type:
                                    - integer
                                    - 'null'
                                created_at:
                                  type: string
                                  format: date-time
                                updated_at:
                                  type: string
                                  format: date-time
                                logo_url:
                                  type: string
                                user_id:
                                  example: 101
                                  type:
                                    - integer
                                    - 'null'
                              required:
                                - id
                                - source
                                - created_at
                                - updated_at
                                - logo_url
                          is_rep:
                            example: true
                            type: boolean
                          is_discarded:
                            example: false
                            type: boolean
                          active_subscriptions_count:
                            example: 10
                            type: integer
                          inactive_subscriptions_count:
                            example: 10
                            type: integer
                          metafields:
                            type: array
                            items:
                              title: LegacyMetafield
                              type: object
                              properties:
                                id:
                                  type: integer
                                namespace:
                                  description: >-
                                    A container for related metafields. Commonly
                                    used to group metafields by app or
                                    functionality.
                                  example: custom
                                  type: string
                                  maxLength: 20
                                  pattern: ^[a-zA-Z0-9_]+$
                                key:
                                  description: >-
                                    The unique identifier for the metafield
                                    within its namespace. Must be unique per
                                    namespace and owner.
                                  example: material
                                  type: string
                                  maxLength: 30
                                  pattern: ^[a-zA-Z0-9_]+$
                                value:
                                  description: >-
                                    The actual data stored in the metafield.
                                    Type depends on value_type.
                                  example: cotton
                                  type:
                                    - string
                                    - object
                                value_type:
                                  description: >-
                                    The data type that defines how the value
                                    should be interpreted and validated.
                                  example: single_line_text_field
                                  type: string
                                description:
                                  description: >-
                                    Optional human-readable description
                                    explaining the purpose of this metafield.
                                  example: The primary material used in this product
                                  type:
                                    - string
                                    - 'null'
                                owner_type:
                                  description: >-
                                    The type of resource that this metafield
                                    belongs to (polymorphic association).
                                  example: Product
                                  type: string
                                owner_id:
                                  description: >-
                                    The ID of the specific resource that this
                                    metafield belongs to.
                                  example: 12345
                                  type: integer
                                created_at:
                                  description: Timestamp when the metafield was created.
                                  example: '2021-01-01T00:00:00Z'
                                  type: string
                                  format: date-time
                                updated_at:
                                  description: >-
                                    Timestamp when the metafield was last
                                    updated.
                                  example: '2021-01-01T00:00:00Z'
                                  type: string
                                  format: date-time
                                metafield_definition:
                                  title: MetafieldDefinition
                                  type:
                                    - object
                                    - 'null'
                                  properties:
                                    id:
                                      type: integer
                                    company_id:
                                      description: >-
                                        The ID of the company that owns this
                                        metafield definition.
                                      example: 1
                                      type: integer
                                    namespace:
                                      description: >-
                                        A container for related metafield
                                        definitions. Used to group definitions
                                        by app or functionality. Must be unique
                                        within company and owner_resource.
                                      example: product_details
                                      type: string
                                      maxLength: 20
                                      pattern: ^[a-zA-Z0-9_]+$
                                    key:
                                      description: >-
                                        The unique identifier for the metafield
                                        definition within its namespace and
                                        owner_resource. Combined with namespace
                                        and owner_resource, this must be unique
                                        per company.
                                      example: material_type
                                      type: string
                                      maxLength: 30
                                      pattern: ^[a-zA-Z0-9_]+$
                                    name:
                                      description: >-
                                        Human-readable display name for the
                                        metafield definition, shown in admin
                                        interfaces and forms.
                                      example: Material Type
                                      type: string
                                      maxLength: 100
                                    description:
                                      description: >-
                                        Detailed explanation of what this
                                        metafield definition represents, how it
                                        should be used, and any special
                                        instructions for content creators.
                                      example: >-
                                        Specify the primary material composition
                                        of the product (e.g., cotton, polyester,
                                        silk). This will be displayed on the
                                        product detail page.
                                      type:
                                        - string
                                        - 'null'
                                    value_type:
                                      description: >-
                                        The data type that defines how metafield
                                        values should be validated, stored, and
                                        displayed. Determines which validation
                                        rules are available.
                                      example: single_line_text_field
                                      type: string
                                    validation_rules:
                                      description: >-
                                        JSON object containing validation
                                        constraints that will be applied to
                                        metafield values. Available rules depend
                                        on the value_type.
                                      example:
                                        choices:
                                          - cotton
                                          - polyester
                                          - silk
                                          - wool
                                          - linen
                                          - bamboo
                                        max: 50
                                        min: 2
                                      type:
                                        - object
                                        - 'null'
                                    owner_resource:
                                      description: >-
                                        The type of resource (model class name)
                                        that metafields using this definition
                                        can be attached to. Must match the
                                        polymorphic owner_type.
                                      example: Product
                                      type: string
                                    pinned:
                                      description: >-
                                        Whether this definition should be
                                        prominently displayed or prioritized in
                                        admin interfaces and forms.
                                      example: false
                                      type:
                                        - boolean
                                        - 'null'
                                      default: false
                                    position:
                                      default: 0
                                      description: >-
                                        Sort order for displaying this
                                        definition relative to others in the
                                        same category and owner_resource. Lower
                                        numbers appear first.
                                      example: 1
                                      type:
                                        - integer
                                        - 'null'
                                    locked:
                                      description: >-
                                        Whether this metafield definition is
                                        locked, preventing direct updates or
                                        deletions of metafields using this
                                        definition.
                                      example: false
                                      type:
                                        - boolean
                                        - 'null'
                                      default: false
                                    created_at:
                                      description: >-
                                        Timestamp when the metafield definition
                                        was created.
                                      example: '2024-01-15T10:30:00Z'
                                      type: string
                                      format: date-time
                                    updated_at:
                                      description: >-
                                        Timestamp when the metafield definition
                                        was last updated.
                                      example: '2024-02-20T14:45:00Z'
                                      type: string
                                      format: date-time
                                    list_type:
                                      description: >-
                                        Whether this definition is for list-type
                                        metafields that store arrays of values.
                                      example: false
                                      type: boolean
                                    reference_type:
                                      description: >-
                                        Whether this definition is for
                                        reference-type metafields that store
                                        references to other resources.
                                      example: false
                                      type: boolean
                                    supported_validations:
                                      description: >-
                                        Array of validation rule names that are
                                        supported for this value_type.
                                      example:
                                        - min
                                        - max
                                        - choices
                                        - regex
                                      type: array
                                    validation_description:
                                      description: >-
                                        Human-readable description of what the
                                        value_type represents and its
                                        constraints.
                                      example: Single line text up to 5000 characters
                                      type: string
                                    category_ids:
                                      description: >-
                                        Array of category IDs that this
                                        metafield definition is associated with
                                        for organizational purposes.
                                      example:
                                        - 1
                                        - 2
                                        - 3
                                      items:
                                        type: integer
                                      type: array
                                  required:
                                    - id
                                    - company_id
                                    - namespace
                                    - key
                                    - name
                                    - value_type
                                    - owner_resource
                                    - created_at
                                    - updated_at
                                    - list_type
                                    - reference_type
                                    - supported_validations
                                    - validation_description
                                    - category_ids
                              required:
                                - id
                                - namespace
                                - key
                                - value
                                - value_type
                                - owner_type
                                - owner_id
                                - created_at
                                - updated_at
                          jwt:
                            type: string
                        required:
                          - id
                          - full_name
                          - email
                          - created_at
                          - display_total_spent
                          - metadata
                          - role
                          - active
                          - total_spent
                          - customer_notes
                          - addresses
                          - payment_methods
                          - is_rep
                          - is_discarded
                          - active_subscriptions_count
                          - inactive_subscriptions_count
                          - metafields
                          - jwt
                      customer_notes:
                        type: array
                      address:
                        title: Address
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: John Doe
                            type: string
                          address1:
                            example: 123 Main St
                            type: string
                          address2:
                            example: Apt 4B
                            type:
                              - string
                              - 'null'
                          address3:
                            example: Building 5
                            type:
                              - string
                              - 'null'
                          city:
                            example: New York
                            type: string
                          state:
                            example: NY
                            type: string
                          subdivision_code:
                            example: NY
                            type:
                              - string
                              - 'null'
                          postal_code:
                            example: '10001'
                            type: string
                          country_code:
                            example: US
                            type:
                              - string
                              - 'null'
                          default:
                            description: >-
                              Use this address by default when there are
                              multiple addresses
                            example: true
                            type:
                              - boolean
                              - 'null'
                            default: false
                          first_name:
                            example: John
                            type: string
                          last_name:
                            example: Doe
                            type: string
                        required:
                          - id
                          - name
                          - address1
                          - city
                          - state
                          - postal_code
                          - first_name
                          - last_name
                      payment_method:
                        title: Commerce::PaymentMethod
                        type: object
                        properties:
                          id:
                            type: integer
                          source:
                            type: string
                            enum:
                              - apple_pay
                              - paypal
                              - card
                              - iap
                              - bread
                              - affirm
                              - google_pay
                              - klarna
                              - droplet
                              - citcon
                              - ppro
                          payload:
                            type:
                              - object
                              - 'null'
                          created_at:
                            type: string
                            format: date-time
                          updated_at:
                            type: string
                            format: date-time
                          default:
                            type: boolean
                          payment_type:
                            example: Credit Card
                            type: string
                          details:
                            type: object
                        required:
                          - id
                          - source
                          - created_at
                          - updated_at
                          - default
                          - payment_type
                          - details
                      currency:
                        title: Currency
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: United States Dollar
                            type:
                              - string
                              - 'null'
                          code:
                            example: USD
                            type: string
                          rate:
                            example: 1
                            type:
                              - number
                              - string
                              - 'null'
                          active:
                            example: true
                            type:
                              - boolean
                              - 'null'
                            default: false
                          symbol:
                            example: $
                            type:
                              - string
                              - 'null'
                        required:
                          - id
                          - code
                      country:
                        title: Country
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: United States
                            type: string
                          iso:
                            description: 2-letter country code (ISO 3166-1 alpha-2)
                            example: US
                            type: string
                        required:
                          - id
                          - name
                          - iso
                      company:
                        title: Company
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: Acme, Inc.
                            type: string
                        required:
                          - id
                          - name
                      subscription_skips:
                        type: array
                        items:
                          title: Commerce::SubscriptionSkip
                          type: object
                          properties:
                            id:
                              type: integer
                            skipped_date:
                              example: '2025-01-01T00:00:00Z'
                              type: string
                              format: date
                            reason:
                              example: Customer requested to skip next billing
                              type:
                                - 'null'
                            created_at:
                              example: '2025-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            updated_at:
                              example: '2025-01-01T00:00:00Z'
                              type: string
                              format: date-time
                          required:
                            - id
                            - skipped_date
                            - created_at
                            - updated_at
                      orders:
                        type: array
                        items:
                          title: Commerce::Order
                          type: object
                          properties:
                            id:
                              type: integer
                            first_name:
                              type:
                                - string
                                - 'null'
                            last_name:
                              type:
                                - string
                                - 'null'
                            email:
                              type:
                                - string
                                - 'null'
                            phone:
                              type:
                                - string
                                - 'null'
                            order_number:
                              type:
                                - string
                                - 'null'
                            status:
                              type: string
                              enum:
                                - awaiting_payment
                                - awaiting_shipment
                                - shipped
                                - delivered
                                - archived
                                - cancelled
                                - failed_payment
                                - draft
                            order_type:
                              type: string
                              enum:
                                - requested
                                - purchased
                                - imported
                                - abandoned
                            source:
                              type: string
                              enum:
                                - mobile
                                - web
                                - admin
                                - backoffice
                                - subscription
                                - enrollment
                            amount:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                            amount_in_base:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                            base_to_currency_rate:
                              type:
                                - number
                                - string
                                - 'null'
                            note:
                              type:
                                - string
                                - 'null'
                            currency_code:
                              type:
                                - string
                                - 'null'
                            created_at:
                              type: string
                              format: date-time
                            updated_at:
                              type: string
                              format: date-time
                            metadata:
                              type:
                                - object
                                - 'null'
                              default: '{}'
                            token:
                              type: string
                            refundable_amount:
                              type: string
                            order_status:
                              type: string
                              enum:
                                - draft
                                - pending
                                - processing
                                - completed
                                - cancelled
                                - archived
                            fulfillment_status:
                              type: string
                              enum:
                                - unfulfilled
                                - in_progress
                                - on_hold
                                - partially_fulfilled
                                - scheduled
                                - fulfilled
                            financial_status:
                              type: string
                              enum:
                                - pending
                                - authorized
                                - partially_paid
                                - paid
                                - partially_refunded
                                - refunded
                                - voided
                                - marked_free
                                - marked_paid
                            warehouse_id:
                              type:
                                - integer
                                - 'null'
                            split_payment:
                              type:
                                - object
                                - 'null'
                            points_applied:
                              default: 0
                              type: integer
                            points_applied_amount_in_currency:
                              type: number
                            order_total_after_points_redemption:
                              type: number
                            free_shipping:
                              description: Whether the order has free shipping
                              type: boolean
                            discount_codes:
                              default: []
                              description: Discount codes applied to the order
                              type: array
                            shipping_method:
                              type: object
                            items_quantity:
                              example: 5
                              type: integer
                          required:
                            - id
                            - status
                            - order_type
                            - source
                            - created_at
                            - updated_at
                            - token
                            - refundable_amount
                            - order_status
                            - fulfillment_status
                            - financial_status
                            - points_applied
                            - points_applied_amount_in_currency
                            - order_total_after_points_redemption
                            - free_shipping
                            - discount_codes
                            - shipping_method
                            - items_quantity
                      bundled_subscriptions:
                        type: array
                      shipping_fee:
                        example:
                          - 15.99
                          - null
                        type:
                          - number
                          - 'null'
                      shipping_fee_for_display:
                        example:
                          - Free
                          - $15.99
                          - null
                        type:
                          - string
                          - 'null'
                    required:
                      - id
                      - next_order
                      - subscription_token
                      - next_bill_date
                      - status
                      - quantity
                      - price
                      - original_price
                      - created_at
                      - updated_at
                      - cv_total
                      - qv_total
                      - subscription_plan
                      - variant
                      - customer
                      - customer_notes
                      - address
                      - payment_method
                      - currency
                      - country
                      - company
                      - subscription_skips
                      - orders
                      - bundled_subscriptions
                      - shipping_fee
                      - shipping_fee_for_display
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - subscription
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
    put:
      summary: Update a subscription
      description: Update a subscription
      tags:
        - Subscriptions
      operationId: updateSubscription
      security:
        - bearer_auth: []
      parameters:
        - name: token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription:
                    title: Commerce::Subscription
                    type: object
                    properties:
                      id:
                        type: integer
                      subscription_token:
                        example: sb_1234567890
                        type: string
                      next_bill_date:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                      last_bill_date:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      next_ship_date:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      last_ship_date:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      status:
                        example: active
                        type: string
                        enum:
                          - pending
                          - active
                          - paused
                          - past_due
                          - cancelled
                      disabled:
                        example: false
                        type:
                          - boolean
                          - 'null'
                        default: false
                      quantity:
                        example: 1
                        type: integer
                        default: 1
                        minimum: 1
                      price:
                        example: 100
                        type: number
                      original_price:
                        example: 100
                        type: number
                      attempts:
                        example: 1
                        type:
                          - integer
                          - 'null'
                        default: 0
                      last_failed_at:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      next_retry_at:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      skipped_count:
                        example: 1
                        type:
                          - integer
                          - 'null'
                        default: 0
                      max_skips:
                        example: 1
                        type:
                          - integer
                          - 'null'
                      cancelled_at:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      created_at:
                        example: '2025-03-10T00:00:00Z'
                        type: string
                        format: date-time
                      updated_at:
                        example: '2025-03-10T00:00:00Z'
                        type: string
                        format: date-time
                      notes:
                        example: This is a sample commerce subscription
                        type:
                          - string
                          - 'null'
                      cv_total:
                        example: 100
                        type: integer
                      qv_total:
                        example: 50
                        type: integer
                      subscription_plan:
                        title: Commerce::SubscriptionPlan
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: Test Subscription Plan
                            type: string
                          billing_interval:
                            example: 1
                            type: integer
                            default: 1
                            minimum: 1
                            maximum: 29
                          billing_interval_unit:
                            description: 'Possible values: `day`, `week`, `month`, `year`'
                            example: day
                            type: string
                            default: month
                          billing_frequency_in_words:
                            example: 2 Months
                            type: string
                          shipping_interval:
                            example: 1
                            type: integer
                            default: 1
                            minimum: 1
                            maximum: 29
                          shipping_interval_unit:
                            description: 'Possible values: `day`, `week`, `month`, `year`'
                            example: day
                            type: string
                            default: month
                          volume_interval:
                            example: 1
                            type: integer
                            default: 1
                            minimum: 1
                            maximum: 29
                          volume_interval_unit:
                            description: 'Possible values: `day`, `week`, `month`, `year`'
                            example: day
                            type: string
                            default: month
                          trial_period:
                            example: 1
                            type:
                              - integer
                              - 'null'
                            minimum: 1
                          trial_period_unit:
                            description: 'Possible values: `day`, `week`, `month`, `year`'
                            example: day
                            type:
                              - string
                              - 'null'
                          split_volume:
                            example: true
                            type: boolean
                            default: false
                          allow_skipping:
                            example: true
                            type:
                              - boolean
                              - 'null'
                            default: true
                          max_skips:
                            example: 1
                            type:
                              - integer
                              - 'null'
                            minimum: 1
                          allow_max_billing_cycles:
                            example: true
                            type: boolean
                            default: false
                          max_billing_cycles:
                            example: 3
                            type:
                              - integer
                              - 'null'
                          price_adjustment_type:
                            example: percentage or fixed_amount
                            type:
                              - string
                              - 'null'
                          price_adjustment_amount:
                            example: 10
                            type:
                              - number
                              - 'null'
                          active:
                            example: true
                            type:
                              - boolean
                              - 'null'
                            default: true
                          company_default:
                            example: false
                            type:
                              - boolean
                              - 'null'
                            default: false
                          created_at:
                            example: '2025-03-10T00:00:00Z'
                            type: string
                            format: date-time
                          updated_at:
                            example: '2025-03-10T00:00:00Z'
                            type: string
                            format: date-time
                          products_count:
                            example: 10
                            type:
                              - integer
                              - 'null'
                          subscribers_count:
                            example: 10
                            type:
                              - integer
                              - 'null'
                        required:
                          - id
                          - name
                          - billing_interval
                          - billing_interval_unit
                          - billing_frequency_in_words
                          - shipping_interval
                          - shipping_interval_unit
                          - volume_interval
                          - volume_interval_unit
                          - split_volume
                          - allow_max_billing_cycles
                          - created_at
                          - updated_at
                      variant:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              title:
                                type:
                                  - string
                                  - 'null'
                                example: Sample Variant
                              image_path:
                                type:
                                  - string
                                  - 'null'
                                example: /images/sample.png
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/images/sample.png
                              primary_image:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/images/primary.png
                              price:
                                type:
                                  - string
                                  - 'null'
                                example: '34.44'
                              price_in_currency:
                                type:
                                  - string
                                  - 'null'
                                example: $34.44
                              sku:
                                type:
                                  - string
                                  - 'null'
                                example: SKU12345
                              options:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    title:
                                      type: string
                                      example: Size
                                    value:
                                      type: string
                                      example: XL
                              product:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  title:
                                    type: string
                                    example: Sample Product
                                  introduction:
                                    type:
                                      - string
                                      - 'null'
                                    example: Sample Short Description
                                  cv:
                                    type: integer
                                    example: 10
                                  cv_in_currency:
                                    type: string
                                    example: $10.00
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: ext-prod-123
                                  image_path:
                                    type:
                                      - string
                                      - 'null'
                                    example: /images/product.png
                                  image_url:
                                    type:
                                      - string
                                      - 'null'
                                    example: https://example.com/images/product.png
                                  price:
                                    type: string
                                    example: '29.99'
                                  price_in_currency:
                                    type: string
                                    example: $29.99
                                  sku:
                                    type:
                                      - string
                                      - 'null'
                                    example: SKU12345
                                  tax:
                                    type: string
                                    example: '2.99'
                                  tax_in_currency:
                                    type: string
                                    example: $2.99
                                  metadata:
                                    type: object
                                    example:
                                      shopify_product_id: 9876054868270
                                  metafields:
                                    type: array
                                    items:
                                      title: LegacyMetafield
                                      type: object
                                      properties:
                                        namespace:
                                          description: >-
                                            A container for related metafields.
                                            Commonly used to group metafields by app
                                            or functionality.
                                          example: custom
                                          type: string
                                          maxLength: 20
                                          pattern: ^[a-zA-Z0-9_]+$
                                        key:
                                          description: >-
                                            The unique identifier for the metafield
                                            within its namespace. Must be unique per
                                            namespace and owner.
                                          example: material
                                          type: string
                                          maxLength: 30
                                          pattern: ^[a-zA-Z0-9_]+$
                                        value:
                                          description: >-
                                            The actual data stored in the metafield.
                                            Type depends on value_type.
                                          example: cotton
                                          type:
                                            - string
                                            - integer
                                            - object
                                            - boolean
                                            - number
                                        value_type:
                                          description: >-
                                            The data type that defines how the value
                                            should be interpreted and validated.
                                          example: single_line_text_field
                                          type: string
                                        description:
                                          description: >-
                                            Optional human-readable description
                                            explaining the purpose of this
                                            metafield.
                                          example: >-
                                            The primary material used in this
                                            product
                                          type:
                                            - string
                                            - 'null'
                                        created_at:
                                          description: >-
                                            Timestamp when the metafield was
                                            created.
                                          example: '2021-01-01T00:00:00Z'
                                          type: string
                                          format: date-time
                                        updated_at:
                                          description: >-
                                            Timestamp when the metafield was last
                                            updated.
                                          example: '2021-01-01T00:00:00Z'
                                          type: string
                                          format: date-time
                                        locked:
                                          description: >-
                                            Whether this metafield is locked and
                                            cannot be updated or deleted directly.
                                          example: false
                                          type:
                                            - boolean
                                            - 'null'
                                            - 'null'
                                        metafield_definition:
                                          description: >-
                                            The definition that defines validation
                                            rules and structure for this metafield
                                          type:
                                            - 'null'
                                            - object
                                      required:
                                        - namespace
                                        - key
                                        - value
                                        - value_type
                                        - description
                                        - created_at
                                        - updated_at
                                        - metafield_definition
                      customer:
                        title: Customer
                        type: object
                        properties:
                          id:
                            type: integer
                          account_id:
                            type:
                              - string
                              - 'null'
                          first_name:
                            type:
                              - string
                              - 'null'
                          last_name:
                            type:
                              - string
                              - 'null'
                          full_name:
                            type: string
                          email:
                            type: string
                            pattern: >-
                              ^[a-zA-Z0-9.!\#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$
                          verified_email:
                            type:
                              - boolean
                              - 'null'
                            default: false
                          phone:
                            type:
                              - string
                              - 'null'
                          orders_count:
                            type:
                              - integer
                              - 'null'
                            default: 0
                          created_at:
                            type: string
                            format: date-time
                          display_total_spent:
                            type: string
                          metadata:
                            type: object
                            default: '{}'
                          user_company_id:
                            type:
                              - integer
                              - 'null'
                          external_id:
                            type:
                              - string
                              - 'null'
                          role:
                            type: string
                            enum:
                              - customer
                              - preferred_customer
                              - rep
                          last_order_id:
                            example: 101
                            type:
                              - integer
                              - 'null'
                          notes:
                            example: This is a note
                            type:
                              - string
                              - 'null'
                          active:
                            type: boolean
                          total_spent:
                            example: 100
                            type:
                              - number
                              - string
                          customer_notes:
                            type: array
                            items:
                              title: CustomerNote
                              type: object
                              properties:
                                id:
                                  type: integer
                                note:
                                  type: string
                                user_company_id:
                                  type:
                                    - integer
                                    - 'null'
                                customer_id:
                                  type: integer
                                resource_id:
                                  type:
                                    - integer
                                    - 'null'
                                resource_type:
                                  type:
                                    - string
                                    - 'null'
                                created_at:
                                  type: string
                                  format: date-time
                              required:
                                - id
                                - note
                                - customer_id
                                - created_at
                          default_address:
                            title: Address
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                              name:
                                example: John Doe
                                type: string
                              address1:
                                example: 123 Main St
                                type: string
                              address2:
                                example: Apt 4B
                                type:
                                  - string
                                  - 'null'
                              address3:
                                example: Building 5
                                type:
                                  - string
                                  - 'null'
                              city:
                                example: New York
                                type: string
                              state:
                                example: NY
                                type: string
                              subdivision_code:
                                example: NY
                                type:
                                  - string
                                  - 'null'
                              postal_code:
                                example: '10001'
                                type: string
                              country_code:
                                example: US
                                type:
                                  - string
                                  - 'null'
                              default:
                                description: >-
                                  Use this address by default when there are
                                  multiple addresses
                                example: true
                                type:
                                  - boolean
                                  - 'null'
                                default: false
                              first_name:
                                example: John
                                type: string
                              last_name:
                                example: Doe
                                type: string
                            required:
                              - id
                              - name
                              - address1
                              - city
                              - state
                              - postal_code
                              - first_name
                              - last_name
                          addresses:
                            type: array
                          payment_methods:
                            type: array
                          is_rep:
                            example: true
                            type: boolean
                          is_discarded:
                            example: false
                            type: boolean
                        required:
                          - id
                          - full_name
                          - email
                          - created_at
                          - display_total_spent
                          - metadata
                          - role
                          - active
                          - total_spent
                          - customer_notes
                          - addresses
                          - payment_methods
                          - is_rep
                          - is_discarded
                      customer_notes:
                        type: array
                      address:
                        title: Address
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: John Doe
                            type: string
                          address1:
                            example: 123 Main St
                            type: string
                          address2:
                            example: Apt 4B
                            type:
                              - string
                              - 'null'
                          address3:
                            example: Building 5
                            type:
                              - string
                              - 'null'
                          city:
                            example: New York
                            type: string
                          state:
                            example: NY
                            type: string
                          subdivision_code:
                            example: NY
                            type:
                              - string
                              - 'null'
                          postal_code:
                            example: '10001'
                            type: string
                          country_code:
                            example: US
                            type:
                              - string
                              - 'null'
                          default:
                            description: >-
                              Use this address by default when there are
                              multiple addresses
                            example: true
                            type:
                              - boolean
                              - 'null'
                            default: false
                          first_name:
                            example: John
                            type: string
                          last_name:
                            example: Doe
                            type: string
                        required:
                          - id
                          - name
                          - address1
                          - city
                          - state
                          - postal_code
                          - first_name
                          - last_name
                      payment_method:
                        title: Commerce::PaymentMethod
                        type: object
                        properties:
                          id:
                            type: integer
                          source:
                            type: string
                            enum:
                              - apple_pay
                              - paypal
                              - card
                              - iap
                              - bread
                              - affirm
                              - google_pay
                              - klarna
                              - droplet
                              - citcon
                              - ppro
                          payload:
                            type:
                              - object
                              - 'null'
                          created_at:
                            type: string
                            format: date-time
                          updated_at:
                            type: string
                            format: date-time
                          default:
                            type: boolean
                          payment_type:
                            example: Credit Card
                            type: string
                          details:
                            type: object
                        required:
                          - id
                          - source
                          - created_at
                          - updated_at
                          - default
                          - payment_type
                          - details
                      currency:
                        title: Currency
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: United States Dollar
                            type:
                              - string
                              - 'null'
                          code:
                            example: USD
                            type: string
                          rate:
                            example: 1
                            type:
                              - number
                              - string
                              - 'null'
                          active:
                            example: true
                            type:
                              - boolean
                              - 'null'
                            default: false
                          symbol:
                            example: $
                            type:
                              - string
                              - 'null'
                        required:
                          - id
                          - code
                      country:
                        title: Country
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: United States
                            type: string
                          iso:
                            description: 2-letter country code (ISO 3166-1 alpha-2)
                            example: US
                            type: string
                        required:
                          - id
                          - name
                          - iso
                      company:
                        title: Company
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: Acme, Inc.
                            type: string
                        required:
                          - id
                          - name
                      subscription_skips:
                        type: array
                        items:
                          title: Commerce::SubscriptionSkip
                          type: object
                          properties:
                            id:
                              type: integer
                            skipped_date:
                              example: '2025-01-01T00:00:00Z'
                              type: string
                              format: date
                            reason:
                              example: Customer requested to skip next billing
                              type:
                                - 'null'
                            created_at:
                              example: '2025-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            updated_at:
                              example: '2025-01-01T00:00:00Z'
                              type: string
                              format: date-time
                          required:
                            - id
                            - skipped_date
                            - created_at
                            - updated_at
                      orders:
                        type: array
                        items:
                          title: Commerce::Order
                          type: object
                          properties:
                            id:
                              type: integer
                            first_name:
                              type:
                                - string
                                - 'null'
                            last_name:
                              type:
                                - string
                                - 'null'
                            email:
                              type:
                                - string
                                - 'null'
                            phone:
                              type:
                                - string
                                - 'null'
                            order_number:
                              type:
                                - string
                                - 'null'
                            status:
                              type: string
                              enum:
                                - awaiting_payment
                                - awaiting_shipment
                                - shipped
                                - delivered
                                - archived
                                - cancelled
                                - failed_payment
                                - draft
                            order_type:
                              type: string
                              enum:
                                - requested
                                - purchased
                                - imported
                                - abandoned
                            source:
                              type: string
                              enum:
                                - mobile
                                - web
                                - admin
                                - backoffice
                                - subscription
                                - enrollment
                            amount:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                            amount_in_base:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                            base_to_currency_rate:
                              type:
                                - number
                                - string
                                - 'null'
                            note:
                              type:
                                - string
                                - 'null'
                            currency_code:
                              type:
                                - string
                                - 'null'
                            created_at:
                              type: string
                              format: date-time
                            updated_at:
                              type: string
                              format: date-time
                            metadata:
                              type:
                                - object
                                - 'null'
                              default: '{}'
                            token:
                              type: string
                            refundable_amount:
                              type: string
                            order_status:
                              type: string
                              enum:
                                - draft
                                - pending
                                - processing
                                - completed
                                - cancelled
                                - archived
                            fulfillment_status:
                              type: string
                              enum:
                                - unfulfilled
                                - in_progress
                                - on_hold
                                - partially_fulfilled
                                - scheduled
                                - fulfilled
                            financial_status:
                              type: string
                              enum:
                                - pending
                                - authorized
                                - partially_paid
                                - paid
                                - partially_refunded
                                - refunded
                                - voided
                                - marked_free
                                - marked_paid
                            warehouse_id:
                              type:
                                - integer
                                - 'null'
                            split_payment:
                              type:
                                - object
                                - 'null'
                            points_applied:
                              default: 0
                              type: integer
                            points_applied_amount_in_currency:
                              type: number
                            order_total_after_points_redemption:
                              type: number
                            free_shipping:
                              description: Whether the order has free shipping
                              type: boolean
                            discount_codes:
                              default: []
                              description: Discount codes applied to the order
                              type: array
                            shipping_method:
                              type: object
                            items_quantity:
                              example: 5
                              type: integer
                          required:
                            - id
                            - status
                            - order_type
                            - source
                            - created_at
                            - updated_at
                            - token
                            - refundable_amount
                            - order_status
                            - fulfillment_status
                            - financial_status
                            - points_applied
                            - points_applied_amount_in_currency
                            - order_total_after_points_redemption
                            - free_shipping
                            - discount_codes
                            - shipping_method
                            - items_quantity
                      bundled_subscriptions:
                        type: array
                    required:
                      - id
                      - subscription_token
                      - next_bill_date
                      - status
                      - quantity
                      - price
                      - original_price
                      - created_at
                      - updated_at
                      - cv_total
                      - qv_total
                      - subscription_plan
                      - variant
                      - customer
                      - customer_notes
                      - address
                      - payment_method
                      - currency
                      - country
                      - company
                      - subscription_skips
                      - orders
                      - bundled_subscriptions
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - subscription
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                token:
                  type: string
                id:
                  type: integer
                subscription:
                  type: object
                  properties:
                    subscription_plan_id:
                      type: integer
                    customer_id:
                      type: integer
                    variant_id:
                      type: integer
                    address_id:
                      type: integer
                    payment_method_id:
                      type: integer
                    order_item_id:
                      type: integer
                    status:
                      type: string
                    disabled:
                      type: boolean
                    quantity:
                      type: integer
                    metadata:
                      type: object
                    notes:
                      type: string
                    next_bill_date:
                      type: string
                      format: date-time
                  required:
                    - subscription_plan_id
                    - customer_id
                    - variant_id
                    - address_id
                    - payment_method_id
              required:
                - subscription
        description: >-
          Subscription params. next_bill_date (YYYY-MM-DD) calculated internally
          if not provided.
  /api/subscriptions/{token}/pause:
    post:
      summary: Pause a subscription
      description: Pause a subscription with a future resume date
      tags:
        - Subscriptions
      operationId: pauseSubscription
      security:
        - bearer_auth: []
      parameters:
        - name: token
          in: path
          required: true
          schema:
            type: string
        - name: next_bill_date
          in: query
          schema:
            type: string
            format: date
          required: false
          description: Resume date for paused subscription. Omit for indefinite pause.
        - name: number_of_orders
          in: query
          schema:
            type: integer
          required: false
          description: >-
            Number of billing cycles to skip. Cannot be used with
            next_bill_date.
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription:
                    title: Commerce::Subscription
                    type: object
                    properties:
                      id:
                        type: integer
                      subscription_token:
                        example: sb_1234567890
                        type: string
                      next_bill_date:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                      last_bill_date:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      next_ship_date:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      last_ship_date:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      status:
                        example: active
                        type: string
                        enum:
                          - pending
                          - active
                          - paused
                          - past_due
                          - cancelled
                      disabled:
                        example: false
                        type:
                          - boolean
                          - 'null'
                        default: false
                      quantity:
                        example: 1
                        type: integer
                        default: 1
                        minimum: 1
                      price:
                        example: 100
                        type: number
                      original_price:
                        example: 100
                        type: number
                      attempts:
                        example: 1
                        type:
                          - integer
                          - 'null'
                        default: 0
                      last_failed_at:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      next_retry_at:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      skipped_count:
                        example: 1
                        type:
                          - integer
                          - 'null'
                        default: 0
                      max_skips:
                        example: 1
                        type:
                          - integer
                          - 'null'
                      cancelled_at:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      created_at:
                        example: '2025-03-10T00:00:00Z'
                        type: string
                        format: date-time
                      updated_at:
                        example: '2025-03-10T00:00:00Z'
                        type: string
                        format: date-time
                      notes:
                        example: This is a sample commerce subscription
                        type:
                          - string
                          - 'null'
                      cv_total:
                        example: 100
                        type: integer
                      qv_total:
                        example: 50
                        type: integer
                      subscription_plan:
                        title: Commerce::SubscriptionPlan
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: Test Subscription Plan
                            type: string
                          billing_interval:
                            example: 1
                            type: integer
                            default: 1
                            minimum: 1
                            maximum: 29
                          billing_interval_unit:
                            description: 'Possible values: `day`, `week`, `month`, `year`'
                            example: day
                            type: string
                            default: month
                          billing_frequency_in_words:
                            example: 2 Months
                            type: string
                          shipping_interval:
                            example: 1
                            type: integer
                            default: 1
                            minimum: 1
                            maximum: 29
                          shipping_interval_unit:
                            description: 'Possible values: `day`, `week`, `month`, `year`'
                            example: day
                            type: string
                            default: month
                          volume_interval:
                            example: 1
                            type: integer
                            default: 1
                            minimum: 1
                            maximum: 29
                          volume_interval_unit:
                            description: 'Possible values: `day`, `week`, `month`, `year`'
                            example: day
                            type: string
                            default: month
                          trial_period:
                            example: 1
                            type:
                              - integer
                              - 'null'
                            minimum: 1
                          trial_period_unit:
                            description: 'Possible values: `day`, `week`, `month`, `year`'
                            example: day
                            type:
                              - string
                              - 'null'
                          split_volume:
                            example: true
                            type: boolean
                            default: false
                          allow_skipping:
                            example: true
                            type:
                              - boolean
                              - 'null'
                            default: true
                          max_skips:
                            example: 1
                            type:
                              - integer
                              - 'null'
                            minimum: 1
                          allow_max_billing_cycles:
                            example: true
                            type: boolean
                            default: false
                          max_billing_cycles:
                            example: 3
                            type:
                              - integer
                              - 'null'
                          price_adjustment_type:
                            example: percentage or fixed_amount
                            type:
                              - string
                              - 'null'
                          price_adjustment_amount:
                            example: 10
                            type:
                              - number
                              - 'null'
                          active:
                            example: true
                            type:
                              - boolean
                              - 'null'
                            default: true
                          company_default:
                            example: false
                            type:
                              - boolean
                              - 'null'
                            default: false
                          created_at:
                            example: '2025-03-10T00:00:00Z'
                            type: string
                            format: date-time
                          updated_at:
                            example: '2025-03-10T00:00:00Z'
                            type: string
                            format: date-time
                          products_count:
                            example: 10
                            type:
                              - integer
                              - 'null'
                          subscribers_count:
                            example: 10
                            type:
                              - integer
                              - 'null'
                        required:
                          - id
                          - name
                          - billing_interval
                          - billing_interval_unit
                          - billing_frequency_in_words
                          - shipping_interval
                          - shipping_interval_unit
                          - volume_interval
                          - volume_interval_unit
                          - split_volume
                          - allow_max_billing_cycles
                          - created_at
                          - updated_at
                      variant:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              title:
                                type:
                                  - string
                                  - 'null'
                                example: Sample Variant
                              image_path:
                                type:
                                  - string
                                  - 'null'
                                example: /images/sample.png
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/images/sample.png
                              primary_image:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/images/primary.png
                              price:
                                type:
                                  - string
                                  - 'null'
                                example: '34.44'
                              price_in_currency:
                                type:
                                  - string
                                  - 'null'
                                example: $34.44
                              sku:
                                type:
                                  - string
                                  - 'null'
                                example: SKU12345
                              options:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    title:
                                      type: string
                                      example: Size
                                    value:
                                      type: string
                                      example: XL
                              product:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  title:
                                    type: string
                                    example: Sample Product
                                  introduction:
                                    type:
                                      - string
                                      - 'null'
                                    example: Sample Short Description
                                  cv:
                                    type: integer
                                    example: 10
                                  cv_in_currency:
                                    type: string
                                    example: $10.00
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: ext-prod-123
                                  image_path:
                                    type:
                                      - string
                                      - 'null'
                                    example: /images/product.png
                                  image_url:
                                    type:
                                      - string
                                      - 'null'
                                    example: https://example.com/images/product.png
                                  price:
                                    type: string
                                    example: '29.99'
                                  price_in_currency:
                                    type: string
                                    example: $29.99
                                  sku:
                                    type:
                                      - string
                                      - 'null'
                                    example: SKU12345
                                  tax:
                                    type: string
                                    example: '2.99'
                                  tax_in_currency:
                                    type: string
                                    example: $2.99
                                  metadata:
                                    type: object
                                    example:
                                      shopify_product_id: 9876054868270
                                  metafields:
                                    type: array
                                    items:
                                      title: LegacyMetafield
                                      type: object
                                      properties:
                                        namespace:
                                          description: >-
                                            A container for related metafields.
                                            Commonly used to group metafields by app
                                            or functionality.
                                          example: custom
                                          type: string
                                          maxLength: 20
                                          pattern: ^[a-zA-Z0-9_]+$
                                        key:
                                          description: >-
                                            The unique identifier for the metafield
                                            within its namespace. Must be unique per
                                            namespace and owner.
                                          example: material
                                          type: string
                                          maxLength: 30
                                          pattern: ^[a-zA-Z0-9_]+$
                                        value:
                                          description: >-
                                            The actual data stored in the metafield.
                                            Type depends on value_type.
                                          example: cotton
                                          type:
                                            - string
                                            - integer
                                            - object
                                            - boolean
                                            - number
                                        value_type:
                                          description: >-
                                            The data type that defines how the value
                                            should be interpreted and validated.
                                          example: single_line_text_field
                                          type: string
                                        description:
                                          description: >-
                                            Optional human-readable description
                                            explaining the purpose of this
                                            metafield.
                                          example: >-
                                            The primary material used in this
                                            product
                                          type:
                                            - string
                                            - 'null'
                                        created_at:
                                          description: >-
                                            Timestamp when the metafield was
                                            created.
                                          example: '2021-01-01T00:00:00Z'
                                          type: string
                                          format: date-time
                                        updated_at:
                                          description: >-
                                            Timestamp when the metafield was last
                                            updated.
                                          example: '2021-01-01T00:00:00Z'
                                          type: string
                                          format: date-time
                                        locked:
                                          description: >-
                                            Whether this metafield is locked and
                                            cannot be updated or deleted directly.
                                          example: false
                                          type:
                                            - boolean
                                            - 'null'
                                            - 'null'
                                        metafield_definition:
                                          description: >-
                                            The definition that defines validation
                                            rules and structure for this metafield
                                          type:
                                            - 'null'
                                            - object
                                      required:
                                        - namespace
                                        - key
                                        - value
                                        - value_type
                                        - description
                                        - created_at
                                        - updated_at
                                        - metafield_definition
                      customer:
                        title: Customer
                        type: object
                        properties:
                          id:
                            type: integer
                          account_id:
                            type:
                              - string
                              - 'null'
                          first_name:
                            type:
                              - string
                              - 'null'
                          last_name:
                            type:
                              - string
                              - 'null'
                          full_name:
                            type: string
                          email:
                            type: string
                            pattern: >-
                              ^[a-zA-Z0-9.!\#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$
                          verified_email:
                            type:
                              - boolean
                              - 'null'
                            default: false
                          phone:
                            type:
                              - string
                              - 'null'
                          orders_count:
                            type:
                              - integer
                              - 'null'
                            default: 0
                          created_at:
                            type: string
                            format: date-time
                          display_total_spent:
                            type: string
                          metadata:
                            type: object
                            default: '{}'
                          user_company_id:
                            type:
                              - integer
                              - 'null'
                          external_id:
                            type:
                              - string
                              - 'null'
                          role:
                            type: string
                            enum:
                              - customer
                              - preferred_customer
                              - rep
                          last_order_id:
                            example: 101
                            type:
                              - integer
                              - 'null'
                          notes:
                            example: This is a note
                            type:
                              - string
                              - 'null'
                          active:
                            type: boolean
                          total_spent:
                            example: 100
                            type:
                              - number
                              - string
                          customer_notes:
                            type: array
                            items:
                              title: CustomerNote
                              type: object
                              properties:
                                id:
                                  type: integer
                                note:
                                  type: string
                                user_company_id:
                                  type:
                                    - integer
                                    - 'null'
                                customer_id:
                                  type: integer
                                resource_id:
                                  type:
                                    - integer
                                    - 'null'
                                resource_type:
                                  type:
                                    - string
                                    - 'null'
                                created_at:
                                  type: string
                                  format: date-time
                              required:
                                - id
                                - note
                                - customer_id
                                - created_at
                          default_address:
                            title: Address
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                              name:
                                example: John Doe
                                type: string
                              address1:
                                example: 123 Main St
                                type: string
                              address2:
                                example: Apt 4B
                                type:
                                  - string
                                  - 'null'
                              address3:
                                example: Building 5
                                type:
                                  - string
                                  - 'null'
                              city:
                                example: New York
                                type: string
                              state:
                                example: NY
                                type: string
                              subdivision_code:
                                example: NY
                                type:
                                  - string
                                  - 'null'
                              postal_code:
                                example: '10001'
                                type: string
                              country_code:
                                example: US
                                type:
                                  - string
                                  - 'null'
                              default:
                                description: >-
                                  Use this address by default when there are
                                  multiple addresses
                                example: true
                                type:
                                  - boolean
                                  - 'null'
                                default: false
                              first_name:
                                example: John
                                type: string
                              last_name:
                                example: Doe
                                type: string
                            required:
                              - id
                              - name
                              - address1
                              - city
                              - state
                              - postal_code
                              - first_name
                              - last_name
                          addresses:
                            type: array
                          payment_methods:
                            type: array
                          is_rep:
                            example: true
                            type: boolean
                          is_discarded:
                            example: false
                            type: boolean
                        required:
                          - id
                          - full_name
                          - email
                          - created_at
                          - display_total_spent
                          - metadata
                          - role
                          - active
                          - total_spent
                          - customer_notes
                          - addresses
                          - payment_methods
                          - is_rep
                          - is_discarded
                      customer_notes:
                        type: array
                      address:
                        title: Address
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: John Doe
                            type: string
                          address1:
                            example: 123 Main St
                            type: string
                          address2:
                            example: Apt 4B
                            type:
                              - string
                              - 'null'
                          address3:
                            example: Building 5
                            type:
                              - string
                              - 'null'
                          city:
                            example: New York
                            type: string
                          state:
                            example: NY
                            type: string
                          subdivision_code:
                            example: NY
                            type:
                              - string
                              - 'null'
                          postal_code:
                            example: '10001'
                            type: string
                          country_code:
                            example: US
                            type:
                              - string
                              - 'null'
                          default:
                            description: >-
                              Use this address by default when there are
                              multiple addresses
                            example: true
                            type:
                              - boolean
                              - 'null'
                            default: false
                          first_name:
                            example: John
                            type: string
                          last_name:
                            example: Doe
                            type: string
                        required:
                          - id
                          - name
                          - address1
                          - city
                          - state
                          - postal_code
                          - first_name
                          - last_name
                      payment_method:
                        title: Commerce::PaymentMethod
                        type: object
                        properties:
                          id:
                            type: integer
                          source:
                            type: string
                            enum:
                              - apple_pay
                              - paypal
                              - card
                              - iap
                              - bread
                              - affirm
                              - google_pay
                              - klarna
                              - droplet
                              - citcon
                              - ppro
                          payload:
                            type:
                              - object
                              - 'null'
                          created_at:
                            type: string
                            format: date-time
                          updated_at:
                            type: string
                            format: date-time
                          default:
                            type: boolean
                          payment_type:
                            example: Credit Card
                            type: string
                          details:
                            type: object
                        required:
                          - id
                          - source
                          - created_at
                          - updated_at
                          - default
                          - payment_type
                          - details
                      currency:
                        title: Currency
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: United States Dollar
                            type:
                              - string
                              - 'null'
                          code:
                            example: USD
                            type: string
                          rate:
                            example: 1
                            type:
                              - number
                              - string
                              - 'null'
                          active:
                            example: true
                            type:
                              - boolean
                              - 'null'
                            default: false
                          symbol:
                            example: $
                            type:
                              - string
                              - 'null'
                        required:
                          - id
                          - code
                      country:
                        title: Country
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: United States
                            type: string
                          iso:
                            description: 2-letter country code (ISO 3166-1 alpha-2)
                            example: US
                            type: string
                        required:
                          - id
                          - name
                          - iso
                      company:
                        title: Company
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: Acme, Inc.
                            type: string
                        required:
                          - id
                          - name
                      subscription_skips:
                        type: array
                        items:
                          title: Commerce::SubscriptionSkip
                          type: object
                          properties:
                            id:
                              type: integer
                            skipped_date:
                              example: '2025-01-01T00:00:00Z'
                              type: string
                              format: date
                            reason:
                              example: Customer requested to skip next billing
                              type:
                                - 'null'
                            created_at:
                              example: '2025-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            updated_at:
                              example: '2025-01-01T00:00:00Z'
                              type: string
                              format: date-time
                          required:
                            - id
                            - skipped_date
                            - created_at
                            - updated_at
                      orders:
                        type: array
                        items:
                          title: Commerce::Order
                          type: object
                          properties:
                            id:
                              type: integer
                            first_name:
                              type:
                                - string
                                - 'null'
                            last_name:
                              type:
                                - string
                                - 'null'
                            email:
                              type:
                                - string
                                - 'null'
                            phone:
                              type:
                                - string
                                - 'null'
                            order_number:
                              type:
                                - string
                                - 'null'
                            status:
                              type: string
                              enum:
                                - awaiting_payment
                                - awaiting_shipment
                                - shipped
                                - delivered
                                - archived
                                - cancelled
                                - failed_payment
                                - draft
                            order_type:
                              type: string
                              enum:
                                - requested
                                - purchased
                                - imported
                                - abandoned
                            source:
                              type: string
                              enum:
                                - mobile
                                - web
                                - admin
                                - backoffice
                                - subscription
                                - enrollment
                            amount:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                            amount_in_base:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                            base_to_currency_rate:
                              type:
                                - number
                                - string
                                - 'null'
                            note:
                              type:
                                - string
                                - 'null'
                            currency_code:
                              type:
                                - string
                                - 'null'
                            created_at:
                              type: string
                              format: date-time
                            updated_at:
                              type: string
                              format: date-time
                            metadata:
                              type:
                                - object
                                - 'null'
                              default: '{}'
                            token:
                              type: string
                            refundable_amount:
                              type: string
                            order_status:
                              type: string
                              enum:
                                - draft
                                - pending
                                - processing
                                - completed
                                - cancelled
                                - archived
                            fulfillment_status:
                              type: string
                              enum:
                                - unfulfilled
                                - in_progress
                                - on_hold
                                - partially_fulfilled
                                - scheduled
                                - fulfilled
                            financial_status:
                              type: string
                              enum:
                                - pending
                                - authorized
                                - partially_paid
                                - paid
                                - partially_refunded
                                - refunded
                                - voided
                                - marked_free
                                - marked_paid
                            warehouse_id:
                              type:
                                - integer
                                - 'null'
                            split_payment:
                              type:
                                - object
                                - 'null'
                            points_applied:
                              default: 0
                              type: integer
                            points_applied_amount_in_currency:
                              type: number
                            order_total_after_points_redemption:
                              type: number
                            free_shipping:
                              description: Whether the order has free shipping
                              type: boolean
                            discount_codes:
                              default: []
                              description: Discount codes applied to the order
                              type: array
                            shipping_method:
                              type: object
                            items_quantity:
                              example: 5
                              type: integer
                          required:
                            - id
                            - status
                            - order_type
                            - source
                            - created_at
                            - updated_at
                            - token
                            - refundable_amount
                            - order_status
                            - fulfillment_status
                            - financial_status
                            - points_applied
                            - points_applied_amount_in_currency
                            - order_total_after_points_redemption
                            - free_shipping
                            - discount_codes
                            - shipping_method
                            - items_quantity
                      bundled_subscriptions:
                        type: array
                    required:
                      - id
                      - subscription_token
                      - next_bill_date
                      - status
                      - quantity
                      - price
                      - original_price
                      - created_at
                      - updated_at
                      - cv_total
                      - qv_total
                      - subscription_plan
                      - variant
                      - customer
                      - customer_notes
                      - address
                      - payment_method
                      - currency
                      - country
                      - company
                      - subscription_skips
                      - orders
                      - bundled_subscriptions
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - subscription
        '404':
          description: not found - subscription
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: unprocessable entity - past date
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/subscriptions/{token}/resume:
    post:
      summary: Resume a paused subscription
      description: Resume a previously paused subscription
      tags:
        - Subscriptions
      operationId: resumeSubscription
      security:
        - bearer_auth: []
      parameters:
        - name: token
          in: path
          required: true
          schema:
            type: string
        - name: next_bill_date
          in: query
          schema:
            type: string
            format: date
          required: false
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription:
                    title: Commerce::Subscription
                    type: object
                    properties:
                      id:
                        type: integer
                      subscription_token:
                        example: sb_1234567890
                        type: string
                      next_bill_date:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                      last_bill_date:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      next_ship_date:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      last_ship_date:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      status:
                        example: active
                        type: string
                        enum:
                          - pending
                          - active
                          - paused
                          - past_due
                          - cancelled
                      disabled:
                        example: false
                        type:
                          - boolean
                          - 'null'
                        default: false
                      quantity:
                        example: 1
                        type: integer
                        default: 1
                        minimum: 1
                      price:
                        example: 100
                        type: number
                      original_price:
                        example: 100
                        type: number
                      attempts:
                        example: 1
                        type:
                          - integer
                          - 'null'
                        default: 0
                      last_failed_at:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      next_retry_at:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      skipped_count:
                        example: 1
                        type:
                          - integer
                          - 'null'
                        default: 0
                      max_skips:
                        example: 1
                        type:
                          - integer
                          - 'null'
                      cancelled_at:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      created_at:
                        example: '2025-03-10T00:00:00Z'
                        type: string
                        format: date-time
                      updated_at:
                        example: '2025-03-10T00:00:00Z'
                        type: string
                        format: date-time
                      notes:
                        example: This is a sample commerce subscription
                        type:
                          - string
                          - 'null'
                      cv_total:
                        example: 100
                        type: integer
                      qv_total:
                        example: 50
                        type: integer
                      subscription_plan:
                        title: Commerce::SubscriptionPlan
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: Test Subscription Plan
                            type: string
                          billing_interval:
                            example: 1
                            type: integer
                            default: 1
                            minimum: 1
                            maximum: 29
                          billing_interval_unit:
                            description: 'Possible values: `day`, `week`, `month`, `year`'
                            example: day
                            type: string
                            default: month
                          billing_frequency_in_words:
                            example: 2 Months
                            type: string
                          shipping_interval:
                            example: 1
                            type: integer
                            default: 1
                            minimum: 1
                            maximum: 29
                          shipping_interval_unit:
                            description: 'Possible values: `day`, `week`, `month`, `year`'
                            example: day
                            type: string
                            default: month
                          volume_interval:
                            example: 1
                            type: integer
                            default: 1
                            minimum: 1
                            maximum: 29
                          volume_interval_unit:
                            description: 'Possible values: `day`, `week`, `month`, `year`'
                            example: day
                            type: string
                            default: month
                          trial_period:
                            example: 1
                            type:
                              - integer
                              - 'null'
                            minimum: 1
                          trial_period_unit:
                            description: 'Possible values: `day`, `week`, `month`, `year`'
                            example: day
                            type:
                              - string
                              - 'null'
                          split_volume:
                            example: true
                            type: boolean
                            default: false
                          allow_skipping:
                            example: true
                            type:
                              - boolean
                              - 'null'
                            default: true
                          max_skips:
                            example: 1
                            type:
                              - integer
                              - 'null'
                            minimum: 1
                          allow_max_billing_cycles:
                            example: true
                            type: boolean
                            default: false
                          max_billing_cycles:
                            example: 3
                            type:
                              - integer
                              - 'null'
                          price_adjustment_type:
                            example: percentage or fixed_amount
                            type:
                              - string
                              - 'null'
                          price_adjustment_amount:
                            example: 10
                            type:
                              - number
                              - 'null'
                          active:
                            example: true
                            type:
                              - boolean
                              - 'null'
                            default: true
                          company_default:
                            example: false
                            type:
                              - boolean
                              - 'null'
                            default: false
                          created_at:
                            example: '2025-03-10T00:00:00Z'
                            type: string
                            format: date-time
                          updated_at:
                            example: '2025-03-10T00:00:00Z'
                            type: string
                            format: date-time
                          products_count:
                            example: 10
                            type:
                              - integer
                              - 'null'
                          subscribers_count:
                            example: 10
                            type:
                              - integer
                              - 'null'
                        required:
                          - id
                          - name
                          - billing_interval
                          - billing_interval_unit
                          - billing_frequency_in_words
                          - shipping_interval
                          - shipping_interval_unit
                          - volume_interval
                          - volume_interval_unit
                          - split_volume
                          - allow_max_billing_cycles
                          - created_at
                          - updated_at
                      variant:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              title:
                                type:
                                  - string
                                  - 'null'
                                example: Sample Variant
                              image_path:
                                type:
                                  - string
                                  - 'null'
                                example: /images/sample.png
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/images/sample.png
                              primary_image:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/images/primary.png
                              price:
                                type:
                                  - string
                                  - 'null'
                                example: '34.44'
                              price_in_currency:
                                type:
                                  - string
                                  - 'null'
                                example: $34.44
                              sku:
                                type:
                                  - string
                                  - 'null'
                                example: SKU12345
                              options:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    title:
                                      type: string
                                      example: Size
                                    value:
                                      type: string
                                      example: XL
                              product:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  title:
                                    type: string
                                    example: Sample Product
                                  introduction:
                                    type:
                                      - string
                                      - 'null'
                                    example: Sample Short Description
                                  cv:
                                    type: integer
                                    example: 10
                                  cv_in_currency:
                                    type: string
                                    example: $10.00
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: ext-prod-123
                                  image_path:
                                    type:
                                      - string
                                      - 'null'
                                    example: /images/product.png
                                  image_url:
                                    type:
                                      - string
                                      - 'null'
                                    example: https://example.com/images/product.png
                                  price:
                                    type: string
                                    example: '29.99'
                                  price_in_currency:
                                    type: string
                                    example: $29.99
                                  sku:
                                    type:
                                      - string
                                      - 'null'
                                    example: SKU12345
                                  tax:
                                    type: string
                                    example: '2.99'
                                  tax_in_currency:
                                    type: string
                                    example: $2.99
                                  metadata:
                                    type: object
                                    example:
                                      shopify_product_id: 9876054868270
                                  metafields:
                                    type: array
                                    items:
                                      title: LegacyMetafield
                                      type: object
                                      properties:
                                        namespace:
                                          description: >-
                                            A container for related metafields.
                                            Commonly used to group metafields by app
                                            or functionality.
                                          example: custom
                                          type: string
                                          maxLength: 20
                                          pattern: ^[a-zA-Z0-9_]+$
                                        key:
                                          description: >-
                                            The unique identifier for the metafield
                                            within its namespace. Must be unique per
                                            namespace and owner.
                                          example: material
                                          type: string
                                          maxLength: 30
                                          pattern: ^[a-zA-Z0-9_]+$
                                        value:
                                          description: >-
                                            The actual data stored in the metafield.
                                            Type depends on value_type.
                                          example: cotton
                                          type:
                                            - string
                                            - integer
                                            - object
                                            - boolean
                                            - number
                                        value_type:
                                          description: >-
                                            The data type that defines how the value
                                            should be interpreted and validated.
                                          example: single_line_text_field
                                          type: string
                                        description:
                                          description: >-
                                            Optional human-readable description
                                            explaining the purpose of this
                                            metafield.
                                          example: >-
                                            The primary material used in this
                                            product
                                          type:
                                            - string
                                            - 'null'
                                        created_at:
                                          description: >-
                                            Timestamp when the metafield was
                                            created.
                                          example: '2021-01-01T00:00:00Z'
                                          type: string
                                          format: date-time
                                        updated_at:
                                          description: >-
                                            Timestamp when the metafield was last
                                            updated.
                                          example: '2021-01-01T00:00:00Z'
                                          type: string
                                          format: date-time
                                        locked:
                                          description: >-
                                            Whether this metafield is locked and
                                            cannot be updated or deleted directly.
                                          example: false
                                          type:
                                            - boolean
                                            - 'null'
                                            - 'null'
                                        metafield_definition:
                                          description: >-
                                            The definition that defines validation
                                            rules and structure for this metafield
                                          type:
                                            - 'null'
                                            - object
                                      required:
                                        - namespace
                                        - key
                                        - value
                                        - value_type
                                        - description
                                        - created_at
                                        - updated_at
                                        - metafield_definition
                      customer:
                        title: Customer
                        type: object
                        properties:
                          id:
                            type: integer
                          account_id:
                            type:
                              - string
                              - 'null'
                          first_name:
                            type:
                              - string
                              - 'null'
                          last_name:
                            type:
                              - string
                              - 'null'
                          full_name:
                            type: string
                          email:
                            type: string
                            pattern: >-
                              ^[a-zA-Z0-9.!\#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$
                          verified_email:
                            type:
                              - boolean
                              - 'null'
                            default: false
                          phone:
                            type:
                              - string
                              - 'null'
                          orders_count:
                            type:
                              - integer
                              - 'null'
                            default: 0
                          created_at:
                            type: string
                            format: date-time
                          display_total_spent:
                            type: string
                          metadata:
                            type: object
                            default: '{}'
                          user_company_id:
                            type:
                              - integer
                              - 'null'
                          external_id:
                            type:
                              - string
                              - 'null'
                          role:
                            type: string
                            enum:
                              - customer
                              - preferred_customer
                              - rep
                          last_order_id:
                            example: 101
                            type:
                              - integer
                              - 'null'
                          notes:
                            example: This is a note
                            type:
                              - string
                              - 'null'
                          active:
                            type: boolean
                          total_spent:
                            example: 100
                            type:
                              - number
                              - string
                          customer_notes:
                            type: array
                            items:
                              title: CustomerNote
                              type: object
                              properties:
                                id:
                                  type: integer
                                note:
                                  type: string
                                user_company_id:
                                  type:
                                    - integer
                                    - 'null'
                                customer_id:
                                  type: integer
                                resource_id:
                                  type:
                                    - integer
                                    - 'null'
                                resource_type:
                                  type:
                                    - string
                                    - 'null'
                                created_at:
                                  type: string
                                  format: date-time
                              required:
                                - id
                                - note
                                - customer_id
                                - created_at
                          default_address:
                            title: Address
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                              name:
                                example: John Doe
                                type: string
                              address1:
                                example: 123 Main St
                                type: string
                              address2:
                                example: Apt 4B
                                type:
                                  - string
                                  - 'null'
                              address3:
                                example: Building 5
                                type:
                                  - string
                                  - 'null'
                              city:
                                example: New York
                                type: string
                              state:
                                example: NY
                                type: string
                              subdivision_code:
                                example: NY
                                type:
                                  - string
                                  - 'null'
                              postal_code:
                                example: '10001'
                                type: string
                              country_code:
                                example: US
                                type:
                                  - string
                                  - 'null'
                              default:
                                description: >-
                                  Use this address by default when there are
                                  multiple addresses
                                example: true
                                type:
                                  - boolean
                                  - 'null'
                                default: false
                              first_name:
                                example: John
                                type: string
                              last_name:
                                example: Doe
                                type: string
                            required:
                              - id
                              - name
                              - address1
                              - city
                              - state
                              - postal_code
                              - first_name
                              - last_name
                          addresses:
                            type: array
                          payment_methods:
                            type: array
                          is_rep:
                            example: true
                            type: boolean
                          is_discarded:
                            example: false
                            type: boolean
                        required:
                          - id
                          - full_name
                          - email
                          - created_at
                          - display_total_spent
                          - metadata
                          - role
                          - active
                          - total_spent
                          - customer_notes
                          - addresses
                          - payment_methods
                          - is_rep
                          - is_discarded
                      customer_notes:
                        type: array
                      address:
                        title: Address
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: John Doe
                            type: string
                          address1:
                            example: 123 Main St
                            type: string
                          address2:
                            example: Apt 4B
                            type:
                              - string
                              - 'null'
                          address3:
                            example: Building 5
                            type:
                              - string
                              - 'null'
                          city:
                            example: New York
                            type: string
                          state:
                            example: NY
                            type: string
                          subdivision_code:
                            example: NY
                            type:
                              - string
                              - 'null'
                          postal_code:
                            example: '10001'
                            type: string
                          country_code:
                            example: US
                            type:
                              - string
                              - 'null'
                          default:
                            description: >-
                              Use this address by default when there are
                              multiple addresses
                            example: true
                            type:
                              - boolean
                              - 'null'
                            default: false
                          first_name:
                            example: John
                            type: string
                          last_name:
                            example: Doe
                            type: string
                        required:
                          - id
                          - name
                          - address1
                          - city
                          - state
                          - postal_code
                          - first_name
                          - last_name
                      payment_method:
                        title: Commerce::PaymentMethod
                        type: object
                        properties:
                          id:
                            type: integer
                          source:
                            type: string
                            enum:
                              - apple_pay
                              - paypal
                              - card
                              - iap
                              - bread
                              - affirm
                              - google_pay
                              - klarna
                              - droplet
                              - citcon
                              - ppro
                          payload:
                            type:
                              - object
                              - 'null'
                          created_at:
                            type: string
                            format: date-time
                          updated_at:
                            type: string
                            format: date-time
                          default:
                            type: boolean
                          payment_type:
                            example: Credit Card
                            type: string
                          details:
                            type: object
                        required:
                          - id
                          - source
                          - created_at
                          - updated_at
                          - default
                          - payment_type
                          - details
                      currency:
                        title: Currency
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: United States Dollar
                            type:
                              - string
                              - 'null'
                          code:
                            example: USD
                            type: string
                          rate:
                            example: 1
                            type:
                              - number
                              - string
                              - 'null'
                          active:
                            example: true
                            type:
                              - boolean
                              - 'null'
                            default: false
                          symbol:
                            example: $
                            type:
                              - string
                              - 'null'
                        required:
                          - id
                          - code
                      country:
                        title: Country
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: United States
                            type: string
                          iso:
                            description: 2-letter country code (ISO 3166-1 alpha-2)
                            example: US
                            type: string
                        required:
                          - id
                          - name
                          - iso
                      company:
                        title: Company
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: Acme, Inc.
                            type: string
                        required:
                          - id
                          - name
                      subscription_skips:
                        type: array
                        items:
                          title: Commerce::SubscriptionSkip
                          type: object
                          properties:
                            id:
                              type: integer
                            skipped_date:
                              example: '2025-01-01T00:00:00Z'
                              type: string
                              format: date
                            reason:
                              example: Customer requested to skip next billing
                              type:
                                - 'null'
                            created_at:
                              example: '2025-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            updated_at:
                              example: '2025-01-01T00:00:00Z'
                              type: string
                              format: date-time
                          required:
                            - id
                            - skipped_date
                            - created_at
                            - updated_at
                      orders:
                        type: array
                        items:
                          title: Commerce::Order
                          type: object
                          properties:
                            id:
                              type: integer
                            first_name:
                              type:
                                - string
                                - 'null'
                            last_name:
                              type:
                                - string
                                - 'null'
                            email:
                              type:
                                - string
                                - 'null'
                            phone:
                              type:
                                - string
                                - 'null'
                            order_number:
                              type:
                                - string
                                - 'null'
                            status:
                              type: string
                              enum:
                                - awaiting_payment
                                - awaiting_shipment
                                - shipped
                                - delivered
                                - archived
                                - cancelled
                                - failed_payment
                                - draft
                            order_type:
                              type: string
                              enum:
                                - requested
                                - purchased
                                - imported
                                - abandoned
                            source:
                              type: string
                              enum:
                                - mobile
                                - web
                                - admin
                                - backoffice
                                - subscription
                                - enrollment
                            amount:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                            amount_in_base:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                            base_to_currency_rate:
                              type:
                                - number
                                - string
                                - 'null'
                            note:
                              type:
                                - string
                                - 'null'
                            currency_code:
                              type:
                                - string
                                - 'null'
                            created_at:
                              type: string
                              format: date-time
                            updated_at:
                              type: string
                              format: date-time
                            metadata:
                              type:
                                - object
                                - 'null'
                              default: '{}'
                            token:
                              type: string
                            refundable_amount:
                              type: string
                            order_status:
                              type: string
                              enum:
                                - draft
                                - pending
                                - processing
                                - completed
                                - cancelled
                                - archived
                            fulfillment_status:
                              type: string
                              enum:
                                - unfulfilled
                                - in_progress
                                - on_hold
                                - partially_fulfilled
                                - scheduled
                                - fulfilled
                            financial_status:
                              type: string
                              enum:
                                - pending
                                - authorized
                                - partially_paid
                                - paid
                                - partially_refunded
                                - refunded
                                - voided
                                - marked_free
                                - marked_paid
                            warehouse_id:
                              type:
                                - integer
                                - 'null'
                            split_payment:
                              type:
                                - object
                                - 'null'
                            points_applied:
                              default: 0
                              type: integer
                            points_applied_amount_in_currency:
                              type: number
                            order_total_after_points_redemption:
                              type: number
                            free_shipping:
                              description: Whether the order has free shipping
                              type: boolean
                            discount_codes:
                              default: []
                              description: Discount codes applied to the order
                              type: array
                            shipping_method:
                              type: object
                            items_quantity:
                              example: 5
                              type: integer
                          required:
                            - id
                            - status
                            - order_type
                            - source
                            - created_at
                            - updated_at
                            - token
                            - refundable_amount
                            - order_status
                            - fulfillment_status
                            - financial_status
                            - points_applied
                            - points_applied_amount_in_currency
                            - order_total_after_points_redemption
                            - free_shipping
                            - discount_codes
                            - shipping_method
                            - items_quantity
                      bundled_subscriptions:
                        type: array
                    required:
                      - id
                      - subscription_token
                      - next_bill_date
                      - status
                      - quantity
                      - price
                      - original_price
                      - created_at
                      - updated_at
                      - cv_total
                      - qv_total
                      - subscription_plan
                      - variant
                      - customer
                      - customer_notes
                      - address
                      - payment_method
                      - currency
                      - country
                      - company
                      - subscription_skips
                      - orders
                      - bundled_subscriptions
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - subscription
        '404':
          description: not found - subscription
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: unprocessable entity - not in paused state
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/subscriptions/{token}/cancel:
    post:
      summary: Cancel a subscription
      description: Cancel a subscription
      tags:
        - Subscriptions
      operationId: cancelSubscription
      security:
        - bearer_auth: []
      parameters:
        - name: token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription:
                    title: Commerce::Subscription
                    type: object
                    properties:
                      id:
                        type: integer
                      subscription_token:
                        example: sb_1234567890
                        type: string
                      next_bill_date:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                      last_bill_date:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      next_ship_date:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      last_ship_date:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      status:
                        example: active
                        type: string
                        enum:
                          - pending
                          - active
                          - paused
                          - past_due
                          - cancelled
                      disabled:
                        example: false
                        type:
                          - boolean
                          - 'null'
                        default: false
                      quantity:
                        example: 1
                        type: integer
                        default: 1
                        minimum: 1
                      price:
                        example: 100
                        type: number
                      original_price:
                        example: 100
                        type: number
                      attempts:
                        example: 1
                        type:
                          - integer
                          - 'null'
                        default: 0
                      last_failed_at:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      next_retry_at:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      skipped_count:
                        example: 1
                        type:
                          - integer
                          - 'null'
                        default: 0
                      max_skips:
                        example: 1
                        type:
                          - integer
                          - 'null'
                      cancelled_at:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      created_at:
                        example: '2025-03-10T00:00:00Z'
                        type: string
                        format: date-time
                      updated_at:
                        example: '2025-03-10T00:00:00Z'
                        type: string
                        format: date-time
                      notes:
                        example: This is a sample commerce subscription
                        type:
                          - string
                          - 'null'
                      cv_total:
                        example: 100
                        type: integer
                      qv_total:
                        example: 50
                        type: integer
                      subscription_plan:
                        title: Commerce::SubscriptionPlan
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: Test Subscription Plan
                            type: string
                          billing_interval:
                            example: 1
                            type: integer
                            default: 1
                            minimum: 1
                            maximum: 29
                          billing_interval_unit:
                            description: 'Possible values: `day`, `week`, `month`, `year`'
                            example: day
                            type: string
                            default: month
                          billing_frequency_in_words:
                            example: 2 Months
                            type: string
                          shipping_interval:
                            example: 1
                            type: integer
                            default: 1
                            minimum: 1
                            maximum: 29
                          shipping_interval_unit:
                            description: 'Possible values: `day`, `week`, `month`, `year`'
                            example: day
                            type: string
                            default: month
                          volume_interval:
                            example: 1
                            type: integer
                            default: 1
                            minimum: 1
                            maximum: 29
                          volume_interval_unit:
                            description: 'Possible values: `day`, `week`, `month`, `year`'
                            example: day
                            type: string
                            default: month
                          trial_period:
                            example: 1
                            type:
                              - integer
                              - 'null'
                            minimum: 1
                          trial_period_unit:
                            description: 'Possible values: `day`, `week`, `month`, `year`'
                            example: day
                            type:
                              - string
                              - 'null'
                          split_volume:
                            example: true
                            type: boolean
                            default: false
                          allow_skipping:
                            example: true
                            type:
                              - boolean
                              - 'null'
                            default: true
                          max_skips:
                            example: 1
                            type:
                              - integer
                              - 'null'
                            minimum: 1
                          allow_max_billing_cycles:
                            example: true
                            type: boolean
                            default: false
                          max_billing_cycles:
                            example: 3
                            type:
                              - integer
                              - 'null'
                          price_adjustment_type:
                            example: percentage or fixed_amount
                            type:
                              - string
                              - 'null'
                          price_adjustment_amount:
                            example: 10
                            type:
                              - number
                              - 'null'
                          active:
                            example: true
                            type:
                              - boolean
                              - 'null'
                            default: true
                          company_default:
                            example: false
                            type:
                              - boolean
                              - 'null'
                            default: false
                          created_at:
                            example: '2025-03-10T00:00:00Z'
                            type: string
                            format: date-time
                          updated_at:
                            example: '2025-03-10T00:00:00Z'
                            type: string
                            format: date-time
                          products_count:
                            example: 10
                            type:
                              - integer
                              - 'null'
                          subscribers_count:
                            example: 10
                            type:
                              - integer
                              - 'null'
                        required:
                          - id
                          - name
                          - billing_interval
                          - billing_interval_unit
                          - billing_frequency_in_words
                          - shipping_interval
                          - shipping_interval_unit
                          - volume_interval
                          - volume_interval_unit
                          - split_volume
                          - allow_max_billing_cycles
                          - created_at
                          - updated_at
                      variant:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              title:
                                type:
                                  - string
                                  - 'null'
                                example: Sample Variant
                              image_path:
                                type:
                                  - string
                                  - 'null'
                                example: /images/sample.png
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/images/sample.png
                              primary_image:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/images/primary.png
                              price:
                                type:
                                  - string
                                  - 'null'
                                example: '34.44'
                              price_in_currency:
                                type:
                                  - string
                                  - 'null'
                                example: $34.44
                              sku:
                                type:
                                  - string
                                  - 'null'
                                example: SKU12345
                              options:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    title:
                                      type: string
                                      example: Size
                                    value:
                                      type: string
                                      example: XL
                              product:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  title:
                                    type: string
                                    example: Sample Product
                                  introduction:
                                    type:
                                      - string
                                      - 'null'
                                    example: Sample Short Description
                                  cv:
                                    type: integer
                                    example: 10
                                  cv_in_currency:
                                    type: string
                                    example: $10.00
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: ext-prod-123
                                  image_path:
                                    type:
                                      - string
                                      - 'null'
                                    example: /images/product.png
                                  image_url:
                                    type:
                                      - string
                                      - 'null'
                                    example: https://example.com/images/product.png
                                  price:
                                    type: string
                                    example: '29.99'
                                  price_in_currency:
                                    type: string
                                    example: $29.99
                                  sku:
                                    type:
                                      - string
                                      - 'null'
                                    example: SKU12345
                                  tax:
                                    type: string
                                    example: '2.99'
                                  tax_in_currency:
                                    type: string
                                    example: $2.99
                                  metadata:
                                    type: object
                                    example:
                                      shopify_product_id: 9876054868270
                                  metafields:
                                    type: array
                                    items:
                                      title: LegacyMetafield
                                      type: object
                                      properties:
                                        namespace:
                                          description: >-
                                            A container for related metafields.
                                            Commonly used to group metafields by app
                                            or functionality.
                                          example: custom
                                          type: string
                                          maxLength: 20
                                          pattern: ^[a-zA-Z0-9_]+$
                                        key:
                                          description: >-
                                            The unique identifier for the metafield
                                            within its namespace. Must be unique per
                                            namespace and owner.
                                          example: material
                                          type: string
                                          maxLength: 30
                                          pattern: ^[a-zA-Z0-9_]+$
                                        value:
                                          description: >-
                                            The actual data stored in the metafield.
                                            Type depends on value_type.
                                          example: cotton
                                          type:
                                            - string
                                            - integer
                                            - object
                                            - boolean
                                            - number
                                        value_type:
                                          description: >-
                                            The data type that defines how the value
                                            should be interpreted and validated.
                                          example: single_line_text_field
                                          type: string
                                        description:
                                          description: >-
                                            Optional human-readable description
                                            explaining the purpose of this
                                            metafield.
                                          example: >-
                                            The primary material used in this
                                            product
                                          type:
                                            - string
                                            - 'null'
                                        created_at:
                                          description: >-
                                            Timestamp when the metafield was
                                            created.
                                          example: '2021-01-01T00:00:00Z'
                                          type: string
                                          format: date-time
                                        updated_at:
                                          description: >-
                                            Timestamp when the metafield was last
                                            updated.
                                          example: '2021-01-01T00:00:00Z'
                                          type: string
                                          format: date-time
                                        locked:
                                          description: >-
                                            Whether this metafield is locked and
                                            cannot be updated or deleted directly.
                                          example: false
                                          type:
                                            - boolean
                                            - 'null'
                                            - 'null'
                                        metafield_definition:
                                          description: >-
                                            The definition that defines validation
                                            rules and structure for this metafield
                                          type:
                                            - 'null'
                                            - object
                                      required:
                                        - namespace
                                        - key
                                        - value
                                        - value_type
                                        - description
                                        - created_at
                                        - updated_at
                                        - metafield_definition
                      customer:
                        title: Customer
                        type: object
                        properties:
                          id:
                            type: integer
                          account_id:
                            type:
                              - string
                              - 'null'
                          first_name:
                            type:
                              - string
                              - 'null'
                          last_name:
                            type:
                              - string
                              - 'null'
                          full_name:
                            type: string
                          email:
                            type: string
                            pattern: >-
                              ^[a-zA-Z0-9.!\#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$
                          verified_email:
                            type:
                              - boolean
                              - 'null'
                            default: false
                          phone:
                            type:
                              - string
                              - 'null'
                          orders_count:
                            type:
                              - integer
                              - 'null'
                            default: 0
                          created_at:
                            type: string
                            format: date-time
                          display_total_spent:
                            type: string
                          metadata:
                            type: object
                            default: '{}'
                          user_company_id:
                            type:
                              - integer
                              - 'null'
                          external_id:
                            type:
                              - string
                              - 'null'
                          role:
                            type: string
                            enum:
                              - customer
                              - preferred_customer
                              - rep
                          last_order_id:
                            example: 101
                            type:
                              - integer
                              - 'null'
                          notes:
                            example: This is a note
                            type:
                              - string
                              - 'null'
                          active:
                            type: boolean
                          total_spent:
                            example: 100
                            type:
                              - number
                              - string
                          customer_notes:
                            type: array
                            items:
                              title: CustomerNote
                              type: object
                              properties:
                                id:
                                  type: integer
                                note:
                                  type: string
                                user_company_id:
                                  type:
                                    - integer
                                    - 'null'
                                customer_id:
                                  type: integer
                                resource_id:
                                  type:
                                    - integer
                                    - 'null'
                                resource_type:
                                  type:
                                    - string
                                    - 'null'
                                created_at:
                                  type: string
                                  format: date-time
                              required:
                                - id
                                - note
                                - customer_id
                                - created_at
                          default_address:
                            title: Address
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                              name:
                                example: John Doe
                                type: string
                              address1:
                                example: 123 Main St
                                type: string
                              address2:
                                example: Apt 4B
                                type:
                                  - string
                                  - 'null'
                              address3:
                                example: Building 5
                                type:
                                  - string
                                  - 'null'
                              city:
                                example: New York
                                type: string
                              state:
                                example: NY
                                type: string
                              subdivision_code:
                                example: NY
                                type:
                                  - string
                                  - 'null'
                              postal_code:
                                example: '10001'
                                type: string
                              country_code:
                                example: US
                                type:
                                  - string
                                  - 'null'
                              default:
                                description: >-
                                  Use this address by default when there are
                                  multiple addresses
                                example: true
                                type:
                                  - boolean
                                  - 'null'
                                default: false
                              first_name:
                                example: John
                                type: string
                              last_name:
                                example: Doe
                                type: string
                            required:
                              - id
                              - name
                              - address1
                              - city
                              - state
                              - postal_code
                              - first_name
                              - last_name
                          addresses:
                            type: array
                          payment_methods:
                            type: array
                          is_rep:
                            example: true
                            type: boolean
                          is_discarded:
                            example: false
                            type: boolean
                        required:
                          - id
                          - full_name
                          - email
                          - created_at
                          - display_total_spent
                          - metadata
                          - role
                          - active
                          - total_spent
                          - customer_notes
                          - addresses
                          - payment_methods
                          - is_rep
                          - is_discarded
                      customer_notes:
                        type: array
                      address:
                        title: Address
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: John Doe
                            type: string
                          address1:
                            example: 123 Main St
                            type: string
                          address2:
                            example: Apt 4B
                            type:
                              - string
                              - 'null'
                          address3:
                            example: Building 5
                            type:
                              - string
                              - 'null'
                          city:
                            example: New York
                            type: string
                          state:
                            example: NY
                            type: string
                          subdivision_code:
                            example: NY
                            type:
                              - string
                              - 'null'
                          postal_code:
                            example: '10001'
                            type: string
                          country_code:
                            example: US
                            type:
                              - string
                              - 'null'
                          default:
                            description: >-
                              Use this address by default when there are
                              multiple addresses
                            example: true
                            type:
                              - boolean
                              - 'null'
                            default: false
                          first_name:
                            example: John
                            type: string
                          last_name:
                            example: Doe
                            type: string
                        required:
                          - id
                          - name
                          - address1
                          - city
                          - state
                          - postal_code
                          - first_name
                          - last_name
                      payment_method:
                        title: Commerce::PaymentMethod
                        type: object
                        properties:
                          id:
                            type: integer
                          source:
                            type: string
                            enum:
                              - apple_pay
                              - paypal
                              - card
                              - iap
                              - bread
                              - affirm
                              - google_pay
                              - klarna
                              - droplet
                              - citcon
                              - ppro
                          payload:
                            type:
                              - object
                              - 'null'
                          created_at:
                            type: string
                            format: date-time
                          updated_at:
                            type: string
                            format: date-time
                          default:
                            type: boolean
                          payment_type:
                            example: Credit Card
                            type: string
                          details:
                            type: object
                        required:
                          - id
                          - source
                          - created_at
                          - updated_at
                          - default
                          - payment_type
                          - details
                      currency:
                        title: Currency
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: United States Dollar
                            type:
                              - string
                              - 'null'
                          code:
                            example: USD
                            type: string
                          rate:
                            example: 1
                            type:
                              - number
                              - string
                              - 'null'
                          active:
                            example: true
                            type:
                              - boolean
                              - 'null'
                            default: false
                          symbol:
                            example: $
                            type:
                              - string
                              - 'null'
                        required:
                          - id
                          - code
                      country:
                        title: Country
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: United States
                            type: string
                          iso:
                            description: 2-letter country code (ISO 3166-1 alpha-2)
                            example: US
                            type: string
                        required:
                          - id
                          - name
                          - iso
                      company:
                        title: Company
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: Acme, Inc.
                            type: string
                        required:
                          - id
                          - name
                      subscription_skips:
                        type: array
                        items:
                          title: Commerce::SubscriptionSkip
                          type: object
                          properties:
                            id:
                              type: integer
                            skipped_date:
                              example: '2025-01-01T00:00:00Z'
                              type: string
                              format: date
                            reason:
                              example: Customer requested to skip next billing
                              type:
                                - 'null'
                            created_at:
                              example: '2025-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            updated_at:
                              example: '2025-01-01T00:00:00Z'
                              type: string
                              format: date-time
                          required:
                            - id
                            - skipped_date
                            - created_at
                            - updated_at
                      orders:
                        type: array
                        items:
                          title: Commerce::Order
                          type: object
                          properties:
                            id:
                              type: integer
                            first_name:
                              type:
                                - string
                                - 'null'
                            last_name:
                              type:
                                - string
                                - 'null'
                            email:
                              type:
                                - string
                                - 'null'
                            phone:
                              type:
                                - string
                                - 'null'
                            order_number:
                              type:
                                - string
                                - 'null'
                            status:
                              type: string
                              enum:
                                - awaiting_payment
                                - awaiting_shipment
                                - shipped
                                - delivered
                                - archived
                                - cancelled
                                - failed_payment
                                - draft
                            order_type:
                              type: string
                              enum:
                                - requested
                                - purchased
                                - imported
                                - abandoned
                            source:
                              type: string
                              enum:
                                - mobile
                                - web
                                - admin
                                - backoffice
                                - subscription
                                - enrollment
                            amount:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                            amount_in_base:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                            base_to_currency_rate:
                              type:
                                - number
                                - string
                                - 'null'
                            note:
                              type:
                                - string
                                - 'null'
                            currency_code:
                              type:
                                - string
                                - 'null'
                            created_at:
                              type: string
                              format: date-time
                            updated_at:
                              type: string
                              format: date-time
                            metadata:
                              type:
                                - object
                                - 'null'
                              default: '{}'
                            token:
                              type: string
                            refundable_amount:
                              type: string
                            order_status:
                              type: string
                              enum:
                                - draft
                                - pending
                                - processing
                                - completed
                                - cancelled
                                - archived
                            fulfillment_status:
                              type: string
                              enum:
                                - unfulfilled
                                - in_progress
                                - on_hold
                                - partially_fulfilled
                                - scheduled
                                - fulfilled
                            financial_status:
                              type: string
                              enum:
                                - pending
                                - authorized
                                - partially_paid
                                - paid
                                - partially_refunded
                                - refunded
                                - voided
                                - marked_free
                                - marked_paid
                            warehouse_id:
                              type:
                                - integer
                                - 'null'
                            split_payment:
                              type:
                                - object
                                - 'null'
                            points_applied:
                              default: 0
                              type: integer
                            points_applied_amount_in_currency:
                              type: number
                            order_total_after_points_redemption:
                              type: number
                            free_shipping:
                              description: Whether the order has free shipping
                              type: boolean
                            discount_codes:
                              default: []
                              description: Discount codes applied to the order
                              type: array
                            shipping_method:
                              type: object
                            items_quantity:
                              example: 5
                              type: integer
                          required:
                            - id
                            - status
                            - order_type
                            - source
                            - created_at
                            - updated_at
                            - token
                            - refundable_amount
                            - order_status
                            - fulfillment_status
                            - financial_status
                            - points_applied
                            - points_applied_amount_in_currency
                            - order_total_after_points_redemption
                            - free_shipping
                            - discount_codes
                            - shipping_method
                            - items_quantity
                      bundled_subscriptions:
                        type: array
                    required:
                      - id
                      - subscription_token
                      - next_bill_date
                      - status
                      - quantity
                      - price
                      - original_price
                      - created_at
                      - updated_at
                      - cv_total
                      - qv_total
                      - subscription_plan
                      - variant
                      - customer
                      - customer_notes
                      - address
                      - payment_method
                      - currency
                      - country
                      - company
                      - subscription_skips
                      - orders
                      - bundled_subscriptions
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - subscription
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/subscriptions/{token}/reactivate:
    post:
      summary: Reactivate a cancelled subscription
      description: Reactivate a previously cancelled subscription
      tags:
        - Subscriptions
      operationId: reactivateSubscription
      security:
        - bearer_auth: []
      parameters:
        - name: token
          in: path
          required: true
          schema:
            type: string
        - name: next_bill_date
          in: query
          schema:
            type: string
            format: date
          required: false
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription:
                    title: Commerce::Subscription
                    type: object
                    properties:
                      id:
                        type: integer
                      subscription_token:
                        example: sb_1234567890
                        type: string
                      next_bill_date:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                      last_bill_date:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      next_ship_date:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      last_ship_date:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      status:
                        example: active
                        type: string
                        enum:
                          - pending
                          - active
                          - paused
                          - past_due
                          - cancelled
                      disabled:
                        example: false
                        type:
                          - boolean
                          - 'null'
                        default: false
                      quantity:
                        example: 1
                        type: integer
                        default: 1
                        minimum: 1
                      price:
                        example: 100
                        type: number
                      original_price:
                        example: 100
                        type: number
                      attempts:
                        example: 1
                        type:
                          - integer
                          - 'null'
                        default: 0
                      last_failed_at:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      next_retry_at:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      skipped_count:
                        example: 1
                        type:
                          - integer
                          - 'null'
                        default: 0
                      max_skips:
                        example: 1
                        type:
                          - integer
                          - 'null'
                      cancelled_at:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      created_at:
                        example: '2025-03-10T00:00:00Z'
                        type: string
                        format: date-time
                      updated_at:
                        example: '2025-03-10T00:00:00Z'
                        type: string
                        format: date-time
                      notes:
                        example: This is a sample commerce subscription
                        type:
                          - string
                          - 'null'
                      cv_total:
                        example: 100
                        type: integer
                      qv_total:
                        example: 50
                        type: integer
                      subscription_plan:
                        title: Commerce::SubscriptionPlan
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: Test Subscription Plan
                            type: string
                          billing_interval:
                            example: 1
                            type: integer
                            default: 1
                            minimum: 1
                            maximum: 29
                          billing_interval_unit:
                            description: 'Possible values: `day`, `week`, `month`, `year`'
                            example: day
                            type: string
                            default: month
                          billing_frequency_in_words:
                            example: 2 Months
                            type: string
                          shipping_interval:
                            example: 1
                            type: integer
                            default: 1
                            minimum: 1
                            maximum: 29
                          shipping_interval_unit:
                            description: 'Possible values: `day`, `week`, `month`, `year`'
                            example: day
                            type: string
                            default: month
                          volume_interval:
                            example: 1
                            type: integer
                            default: 1
                            minimum: 1
                            maximum: 29
                          volume_interval_unit:
                            description: 'Possible values: `day`, `week`, `month`, `year`'
                            example: day
                            type: string
                            default: month
                          trial_period:
                            example: 1
                            type:
                              - integer
                              - 'null'
                            minimum: 1
                          trial_period_unit:
                            description: 'Possible values: `day`, `week`, `month`, `year`'
                            example: day
                            type:
                              - string
                              - 'null'
                          split_volume:
                            example: true
                            type: boolean
                            default: false
                          allow_skipping:
                            example: true
                            type:
                              - boolean
                              - 'null'
                            default: true
                          max_skips:
                            example: 1
                            type:
                              - integer
                              - 'null'
                            minimum: 1
                          allow_max_billing_cycles:
                            example: true
                            type: boolean
                            default: false
                          max_billing_cycles:
                            example: 3
                            type:
                              - integer
                              - 'null'
                          price_adjustment_type:
                            example: percentage or fixed_amount
                            type:
                              - string
                              - 'null'
                          price_adjustment_amount:
                            example: 10
                            type:
                              - number
                              - 'null'
                          active:
                            example: true
                            type:
                              - boolean
                              - 'null'
                            default: true
                          company_default:
                            example: false
                            type:
                              - boolean
                              - 'null'
                            default: false
                          created_at:
                            example: '2025-03-10T00:00:00Z'
                            type: string
                            format: date-time
                          updated_at:
                            example: '2025-03-10T00:00:00Z'
                            type: string
                            format: date-time
                          products_count:
                            example: 10
                            type:
                              - integer
                              - 'null'
                          subscribers_count:
                            example: 10
                            type:
                              - integer
                              - 'null'
                        required:
                          - id
                          - name
                          - billing_interval
                          - billing_interval_unit
                          - billing_frequency_in_words
                          - shipping_interval
                          - shipping_interval_unit
                          - volume_interval
                          - volume_interval_unit
                          - split_volume
                          - allow_max_billing_cycles
                          - created_at
                          - updated_at
                      variant:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              title:
                                type:
                                  - string
                                  - 'null'
                                example: Sample Variant
                              image_path:
                                type:
                                  - string
                                  - 'null'
                                example: /images/sample.png
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/images/sample.png
                              primary_image:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/images/primary.png
                              price:
                                type:
                                  - string
                                  - 'null'
                                example: '34.44'
                              price_in_currency:
                                type:
                                  - string
                                  - 'null'
                                example: $34.44
                              sku:
                                type:
                                  - string
                                  - 'null'
                                example: SKU12345
                              options:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    title:
                                      type: string
                                      example: Size
                                    value:
                                      type: string
                                      example: XL
                              product:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  title:
                                    type: string
                                    example: Sample Product
                                  introduction:
                                    type:
                                      - string
                                      - 'null'
                                    example: Sample Short Description
                                  cv:
                                    type: integer
                                    example: 10
                                  cv_in_currency:
                                    type: string
                                    example: $10.00
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: ext-prod-123
                                  image_path:
                                    type:
                                      - string
                                      - 'null'
                                    example: /images/product.png
                                  image_url:
                                    type:
                                      - string
                                      - 'null'
                                    example: https://example.com/images/product.png
                                  price:
                                    type: string
                                    example: '29.99'
                                  price_in_currency:
                                    type: string
                                    example: $29.99
                                  sku:
                                    type:
                                      - string
                                      - 'null'
                                    example: SKU12345
                                  tax:
                                    type: string
                                    example: '2.99'
                                  tax_in_currency:
                                    type: string
                                    example: $2.99
                                  metadata:
                                    type: object
                                    example:
                                      shopify_product_id: 9876054868270
                                  metafields:
                                    type: array
                                    items:
                                      title: LegacyMetafield
                                      type: object
                                      properties:
                                        namespace:
                                          description: >-
                                            A container for related metafields.
                                            Commonly used to group metafields by app
                                            or functionality.
                                          example: custom
                                          type: string
                                          maxLength: 20
                                          pattern: ^[a-zA-Z0-9_]+$
                                        key:
                                          description: >-
                                            The unique identifier for the metafield
                                            within its namespace. Must be unique per
                                            namespace and owner.
                                          example: material
                                          type: string
                                          maxLength: 30
                                          pattern: ^[a-zA-Z0-9_]+$
                                        value:
                                          description: >-
                                            The actual data stored in the metafield.
                                            Type depends on value_type.
                                          example: cotton
                                          type:
                                            - string
                                            - integer
                                            - object
                                            - boolean
                                            - number
                                        value_type:
                                          description: >-
                                            The data type that defines how the value
                                            should be interpreted and validated.
                                          example: single_line_text_field
                                          type: string
                                        description:
                                          description: >-
                                            Optional human-readable description
                                            explaining the purpose of this
                                            metafield.
                                          example: >-
                                            The primary material used in this
                                            product
                                          type:
                                            - string
                                            - 'null'
                                        created_at:
                                          description: >-
                                            Timestamp when the metafield was
                                            created.
                                          example: '2021-01-01T00:00:00Z'
                                          type: string
                                          format: date-time
                                        updated_at:
                                          description: >-
                                            Timestamp when the metafield was last
                                            updated.
                                          example: '2021-01-01T00:00:00Z'
                                          type: string
                                          format: date-time
                                        locked:
                                          description: >-
                                            Whether this metafield is locked and
                                            cannot be updated or deleted directly.
                                          example: false
                                          type:
                                            - boolean
                                            - 'null'
                                            - 'null'
                                        metafield_definition:
                                          description: >-
                                            The definition that defines validation
                                            rules and structure for this metafield
                                          type:
                                            - 'null'
                                            - object
                                      required:
                                        - namespace
                                        - key
                                        - value
                                        - value_type
                                        - description
                                        - created_at
                                        - updated_at
                                        - metafield_definition
                      customer:
                        title: Customer
                        type: object
                        properties:
                          id:
                            type: integer
                          account_id:
                            type:
                              - string
                              - 'null'
                          first_name:
                            type:
                              - string
                              - 'null'
                          last_name:
                            type:
                              - string
                              - 'null'
                          full_name:
                            type: string
                          email:
                            type: string
                            pattern: >-
                              ^[a-zA-Z0-9.!\#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$
                          verified_email:
                            type:
                              - boolean
                              - 'null'
                            default: false
                          phone:
                            type:
                              - string
                              - 'null'
                          orders_count:
                            type:
                              - integer
                              - 'null'
                            default: 0
                          created_at:
                            type: string
                            format: date-time
                          display_total_spent:
                            type: string
                          metadata:
                            type: object
                            default: '{}'
                          user_company_id:
                            type:
                              - integer
                              - 'null'
                          external_id:
                            type:
                              - string
                              - 'null'
                          role:
                            type: string
                            enum:
                              - customer
                              - preferred_customer
                              - rep
                          last_order_id:
                            example: 101
                            type:
                              - integer
                              - 'null'
                          notes:
                            example: This is a note
                            type:
                              - string
                              - 'null'
                          active:
                            type: boolean
                          total_spent:
                            example: 100
                            type:
                              - number
                              - string
                          customer_notes:
                            type: array
                            items:
                              title: CustomerNote
                              type: object
                              properties:
                                id:
                                  type: integer
                                note:
                                  type: string
                                user_company_id:
                                  type:
                                    - integer
                                    - 'null'
                                customer_id:
                                  type: integer
                                resource_id:
                                  type:
                                    - integer
                                    - 'null'
                                resource_type:
                                  type:
                                    - string
                                    - 'null'
                                created_at:
                                  type: string
                                  format: date-time
                              required:
                                - id
                                - note
                                - customer_id
                                - created_at
                          default_address:
                            title: Address
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                              name:
                                example: John Doe
                                type: string
                              address1:
                                example: 123 Main St
                                type: string
                              address2:
                                example: Apt 4B
                                type:
                                  - string
                                  - 'null'
                              address3:
                                example: Building 5
                                type:
                                  - string
                                  - 'null'
                              city:
                                example: New York
                                type: string
                              state:
                                example: NY
                                type: string
                              subdivision_code:
                                example: NY
                                type:
                                  - string
                                  - 'null'
                              postal_code:
                                example: '10001'
                                type: string
                              country_code:
                                example: US
                                type:
                                  - string
                                  - 'null'
                              default:
                                description: >-
                                  Use this address by default when there are
                                  multiple addresses
                                example: true
                                type:
                                  - boolean
                                  - 'null'
                                default: false
                              first_name:
                                example: John
                                type: string
                              last_name:
                                example: Doe
                                type: string
                            required:
                              - id
                              - name
                              - address1
                              - city
                              - state
                              - postal_code
                              - first_name
                              - last_name
                          addresses:
                            type: array
                          payment_methods:
                            type: array
                          is_rep:
                            example: true
                            type: boolean
                          is_discarded:
                            example: false
                            type: boolean
                        required:
                          - id
                          - full_name
                          - email
                          - created_at
                          - display_total_spent
                          - metadata
                          - role
                          - active
                          - total_spent
                          - customer_notes
                          - addresses
                          - payment_methods
                          - is_rep
                          - is_discarded
                      customer_notes:
                        type: array
                      address:
                        title: Address
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: John Doe
                            type: string
                          address1:
                            example: 123 Main St
                            type: string
                          address2:
                            example: Apt 4B
                            type:
                              - string
                              - 'null'
                          address3:
                            example: Building 5
                            type:
                              - string
                              - 'null'
                          city:
                            example: New York
                            type: string
                          state:
                            example: NY
                            type: string
                          subdivision_code:
                            example: NY
                            type:
                              - string
                              - 'null'
                          postal_code:
                            example: '10001'
                            type: string
                          country_code:
                            example: US
                            type:
                              - string
                              - 'null'
                          default:
                            description: >-
                              Use this address by default when there are
                              multiple addresses
                            example: true
                            type:
                              - boolean
                              - 'null'
                            default: false
                          first_name:
                            example: John
                            type: string
                          last_name:
                            example: Doe
                            type: string
                        required:
                          - id
                          - name
                          - address1
                          - city
                          - state
                          - postal_code
                          - first_name
                          - last_name
                      payment_method:
                        title: Commerce::PaymentMethod
                        type: object
                        properties:
                          id:
                            type: integer
                          source:
                            type: string
                            enum:
                              - apple_pay
                              - paypal
                              - card
                              - iap
                              - bread
                              - affirm
                              - google_pay
                              - klarna
                              - droplet
                              - citcon
                              - ppro
                          payload:
                            type:
                              - object
                              - 'null'
                          created_at:
                            type: string
                            format: date-time
                          updated_at:
                            type: string
                            format: date-time
                          default:
                            type: boolean
                          payment_type:
                            example: Credit Card
                            type: string
                          details:
                            type: object
                        required:
                          - id
                          - source
                          - created_at
                          - updated_at
                          - default
                          - payment_type
                          - details
                      currency:
                        title: Currency
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: United States Dollar
                            type:
                              - string
                              - 'null'
                          code:
                            example: USD
                            type: string
                          rate:
                            example: 1
                            type:
                              - number
                              - string
                              - 'null'
                          active:
                            example: true
                            type:
                              - boolean
                              - 'null'
                            default: false
                          symbol:
                            example: $
                            type:
                              - string
                              - 'null'
                        required:
                          - id
                          - code
                      country:
                        title: Country
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: United States
                            type: string
                          iso:
                            description: 2-letter country code (ISO 3166-1 alpha-2)
                            example: US
                            type: string
                        required:
                          - id
                          - name
                          - iso
                      company:
                        title: Company
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: Acme, Inc.
                            type: string
                        required:
                          - id
                          - name
                      subscription_skips:
                        type: array
                        items:
                          title: Commerce::SubscriptionSkip
                          type: object
                          properties:
                            id:
                              type: integer
                            skipped_date:
                              example: '2025-01-01T00:00:00Z'
                              type: string
                              format: date
                            reason:
                              example: Customer requested to skip next billing
                              type:
                                - 'null'
                            created_at:
                              example: '2025-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            updated_at:
                              example: '2025-01-01T00:00:00Z'
                              type: string
                              format: date-time
                          required:
                            - id
                            - skipped_date
                            - created_at
                            - updated_at
                      orders:
                        type: array
                        items:
                          title: Commerce::Order
                          type: object
                          properties:
                            id:
                              type: integer
                            first_name:
                              type:
                                - string
                                - 'null'
                            last_name:
                              type:
                                - string
                                - 'null'
                            email:
                              type:
                                - string
                                - 'null'
                            phone:
                              type:
                                - string
                                - 'null'
                            order_number:
                              type:
                                - string
                                - 'null'
                            status:
                              type: string
                              enum:
                                - awaiting_payment
                                - awaiting_shipment
                                - shipped
                                - delivered
                                - archived
                                - cancelled
                                - failed_payment
                                - draft
                            order_type:
                              type: string
                              enum:
                                - requested
                                - purchased
                                - imported
                                - abandoned
                            source:
                              type: string
                              enum:
                                - mobile
                                - web
                                - admin
                                - backoffice
                                - subscription
                                - enrollment
                            amount:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                            amount_in_base:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                            base_to_currency_rate:
                              type:
                                - number
                                - string
                                - 'null'
                            note:
                              type:
                                - string
                                - 'null'
                            currency_code:
                              type:
                                - string
                                - 'null'
                            created_at:
                              type: string
                              format: date-time
                            updated_at:
                              type: string
                              format: date-time
                            metadata:
                              type:
                                - object
                                - 'null'
                              default: '{}'
                            token:
                              type: string
                            refundable_amount:
                              type: string
                            order_status:
                              type: string
                              enum:
                                - draft
                                - pending
                                - processing
                                - completed
                                - cancelled
                                - archived
                            fulfillment_status:
                              type: string
                              enum:
                                - unfulfilled
                                - in_progress
                                - on_hold
                                - partially_fulfilled
                                - scheduled
                                - fulfilled
                            financial_status:
                              type: string
                              enum:
                                - pending
                                - authorized
                                - partially_paid
                                - paid
                                - partially_refunded
                                - refunded
                                - voided
                                - marked_free
                                - marked_paid
                            warehouse_id:
                              type:
                                - integer
                                - 'null'
                            split_payment:
                              type:
                                - object
                                - 'null'
                            points_applied:
                              default: 0
                              type: integer
                            points_applied_amount_in_currency:
                              type: number
                            order_total_after_points_redemption:
                              type: number
                            free_shipping:
                              description: Whether the order has free shipping
                              type: boolean
                            discount_codes:
                              default: []
                              description: Discount codes applied to the order
                              type: array
                            shipping_method:
                              type: object
                            items_quantity:
                              example: 5
                              type: integer
                          required:
                            - id
                            - status
                            - order_type
                            - source
                            - created_at
                            - updated_at
                            - token
                            - refundable_amount
                            - order_status
                            - fulfillment_status
                            - financial_status
                            - points_applied
                            - points_applied_amount_in_currency
                            - order_total_after_points_redemption
                            - free_shipping
                            - discount_codes
                            - shipping_method
                            - items_quantity
                      bundled_subscriptions:
                        type: array
                    required:
                      - id
                      - subscription_token
                      - next_bill_date
                      - status
                      - quantity
                      - price
                      - original_price
                      - created_at
                      - updated_at
                      - cv_total
                      - qv_total
                      - subscription_plan
                      - variant
                      - customer
                      - customer_notes
                      - address
                      - payment_method
                      - currency
                      - country
                      - company
                      - subscription_skips
                      - orders
                      - bundled_subscriptions
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - subscription
        '404':
          description: not found - subscription
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: unprocessable entity - not in cancelled state
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/subscriptions/{token}/skip_next_billing:
    post:
      summary: Skip next billing
      description: Skip next billing
      tags:
        - Subscriptions
      operationId: skipNextBilling
      security:
        - bearer_auth: []
      parameters:
        - name: token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription:
                    title: Commerce::Subscription
                    type: object
                    properties:
                      id:
                        type: integer
                      subscription_token:
                        example: sb_1234567890
                        type: string
                      next_bill_date:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                      last_bill_date:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      next_ship_date:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      last_ship_date:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      status:
                        example: active
                        type: string
                        enum:
                          - pending
                          - active
                          - paused
                          - past_due
                          - cancelled
                      disabled:
                        example: false
                        type:
                          - boolean
                          - 'null'
                        default: false
                      quantity:
                        example: 1
                        type: integer
                        default: 1
                        minimum: 1
                      price:
                        example: 100
                        type: number
                      original_price:
                        example: 100
                        type: number
                      attempts:
                        example: 1
                        type:
                          - integer
                          - 'null'
                        default: 0
                      last_failed_at:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      next_retry_at:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      skipped_count:
                        example: 1
                        type:
                          - integer
                          - 'null'
                        default: 0
                      max_skips:
                        example: 1
                        type:
                          - integer
                          - 'null'
                      cancelled_at:
                        example: '2025-03-10T00:00:00Z'
                        type:
                          - string
                          - 'null'
                        format: date-time
                      created_at:
                        example: '2025-03-10T00:00:00Z'
                        type: string
                        format: date-time
                      updated_at:
                        example: '2025-03-10T00:00:00Z'
                        type: string
                        format: date-time
                      notes:
                        example: This is a sample commerce subscription
                        type:
                          - string
                          - 'null'
                      cv_total:
                        example: 100
                        type: integer
                      qv_total:
                        example: 50
                        type: integer
                      subscription_plan:
                        title: Commerce::SubscriptionPlan
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: Test Subscription Plan
                            type: string
                          billing_interval:
                            example: 1
                            type: integer
                            default: 1
                            minimum: 1
                            maximum: 29
                          billing_interval_unit:
                            description: 'Possible values: `day`, `week`, `month`, `year`'
                            example: day
                            type: string
                            default: month
                          billing_frequency_in_words:
                            example: 2 Months
                            type: string
                          shipping_interval:
                            example: 1
                            type: integer
                            default: 1
                            minimum: 1
                            maximum: 29
                          shipping_interval_unit:
                            description: 'Possible values: `day`, `week`, `month`, `year`'
                            example: day
                            type: string
                            default: month
                          volume_interval:
                            example: 1
                            type: integer
                            default: 1
                            minimum: 1
                            maximum: 29
                          volume_interval_unit:
                            description: 'Possible values: `day`, `week`, `month`, `year`'
                            example: day
                            type: string
                            default: month
                          trial_period:
                            example: 1
                            type:
                              - integer
                              - 'null'
                            minimum: 1
                          trial_period_unit:
                            description: 'Possible values: `day`, `week`, `month`, `year`'
                            example: day
                            type:
                              - string
                              - 'null'
                          split_volume:
                            example: true
                            type: boolean
                            default: false
                          allow_skipping:
                            example: true
                            type:
                              - boolean
                              - 'null'
                            default: true
                          max_skips:
                            example: 1
                            type:
                              - integer
                              - 'null'
                            minimum: 1
                          allow_max_billing_cycles:
                            example: true
                            type: boolean
                            default: false
                          max_billing_cycles:
                            example: 3
                            type:
                              - integer
                              - 'null'
                          price_adjustment_type:
                            example: percentage or fixed_amount
                            type:
                              - string
                              - 'null'
                          price_adjustment_amount:
                            example: 10
                            type:
                              - number
                              - 'null'
                          active:
                            example: true
                            type:
                              - boolean
                              - 'null'
                            default: true
                          company_default:
                            example: false
                            type:
                              - boolean
                              - 'null'
                            default: false
                          created_at:
                            example: '2025-03-10T00:00:00Z'
                            type: string
                            format: date-time
                          updated_at:
                            example: '2025-03-10T00:00:00Z'
                            type: string
                            format: date-time
                          products_count:
                            example: 10
                            type:
                              - integer
                              - 'null'
                          subscribers_count:
                            example: 10
                            type:
                              - integer
                              - 'null'
                        required:
                          - id
                          - name
                          - billing_interval
                          - billing_interval_unit
                          - billing_frequency_in_words
                          - shipping_interval
                          - shipping_interval_unit
                          - volume_interval
                          - volume_interval_unit
                          - split_volume
                          - allow_max_billing_cycles
                          - created_at
                          - updated_at
                      variant:
                        oneOf:
                          - type: 'null'
                          - type: object
                            properties:
                              id:
                                type: integer
                                example: 1
                              title:
                                type:
                                  - string
                                  - 'null'
                                example: Sample Variant
                              image_path:
                                type:
                                  - string
                                  - 'null'
                                example: /images/sample.png
                              image_url:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/images/sample.png
                              primary_image:
                                type:
                                  - string
                                  - 'null'
                                example: https://example.com/images/primary.png
                              price:
                                type:
                                  - string
                                  - 'null'
                                example: '34.44'
                              price_in_currency:
                                type:
                                  - string
                                  - 'null'
                                example: $34.44
                              sku:
                                type:
                                  - string
                                  - 'null'
                                example: SKU12345
                              options:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    title:
                                      type: string
                                      example: Size
                                    value:
                                      type: string
                                      example: XL
                              product:
                                type: object
                                properties:
                                  id:
                                    type: integer
                                    example: 1
                                  title:
                                    type: string
                                    example: Sample Product
                                  introduction:
                                    type:
                                      - string
                                      - 'null'
                                    example: Sample Short Description
                                  cv:
                                    type: integer
                                    example: 10
                                  cv_in_currency:
                                    type: string
                                    example: $10.00
                                  external_id:
                                    type:
                                      - string
                                      - 'null'
                                    example: ext-prod-123
                                  image_path:
                                    type:
                                      - string
                                      - 'null'
                                    example: /images/product.png
                                  image_url:
                                    type:
                                      - string
                                      - 'null'
                                    example: https://example.com/images/product.png
                                  price:
                                    type: string
                                    example: '29.99'
                                  price_in_currency:
                                    type: string
                                    example: $29.99
                                  sku:
                                    type:
                                      - string
                                      - 'null'
                                    example: SKU12345
                                  tax:
                                    type: string
                                    example: '2.99'
                                  tax_in_currency:
                                    type: string
                                    example: $2.99
                                  metadata:
                                    type: object
                                    example:
                                      shopify_product_id: 9876054868270
                                  metafields:
                                    type: array
                                    items:
                                      title: LegacyMetafield
                                      type: object
                                      properties:
                                        namespace:
                                          description: >-
                                            A container for related metafields.
                                            Commonly used to group metafields by app
                                            or functionality.
                                          example: custom
                                          type: string
                                          maxLength: 20
                                          pattern: ^[a-zA-Z0-9_]+$
                                        key:
                                          description: >-
                                            The unique identifier for the metafield
                                            within its namespace. Must be unique per
                                            namespace and owner.
                                          example: material
                                          type: string
                                          maxLength: 30
                                          pattern: ^[a-zA-Z0-9_]+$
                                        value:
                                          description: >-
                                            The actual data stored in the metafield.
                                            Type depends on value_type.
                                          example: cotton
                                          type:
                                            - string
                                            - integer
                                            - object
                                            - boolean
                                            - number
                                        value_type:
                                          description: >-
                                            The data type that defines how the value
                                            should be interpreted and validated.
                                          example: single_line_text_field
                                          type: string
                                        description:
                                          description: >-
                                            Optional human-readable description
                                            explaining the purpose of this
                                            metafield.
                                          example: >-
                                            The primary material used in this
                                            product
                                          type:
                                            - string
                                            - 'null'
                                        created_at:
                                          description: >-
                                            Timestamp when the metafield was
                                            created.
                                          example: '2021-01-01T00:00:00Z'
                                          type: string
                                          format: date-time
                                        updated_at:
                                          description: >-
                                            Timestamp when the metafield was last
                                            updated.
                                          example: '2021-01-01T00:00:00Z'
                                          type: string
                                          format: date-time
                                        locked:
                                          description: >-
                                            Whether this metafield is locked and
                                            cannot be updated or deleted directly.
                                          example: false
                                          type:
                                            - boolean
                                            - 'null'
                                            - 'null'
                                        metafield_definition:
                                          description: >-
                                            The definition that defines validation
                                            rules and structure for this metafield
                                          type:
                                            - 'null'
                                            - object
                                      required:
                                        - namespace
                                        - key
                                        - value
                                        - value_type
                                        - description
                                        - created_at
                                        - updated_at
                                        - metafield_definition
                      customer:
                        title: Customer
                        type: object
                        properties:
                          id:
                            type: integer
                          account_id:
                            type:
                              - string
                              - 'null'
                          first_name:
                            type:
                              - string
                              - 'null'
                          last_name:
                            type:
                              - string
                              - 'null'
                          full_name:
                            type: string
                          email:
                            type: string
                            pattern: >-
                              ^[a-zA-Z0-9.!\#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$
                          verified_email:
                            type:
                              - boolean
                              - 'null'
                            default: false
                          phone:
                            type:
                              - string
                              - 'null'
                          orders_count:
                            type:
                              - integer
                              - 'null'
                            default: 0
                          created_at:
                            type: string
                            format: date-time
                          display_total_spent:
                            type: string
                          metadata:
                            type: object
                            default: '{}'
                          user_company_id:
                            type:
                              - integer
                              - 'null'
                          external_id:
                            type:
                              - string
                              - 'null'
                          role:
                            type: string
                            enum:
                              - customer
                              - preferred_customer
                              - rep
                          last_order_id:
                            example: 101
                            type:
                              - integer
                              - 'null'
                          notes:
                            example: This is a note
                            type:
                              - string
                              - 'null'
                          active:
                            type: boolean
                          total_spent:
                            example: 100
                            type:
                              - number
                              - string
                          customer_notes:
                            type: array
                            items:
                              title: CustomerNote
                              type: object
                              properties:
                                id:
                                  type: integer
                                note:
                                  type: string
                                user_company_id:
                                  type:
                                    - integer
                                    - 'null'
                                customer_id:
                                  type: integer
                                resource_id:
                                  type:
                                    - integer
                                    - 'null'
                                resource_type:
                                  type:
                                    - string
                                    - 'null'
                                created_at:
                                  type: string
                                  format: date-time
                              required:
                                - id
                                - note
                                - customer_id
                                - created_at
                          default_address:
                            title: Address
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                              name:
                                example: John Doe
                                type: string
                              address1:
                                example: 123 Main St
                                type: string
                              address2:
                                example: Apt 4B
                                type:
                                  - string
                                  - 'null'
                              address3:
                                example: Building 5
                                type:
                                  - string
                                  - 'null'
                              city:
                                example: New York
                                type: string
                              state:
                                example: NY
                                type: string
                              subdivision_code:
                                example: NY
                                type:
                                  - string
                                  - 'null'
                              postal_code:
                                example: '10001'
                                type: string
                              country_code:
                                example: US
                                type:
                                  - string
                                  - 'null'
                              default:
                                description: >-
                                  Use this address by default when there are
                                  multiple addresses
                                example: true
                                type:
                                  - boolean
                                  - 'null'
                                default: false
                              first_name:
                                example: John
                                type: string
                              last_name:
                                example: Doe
                                type: string
                            required:
                              - id
                              - name
                              - address1
                              - city
                              - state
                              - postal_code
                              - first_name
                              - last_name
                          addresses:
                            type: array
                          payment_methods:
                            type: array
                          is_rep:
                            example: true
                            type: boolean
                          is_discarded:
                            example: false
                            type: boolean
                        required:
                          - id
                          - full_name
                          - email
                          - created_at
                          - display_total_spent
                          - metadata
                          - role
                          - active
                          - total_spent
                          - customer_notes
                          - addresses
                          - payment_methods
                          - is_rep
                          - is_discarded
                      customer_notes:
                        type: array
                      address:
                        title: Address
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: John Doe
                            type: string
                          address1:
                            example: 123 Main St
                            type: string
                          address2:
                            example: Apt 4B
                            type:
                              - string
                              - 'null'
                          address3:
                            example: Building 5
                            type:
                              - string
                              - 'null'
                          city:
                            example: New York
                            type: string
                          state:
                            example: NY
                            type: string
                          subdivision_code:
                            example: NY
                            type:
                              - string
                              - 'null'
                          postal_code:
                            example: '10001'
                            type: string
                          country_code:
                            example: US
                            type:
                              - string
                              - 'null'
                          default:
                            description: >-
                              Use this address by default when there are
                              multiple addresses
                            example: true
                            type:
                              - boolean
                              - 'null'
                            default: false
                          first_name:
                            example: John
                            type: string
                          last_name:
                            example: Doe
                            type: string
                        required:
                          - id
                          - name
                          - address1
                          - city
                          - state
                          - postal_code
                          - first_name
                          - last_name
                      payment_method:
                        title: Commerce::PaymentMethod
                        type: object
                        properties:
                          id:
                            type: integer
                          source:
                            type: string
                            enum:
                              - apple_pay
                              - paypal
                              - card
                              - iap
                              - bread
                              - affirm
                              - google_pay
                              - klarna
                              - droplet
                              - citcon
                              - ppro
                          payload:
                            type:
                              - object
                              - 'null'
                          created_at:
                            type: string
                            format: date-time
                          updated_at:
                            type: string
                            format: date-time
                          default:
                            type: boolean
                          payment_type:
                            example: Credit Card
                            type: string
                          details:
                            type: object
                        required:
                          - id
                          - source
                          - created_at
                          - updated_at
                          - default
                          - payment_type
                          - details
                      currency:
                        title: Currency
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: United States Dollar
                            type:
                              - string
                              - 'null'
                          code:
                            example: USD
                            type: string
                          rate:
                            example: 1
                            type:
                              - number
                              - string
                              - 'null'
                          active:
                            example: true
                            type:
                              - boolean
                              - 'null'
                            default: false
                          symbol:
                            example: $
                            type:
                              - string
                              - 'null'
                        required:
                          - id
                          - code
                      country:
                        title: Country
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: United States
                            type: string
                          iso:
                            description: 2-letter country code (ISO 3166-1 alpha-2)
                            example: US
                            type: string
                        required:
                          - id
                          - name
                          - iso
                      company:
                        title: Company
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            example: Acme, Inc.
                            type: string
                        required:
                          - id
                          - name
                      subscription_skips:
                        type: array
                        items:
                          title: Commerce::SubscriptionSkip
                          type: object
                          properties:
                            id:
                              type: integer
                            skipped_date:
                              example: '2025-01-01T00:00:00Z'
                              type: string
                              format: date
                            reason:
                              example: Customer requested to skip next billing
                              type:
                                - 'null'
                            created_at:
                              example: '2025-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            updated_at:
                              example: '2025-01-01T00:00:00Z'
                              type: string
                              format: date-time
                          required:
                            - id
                            - skipped_date
                            - created_at
                            - updated_at
                      orders:
                        type: array
                        items:
                          title: Commerce::Order
                          type: object
                          properties:
                            id:
                              type: integer
                            first_name:
                              type:
                                - string
                                - 'null'
                            last_name:
                              type:
                                - string
                                - 'null'
                            email:
                              type:
                                - string
                                - 'null'
                            phone:
                              type:
                                - string
                                - 'null'
                            order_number:
                              type:
                                - string
                                - 'null'
                            status:
                              type: string
                              enum:
                                - awaiting_payment
                                - awaiting_shipment
                                - shipped
                                - delivered
                                - archived
                                - cancelled
                                - failed_payment
                                - draft
                            order_type:
                              type: string
                              enum:
                                - requested
                                - purchased
                                - imported
                                - abandoned
                            source:
                              type: string
                              enum:
                                - mobile
                                - web
                                - admin
                                - backoffice
                                - subscription
                                - enrollment
                            amount:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                            amount_in_base:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                            base_to_currency_rate:
                              type:
                                - number
                                - string
                                - 'null'
                            note:
                              type:
                                - string
                                - 'null'
                            currency_code:
                              type:
                                - string
                                - 'null'
                            created_at:
                              type: string
                              format: date-time
                            updated_at:
                              type: string
                              format: date-time
                            metadata:
                              type:
                                - object
                                - 'null'
                              default: '{}'
                            token:
                              type: string
                            refundable_amount:
                              type: string
                            order_status:
                              type: string
                              enum:
                                - draft
                                - pending
                                - processing
                                - completed
                                - cancelled
                                - archived
                            fulfillment_status:
                              type: string
                              enum:
                                - unfulfilled
                                - in_progress
                                - on_hold
                                - partially_fulfilled
                                - scheduled
                                - fulfilled
                            financial_status:
                              type: string
                              enum:
                                - pending
                                - authorized
                                - partially_paid
                                - paid
                                - partially_refunded
                                - refunded
                                - voided
                                - marked_free
                                - marked_paid
                            warehouse_id:
                              type:
                                - integer
                                - 'null'
                            split_payment:
                              type:
                                - object
                                - 'null'
                            points_applied:
                              default: 0
                              type: integer
                            points_applied_amount_in_currency:
                              type: number
                            order_total_after_points_redemption:
                              type: number
                            free_shipping:
                              description: Whether the order has free shipping
                              type: boolean
                            discount_codes:
                              default: []
                              description: Discount codes applied to the order
                              type: array
                            shipping_method:
                              type: object
                            items_quantity:
                              example: 5
                              type: integer
                          required:
                            - id
                            - status
                            - order_type
                            - source
                            - created_at
                            - updated_at
                            - token
                            - refundable_amount
                            - order_status
                            - fulfillment_status
                            - financial_status
                            - points_applied
                            - points_applied_amount_in_currency
                            - order_total_after_points_redemption
                            - free_shipping
                            - discount_codes
                            - shipping_method
                            - items_quantity
                      bundled_subscriptions:
                        type: array
                    required:
                      - id
                      - subscription_token
                      - next_bill_date
                      - status
                      - quantity
                      - price
                      - original_price
                      - created_at
                      - updated_at
                      - cv_total
                      - qv_total
                      - subscription_plan
                      - variant
                      - customer
                      - customer_notes
                      - address
                      - payment_method
                      - currency
                      - country
                      - company
                      - subscription_skips
                      - orders
                      - bundled_subscriptions
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - subscription
  /api/subscriptions/{token}/orders:
    get:
      summary: Show orders created from the subscription
      description: Show a subscription
      tags:
        - Subscriptions
      operationId: showOrders
      security:
        - bearer_auth: []
      parameters:
        - name: token
          in: path
          required: true
          schema:
            type: string
        - name: sort_by
          in: query
          required: false
          description: Sort field for orders
          schema:
            type: string
            enum:
              - created_at
              - id
              - no_of_items
              - amount
        - name: sort_direction
          in: query
          required: false
          description: Sort direction
          schema:
            type: string
            enum:
              - asc
              - desc
            default: desc
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  orders:
                    type: array
                    items:
                      title: Commerce::Order
                      type: object
                      properties:
                        id:
                          type: integer
                        first_name:
                          type:
                            - string
                            - 'null'
                        last_name:
                          type:
                            - string
                            - 'null'
                        email:
                          type:
                            - string
                            - 'null'
                        phone:
                          type:
                            - string
                            - 'null'
                        order_number:
                          type:
                            - string
                            - 'null'
                        status:
                          type: string
                          enum:
                            - awaiting_payment
                            - awaiting_shipment
                            - shipped
                            - delivered
                            - archived
                            - cancelled
                            - failed_payment
                            - draft
                        order_type:
                          type: string
                          enum:
                            - requested
                            - purchased
                            - imported
                            - abandoned
                        source:
                          type: string
                          enum:
                            - mobile
                            - web
                            - admin
                            - backoffice
                            - subscription
                            - enrollment
                        amount:
                          type:
                            - number
                            - string
                            - 'null'
                          default: '0.0'
                        amount_in_base:
                          type:
                            - number
                            - string
                            - 'null'
                          default: '0.0'
                        base_to_currency_rate:
                          type:
                            - number
                            - string
                            - 'null'
                        note:
                          type:
                            - string
                            - 'null'
                        currency_code:
                          type:
                            - string
                            - 'null'
                        created_at:
                          type: string
                          format: date-time
                        updated_at:
                          type: string
                          format: date-time
                        metadata:
                          type:
                            - object
                            - 'null'
                          default: '{}'
                        token:
                          type: string
                        refundable_amount:
                          type: string
                        order_status:
                          type: string
                          enum:
                            - draft
                            - pending
                            - processing
                            - completed
                            - cancelled
                            - archived
                        fulfillment_status:
                          type: string
                          enum:
                            - unfulfilled
                            - in_progress
                            - on_hold
                            - partially_fulfilled
                            - scheduled
                            - fulfilled
                        financial_status:
                          type: string
                          enum:
                            - pending
                            - authorized
                            - partially_paid
                            - paid
                            - partially_refunded
                            - refunded
                            - voided
                            - marked_free
                            - marked_paid
                        warehouse_id:
                          type:
                            - integer
                            - 'null'
                        split_payment:
                          type:
                            - object
                            - 'null'
                        points_applied:
                          default: 0
                          type: integer
                        points_applied_amount_in_currency:
                          type: number
                        order_total_after_points_redemption:
                          type: number
                        free_shipping:
                          description: Whether the order has free shipping
                          type: boolean
                        discount_codes:
                          default: []
                          description: Discount codes applied to the order
                          type: array
                      required:
                        - id
                        - status
                        - order_type
                        - source
                        - created_at
                        - updated_at
                        - token
                        - refundable_amount
                        - order_status
                        - fulfillment_status
                        - financial_status
                        - points_applied
                        - points_applied_amount_in_currency
                        - order_total_after_points_redemption
                        - free_shipping
                        - discount_codes
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - orders
  /api/subscriptions/send_invoice_email:
    post:
      summary: Send invoice email
      description: Send an invoice email for a cart without requiring subscription
      tags:
        - Subscriptions
      operationId: sendInvoiceEmail
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart_token:
                    type: string
                    example: ct_ABC123
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - cart_token
        '404':
          description: cart not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: subscription_plan_id must be an integer
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                cart_token:
                  type: string
                subscription_plan_id:
                  type: integer
              required:
                - cart_token
                - subscription_plan_id
        description: Invoice email parameters
  /api/subscriptions/bulk_cancel:
    post:
      summary: Bulk cancel subscriptions
      description: Cancel multiple subscriptions by token
      tags:
        - Subscriptions
      operationId: bulkCancelSubscriptions
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: successful bulk cancel
          content:
            application/json:
              schema:
                type: object
                properties:
                  success_tokens:
                    type: array
                    items:
                      type: string
                      example: sb_1234567890
                  failed_tokens:
                    type: array
                    items:
                      type: object
                      properties:
                        token:
                          type: string
                          example: sb_1234567890
                        error:
                          type: string
                          example: subscription not found
                      required:
                        - token
                        - error
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - success_tokens
                  - failed_tokens
                  - meta
        '422':
          description: validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                tokens:
                  type: array
                  items:
                    type: string
                    example: sb_1234567890
                  minItems: 1
              required:
                - tokens
        required: true
  /api/company/system_monitoring/webhook_status_timeline:
    post:
      summary: Get webhook status timeline data
      tags:
        - System Monitoring
      security:
        - bearer_auth: []
      parameters:
        - name: time[primary]
          in: query
          required: false
          description: Primary time filter
          schema:
            type: string
        - name: time[secondary]
          in: query
          required: false
          description: Secondary time filter
          schema:
            type: string
      responses:
        '200':
          description: webhook status timeline data
        '401':
          description: unauthorized
  /api/company/tags:
    get:
      summary: List Tags
      tags:
        - Tags
      security:
        - bearer_auth: []
      operationId: listTags
      parameters: []
      responses:
        '200':
          description: tags found
          content:
            application/json:
              schema:
                type: object
                properties:
                  tag:
                    type: array
                    items:
                      title: Tag
                      type: object
                      properties:
                        id:
                          type: integer
                        name:
                          example: Bundle
                          type: string
                        source:
                          example: product
                          type: string
                      required:
                        - id
                        - name
                        - source
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
    post:
      summary: Create Tags
      tags:
        - Tags
      security:
        - bearer_auth: []
      operationId: createTag
      parameters: []
      responses:
        '201':
          description: tags created
          content:
            application/json:
              schema:
                type: object
                properties:
                  tag:
                    title: Tag
                    type: object
                    properties:
                      id:
                        type: integer
                      name:
                        example: Bundle
                        type: string
                      source:
                        example: product
                        type: string
                    required:
                      - id
                      - name
                      - source
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: unprocessable entity
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                tag:
                  type: object
                  properties:
                    name:
                      type: string
                    source:
                      type: string
                  required:
                    - name
                    - source
              required:
                - tag
        required: true
  /api/tax_categories:
    get:
      summary: Get tax categories
      tags:
        - Tax Categories
      operationId: getTaxCategories
      security:
        - bearer_auth: []
      description: Get the tax categories
      parameters:
        - name: parent_id
          in: query
          required: false
          description: Children of this Category id
          schema:
            type: integer
        - name: search
          in: query
          required: false
          description: Search Keyword
          example: Tangible personal property
          schema:
            type: string
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  tax_categories:
                    type: array
                    items:
                      title: TaxCategory
                      type: object
                      properties:
                        id:
                          type: integer
                        code:
                          example: SV010020
                          type: string
                        title:
                          example: Tangible personal property (tpp)
                          type: string
                        has_children:
                          description: >-
                            Indicates whether the tax category has any
                            sub-categories
                          example: true
                          type: boolean
                        selectable:
                          description: >-
                            Indicates whether the tax category can be
                            selected.          Only categories with tax codes
                            are selectable
                          example: true
                          type: boolean
                        parent_id:
                          description: >-
                            ID of the parent tax category, null for root
                            categories
                          example: 123
                          type:
                            - integer
                            - 'null'
                        parent_title:
                          description: >-
                            Title of the parent tax category, null for root
                            categories
                          example: Parent Category
                          type:
                            - string
                            - 'null'
                      required:
                        - id
                        - code
                        - title
                        - has_children
                        - selectable
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
  /api/tax_categories/{id}:
    get:
      summary: Retrieve a tax category
      tags:
        - Tax Categories
      operationId: getTaxCategory
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: tax category found
          content:
            application/json:
              schema:
                type: object
                properties:
                  tax_category:
                    title: TaxCategory
                    type: object
                    properties:
                      id:
                        type: integer
                      code:
                        example: SV010020
                        type: string
                      title:
                        example: Tangible personal property (tpp)
                        type: string
                      has_children:
                        description: >-
                          Indicates whether the tax category has any
                          sub-categories
                        example: true
                        type: boolean
                      selectable:
                        description: >-
                          Indicates whether the tax category can be
                          selected.          Only categories with tax codes are
                          selectable
                        example: true
                        type: boolean
                      parent_id:
                        description: >-
                          ID of the parent tax category, null for root
                          categories
                        example: 123
                        type:
                          - integer
                          - 'null'
                      parent_title:
                        description: >-
                          Title of the parent tax category, null for root
                          categories
                        example: Parent Category
                        type:
                          - string
                          - 'null'
                    required:
                      - id
                      - code
                      - title
                      - has_children
                      - selectable
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                        example:
                          - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
  /api/theme_region_rules:
    get:
      summary: List theme region rules
      tags:
        - Theme Region Rules
      description: Retrieve a list of theme region rules for the current company
      security:
        - bearer_auth: []
      parameters:
        - name: company_id
          in: query
          required: false
          description: Filter by company ID
          schema:
            type: integer
        - name: application_theme_template_id
          in: query
          required: false
          description: Filter by application theme template ID
          schema:
            type: integer
        - name: route_path
          in: query
          required: false
          description: Filter by route path
          schema:
            type: string
        - name: region_code
          in: query
          required: false
          description: Filter by region code
          schema:
            type: string
        - name: active
          in: query
          required: false
          description: Filter by active status
          schema:
            type: boolean
        - name: page
          in: query
          required: false
          description: Page number for pagination
          schema:
            type: integer
        - name: per_page
          in: query
          required: false
          description: Number of items per page
          schema:
            type: integer
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  theme_region_rules:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 1
                        company_id:
                          type: integer
                          example: 1
                        application_theme_template_id:
                          type: integer
                          example: 1
                        route_path:
                          type: string
                          example: /
                        region_code:
                          type: string
                          example: US
                        priority:
                          type: integer
                          example: 0
                        active:
                          type: boolean
                          example: true
                        redirect_type:
                          type: string
                          example: template
                        redirect_url:
                          type:
                            - string
                            - 'null'
                          example: null
                        description:
                          type:
                            - string
                            - 'null'
                          example: Default theme for US region
                        resource_type:
                          type:
                            - string
                            - 'null'
                          example: null
                        resource_id:
                          type:
                            - integer
                            - 'null'
                          example: null
                        created_at:
                          type: string
                          format: date_time
                          example: '2025-01-28T12:00:00Z'
                        updated_at:
                          type: string
                          format: date_time
                          example: '2025-01-28T12:00:00Z'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: uuid-string
                      timestamp:
                        type: string
                        format: date_time
                        example: '2025-01-28T12:00:00Z'
                      current_page:
                        type: integer
                        example: 1
                      total_pages:
                        type: integer
                        example: 1
                      total_count:
                        type: integer
                        example: 3
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Not authorized.
                required:
                  - message
    post:
      summary: Create theme region rule
      tags:
        - Theme Region Rules
      description: Create a new theme region rule
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: created
          content:
            application/json:
              schema:
                type: object
                properties:
                  theme_region_rule:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      route_path:
                        type: string
                        example: /test
                      region_code:
                        type: string
                        example: US
                      priority:
                        type: integer
                        example: 0
                      active:
                        type: boolean
                        example: true
                      redirect_type:
                        type: string
                        example: template
                      redirect_url:
                        type:
                          - string
                          - 'null'
                        example: null
                      description:
                        type:
                          - string
                          - 'null'
                        example: Test rule
                      resource_type:
                        type:
                          - string
                          - 'null'
                        example: null
                      resource_id:
                        type:
                          - integer
                          - 'null'
                        example: null
                      created_at:
                        type: string
                        format: date_time
                        example: '2025-01-28T12:00:00Z'
                      updated_at:
                        type: string
                        format: date_time
                        example: '2025-01-28T12:00:00Z'
                      company_id:
                        type: integer
                        example: 1
                      application_theme_template_id:
                        type: integer
                        example: 1
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: aa33f027-5b09-427e-af2b-30da8cc24867
                      timestamp:
                        type: string
                        format: date_time
                        example: '2025-01-28T12:00:00Z'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Not authorized.
                required:
                  - message
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Validation failed
                  errors:
                    type: object
                    additionalProperties:
                      type: object
                      additionalProperties:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                    required:
                      - request_id
                      - timestamp
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                theme_region_rule:
                  type: object
                  properties:
                    application_theme_template_id:
                      type: integer
                      example: 1
                    route_path:
                      type: string
                      example: /test
                    region_code:
                      type: string
                      example: US
                    priority:
                      type: integer
                      example: 0
                    active:
                      type: boolean
                      example: true
                    redirect_type:
                      type: string
                      enum:
                        - template
                        - redirect
                      example: template
                    redirect_url:
                      type:
                        - string
                        - 'null'
                      example: null
                    description:
                      type:
                        - string
                        - 'null'
                      example: Test rule
                    resource_type:
                      type:
                        - string
                        - 'null'
                      enum:
                        - Product
                        - Medium
                        - Page
                      example: null
                    resource_id:
                      type:
                        - integer
                        - 'null'
                      example: null
                  required:
                    - application_theme_template_id
                    - route_path
                    - region_code
  /api/theme_region_rules/{id}:
    get:
      summary: Show theme region rule
      tags:
        - Theme Region Rules
      description: Retrieve a specific theme region rule
      security:
        - bearer_auth: []
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  theme_region_rule:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      company_id:
                        type: integer
                        example: 1
                      application_theme_template_id:
                        type: integer
                        example: 1
                      route_path:
                        type: string
                        example: /
                      region_code:
                        type: string
                        example: US
                      priority:
                        type: integer
                        example: 0
                      active:
                        type: boolean
                        example: true
                      redirect_type:
                        type: string
                        example: template
                      redirect_url:
                        type:
                          - string
                          - 'null'
                        example: null
                      description:
                        type:
                          - string
                          - 'null'
                        example: Default theme for US region
                      resource_type:
                        type:
                          - string
                          - 'null'
                        example: null
                      resource_id:
                        type:
                          - integer
                          - 'null'
                        example: null
                      created_at:
                        type: string
                        format: date_time
                        example: '2025-01-28T12:00:00Z'
                      updated_at:
                        type: string
                        format: date_time
                        example: '2025-01-28T12:00:00Z'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: aa33f027-5b09-427e-af2b-30da8cc24867
                      timestamp:
                        type: string
                        format: date_time
                        example: '2025-01-28T12:00:00Z'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Not authorized.
                required:
                  - message
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Validation failed
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: aa33f027-5b09-427e-af2b-30da8cc24867
                      timestamp:
                        type: string
                        format: date_time
                        example: '2025-01-28T12:00:00Z'
                required:
                  - error_message
                  - errors
    patch:
      summary: Update theme region rule
      tags:
        - Theme Region Rules
      description: Update an existing theme region rule
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  theme_region_rule:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      company_id:
                        type: integer
                        example: 1
                      application_theme_template_id:
                        type: integer
                        example: 1
                      route_path:
                        type: string
                        example: /updated
                      region_code:
                        type: string
                        example: CA
                      priority:
                        type: integer
                        example: 10
                      active:
                        type: boolean
                        example: false
                      redirect_type:
                        type: string
                        example: redirect
                      redirect_url:
                        type:
                          - string
                          - 'null'
                        example: https://example.com/redirect
                      description:
                        type:
                          - string
                          - 'null'
                        example: Updated rule
                      resource_type:
                        type:
                          - string
                          - 'null'
                        example: Product
                      resource_id:
                        type:
                          - integer
                          - 'null'
                        example: 1
                      created_at:
                        type: string
                        format: date_time
                        example: '2025-01-28T12:00:00Z'
                      updated_at:
                        type: string
                        format: date_time
                        example: '2025-01-28T12:00:00Z'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: aa33f027-5b09-427e-af2b-30da8cc24867
                      timestamp:
                        type: string
                        format: date_time
                        example: '2025-01-28T12:00:00Z'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Not authorized.
                required:
                  - message
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Validation failed
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: aa33f027-5b09-427e-af2b-30da8cc24867
                      timestamp:
                        type: string
                        format: date_time
                        example: '2025-01-28T12:00:00Z'
                required:
                  - error_message
                  - errors
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Validation failed
                  errors:
                    type: object
                    additionalProperties:
                      type: object
                      additionalProperties:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: aa33f027-5b09-427e-af2b-30da8cc24867
                      timestamp:
                        type: string
                        format: date_time
                        example: '2025-01-28T12:00:00Z'
                required:
                  - error_message
                  - errors
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                theme_region_rule:
                  type: object
                  properties:
                    application_theme_template_id:
                      type: integer
                      example: 1
                    route_path:
                      type: string
                      example: /updated
                    region_code:
                      type: string
                      example: CA
                    priority:
                      type: integer
                      example: 10
                    active:
                      type: boolean
                      example: false
                    redirect_type:
                      type: string
                      enum:
                        - template
                        - redirect
                      example: redirect
                    redirect_url:
                      type:
                        - string
                        - 'null'
                      example: https://example.com/redirect
                    description:
                      type:
                        - string
                        - 'null'
                      example: Updated rule
                    resource_type:
                      type:
                        - string
                        - 'null'
                      enum:
                        - Product
                        - Medium
                        - Page
                      example: Product
                    resource_id:
                      type:
                        - integer
                        - 'null'
                      example: 1
    delete:
      summary: Delete theme region rule
      tags:
        - Theme Region Rules
      description: Delete a theme region rule
      security:
        - bearer_auth: []
      responses:
        '204':
          description: no content
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Not authorized.
                required:
                  - message
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Validation failed
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: aa33f027-5b09-427e-af2b-30da8cc24867
                      timestamp:
                        type: string
                        format: date_time
                        example: '2025-01-28T12:00:00Z'
                required:
                  - error_message
                  - errors
    parameters:
      - name: id
        in: path
        description: Theme region rule ID
        required: true
        schema:
          type: integer
  /api/company/tiles:
    get:
      tags:
        - Tiles
      summary: List Company Tiles
      description: >-
        Retrieves a list of company tiles containing basic information and
        links.
      operationId: listCompanyTiles
      parameters: []
      responses:
        '200':
          description: ''
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
      deprecated: false
      security:
        - bearer: []
    post:
      tags:
        - Tiles
      summary: Create Company Tile
      description: >-
        Creates a new tile for a company with specified details like title, URL,
        and optional attributes such as subtitle, images, and country
        associations.
      operationId: createCompanyTile
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/createrequest9'
                - example:
                    tile:
                      title: ADSite
                      url: https://www.anupamdahal.com.np
                      subtitle: Personal Portfolio
                      image_url: https://miracleanupam.github.io/favicon.ico
                      icon_url: ''
                      active: true
                      available_countries:
                        - us
                        - in
                        - npl
            example:
              tile:
                title: ADSite
                url: https://www.anupamdahal.com.np
                subtitle: Personal Portfolio
                image_url: https://miracleanupam.github.io/favicon.ico
                icon_url: ''
                active: true
                available_countries:
                  - us
                  - in
                  - npl
        required: true
      responses:
        '200':
          description: ''
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
      deprecated: false
      security:
        - bearer: []
  /api/company/tiles/{id}:
    patch:
      tags:
        - Tiles
      summary: Update Company Tile
      description: >-
        Updates a specific tile associated with a company with new properties
        like title, URL, subtitle, images, and country associations.
      operationId: updateCompanyTile
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
          description: The ID of the tile to update
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/updaterequest8'
                - example:
                    tile:
                      title: 'ADSite: Anupam''s Blog'
                      active: true
                      available_countries: []
            example:
              tile:
                title: 'ADSite: Anupam''s Blog'
                active: true
                available_countries: []
        required: true
      responses:
        '200':
          description: ''
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
      deprecated: false
      security:
        - bearer: []
    get:
      tags:
        - Tiles
      summary: Get Company Tile Details
      description: Retrieves the details of a specific company tile.
      operationId: getCompanyTile
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
          description: The unique identifier of the company tile
      responses:
        '200':
          description: ''
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
      deprecated: false
      security:
        - bearer: []
    delete:
      tags:
        - Tiles
      summary: Delete Company Title
      description: Deletes a specific title from the company.
      operationId: deleteCompanyTitle
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
          description: The ID of the company title to delete
      responses:
        '200':
          description: ''
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
      deprecated: false
      security:
        - bearer: []
  /api/tracking_informations:
    get:
      summary: List tracking informations
      description: List all tracking informations
      tags:
        - Tracking Informations
      operationId: listTrackingInformations
      security:
        - bearer_auth: []
      parameters:
        - name: order_id
          in: query
          required: false
          description: Filter by order ID
          schema:
            type: integer
        - name: order_fulfillment_id
          in: query
          required: false
          description: Filter by order fulfillment ID
          schema:
            type: integer
        - name: page
          in: query
          required: false
          description: Page number
          schema:
            type: integer
        - name: per_page
          in: query
          required: false
          description: Items per page
          schema:
            type: integer
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  json:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                        tracking_number:
                          type: string
                          example: 1Z999AA10123456784
                        shipping_carrier:
                          type: string
                          example: UPS
                        created_at:
                          type: string
                          format: date-time
                        updated_at:
                          type: string
                          format: date-time
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
                      pagination:
                        type: object
                        properties:
                          current_page:
                            type: integer
                          total_pages:
                            type: integer
                          total_count:
                            type: integer
                          per_page:
                            type: integer
    post:
      summary: Create tracking information
      tags:
        - Tracking Informations
      operationId: createTrackingInformation
      description: Create a new tracking information
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: created
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  tracking_number:
                    type: string
                    example: 1Z999AA10123456784
                  shipping_carrier:
                    type: string
                    example: UPS
                  created_at:
                    type: string
                    format: date-time
                  updated_at:
                    type: string
                    format: date-time
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: order not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      base:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                tracking_information:
                  type: object
                  properties:
                    tracking_number:
                      type: string
                    shipping_carrier:
                      type: string
                    order_id:
                      type: integer
                    order_fulfillment_id:
                      type: integer
                  required:
                    - tracking_number
                    - order_id
              required:
                - tracking_information
  /api/tracking_informations/{id}:
    get:
      summary: Show tracking information
      tags:
        - Tracking Informations
      operationId: showTrackingInformation
      description: Show a specific tracking information
      security:
        - bearer_auth: []
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  tracking_number:
                    type: string
                    example: 1Z999AA10123456784
                  shipping_carrier:
                    type: string
                    example: UPS
                  created_at:
                    type: string
                    format: date-time
                  updated_at:
                    type: string
                    format: date-time
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      base:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
    put:
      summary: Update tracking information
      tags:
        - Tracking Informations
      operationId: updateTrackingInformation
      description: Update a tracking information
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  tracking_number:
                    type: string
                    example: 1Z999AA10123456784
                  shipping_carrier:
                    type: string
                    example: UPS
                  created_at:
                    type: string
                    format: date-time
                  updated_at:
                    type: string
                    format: date-time
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      base:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                tracking_information:
                  type: object
                  properties:
                    tracking_number:
                      type: string
                    shipping_carrier:
                      type: string
                    order_fulfillment_id:
                      type: integer
              required:
                - tracking_information
    delete:
      summary: Delete tracking information
      tags:
        - Tracking Informations
      operationId: deleteTrackingInformation
      description: Delete a tracking information
      security:
        - bearer_auth: []
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      base:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
    parameters:
      - name: id
        in: path
        description: Tracking Information ID
        required: true
        schema:
          type: integer
  /api/v202506/trainings:
    get:
      summary: List all trainings
      tags:
        - Trainings
      security:
        - bearer_auth: []
      parameters:
        - name: search_query
          in: query
          required: false
          description: Search trainings by title, description, tags, or category
          schema:
            type: string
        - name: active
          in: query
          required: false
          description: Filter trainings by active status
          schema:
            type: boolean
        - name: sorted_by
          in: query
          required: false
          description: >-
            Sort trainings (e.g., 'created_at_desc', 'title_asc', 'active_desc',
            'views_desc')
          schema:
            type: string
        - name: with_type
          in: query
          required: false
          description: Filter trainings by type (e.g., 'image', 'video', 'pdf')
          schema:
            type: string
        - name: page
          in: query
          schema:
            type: integer
            exclusiveMinimum: 0
          required: false
          description: Page number for pagination
        - name: per_page
          in: query
          schema:
            type: integer
            exclusiveMinimum: 0
            maximum: 100
          required: false
          description: Number of records per page
      responses:
        '200':
          description: trainings found with with_type filter
          content:
            application/json:
              schema:
                type: object
                properties:
                  trainings:
                    type: array
                    items:
                      title: Medium
                      type: object
                      properties:
                        id:
                          type: integer
                        slug:
                          type:
                            - string
                            - 'null'
                        custom_slug:
                          type: boolean
                          default: false
                        title:
                          type: string
                        kind:
                          type:
                            - string
                            - 'null'
                        media_type:
                          type: string
                        media_format:
                          type: string
                        image_url:
                          type:
                            - string
                            - 'null'
                        video_url:
                          type:
                            - string
                            - 'null'
                        pdf_url:
                          type:
                            - string
                            - 'null'
                        powerpoint_url:
                          type:
                            - string
                            - 'null'
                        duration:
                          type:
                            - integer
                            - 'null'
                          default: 0
                        active:
                          type:
                            - boolean
                            - 'null'
                          default: true
                        canonical_url:
                          type: string
                        description:
                          type:
                            - string
                            - 'null'
                        subtitles:
                          type:
                            - object
                            - 'null'
                          default: '{}'
                        comments_count:
                          type: integer
                        settings:
                          type:
                            - object
                            - 'null'
                        created_at:
                          type: string
                          format: date-time
                        views:
                          type: integer
                      required:
                        - id
                        - custom_slug
                        - title
                        - media_type
                        - media_format
                        - canonical_url
                        - comments_count
                        - created_at
                        - views
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      pagination:
                        type: object
                        properties:
                          current_page:
                            type: integer
                            example: 1
                          total_pages:
                            type: integer
                            example: 10
                          total_count:
                            type: integer
                            example: 100
                          per_page:
                            type: integer
                            example: 10
                required:
                  - trainings
                  - meta
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
                required:
                  - message
  /api/v202506/trainings/{id}:
    get:
      summary: Get a training
      tags:
        - Trainings
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: training found
          content:
            application/json:
              schema:
                title: Medium
                type: object
                properties:
                  id:
                    type: integer
                  slug:
                    type:
                      - string
                      - 'null'
                  custom_slug:
                    type: boolean
                    default: false
                  title:
                    type: string
                  kind:
                    type:
                      - string
                      - 'null'
                  media_type:
                    type: string
                  media_format:
                    type: string
                  image_url:
                    type:
                      - string
                      - 'null'
                  video_url:
                    type:
                      - string
                      - 'null'
                  pdf_url:
                    type:
                      - string
                      - 'null'
                  powerpoint_url:
                    type:
                      - string
                      - 'null'
                  duration:
                    type:
                      - integer
                      - 'null'
                    default: 0
                  active:
                    type:
                      - boolean
                      - 'null'
                    default: true
                  canonical_url:
                    type: string
                  description:
                    type:
                      - string
                      - 'null'
                  subtitles:
                    type:
                      - object
                      - 'null'
                    default: '{}'
                  comments_count:
                    type: integer
                  settings:
                    type:
                      - object
                      - 'null'
                  created_at:
                    type: string
                    format: date-time
                  views:
                    type: integer
                  application_theme_template_id:
                    type:
                      - integer
                      - 'null'
                  countries:
                    type: array
                  tags:
                    type: array
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - id
                  - custom_slug
                  - title
                  - media_type
                  - media_format
                  - canonical_url
                  - comments_count
                  - created_at
                  - views
                  - countries
                  - tags
                  - meta
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
                required:
                  - message
        '404':
          description: training not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      training:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - error_message
                  - errors
                  - meta
  /api/trees/{tree_id}/tree_nodes:
    get:
      summary: List of tree nodes
      description: List all tree nodes
      tags:
        - Tree Nodes
      operationId: listTreeNodes
      security:
        - bearer_auth: []
      parameters:
        - name: tree_id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  tree_nodes:
                    type: array
                    items:
                      title: TreeNode
                      type: object
                      properties:
                        id:
                          type: integer
                        member_id:
                          description: The ID of the member
                          example: 110
                          type: integer
                        member_type:
                          description: Can either be a Customer or an UserCompany/Rep
                          example: Customer
                          type: string
                        created_at:
                          example: '2021-01-01T00:00:00Z'
                          type: string
                          format: date-time
                        updated_at:
                          example: '2021-01-01T00:00:00Z'
                          type: string
                          format: date-time
                      required:
                        - id
                        - member_id
                        - member_type
                        - created_at
                        - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - tree_nodes
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
    post:
      summary: Create a tree node
      description: Create a tree node
      tags:
        - Tree Nodes
      operationId: createTreeNode
      security:
        - bearer_auth: []
      parameters:
        - name: tree_id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '201':
          description: success with parent
          content:
            application/json:
              schema:
                type: object
                properties:
                  tree_node:
                    title: TreeNode
                    type: object
                    properties:
                      id:
                        type: integer
                      member_id:
                        description: The ID of the member
                        example: 110
                        type: integer
                      member_type:
                        description: Can either be a Customer or an UserCompany/Rep
                        example: Customer
                        type: string
                      created_at:
                        example: '2021-01-01T00:00:00Z'
                        type: string
                        format: date-time
                      updated_at:
                        example: '2021-01-01T00:00:00Z'
                        type: string
                        format: date-time
                    required:
                      - id
                      - member_id
                      - member_type
                      - created_at
                      - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - tree_node
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                tree_node:
                  type: object
                  properties:
                    member_id:
                      type: integer
                    member_type:
                      type: string
                    parent_id:
                      type: integer
                  required:
                    - member_id
                    - member_type
              required:
                - tree_id
                - tree_node
  /api/trees/{tree_id}/tree_nodes/{id}:
    get:
      summary: Show a tree node
      description: Show a tree node
      tags:
        - Tree Nodes
      operationId: showTreeNode
      security:
        - bearer_auth: []
      parameters:
        - name: tree_id
          in: path
          required: true
          schema:
            type: integer
        - name: id
          in: path
          required: true
          schema:
            type: integer
        - name: member_type
          in: query
          schema:
            type: string
          required: false
          description: >-
            Member type. Either Customer or UserCompany. When this is present,
            the id parameter is the member_id.
        - name: downline
          in: query
          schema:
            type: boolean
          required: false
          description: Include downline in response
        - name: levels
          in: query
          schema:
            type: integer
          required: false
          description: Number of levels to include in downline (defaults to 2)
      responses:
        '200':
          description: success with levels=3
          content:
            application/json:
              schema:
                type: object
                properties:
                  tree_node:
                    title: TreeNode
                    type: object
                    properties:
                      id:
                        type: integer
                      member_id:
                        description: The ID of the member
                        example: 110
                        type: integer
                      member_type:
                        description: Can either be a Customer or an UserCompany/Rep
                        example: Customer
                        type: string
                      created_at:
                        example: '2021-01-01T00:00:00Z'
                        type: string
                        format: date-time
                      updated_at:
                        example: '2021-01-01T00:00:00Z'
                        type: string
                        format: date-time
                      downline:
                        type: array
                    required:
                      - id
                      - member_id
                      - member_type
                      - created_at
                      - updated_at
                      - downline
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - tree_node
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
    put:
      summary: Update a tree node
      description: Update a tree node
      tags:
        - Tree Nodes
      operationId: updateTreeNode
      security:
        - bearer_auth: []
      parameters:
        - name: tree_id
          in: path
          required: true
          schema:
            type: integer
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  tree_node:
                    title: TreeNode
                    type: object
                    properties:
                      id:
                        type: integer
                      member_id:
                        description: The ID of the member
                        example: 110
                        type: integer
                      member_type:
                        description: Can either be a Customer or an UserCompany/Rep
                        example: Customer
                        type: string
                      created_at:
                        example: '2021-01-01T00:00:00Z'
                        type: string
                        format: date-time
                      updated_at:
                        example: '2021-01-01T00:00:00Z'
                        type: string
                        format: date-time
                    required:
                      - id
                      - member_id
                      - member_type
                      - created_at
                      - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - tree_node
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                tree_node:
                  type: object
                  properties:
                    member_id:
                      type: integer
                    member_type:
                      type: string
                    parent_id:
                      type: integer
                  required:
                    - member_id
                    - member_type
              required:
                - tree_id
                - id
                - tree_node
    delete:
      summary: Delete a tree node
      description: Delete a tree node
      tags:
        - Tree Nodes
      operationId: destroyTreeNode
      security:
        - bearer_auth: []
      parameters:
        - name: tree_id
          in: path
          required: true
          schema:
            type: integer
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  tree_node:
                    title: TreeNode
                    type: object
                    properties:
                      id:
                        type: integer
                    required:
                      - id
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - tree_node
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/trees:
    get:
      summary: List of trees
      description: List all trees
      tags:
        - Trees
      operationId: listTrees
      security:
        - bearer_auth: []
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  trees:
                    type: array
                    items:
                      title: Tree
                      type: object
                      properties:
                        id:
                          type: integer
                        name:
                          example: Test Tree
                          type: string
                        tree_type:
                          example: enrollment
                          type: string
                        settings:
                          example:
                            enabled: true
                          type:
                            - object
                            - 'null'
                          default: '{}'
                        created_at:
                          example: '2021-01-01T00:00:00Z'
                          type: string
                          format: date-time
                        updated_at:
                          example: '2021-01-01T00:00:00Z'
                          type: string
                          format: date-time
                      required:
                        - id
                        - name
                        - tree_type
                        - created_at
                        - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - trees
    post:
      summary: Create a tree
      description: Create a tree
      tags:
        - Trees
      operationId: createTree
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  tree:
                    title: Tree
                    type: object
                    properties:
                      id:
                        type: integer
                      name:
                        example: Test Tree
                        type: string
                      tree_type:
                        example: enrollment
                        type: string
                      settings:
                        example:
                          enabled: true
                        type:
                          - object
                          - 'null'
                        default: '{}'
                      created_at:
                        example: '2021-01-01T00:00:00Z'
                        type: string
                        format: date-time
                      updated_at:
                        example: '2021-01-01T00:00:00Z'
                        type: string
                        format: date-time
                    required:
                      - id
                      - name
                      - tree_type
                      - created_at
                      - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - tree
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                tree:
                  type: object
                  properties:
                    name:
                      type: string
                    tree_type:
                      type: string
                    settings:
                      type: object
                  required:
                    - name
                    - tree_type
              required:
                - tree
  /api/trees/{id}:
    get:
      summary: Show a tree
      description: Show a tree
      tags:
        - Trees
      operationId: showTree
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  tree:
                    title: Tree
                    type: object
                    properties:
                      id:
                        type: integer
                      name:
                        example: Test Tree
                        type: string
                      tree_type:
                        example: enrollment
                        type: string
                      settings:
                        example:
                          enabled: true
                        type:
                          - object
                          - 'null'
                        default: '{}'
                      created_at:
                        example: '2021-01-01T00:00:00Z'
                        type: string
                        format: date-time
                      updated_at:
                        example: '2021-01-01T00:00:00Z'
                        type: string
                        format: date-time
                    required:
                      - id
                      - name
                      - tree_type
                      - created_at
                      - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - tree
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
    put:
      summary: Update a tree
      description: Update a tree
      tags:
        - Trees
      operationId: updateTree
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  tree:
                    title: Tree
                    type: object
                    properties:
                      id:
                        type: integer
                      name:
                        example: Test Tree
                        type: string
                      tree_type:
                        example: enrollment
                        type: string
                      settings:
                        example:
                          enabled: true
                        type:
                          - object
                          - 'null'
                        default: '{}'
                      created_at:
                        example: '2021-01-01T00:00:00Z'
                        type: string
                        format: date-time
                      updated_at:
                        example: '2021-01-01T00:00:00Z'
                        type: string
                        format: date-time
                    required:
                      - id
                      - name
                      - tree_type
                      - created_at
                      - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - tree
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                tree:
                  type: object
                  properties:
                    name:
                      type: string
                      example: Test Tree
                    tree_type:
                      type: string
                      enum:
                        - enrollment
                        - placement
                        - other
                      example: enrollment
                    settings:
                      type: object
                      example:
                        test: true
                  required:
                    - name
                    - tree_type
              required:
                - tree
    delete:
      summary: Delete a tree
      description: Delete a tree
      tags:
        - Trees
      operationId: destroyTree
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  tree:
                    title: Tree
                    type: object
                    properties:
                      id:
                        type: integer
                    required:
                      - id
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - tree
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/users/create_and_invite:
    post:
      summary: Creates and invites a user
      tags:
        - Users
      operationId: createAndInviteUser
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: existing user invited successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  user:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 123
                      email:
                        type: string
                        example: existing@example.com
                      first_name:
                        type: string
                        example: Existing
                      last_name:
                        type: string
                        example: User
                    required:
                      - id
                      - email
                      - first_name
                      - last_name
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - user
                  - meta
        '404':
          description: company not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Company not found
                  errors:
                    type: object
                    properties:
                      company:
                        type: array
                        items:
                          type: string
                        example:
                          - Couldn't find Company with 'id'=99999
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - error_message
                  - errors
                  - meta
        '422':
          description: missing required parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameters
                  errors:
                    type: object
                    example:
                      email:
                        - can't be blank
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - error_message
                  - errors
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                user:
                  type: object
                  properties:
                    email:
                      type: string
                      minLength: 1
                    first_name:
                      type:
                        - 'null'
                        - string
                    last_name:
                      type:
                        - 'null'
                        - string
                    company_id:
                      type: integer
                      not:
                        type: 'null'
                    roles:
                      type:
                        - 'null'
                        - string
                    admin_roles:
                      type: array
                      items:
                        type: integer
                    phone:
                      type:
                        - 'null'
                        - string
                    external_id:
                      type:
                        - 'null'
                        - string
                    share_guid:
                      type:
                        - 'null'
                        - string
                    username:
                      type:
                        - 'null'
                        - string
                  required:
                    - email
              required:
                - user
  /api/v202506/users:
    post:
      summary: Creates a user
      tags:
        - Users
      operationId: createUserInvalidRole
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: user created with admin role and admin_roles
          content:
            application/json:
              schema:
                type: object
                properties:
                  user_company:
                    title: UserCompany
                    type: object
                    properties:
                      id:
                        type: integer
                      first_name:
                        description: User's first name
                        example: John
                        type:
                          - string
                          - 'null'
                      last_name:
                        description: User's last name
                        example: Doe
                        type:
                          - string
                          - 'null'
                      image_url:
                        description: User's image URL
                        example: https://example.com/image.jpg
                        type:
                          - string
                          - 'null'
                      company_id:
                        description: ID of the company the user belongs to
                        example: 42
                        type:
                          - integer
                          - 'null'
                      external_id:
                        description: External identifier for the user
                        example: EXT123456
                        type:
                          - string
                          - 'null'
                      username:
                        description: User's unique username within the company
                        example: johny_jobs
                        type:
                          - string
                          - 'null'
                      active:
                        default: true
                        description: Whether the user is active in the company
                        example: true
                        type: boolean
                      mysite_url:
                        description: URL to the user's personal site
                        example: https://mycompany.com/johny_jobs
                        type:
                          - string
                          - 'null'
                      rank:
                        description: External ID of Rank the User is linked to
                        example: '234234'
                        type:
                          - integer
                          - string
                          - 'null'
                      share_guid:
                        description: Unique identifier for sharing content
                        example: a6848f0b
                        type:
                          - string
                          - 'null'
                      legacy_number:
                        description: User's legacy phone number
                        example: '+18001234567'
                        type:
                          - string
                          - 'null'
                      metadata:
                        description: >-
                          User's metadata JSON object containing optional
                          metadata about the user, such as tracking data, or
                          third-party identifiers.
                        example:
                          tags:
                            - vip
                            - retail
                        type:
                          - object
                          - 'null'
                      created_at:
                        description: Date and time the user was created
                        example: '2021-01-01T00:00:00Z'
                        type:
                          - string
                          - 'null'
                      roles:
                        description: Roles of the user
                        example:
                          - customer_service
                          - developer
                        type:
                          - array
                          - 'null'
                      email:
                        type:
                          - string
                          - 'null'
                      full_name:
                        description: User's full name
                        example: John Doe
                        type:
                          - string
                          - 'null'
                      affiliate:
                        description: User's affiliate information
                        example: >-
                          {id: 1, external_id: 3, username: "johny_jobs", email:
                          "johny.jobs@example.com", credit: "a6848f0b"}
                        type:
                          - object
                          - 'null'
                      rank_id:
                        description: ID of Rank the User is linked to
                        example: 234234
                        type:
                          - integer
                          - 'null'
                      user:
                        title: User
                        type: object
                        properties:
                          id:
                            type: integer
                          first_name:
                            description: User's first name
                            example: John
                            type:
                              - string
                              - 'null'
                          last_name:
                            description: User's last name
                            example: Doe
                            type:
                              - string
                              - 'null'
                          email:
                            description: User's email address
                            example: john@example.com
                            type:
                              - string
                              - 'null'
                          avatar:
                            description: User's avatar URL
                            example: https://example.com/avatar.jpg
                            type:
                              - string
                              - 'null'
                          phone:
                            description: User's phone
                            example: '+18018888888'
                            type:
                              - string
                              - 'null'
                          google_id:
                            description: User's Google Id
                            example: ''
                            type:
                              - string
                              - 'null'
                          bio:
                            description: User's Bio
                            example: >-
                              Software engineer passionate about creating
                              intuitive user experiences
                            type:
                              - string
                              - 'null'
                          facebook:
                            description: User's Facebook profile URL
                            example: https://facebook.com/johndoe
                            type:
                              - string
                              - 'null'
                          instagram:
                            description: User's Instagram handle
                            example: johndoe_insta
                            type:
                              - string
                              - 'null'
                          twitter:
                            description: User's Twitter/X handle
                            example: johndoe_tweets
                            type:
                              - string
                              - 'null'
                          linkedin:
                            description: User's LinkedIn profile URL
                            example: https://linkedin.com/in/johndoe
                            type:
                              - string
                              - 'null'
                          whatsapp:
                            description: User's WhatsApp number
                            example: '+18019999999'
                            type:
                              - string
                              - 'null'
                          wechat:
                            description: User's WeChat ID
                            example: johndoe_wechat
                            type:
                              - string
                              - 'null'
                          youtube:
                            description: User's YouTube channel URL
                            example: https://youtube.com/channel/UC123abc456def
                            type:
                              - string
                              - 'null'
                          zip_code:
                            description: User's ZIP/postal code
                            example: '84102'
                            type:
                              - string
                              - 'null'
                          dob:
                            description: User's date of birth
                            example: '1990-05-15'
                            type:
                              - string
                              - 'null'
                          gender:
                            description: User's gender
                            example: male
                            type:
                              - string
                              - 'null'
                          time_zone:
                            description: User's time zone
                            example: America/New_York
                            type:
                              - string
                              - 'null'
                          dnd:
                            default: 'off'
                            description: User's Do Not Disturb preference
                            example: 'true'
                            type:
                              - string
                              - 'null'
                          user_type:
                            description: Type of user
                            example: admin
                            type:
                              - string
                              - 'null'
                          language:
                            title: Language
                            type: object
                            properties:
                              id:
                                type: integer
                              name:
                                example: English
                                type:
                                  - string
                                  - 'null'
                              iso:
                                example: en
                                type:
                                  - string
                                  - 'null'
                            required:
                              - id
                          country:
                            title: Country
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                              name:
                                example: United States
                                type: string
                              iso:
                                description: 2-letter country code (ISO 3166-1 alpha-2)
                                example: US
                                type: string
                            required:
                              - id
                              - name
                              - iso
                          addresses:
                            type: array
                            items:
                              title: Address
                              type: object
                              properties:
                                id:
                                  type: integer
                                name:
                                  example: John Doe
                                  type: string
                                address1:
                                  example: 123 Main St
                                  type: string
                                address2:
                                  example: Apt 4B
                                  type:
                                    - string
                                    - 'null'
                                address3:
                                  example: Building 5
                                  type:
                                    - string
                                    - 'null'
                                city:
                                  example: New York
                                  type: string
                                state:
                                  example: NY
                                  type: string
                                subdivision_code:
                                  example: NY
                                  type:
                                    - string
                                    - 'null'
                                postal_code:
                                  example: '10001'
                                  type: string
                                country_code:
                                  example: US
                                  type:
                                    - string
                                    - 'null'
                                default:
                                  description: >-
                                    Use this address by default when there are
                                    multiple addresses
                                  example: true
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                first_name:
                                  example: John
                                  type: string
                                last_name:
                                  example: Doe
                                  type: string
                              required:
                                - id
                                - name
                                - address1
                                - city
                                - state
                                - postal_code
                                - first_name
                                - last_name
                        required:
                          - id
                          - first_name
                          - last_name
                          - email
                          - avatar
                          - phone
                          - google_id
                          - bio
                          - facebook
                          - instagram
                          - twitter
                          - linkedin
                          - whatsapp
                          - wechat
                          - youtube
                          - zip_code
                          - dob
                          - gender
                          - time_zone
                          - dnd
                          - user_type
                          - language
                          - addresses
                    required:
                      - id
                      - first_name
                      - last_name
                      - company_id
                      - external_id
                      - username
                      - active
                      - mysite_url
                      - rank
                      - share_guid
                      - legacy_number
                      - metadata
                      - created_at
                      - roles
                      - full_name
                      - affiliate
                      - rank_id
                      - user
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - user_company
                  - meta
        '422':
          description: invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameters
                  errors:
                    type: object
                    properties:
                      admin_roles:
                        type: array
                        items:
                          type: string
                        example:
                          - Admin roles can only be set when role is admin
                      role_assignments.role:
                        type: array
                        items:
                          type: string
                        example:
                          - company_id mismatch
                      role_assignments:
                        type: array
                        items:
                          type: string
                        example:
                          - is invalid
                      user.user_companies.role_assignments.role:
                        type: array
                        items:
                          type: string
                        example:
                          - company_id mismatch
                      user.user_companies.role_assignments:
                        type: array
                        items:
                          type: string
                        example:
                          - is invalid
                      user:
                        type: object
                        properties:
                          role:
                            type: array
                            items:
                              type: string
                            example:
                              - 'must be one of: admin, rep, user'
                    example:
                      country_code:
                        - is missing
                      language_code:
                        - is missing
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                country_code:
                  type: string
                language_code:
                  type: string
                user:
                  type: object
                  properties:
                    email:
                      type: string
                    first_name:
                      type: string
                    last_name:
                      type: string
                    password:
                      type: string
                    avatar:
                      type: string
                    phone:
                      type: string
                    google_id:
                      type: string
                    bio:
                      type: string
                    facebook:
                      type: string
                    instagram:
                      type: string
                    twitter:
                      type: string
                    linkedin:
                      type: string
                    whatsapp:
                      type: string
                    wechat:
                      type: string
                    youtube:
                      type: string
                    zip_code:
                      type: string
                    dob:
                      type: string
                      format: date
                    gender:
                      type: string
                    time_zone:
                      type: string
                    push_notifications:
                      type: boolean
                    email_notifications:
                      type: boolean
                    sms_notifications:
                      type: boolean
                    external_id:
                      type: string
                    username:
                      type: string
                    active:
                      type: boolean
                    role:
                      type: string
                      enum:
                        - admin
                        - rep
                        - user
                    admin_roles:
                      type: array
                      items:
                        type: integer
                    affiliate:
                      type: object
                      properties:
                        id:
                          type: string
                        external_id:
                          type: string
                        username:
                          type: string
                        email:
                          type: string
                      required: []
                  required:
                    - email
                    - affiliate
              required:
                - country_code
                - language_code
                - user
    get:
      summary: Get users with optional filters
      tags:
        - Users
      operationId: indexUsers
      security:
        - bearer_auth: []
      parameters:
        - name: search_query
          in: query
          required: false
          description: >-
            Filter users with search query that matches with their first name,
            last name or email
          schema:
            type: string
        - name: role
          in: query
          required: false
          example: rep
          description: Filter users by their roles.
          schema:
            type: string
        - name: sorted_by
          in: query
          required: false
          example: first_name_asc
          description: >
            Sort the records by one of the supported attributes:

              - first_name

            The sort attribute should be followed by one of the order
            directives: '_asc', '_desc'
          schema:
            type: string
        - name: page
          in: query
          schema:
            type: integer
            default: 1
          required: false
          description: Page number for pagination
        - name: per_page
          in: query
          schema:
            type: integer
            default: 50
          required: false
          description: Number of records per page
        - name: by_metadata
          in: query
          schema:
            type: string
            default: '{}'
            format: json
          required: false
          description: Search JSON meta data
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  user_companies:
                    type: array
                    items:
                      title: UserCompany
                      type: object
                      properties:
                        id:
                          type: integer
                        first_name:
                          description: User's first name
                          example: John
                          type:
                            - string
                            - 'null'
                        last_name:
                          description: User's last name
                          example: Doe
                          type:
                            - string
                            - 'null'
                        image_url:
                          description: User's image URL
                          example: https://example.com/image.jpg
                          type:
                            - string
                            - 'null'
                        company_id:
                          description: ID of the company the user belongs to
                          example: 42
                          type:
                            - integer
                            - 'null'
                        external_id:
                          description: External identifier for the user
                          example: EXT123456
                          type:
                            - string
                            - 'null'
                        username:
                          description: User's unique username within the company
                          example: johny_jobs
                          type:
                            - string
                            - 'null'
                        active:
                          default: true
                          description: Whether the user is active in the company
                          example: true
                          type: boolean
                        mysite_url:
                          description: URL to the user's personal site
                          example: https://mycompany.com/johny_jobs
                          type:
                            - string
                            - 'null'
                        rank:
                          description: External ID of Rank the User is linked to
                          example: '234234'
                          type:
                            - integer
                            - string
                            - 'null'
                        share_guid:
                          description: Unique identifier for sharing content
                          example: a6848f0b
                          type:
                            - string
                            - 'null'
                        legacy_number:
                          description: User's legacy phone number
                          example: '+18001234567'
                          type:
                            - string
                            - 'null'
                        metadata:
                          description: >-
                            User's metadata JSON object containing optional
                            metadata about the user, such as tracking data, or
                            third-party identifiers.
                          example:
                            tags:
                              - vip
                              - retail
                          type:
                            - object
                            - 'null'
                        created_at:
                          description: Date and time the user was created
                          example: '2021-01-01T00:00:00Z'
                          type:
                            - string
                            - 'null'
                        roles:
                          description: Roles of the user
                          example:
                            - customer_service
                            - developer
                          type:
                            - array
                            - 'null'
                        email:
                          type:
                            - string
                            - 'null'
                        full_name:
                          description: User's full name
                          example: John Doe
                          type:
                            - string
                            - 'null'
                        affiliate:
                          description: User's affiliate information
                          example: >-
                            {id: 1, external_id: 3, username: "johny_jobs",
                            email: "johny.jobs@example.com", credit: "a6848f0b"}
                          type:
                            - object
                            - 'null'
                        rank_id:
                          description: ID of Rank the User is linked to
                          example: 234234
                          type:
                            - integer
                            - 'null'
                        user:
                          title: User
                          type: object
                          properties:
                            id:
                              type: integer
                            first_name:
                              description: User's first name
                              example: John
                              type:
                                - string
                                - 'null'
                            last_name:
                              description: User's last name
                              example: Doe
                              type:
                                - string
                                - 'null'
                            email:
                              description: User's email address
                              example: john@example.com
                              type:
                                - string
                                - 'null'
                            avatar:
                              description: User's avatar URL
                              example: https://example.com/avatar.jpg
                              type:
                                - string
                                - 'null'
                            phone:
                              description: User's phone
                              example: '+18018888888'
                              type:
                                - string
                                - 'null'
                            google_id:
                              description: User's Google Id
                              example: ''
                              type:
                                - string
                                - 'null'
                            bio:
                              description: User's Bio
                              example: >-
                                Software engineer passionate about creating
                                intuitive user experiences
                              type:
                                - string
                                - 'null'
                            facebook:
                              description: User's Facebook profile URL
                              example: https://facebook.com/johndoe
                              type:
                                - string
                                - 'null'
                            instagram:
                              description: User's Instagram handle
                              example: johndoe_insta
                              type:
                                - string
                                - 'null'
                            twitter:
                              description: User's Twitter/X handle
                              example: johndoe_tweets
                              type:
                                - string
                                - 'null'
                            linkedin:
                              description: User's LinkedIn profile URL
                              example: https://linkedin.com/in/johndoe
                              type:
                                - string
                                - 'null'
                            whatsapp:
                              description: User's WhatsApp number
                              example: '+18019999999'
                              type:
                                - string
                                - 'null'
                            wechat:
                              description: User's WeChat ID
                              example: johndoe_wechat
                              type:
                                - string
                                - 'null'
                            youtube:
                              description: User's YouTube channel URL
                              example: https://youtube.com/channel/UC123abc456def
                              type:
                                - string
                                - 'null'
                            zip_code:
                              description: User's ZIP/postal code
                              example: '84102'
                              type:
                                - string
                                - 'null'
                            dob:
                              description: User's date of birth
                              example: '1990-05-15'
                              type:
                                - string
                                - 'null'
                            gender:
                              description: User's gender
                              example: male
                              type:
                                - string
                                - 'null'
                            time_zone:
                              description: User's time zone
                              example: America/New_York
                              type:
                                - string
                                - 'null'
                            dnd:
                              default: 'off'
                              description: User's Do Not Disturb preference
                              example: 'true'
                              type:
                                - string
                                - 'null'
                            user_type:
                              description: Type of user
                              example: admin
                              type:
                                - string
                                - 'null'
                            language:
                              title: Language
                              type: object
                              properties:
                                id:
                                  type: integer
                                name:
                                  example: English
                                  type:
                                    - string
                                    - 'null'
                                iso:
                                  example: en
                                  type:
                                    - string
                                    - 'null'
                              required:
                                - id
                            country:
                              title: Country
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                name:
                                  example: United States
                                  type: string
                                iso:
                                  description: 2-letter country code (ISO 3166-1 alpha-2)
                                  example: US
                                  type: string
                              required:
                                - id
                                - name
                                - iso
                            addresses:
                              type: array
                              items:
                                title: Address
                                type: object
                                properties:
                                  id:
                                    type: integer
                                  name:
                                    example: John Doe
                                    type: string
                                  address1:
                                    example: 123 Main St
                                    type: string
                                  address2:
                                    example: Apt 4B
                                    type:
                                      - string
                                      - 'null'
                                  address3:
                                    example: Building 5
                                    type:
                                      - string
                                      - 'null'
                                  city:
                                    example: New York
                                    type: string
                                  state:
                                    example: NY
                                    type: string
                                  subdivision_code:
                                    example: NY
                                    type:
                                      - string
                                      - 'null'
                                  postal_code:
                                    example: '10001'
                                    type: string
                                  country_code:
                                    example: US
                                    type:
                                      - string
                                      - 'null'
                                  default:
                                    description: >-
                                      Use this address by default when there are
                                      multiple addresses
                                    example: true
                                    type:
                                      - boolean
                                      - 'null'
                                    default: false
                                  first_name:
                                    example: John
                                    type: string
                                  last_name:
                                    example: Doe
                                    type: string
                                required:
                                  - id
                                  - name
                                  - address1
                                  - city
                                  - state
                                  - postal_code
                                  - first_name
                                  - last_name
                          required:
                            - id
                            - first_name
                            - last_name
                            - email
                            - avatar
                            - phone
                            - google_id
                            - bio
                            - facebook
                            - instagram
                            - twitter
                            - linkedin
                            - whatsapp
                            - wechat
                            - youtube
                            - zip_code
                            - dob
                            - gender
                            - time_zone
                            - dnd
                            - user_type
                            - language
                            - addresses
                      required:
                        - id
                        - first_name
                        - last_name
                        - company_id
                        - external_id
                        - username
                        - active
                        - mysite_url
                        - rank
                        - share_guid
                        - legacy_number
                        - metadata
                        - created_at
                        - roles
                        - full_name
                        - affiliate
                        - rank_id
                        - user
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      pagination:
                        type: object
                        properties:
                          current_page:
                            type: integer
                            example: 1
                          total_pages:
                            type: integer
                            example: 10
                          total_count:
                            type: integer
                            example: 100
                          per_page:
                            type: integer
                            example: 10
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameters
                  errors:
                    type: object
                    example:
                      by_metadata:
                        - >-
                          The value `{referred_by: {user: 'John},}` in parameter
                          `by_metadata` is not a valid JSON
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
  /api/v202506/users/{id}:
    get:
      summary: Retrieves a user
      tags:
        - Users
      operationId: showUser
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          description: User ID or auth token
          required: true
          schema:
            type: string
      responses:
        '200':
          description: user found via auth token
          content:
            application/json:
              schema:
                type: object
                properties:
                  user_company:
                    title: UserCompany
                    type: object
                    properties:
                      id:
                        type: integer
                      first_name:
                        description: User's first name
                        example: John
                        type:
                          - string
                          - 'null'
                      last_name:
                        description: User's last name
                        example: Doe
                        type:
                          - string
                          - 'null'
                      image_url:
                        description: User's image URL
                        example: https://example.com/image.jpg
                        type:
                          - string
                          - 'null'
                      company_id:
                        description: ID of the company the user belongs to
                        example: 42
                        type:
                          - integer
                          - 'null'
                      external_id:
                        description: External identifier for the user
                        example: EXT123456
                        type:
                          - string
                          - 'null'
                      username:
                        description: User's unique username within the company
                        example: johny_jobs
                        type:
                          - string
                          - 'null'
                      active:
                        default: true
                        description: Whether the user is active in the company
                        example: true
                        type: boolean
                      mysite_url:
                        description: URL to the user's personal site
                        example: https://mycompany.com/johny_jobs
                        type:
                          - string
                          - 'null'
                      rank:
                        description: External ID of Rank the User is linked to
                        example: '234234'
                        type:
                          - integer
                          - string
                          - 'null'
                      share_guid:
                        description: Unique identifier for sharing content
                        example: a6848f0b
                        type:
                          - string
                          - 'null'
                      legacy_number:
                        description: User's legacy phone number
                        example: '+18001234567'
                        type:
                          - string
                          - 'null'
                      metadata:
                        description: >-
                          User's metadata JSON object containing optional
                          metadata about the user, such as tracking data, or
                          third-party identifiers.
                        example:
                          tags:
                            - vip
                            - retail
                        type:
                          - object
                          - 'null'
                      created_at:
                        description: Date and time the user was created
                        example: '2021-01-01T00:00:00Z'
                        type:
                          - string
                          - 'null'
                      roles:
                        description: Roles of the user
                        example:
                          - customer_service
                          - developer
                        type:
                          - array
                          - 'null'
                      email:
                        type:
                          - string
                          - 'null'
                      full_name:
                        description: User's full name
                        example: John Doe
                        type:
                          - string
                          - 'null'
                      affiliate:
                        description: User's affiliate information
                        example: >-
                          {id: 1, external_id: 3, username: "johny_jobs", email:
                          "johny.jobs@example.com", credit: "a6848f0b"}
                        type:
                          - object
                          - 'null'
                      rank_id:
                        description: ID of Rank the User is linked to
                        example: 234234
                        type:
                          - integer
                          - 'null'
                      user:
                        title: User
                        type: object
                        properties:
                          id:
                            type: integer
                          first_name:
                            description: User's first name
                            example: John
                            type:
                              - string
                              - 'null'
                          last_name:
                            description: User's last name
                            example: Doe
                            type:
                              - string
                              - 'null'
                          email:
                            description: User's email address
                            example: john@example.com
                            type:
                              - string
                              - 'null'
                          avatar:
                            description: User's avatar URL
                            example: https://example.com/avatar.jpg
                            type:
                              - string
                              - 'null'
                          phone:
                            description: User's phone
                            example: '+18018888888'
                            type:
                              - string
                              - 'null'
                          google_id:
                            description: User's Google Id
                            example: ''
                            type:
                              - string
                              - 'null'
                          bio:
                            description: User's Bio
                            example: >-
                              Software engineer passionate about creating
                              intuitive user experiences
                            type:
                              - string
                              - 'null'
                          facebook:
                            description: User's Facebook profile URL
                            example: https://facebook.com/johndoe
                            type:
                              - string
                              - 'null'
                          instagram:
                            description: User's Instagram handle
                            example: johndoe_insta
                            type:
                              - string
                              - 'null'
                          twitter:
                            description: User's Twitter/X handle
                            example: johndoe_tweets
                            type:
                              - string
                              - 'null'
                          linkedin:
                            description: User's LinkedIn profile URL
                            example: https://linkedin.com/in/johndoe
                            type:
                              - string
                              - 'null'
                          whatsapp:
                            description: User's WhatsApp number
                            example: '+18019999999'
                            type:
                              - string
                              - 'null'
                          wechat:
                            description: User's WeChat ID
                            example: johndoe_wechat
                            type:
                              - string
                              - 'null'
                          youtube:
                            description: User's YouTube channel URL
                            example: https://youtube.com/channel/UC123abc456def
                            type:
                              - string
                              - 'null'
                          zip_code:
                            description: User's ZIP/postal code
                            example: '84102'
                            type:
                              - string
                              - 'null'
                          dob:
                            description: User's date of birth
                            example: '1990-05-15'
                            type:
                              - string
                              - 'null'
                          gender:
                            description: User's gender
                            example: male
                            type:
                              - string
                              - 'null'
                          time_zone:
                            description: User's time zone
                            example: America/New_York
                            type:
                              - string
                              - 'null'
                          dnd:
                            default: 'off'
                            description: User's Do Not Disturb preference
                            example: 'true'
                            type:
                              - string
                              - 'null'
                          user_type:
                            description: Type of user
                            example: admin
                            type:
                              - string
                              - 'null'
                          language:
                            title: Language
                            type: object
                            properties:
                              id:
                                type: integer
                              name:
                                example: English
                                type:
                                  - string
                                  - 'null'
                              iso:
                                example: en
                                type:
                                  - string
                                  - 'null'
                            required:
                              - id
                          country:
                            title: Country
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                              name:
                                example: United States
                                type: string
                              iso:
                                description: 2-letter country code (ISO 3166-1 alpha-2)
                                example: US
                                type: string
                            required:
                              - id
                              - name
                              - iso
                          addresses:
                            type: array
                            items:
                              title: Address
                              type: object
                              properties:
                                id:
                                  type: integer
                                name:
                                  example: John Doe
                                  type: string
                                address1:
                                  example: 123 Main St
                                  type: string
                                address2:
                                  example: Apt 4B
                                  type:
                                    - string
                                    - 'null'
                                address3:
                                  example: Building 5
                                  type:
                                    - string
                                    - 'null'
                                city:
                                  example: New York
                                  type: string
                                state:
                                  example: NY
                                  type: string
                                subdivision_code:
                                  example: NY
                                  type:
                                    - string
                                    - 'null'
                                postal_code:
                                  example: '10001'
                                  type: string
                                country_code:
                                  example: US
                                  type:
                                    - string
                                    - 'null'
                                default:
                                  description: >-
                                    Use this address by default when there are
                                    multiple addresses
                                  example: true
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                first_name:
                                  example: John
                                  type: string
                                last_name:
                                  example: Doe
                                  type: string
                              required:
                                - id
                                - name
                                - address1
                                - city
                                - state
                                - postal_code
                                - first_name
                                - last_name
                        required:
                          - id
                          - first_name
                          - last_name
                          - email
                          - avatar
                          - phone
                          - google_id
                          - bio
                          - facebook
                          - instagram
                          - twitter
                          - linkedin
                          - whatsapp
                          - wechat
                          - youtube
                          - zip_code
                          - dob
                          - gender
                          - time_zone
                          - dnd
                          - user_type
                          - language
                          - addresses
                    required:
                      - id
                      - first_name
                      - last_name
                      - company_id
                      - external_id
                      - username
                      - active
                      - mysite_url
                      - rank
                      - share_guid
                      - legacy_number
                      - metadata
                      - created_at
                      - roles
                      - full_name
                      - affiliate
                      - rank_id
                      - user
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - user_company
        '404':
          description: user not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: User not found
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                        example:
                          - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
    patch:
      summary: Updates a user
      tags:
        - Users
      operationId: updateUserInvalidRole
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          description: User ID or auth token
          required: true
          schema:
            type: string
      responses:
        '200':
          description: user role updated to admin with admin_roles
          content:
            application/json:
              schema:
                type: object
                properties:
                  user_company:
                    title: UserCompany
                    type: object
                    properties:
                      id:
                        type: integer
                      first_name:
                        description: User's first name
                        example: John
                        type:
                          - string
                          - 'null'
                      last_name:
                        description: User's last name
                        example: Doe
                        type:
                          - string
                          - 'null'
                      image_url:
                        description: User's image URL
                        example: https://example.com/image.jpg
                        type:
                          - string
                          - 'null'
                      company_id:
                        description: ID of the company the user belongs to
                        example: 42
                        type:
                          - integer
                          - 'null'
                      external_id:
                        description: External identifier for the user
                        example: EXT123456
                        type:
                          - string
                          - 'null'
                      username:
                        description: User's unique username within the company
                        example: johny_jobs
                        type:
                          - string
                          - 'null'
                      active:
                        default: true
                        description: Whether the user is active in the company
                        example: true
                        type: boolean
                      mysite_url:
                        description: URL to the user's personal site
                        example: https://mycompany.com/johny_jobs
                        type:
                          - string
                          - 'null'
                      rank:
                        description: External ID of Rank the User is linked to
                        example: '234234'
                        type:
                          - integer
                          - string
                          - 'null'
                      share_guid:
                        description: Unique identifier for sharing content
                        example: a6848f0b
                        type:
                          - string
                          - 'null'
                      legacy_number:
                        description: User's legacy phone number
                        example: '+18001234567'
                        type:
                          - string
                          - 'null'
                      metadata:
                        description: >-
                          User's metadata JSON object containing optional
                          metadata about the user, such as tracking data, or
                          third-party identifiers.
                        example:
                          tags:
                            - vip
                            - retail
                        type:
                          - object
                          - 'null'
                      created_at:
                        description: Date and time the user was created
                        example: '2021-01-01T00:00:00Z'
                        type:
                          - string
                          - 'null'
                      roles:
                        description: Roles of the user
                        example:
                          - customer_service
                          - developer
                        type:
                          - array
                          - 'null'
                      email:
                        type:
                          - string
                          - 'null'
                      full_name:
                        description: User's full name
                        example: John Doe
                        type:
                          - string
                          - 'null'
                      affiliate:
                        description: User's affiliate information
                        example: >-
                          {id: 1, external_id: 3, username: "johny_jobs", email:
                          "johny.jobs@example.com", credit: "a6848f0b"}
                        type:
                          - object
                          - 'null'
                      rank_id:
                        description: ID of Rank the User is linked to
                        example: 234234
                        type:
                          - integer
                          - 'null'
                      user:
                        title: User
                        type: object
                        properties:
                          id:
                            type: integer
                          first_name:
                            description: User's first name
                            example: John
                            type:
                              - string
                              - 'null'
                          last_name:
                            description: User's last name
                            example: Doe
                            type:
                              - string
                              - 'null'
                          email:
                            description: User's email address
                            example: john@example.com
                            type:
                              - string
                              - 'null'
                          avatar:
                            description: User's avatar URL
                            example: https://example.com/avatar.jpg
                            type:
                              - string
                              - 'null'
                          phone:
                            description: User's phone
                            example: '+18018888888'
                            type:
                              - string
                              - 'null'
                          google_id:
                            description: User's Google Id
                            example: ''
                            type:
                              - string
                              - 'null'
                          bio:
                            description: User's Bio
                            example: >-
                              Software engineer passionate about creating
                              intuitive user experiences
                            type:
                              - string
                              - 'null'
                          facebook:
                            description: User's Facebook profile URL
                            example: https://facebook.com/johndoe
                            type:
                              - string
                              - 'null'
                          instagram:
                            description: User's Instagram handle
                            example: johndoe_insta
                            type:
                              - string
                              - 'null'
                          twitter:
                            description: User's Twitter/X handle
                            example: johndoe_tweets
                            type:
                              - string
                              - 'null'
                          linkedin:
                            description: User's LinkedIn profile URL
                            example: https://linkedin.com/in/johndoe
                            type:
                              - string
                              - 'null'
                          whatsapp:
                            description: User's WhatsApp number
                            example: '+18019999999'
                            type:
                              - string
                              - 'null'
                          wechat:
                            description: User's WeChat ID
                            example: johndoe_wechat
                            type:
                              - string
                              - 'null'
                          youtube:
                            description: User's YouTube channel URL
                            example: https://youtube.com/channel/UC123abc456def
                            type:
                              - string
                              - 'null'
                          zip_code:
                            description: User's ZIP/postal code
                            example: '84102'
                            type:
                              - string
                              - 'null'
                          dob:
                            description: User's date of birth
                            example: '1990-05-15'
                            type:
                              - string
                              - 'null'
                          gender:
                            description: User's gender
                            example: male
                            type:
                              - string
                              - 'null'
                          time_zone:
                            description: User's time zone
                            example: America/New_York
                            type:
                              - string
                              - 'null'
                          dnd:
                            default: 'off'
                            description: User's Do Not Disturb preference
                            example: 'true'
                            type:
                              - string
                              - 'null'
                          user_type:
                            description: Type of user
                            example: admin
                            type:
                              - string
                              - 'null'
                          language:
                            title: Language
                            type: object
                            properties:
                              id:
                                type: integer
                              name:
                                example: English
                                type:
                                  - string
                                  - 'null'
                              iso:
                                example: en
                                type:
                                  - string
                                  - 'null'
                            required:
                              - id
                          country:
                            title: Country
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                              name:
                                example: United States
                                type: string
                              iso:
                                description: 2-letter country code (ISO 3166-1 alpha-2)
                                example: US
                                type: string
                            required:
                              - id
                              - name
                              - iso
                          addresses:
                            type: array
                            items:
                              title: Address
                              type: object
                              properties:
                                id:
                                  type: integer
                                name:
                                  example: John Doe
                                  type: string
                                address1:
                                  example: 123 Main St
                                  type: string
                                address2:
                                  example: Apt 4B
                                  type:
                                    - string
                                    - 'null'
                                address3:
                                  example: Building 5
                                  type:
                                    - string
                                    - 'null'
                                city:
                                  example: New York
                                  type: string
                                state:
                                  example: NY
                                  type: string
                                subdivision_code:
                                  example: NY
                                  type:
                                    - string
                                    - 'null'
                                postal_code:
                                  example: '10001'
                                  type: string
                                country_code:
                                  example: US
                                  type:
                                    - string
                                    - 'null'
                                default:
                                  description: >-
                                    Use this address by default when there are
                                    multiple addresses
                                  example: true
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                first_name:
                                  example: John
                                  type: string
                                last_name:
                                  example: Doe
                                  type: string
                              required:
                                - id
                                - name
                                - address1
                                - city
                                - state
                                - postal_code
                                - first_name
                                - last_name
                        required:
                          - id
                          - first_name
                          - last_name
                          - email
                          - avatar
                          - phone
                          - google_id
                          - bio
                          - facebook
                          - instagram
                          - twitter
                          - linkedin
                          - whatsapp
                          - wechat
                          - youtube
                          - zip_code
                          - dob
                          - gender
                          - time_zone
                          - dnd
                          - user_type
                          - language
                          - addresses
                    required:
                      - id
                      - first_name
                      - last_name
                      - company_id
                      - external_id
                      - username
                      - active
                      - mysite_url
                      - rank
                      - share_guid
                      - legacy_number
                      - metadata
                      - created_at
                      - roles
                      - full_name
                      - affiliate
                      - rank_id
                      - user
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - user_company
                  - meta
        '404':
          description: user not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: User not found
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                        example:
                          - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: validation fails for invalid role
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    properties:
                      base:
                        type: array
                        items:
                          type: string
                        example:
                          - 'Validation failed: Role company_id mismatch'
                      admin_roles:
                        type: array
                        items:
                          type: string
                    example: Invalid parameters
                  errors:
                    type: object
                    properties:
                      user_company:
                        type: array
                        items:
                          type: object
                          properties:
                            base:
                              type: array
                              items:
                                type: string
                              example:
                                - 'Validation failed: Role company_id mismatch'
                            admin_roles:
                              type: array
                              items:
                                type: string
                      user:
                        type: object
                        properties:
                          role:
                            type: array
                            items:
                              type: string
                            example:
                              - 'must be one of: admin, rep, user'
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                user:
                  type: object
                  properties:
                    email:
                      type: string
                    first_name:
                      type: string
                    last_name:
                      type: string
                    password:
                      type: string
                    avatar:
                      type: string
                    phone:
                      type: string
                    google_id:
                      type: string
                    bio:
                      type: string
                    facebook:
                      type: string
                    instagram:
                      type: string
                    twitter:
                      type: string
                    linkedin:
                      type: string
                    whatsapp:
                      type: string
                    wechat:
                      type: string
                    youtube:
                      type: string
                    zip_code:
                      type: string
                    dob:
                      type: string
                      format: date
                    gender:
                      type: string
                    time_zone:
                      type: string
                    push_notifications:
                      type: boolean
                    email_notifications:
                      type: boolean
                    sms_notifications:
                      type: boolean
                    external_id:
                      type: string
                    username:
                      type: string
                    active:
                      type: boolean
                    role:
                      type: string
                      enum:
                        - admin
                        - rep
                        - user
                    admin_roles:
                      type: array
                      items:
                        type: integer
                    affiliate:
                      type: object
                      properties:
                        id:
                          type: string
                        external_id:
                          type: string
                        username:
                          type: string
                        email:
                          type: string
                      required: []
                  required:
                    - email
                    - affiliate
              required:
                - country_code
                - language_code
                - user
    delete:
      summary: Deletes a user
      tags:
        - Users
      operationId: destroyUser
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          description: User ID or auth token
          required: true
          schema:
            type: string
      responses:
        '200':
          description: user deleted successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                    description: User ID
                    example: 1
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - id
                  - meta
        '404':
          description: user not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: User not found
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                        example:
                          - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: failed to delete user
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Failed to delete user
                  errors:
                    type: object
                    properties:
                      user:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/v202506/users/{id}/append_metadata:
    patch:
      summary: Append metadata field
      tags:
        - Users
      operationId: userAppendMetadataField
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          description: User ID or auth token
          required: true
          schema:
            type: string
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  user_company:
                    title: UserCompany
                    type: object
                    properties:
                      id:
                        type: integer
                      first_name:
                        description: User's first name
                        example: John
                        type:
                          - string
                          - 'null'
                      last_name:
                        description: User's last name
                        example: Doe
                        type:
                          - string
                          - 'null'
                      image_url:
                        description: User's image URL
                        example: https://example.com/image.jpg
                        type:
                          - string
                          - 'null'
                      company_id:
                        description: ID of the company the user belongs to
                        example: 42
                        type:
                          - integer
                          - 'null'
                      external_id:
                        description: External identifier for the user
                        example: EXT123456
                        type:
                          - string
                          - 'null'
                      username:
                        description: User's unique username within the company
                        example: johny_jobs
                        type:
                          - string
                          - 'null'
                      active:
                        default: true
                        description: Whether the user is active in the company
                        example: true
                        type: boolean
                      mysite_url:
                        description: URL to the user's personal site
                        example: https://mycompany.com/johny_jobs
                        type:
                          - string
                          - 'null'
                      rank:
                        description: External ID of Rank the User is linked to
                        example: '234234'
                        type:
                          - integer
                          - string
                          - 'null'
                      share_guid:
                        description: Unique identifier for sharing content
                        example: a6848f0b
                        type:
                          - string
                          - 'null'
                      legacy_number:
                        description: User's legacy phone number
                        example: '+18001234567'
                        type:
                          - string
                          - 'null'
                      metadata:
                        description: >-
                          User's metadata JSON object containing optional
                          metadata about the user, such as tracking data, or
                          third-party identifiers.
                        example:
                          tags:
                            - vip
                            - retail
                        type:
                          - object
                          - 'null'
                      created_at:
                        description: Date and time the user was created
                        example: '2021-01-01T00:00:00Z'
                        type:
                          - string
                          - 'null'
                      roles:
                        description: Roles of the user
                        example:
                          - customer_service
                          - developer
                        type:
                          - array
                          - 'null'
                      email:
                        type:
                          - string
                          - 'null'
                      full_name:
                        description: User's full name
                        example: John Doe
                        type:
                          - string
                          - 'null'
                      affiliate:
                        description: User's affiliate information
                        example: >-
                          {id: 1, external_id: 3, username: "johny_jobs", email:
                          "johny.jobs@example.com", credit: "a6848f0b"}
                        type:
                          - object
                          - 'null'
                      rank_id:
                        description: ID of Rank the User is linked to
                        example: 234234
                        type:
                          - integer
                          - 'null'
                      user:
                        title: User
                        type: object
                        properties:
                          id:
                            type: integer
                          first_name:
                            description: User's first name
                            example: John
                            type:
                              - string
                              - 'null'
                          last_name:
                            description: User's last name
                            example: Doe
                            type:
                              - string
                              - 'null'
                          email:
                            description: User's email address
                            example: john@example.com
                            type:
                              - string
                              - 'null'
                          avatar:
                            description: User's avatar URL
                            example: https://example.com/avatar.jpg
                            type:
                              - string
                              - 'null'
                          phone:
                            description: User's phone
                            example: '+18018888888'
                            type:
                              - string
                              - 'null'
                          google_id:
                            description: User's Google Id
                            example: ''
                            type:
                              - string
                              - 'null'
                          bio:
                            description: User's Bio
                            example: >-
                              Software engineer passionate about creating
                              intuitive user experiences
                            type:
                              - string
                              - 'null'
                          facebook:
                            description: User's Facebook profile URL
                            example: https://facebook.com/johndoe
                            type:
                              - string
                              - 'null'
                          instagram:
                            description: User's Instagram handle
                            example: johndoe_insta
                            type:
                              - string
                              - 'null'
                          twitter:
                            description: User's Twitter/X handle
                            example: johndoe_tweets
                            type:
                              - string
                              - 'null'
                          linkedin:
                            description: User's LinkedIn profile URL
                            example: https://linkedin.com/in/johndoe
                            type:
                              - string
                              - 'null'
                          whatsapp:
                            description: User's WhatsApp number
                            example: '+18019999999'
                            type:
                              - string
                              - 'null'
                          wechat:
                            description: User's WeChat ID
                            example: johndoe_wechat
                            type:
                              - string
                              - 'null'
                          youtube:
                            description: User's YouTube channel URL
                            example: https://youtube.com/channel/UC123abc456def
                            type:
                              - string
                              - 'null'
                          zip_code:
                            description: User's ZIP/postal code
                            example: '84102'
                            type:
                              - string
                              - 'null'
                          dob:
                            description: User's date of birth
                            example: '1990-05-15'
                            type:
                              - string
                              - 'null'
                          gender:
                            description: User's gender
                            example: male
                            type:
                              - string
                              - 'null'
                          time_zone:
                            description: User's time zone
                            example: America/New_York
                            type:
                              - string
                              - 'null'
                          dnd:
                            default: 'off'
                            description: User's Do Not Disturb preference
                            example: 'true'
                            type:
                              - string
                              - 'null'
                          user_type:
                            description: Type of user
                            example: admin
                            type:
                              - string
                              - 'null'
                          language:
                            title: Language
                            type: object
                            properties:
                              id:
                                type: integer
                              name:
                                example: English
                                type:
                                  - string
                                  - 'null'
                              iso:
                                example: en
                                type:
                                  - string
                                  - 'null'
                            required:
                              - id
                          country:
                            title: Country
                            type:
                              - object
                              - 'null'
                            properties:
                              id:
                                type: integer
                              name:
                                example: United States
                                type: string
                              iso:
                                description: 2-letter country code (ISO 3166-1 alpha-2)
                                example: US
                                type: string
                            required:
                              - id
                              - name
                              - iso
                          addresses:
                            type: array
                            items:
                              title: Address
                              type: object
                              properties:
                                id:
                                  type: integer
                                name:
                                  example: John Doe
                                  type: string
                                address1:
                                  example: 123 Main St
                                  type: string
                                address2:
                                  example: Apt 4B
                                  type:
                                    - string
                                    - 'null'
                                address3:
                                  example: Building 5
                                  type:
                                    - string
                                    - 'null'
                                city:
                                  example: New York
                                  type: string
                                state:
                                  example: NY
                                  type: string
                                subdivision_code:
                                  example: NY
                                  type:
                                    - string
                                    - 'null'
                                postal_code:
                                  example: '10001'
                                  type: string
                                country_code:
                                  example: US
                                  type:
                                    - string
                                    - 'null'
                                default:
                                  description: >-
                                    Use this address by default when there are
                                    multiple addresses
                                  example: true
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                first_name:
                                  example: John
                                  type: string
                                last_name:
                                  example: Doe
                                  type: string
                              required:
                                - id
                                - name
                                - address1
                                - city
                                - state
                                - postal_code
                                - first_name
                                - last_name
                        required:
                          - id
                          - first_name
                          - last_name
                          - email
                          - avatar
                          - phone
                          - google_id
                          - bio
                          - facebook
                          - instagram
                          - twitter
                          - linkedin
                          - whatsapp
                          - wechat
                          - youtube
                          - zip_code
                          - dob
                          - gender
                          - time_zone
                          - dnd
                          - user_type
                          - language
                          - addresses
                    required:
                      - id
                      - first_name
                      - last_name
                      - company_id
                      - external_id
                      - username
                      - active
                      - mysite_url
                      - rank
                      - share_guid
                      - legacy_number
                      - metadata
                      - created_at
                      - roles
                      - full_name
                      - affiliate
                      - rank_id
                      - user
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                        example:
                          - User Company not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                metadata:
                  type: object
                  description: A JSON object that can store any custom data structure.
                  example:
                    profile_complete: true
                    preferences:
                      theme: dark
                      newsletter: true
              required:
                - metadata
  /api/v202506/users/find:
    get:
      summary: Finds a user
      tags:
        - Users
      operationId: findUser
      description: Find user using one of it's identifiers
      security:
        - bearer_auth: []
      parameters:
        - name: external_id
          in: query
          description: User's external id
          required: false
          schema:
            type: string
        - name: username
          in: query
          description: User's username
          required: false
          schema:
            type: string
        - name: email
          in: query
          description: User's email
          required: false
          schema:
            type: string
        - name: token
          in: query
          description: User's auth token
          required: false
          schema:
            type: string
        - name: share_guid
          in: query
          description: User's share guid
          required: false
          schema:
            type: string
      responses:
        '200':
          description: user found by share_guid
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                    description: User ID
                    example: 1
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - id
                  - meta
        '404':
          description: user not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: User not found
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                        example:
                          - not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/company/users:
    get:
      tags:
        - Users
      summary: List Company Users
      description: Retrieves a list of company users.
      operationId: listCompanyUsers
      parameters:
        - name: page
          in: query
          required: false
          schema:
            type: integer
          description: The page number for paginated results
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/index6'
                description: ''
      deprecated: false
      security:
        - bearer: []
    post:
      tags:
        - Users
      summary: Create Company User
      description: Creates a new user associated with a company.
      operationId: createCompanyUser
      parameters:
        - name: email
          in: query
          required: true
          schema:
            type: string
          description: Email address of the user
        - name: username
          in: query
          required: false
          schema:
            type: string
          description: Username for the user
        - name: external_id
          in: query
          required: false
          schema:
            type: string
          description: External identifier for the user
        - name: active
          in: query
          required: false
          schema:
            type: boolean
          description: Whether the user account is active
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/createrequest4'
                - example:
                    affiliate:
                      id: null
                      external_id: null
                      username: sammysample12
                      email: null
                    username: ''
                    active: true
                    email: juliete1411232@google.com
                    first_name: fussname
                    last_name: lassname
                    avatar: ''
                    phone: ''
                    google_id: ''
                    bio: ''
                    facebook: ''
                    instagram: ''
                    twitter: ''
                    linkedin: ''
                    whatsapp: ''
                    wechat: ''
                    youtube: ''
                    zip_code: ''
                    dob: ''
                    gender: ''
                    time_zone: ''
                    push_notifications: ''
                    email_notifications: ''
                    sms_notifications: ''
                    language_code: en
                    country_code: US
            example:
              affiliate:
                id: null
                external_id: null
                username: sammysample12
                email: null
              username: ''
              active: true
              email: juliete1411232@google.com
              first_name: fussname
              last_name: lassname
              password: ''
              avatar: ''
              phone: ''
              google_id: ''
              bio: ''
              facebook: ''
              instagram: ''
              twitter: ''
              linkedin: ''
              whatsapp: ''
              wechat: ''
              youtube: ''
              zip_code: ''
              dob: ''
              gender: ''
              time_zone: ''
              push_notifications: ''
              email_notifications: ''
              sms_notifications: ''
              language_code: en
              country_code: US
        required: true
      responses:
        '201':
          description: Created
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/create4'
                  - example:
                      id: 3477
                      external_id: ''
                      username: ''
                      active: true
                      affiliate: {}
                      user:
                        email: juliete1411232@google.com
                        first_name: fussname
                        last_name: lassname
                        avatar: ''
                        phone: ''
                        google_id: ''
                        bio: ''
                        facebook: ''
                        instagram: ''
                        twitter: ''
                        linkedin: ''
                        whatsapp: ''
                        wechat: ''
                        youtube: ''
                        zip_code: ''
                        dob: null
                        gender: ''
                        time_zone: ''
                        language:
                          name: English
                          iso: en
                        country:
                          name: United States
                          iso: US
              example:
                id: 3477
                external_id: ''
                username: ''
                active: true
                affiliate: {}
                user:
                  email: juliete1411232@google.com
                  first_name: fussname
                  last_name: lassname
                  avatar: ''
                  phone: ''
                  google_id: ''
                  bio: ''
                  facebook: ''
                  instagram: ''
                  twitter: ''
                  linkedin: ''
                  whatsapp: ''
                  wechat: ''
                  youtube: ''
                  zip_code: ''
                  dob: null
                  gender: ''
                  time_zone: ''
                  language:
                    name: English
                    iso: en
                  country:
                    name: United States
                    iso: US
      deprecated: false
      security:
        - bearer: []
  /api/company/users/{id}:
    get:
      tags:
        - Users
      summary: Get Company User Details
      description: >-
        Retrieves detailed information for a specific company user, including
        their profile data and activity status.
      operationId: getCompanyUserById
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
          description: The unique identifier of the company user to retrieve
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/show4'
                  - example:
                      id: 3470
                      external_id: null
                      username: null
                      active: true
                      affiliate: {}
                      user:
                        email: pralishkayastha@gmail.com
                        first_name: Yucatán
                        last_name: résumé
                        avatar: null
                        phone: null
                        google_id: null
                        bio: null
                        facebook: null
                        instagram: null
                        twitter: null
                        linkedin: null
                        whatsapp: null
                        wechat: null
                        youtube: null
                        zip_code: null
                        dob: null
                        gender: null
                        time_zone: null
                        language:
                          name: English
                          iso: en
                        country:
                          name: United States
                          iso: US
              example:
                id: 3470
                external_id: null
                username: null
                active: true
                affiliate: {}
                user:
                  email: pralishkayastha@gmail.com
                  first_name: Yucatán
                  last_name: résumé
                  avatar: null
                  phone: null
                  google_id: null
                  bio: null
                  facebook: null
                  instagram: null
                  twitter: null
                  linkedin: null
                  whatsapp: null
                  wechat: null
                  youtube: null
                  zip_code: null
                  dob: null
                  gender: null
                  time_zone: null
                  language:
                    name: English
                    iso: en
                  country:
                    name: United States
                    iso: US
      deprecated: false
      security:
        - bearer: []
    put:
      tags:
        - Users
      summary: Update Affiliate User Information
      description: >-
        Updates user information and preferences for a specific affiliate within
        the company.
      operationId: updateAffiliateUser
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: Unique identifier of the affiliate
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/updaterequest5'
                - example:
                    affiliate:
                      id: 3355
                      external_id: null
                      username: null
                      email: null
                    first_name: testfirst
                    last_name: testlast
                    avatar: ''
                    phone: '+14844145967'
                    google_id: julies.home
                    bio: hi im jules
                    facebook: jle
                    instagram: jules
                    twitter: jj
                    linkedin: ju
                    whatsapp: ul
                    wechat: '9865326598'
                    youtube: juleshome
                    zip_code: '97655'
                    dob: '1997-08-08'
                    gender: female
                    time_zone: CST
                    push_notifications: ''
                    email_notifications: ''
                    sms_notifications: ''
            example:
              affiliate:
                id: 3355
                external_id: null
                username: null
                email: null
              first_name: testfirst
              last_name: testlast
              avatar: ''
              phone: '+14844145967'
              google_id: julies.home
              bio: hi im jules
              facebook: jle
              instagram: jules
              twitter: jj
              linkedin: ju
              whatsapp: ul
              wechat: '9865326598'
              youtube: juleshome
              zip_code: '97655'
              dob: '1997-08-08'
              gender: female
              time_zone: CST
              push_notifications: ''
              email_notifications: ''
              sms_notifications: ''
        required: true
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/update5'
                  - example:
                      id: 3484
                      external_id: null
                      username: ''
                      active: true
                      affiliate:
                        id: 3355
                        email: nitesh@tester.com
                      user:
                        email: juliete1411232111@google.com
                        first_name: testfirst
                        last_name: testlast
                        avatar: ''
                        phone: '+14844145967'
                        google_id: julies.home
                        bio: hi im jules
                        facebook: jle
                        instagram: jules
                        twitter: jj
                        linkedin: ju
                        whatsapp: ul
                        wechat: '9865326598'
                        youtube: juleshome
                        zip_code: '97655'
                        dob: '1997-08-08'
                        gender: female
                        time_zone: CST
                        language:
                          name: English
                          iso: en
                        country:
                          name: United States
                          iso: US
              example:
                id: 3484
                external_id: null
                username: ''
                active: true
                affiliate:
                  id: 3355
                  email: nitesh@tester.com
                user:
                  email: juliete1411232111@google.com
                  first_name: testfirst
                  last_name: testlast
                  avatar: ''
                  phone: '+14844145967'
                  google_id: julies.home
                  bio: hi im jules
                  facebook: jle
                  instagram: jules
                  twitter: jj
                  linkedin: ju
                  whatsapp: ul
                  wechat: '9865326598'
                  youtube: juleshome
                  zip_code: '97655'
                  dob: '1997-08-08'
                  gender: female
                  time_zone: CST
                  language:
                    name: English
                    iso: en
                  country:
                    name: United States
                    iso: US
      deprecated: false
      security:
        - bearer: []
    delete:
      tags:
        - Users
      summary: Delete Company User
      description: Deletes a user's record associated with the company.
      operationId: deleteCompanyUser
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The unique identifier of the user to delete
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                type: string
                example: User deleted successfully.
              example: User deleted successfully.
      deprecated: false
      security:
        - bearer: []
  /api/v1/variants/variant_countries:
    get:
      summary: Retrieves a list of variant countries of variant
      tags:
        - Variant Countries
      parameters:
        - name: variant_ids[]
          in: query
          required: true
          schema:
            type: array
            items:
              type: integer
              example: 1
      responses:
        '200':
          description: List of variant countries retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  variant_countries:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 662
                        active:
                          type: boolean
                          example: true
                        compare_price:
                          type: string
                          format: decimal
                          example: '0.0'
                        cost_of_goods_sold:
                          type: string
                          format: decimal
                          example: '0.0'
                        country_code:
                          type: string
                          example: US
                        currency_code:
                          type: string
                          example: USD
                        display_price:
                          type: string
                          example: $42.20 (USD)
                        display_subscription_price:
                          type: string
                          example: $0.00 (USD)
                        display_wholesale:
                          type: string
                          example: $0.00 (USD)
                        display_wholesale_subscription_price:
                          type: string
                          example: $0.00 (USD)
                        price:
                          type: string
                          format: decimal
                          example: '42.2'
                        shipping:
                          type: string
                          format: decimal
                          example: '0.0'
                        shipping_time:
                          type:
                            - string
                            - 'null'
                          example: null
                        subscription_price:
                          type: string
                          format: decimal
                          example: '0.0'
                        variant_id:
                          type: integer
                          example: 90
                        wholesale:
                          type: string
                          format: decimal
                          example: '0.0'
                        wholesale_subscription_price:
                          type: string
                          format: decimal
                          example: '0.0'
                        points:
                          type: number
                          example: 100
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        format: date_time
                        example: '2024-12-11T08:00:00Z'
  /api/v1/variants/variant_countries/bulk_update:
    post:
      summary: Bulk Update Variant Countries
      tags:
        - Variant Countries
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: Bulk Update Successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  variant_countries:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 662
                        active:
                          type: boolean
                          example: true
                        compare_price:
                          type: string
                          format: decimal
                          example: '0.0'
                        cost_of_goods_sold:
                          type: string
                          format: decimal
                          example: '0.0'
                        country_code:
                          type: string
                          example: US
                        currency_code:
                          type: string
                          example: USD
                        display_price:
                          type: string
                          example: $42.20 (USD)
                        display_subscription_price:
                          type: string
                          example: $0.00 (USD)
                        display_wholesale:
                          type: string
                          example: $0.00 (USD)
                        display_wholesale_subscription_price:
                          type: string
                          example: $0.00 (USD)
                        price:
                          type: string
                          format: decimal
                          example: '42.2'
                        shipping:
                          type: string
                          format: decimal
                          example: '0.0'
                        shipping_time:
                          type:
                            - string
                            - 'null'
                          example: null
                        subscription_price:
                          type: string
                          format: decimal
                          example: '0.0'
                        variant_id:
                          type: integer
                          example: 90
                        wholesale:
                          type: string
                          format: decimal
                          example: '0.0'
                        wholesale_subscription_price:
                          type: string
                          format: decimal
                          example: '0.0'
                        points:
                          type: number
                          example: 100
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        format: date_time
                        example: '2024-12-11T08:00:00Z'
        '422':
          description: Validation Errors
          content:
            application/json:
              schema:
                type: object
                properties:
                  variant_countries:
                    type: array
                  errors:
                    type: array
                    items:
                      type: object
                      properties:
                        sku:
                          type: string
                          example: invalid_sku
                        error_messages:
                          type: object
                          properties:
                            sku:
                              type: string
                              example: >-
                                There are 3 active variants with the SKU
                                invalid_sku
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        format: date_time
                        example: '2024-12-11T08:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                variant_countries:
                  type: array
                  items:
                    type: object
                    properties:
                      variant_country_id:
                        type:
                          - string
                          - 'null'
                        default: null
                      variant_country_external_id:
                        type:
                          - string
                          - 'null'
                        default: null
                      variant_id:
                        type:
                          - string
                          - 'null'
                        default: null
                      variant_external_id:
                        type:
                          - string
                          - 'null'
                        default: null
                      currency_code:
                        type: string
                      country_code:
                        type:
                          - string
                          - 'null'
                      sku:
                        type:
                          - string
                          - 'null'
                      price:
                        type:
                          - number
                          - string
                        format: float
                      wholesale:
                        type:
                          - number
                          - string
                        format: float
                      cv:
                        type: integer
                      qv:
                        type: integer
                      pc_cv:
                        type: integer
                      pc_qv:
                        type: integer
                    required:
                      - currency_code
                    anyOf:
                      - required:
                          - variant_country_id
                      - required:
                          - variant_country_external_id
                      - allOf:
                          - anyOf:
                              - required:
                                  - variant_id
                              - required:
                                  - variant_external_id
                          - required:
                              - country_code
                      - required:
                          - sku
                          - country_code
              required:
                - variant_countries
  /api/company/v1/variants/{variant_id}/variant_countries:
    post:
      summary: Create a new variant country
      tags:
        - Variant Countries
      operationId: createVariantCountry
      security:
        - bearer_auth: []
      parameters:
        - name: variant_id
          in: path
          required: true
          description: Variant ID
          example: 1
          schema:
            type: integer
      responses:
        '201':
          description: Variant country created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  variant_country:
                    title: VariantCountry
                    type: object
                    properties:
                      id:
                        type: integer
                      variant_id:
                        type: integer
                      active:
                        type:
                          - boolean
                          - 'null'
                        default: true
                      currency_code:
                        type:
                          - string
                          - 'null'
                      price:
                        type:
                          - number
                          - string
                          - 'null'
                        default: '0.0'
                        minimum: 0
                        maximum: 99999999
                      shipping:
                        type:
                          - number
                          - string
                          - 'null'
                        default: '0.0'
                      shipping_time:
                        type:
                          - string
                          - 'null'
                      subscription_price:
                        type:
                          - number
                          - string
                          - 'null'
                        default: '0.0'
                      wholesale:
                        type:
                          - number
                          - string
                          - 'null'
                        default: '0.0'
                      wholesale_subscription_price:
                        type:
                          - number
                          - string
                          - 'null'
                        default: '0.0'
                      cost_of_goods_sold:
                        type:
                          - number
                          - string
                          - 'null'
                        default: '0.0'
                      compare_price:
                        type:
                          - number
                          - string
                          - 'null'
                        default: '0.0'
                      points:
                        type: integer
                        default: 0
                        minimum: 0
                      country_code:
                        type: string
                      display_price:
                        type: string
                      display_subscription_price:
                        type: string
                      display_wholesale:
                        type: string
                      display_wholesale_subscription_price:
                        type: string
                    required:
                      - id
                      - variant_id
                      - points
                      - country_code
                      - display_price
                      - display_subscription_price
                      - display_wholesale
                      - display_wholesale_subscription_price
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - variant_country
                  - meta
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '404':
          description: Variant not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: Invalid parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                variant_country:
                  type: object
                  properties:
                    active:
                      type: boolean
                    country_id:
                      type: integer
                    price:
                      type: number
                    subscription_price:
                      type: number
                    wholesale:
                      type: number
                    wholesale_subscription_price:
                      type: number
                    compare_price:
                      type: number
                    cv:
                      type: integer
                    qv:
                      type: integer
                    pc_cv:
                      type: integer
                    pc_qv:
                      type: integer
                    cost_of_goods_sold:
                      type: number
                    shipping:
                      type: number
                    tax:
                      type: number
                  required:
                    - active
                    - country_id
                    - price
              required:
                - variant_country
  /api/company/v1/variants/{variant_id}/images:
    post:
      summary: Create a new variant image
      tags:
        - Variant Images
      operationId: createVariantImage
      security:
        - bearer_auth: []
      parameters:
        - name: variant_id
          in: path
          required: true
          description: Variant ID
          example: 1
          schema:
            type: integer
      responses:
        '201':
          description: Variant image created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  variant_image:
                    title: Image
                    type: object
                    properties:
                      id:
                        type: integer
                      image_url:
                        description: The URL of the image
                        example: https://example.com/images/product-123.jpg
                        type:
                          - string
                          - 'null'
                      image_path:
                        description: The file path of the image
                        example: uploads/products/images/product-123.jpg
                        type:
                          - string
                          - 'null'
                      position:
                        description: >-
                          The display order position of the image (lower numbers
                          display first)
                        example: 1
                        type:
                          - integer
                          - 'null'
                      created_at:
                        type: string
                        format: date-time
                      updated_at:
                        type: string
                        format: date-time
                    required:
                      - id
                      - created_at
                      - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - variant_image
                  - meta
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '404':
          description: Variant not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: Invalid parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                image:
                  type: object
                  properties:
                    position:
                      type: integer
                    image_url:
                      type: string
                  required:
                    - position
                    - image_url
              required:
                - image
  /api/company/v1/variants/{variant_id}/inventory_levels:
    post:
      summary: Create a new variant inventory level
      tags:
        - Variant Inventory Levels
      operationId: createVariantInventoryLevel
      security:
        - bearer_auth: []
      parameters:
        - name: variant_id
          in: path
          required: true
          description: Variant ID
          example: 1
          schema:
            type: integer
      responses:
        '201':
          description: Variant inventory level created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  inventory_level:
                    title: InventoryLevel
                    type: object
                    properties:
                      id:
                        type: integer
                      committed:
                        description: Number of items committed to orders
                        example: 10
                        type: integer
                      available:
                        description: Number of items available for sale
                        example: 25
                        type: integer
                      on_hand:
                        description: Total number of items physically in stock
                        example: 35
                        type: integer
                      unavailable:
                        description: Number of items unavailable for sale
                        example: 5
                        type: integer
                      adjustments:
                        description: Inventory adjustments made to this level
                        example:
                          - id: 1
                            quantity: -2
                            reason: damaged
                        type:
                          - array
                          - 'null'
                      unavailable_item_counts_by_category:
                        description: Count of unavailable items grouped by category
                        example:
                          damaged: 3
                          reserved: 2
                        type:
                          - object
                          - 'null'
                      warning:
                        description: Warning message for this inventory level
                        example: Low stock alert
                        type:
                          - string
                          - 'null'
                      variant:
                        description: Variant information for this inventory level
                        example:
                          id: 456
                          sku: WIDGET-001
                          track_quantity: true
                          keep_selling: false
                        type: object
                      product:
                        description: Product information for this inventory level
                        example:
                          id: 789
                          title: Premium Widget Collection
                          image_url: https://example.com/images/widget.jpg
                        type: object
                      warehouse:
                        description: Warehouse information where this inventory is stored
                        example:
                          id: 101
                          country:
                            id: 1
                            name: United States
                            iso: US
                          address:
                            id: 201
                            city: New York
                            state: NY
                            address1: 123 Main Street
                            postal_code: '10001'
                        type: object
                    required:
                      - id
                      - committed
                      - available
                      - on_hand
                      - unavailable
                      - variant
                      - product
                      - warehouse
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - inventory_level
                  - meta
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid credentials.
        '404':
          description: Variant not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: Invalid parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                inventory_level:
                  type: object
                  properties:
                    warehouse_id:
                      type: integer
                      not:
                        type: 'null'
                    available:
                      type: integer
                      not:
                        type: 'null'
                    committed:
                      type: integer
                      not:
                        type: 'null'
                    on_hand:
                      type: integer
                      not:
                        type: 'null'
                    unavailable:
                      type: integer
                      not:
                        type: 'null'
                  required: []
              required:
                - inventory_level
  /api/company/v1/variants:
    post:
      summary: Create variant
      tags:
        - Variants
      description: >-
        Create a new variant for a product with pricing, inventory, attribute
        data, and metafields
      operationId: createVariant
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: Variant created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  variant:
                    title: Variant
                    type: object
                    properties:
                      id:
                        type: integer
                      title:
                        example: Variant 1
                        type:
                          - string
                          - 'null'
                      image_url:
                        example: https://via.placeholder.com/150
                        type:
                          - string
                          - 'null'
                      image_path:
                        example: https://via.placeholder.com/150
                        type:
                          - string
                          - 'null'
                      sku:
                        example: SKU-123456
                        type:
                          - string
                          - 'null'
                      primary_image:
                        example: https://via.placeholder.com/150
                        type:
                          - string
                          - 'null'
                      price:
                        example: 100
                        type:
                          - number
                          - string
                          - 'null'
                      price_in_currency:
                        example: USD 100.00
                        type: string
                      options:
                        items:
                          type: object
                          properties:
                            title:
                              type: string
                              example: Size
                            value:
                              type: string
                              example: XL
                        type: array
                      physical:
                        type:
                          - boolean
                          - 'null'
                      unit_of_size:
                        example: cm
                        type:
                          - string
                          - 'null'
                      height:
                        example: '13'
                        type:
                          - number
                          - 'null'
                      width:
                        example: '6'
                        type:
                          - number
                          - 'null'
                      length:
                        example: '12'
                        type:
                          - number
                          - 'null'
                      unit_of_weight:
                        example: kg
                        type:
                          - string
                          - 'null'
                      weight:
                        example: '3.2'
                        type:
                          - string
                          - 'null'
                      hs_code:
                        example: '3.2'
                        type:
                          - string
                          - 'null'
                      product_id:
                        example: 1
                        type: integer
                      is_master:
                        type:
                          - boolean
                          - 'null'
                        default: false
                      track_quantity:
                        type:
                          - boolean
                          - 'null'
                        default: false
                      bar_code:
                        type:
                          - string
                          - 'null'
                      limit_subscription:
                        type:
                          - boolean
                          - 'null'
                        default: false
                      subscription_max_qty:
                        type:
                          - integer
                          - 'null'
                      customer_limit:
                        type:
                          - integer
                          - 'null'
                        default: 0
                        minimum: 0
                      keep_selling:
                        type:
                          - boolean
                          - 'null'
                        default: false
                      active:
                        default: true
                        type: boolean
                      allow_subscription:
                        default: true
                        type: boolean
                      subscription_only:
                        default: false
                        type: boolean
                      shipping_included_in_price:
                        default: false
                        type: boolean
                      inventory_quantity:
                        default: 0
                        type: integer
                      option_attrs:
                        type: array
                      buyable:
                        type: boolean
                      images:
                        type: array
                      inventory_levels:
                        type: array
                      limit_quantity_per_customer:
                        type: boolean
                      country_of_origin:
                        title: Country
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                          name:
                            example: United States
                            type: string
                          iso:
                            description: 2-letter country code (ISO 3166-1 alpha-2)
                            example: US
                            type: string
                        required:
                          - id
                          - name
                          - iso
                      variant_countries:
                        type: array
                        items:
                          title: VariantCountry
                          type: object
                          properties:
                            id:
                              type: integer
                            variant_id:
                              type: integer
                            active:
                              type:
                                - boolean
                                - 'null'
                              default: true
                            currency_code:
                              type:
                                - string
                                - 'null'
                            price:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                              minimum: 0
                              maximum: 99999999
                            shipping:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                            shipping_time:
                              type:
                                - string
                                - 'null'
                            subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                            wholesale:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                            wholesale_subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                            cost_of_goods_sold:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                            compare_price:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                            points:
                              type: integer
                              default: 0
                              minimum: 0
                            country_code:
                              type: string
                            display_price:
                              type: string
                            display_subscription_price:
                              type: string
                            display_wholesale:
                              type: string
                            display_wholesale_subscription_price:
                              type: string
                            cv:
                              type:
                                - integer
                                - 'null'
                              default: 0
                            qv:
                              type:
                                - integer
                                - 'null'
                              default: 0
                            pc_cv:
                              type:
                                - integer
                                - 'null'
                            pc_qv:
                              type:
                                - integer
                                - 'null'
                          required:
                            - id
                            - variant_id
                            - points
                            - country_code
                            - display_price
                            - display_subscription_price
                            - display_wholesale
                            - display_wholesale_subscription_price
                      metafields:
                        type: array
                        items:
                          title: LegacyMetafield
                          type: object
                          properties:
                            id:
                              type: integer
                            namespace:
                              description: >-
                                A container for related metafields. Commonly
                                used to group metafields by app or
                                functionality.
                              example: custom
                              type: string
                              maxLength: 20
                              pattern: ^[a-zA-Z0-9_]+$
                            key:
                              description: >-
                                The unique identifier for the metafield within
                                its namespace. Must be unique per namespace and
                                owner.
                              example: material
                              type: string
                              maxLength: 30
                              pattern: ^[a-zA-Z0-9_]+$
                            value:
                              description: >-
                                The actual data stored in the metafield. Type
                                depends on value_type.
                              example: cotton
                              type:
                                - string
                                - object
                            value_type:
                              description: >-
                                The data type that defines how the value should
                                be interpreted and validated.
                              example: single_line_text_field
                              type: string
                            description:
                              description: >-
                                Optional human-readable description explaining
                                the purpose of this metafield.
                              example: The primary material used in this product
                              type:
                                - string
                                - 'null'
                            owner_type:
                              description: >-
                                The type of resource that this metafield belongs
                                to (polymorphic association).
                              example: Product
                              type: string
                            owner_id:
                              description: >-
                                The ID of the specific resource that this
                                metafield belongs to.
                              example: 12345
                              type: integer
                            created_at:
                              description: Timestamp when the metafield was created.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            updated_at:
                              description: Timestamp when the metafield was last updated.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            metafield_definition:
                              title: MetafieldDefinition
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                company_id:
                                  description: >-
                                    The ID of the company that owns this
                                    metafield definition.
                                  example: 1
                                  type: integer
                                namespace:
                                  description: >-
                                    A container for related metafield
                                    definitions. Used to group definitions by
                                    app or functionality. Must be unique within
                                    company and owner_resource.
                                  example: product_details
                                  type: string
                                  maxLength: 20
                                  pattern: ^[a-zA-Z0-9_]+$
                                key:
                                  description: >-
                                    The unique identifier for the metafield
                                    definition within its namespace and
                                    owner_resource. Combined with namespace and
                                    owner_resource, this must be unique per
                                    company.
                                  example: material_type
                                  type: string
                                  maxLength: 30
                                  pattern: ^[a-zA-Z0-9_]+$
                                name:
                                  description: >-
                                    Human-readable display name for the
                                    metafield definition, shown in admin
                                    interfaces and forms.
                                  example: Material Type
                                  type: string
                                  maxLength: 100
                                description:
                                  description: >-
                                    Detailed explanation of what this metafield
                                    definition represents, how it should be
                                    used, and any special instructions for
                                    content creators.
                                  example: >-
                                    Specify the primary material composition of
                                    the product (e.g., cotton, polyester, silk).
                                    This will be displayed on the product detail
                                    page.
                                  type:
                                    - string
                                    - 'null'
                                value_type:
                                  description: >-
                                    The data type that defines how metafield
                                    values should be validated, stored, and
                                    displayed. Determines which validation rules
                                    are available.
                                  example: single_line_text_field
                                  type: string
                                validation_rules:
                                  description: >-
                                    JSON object containing validation
                                    constraints that will be applied to
                                    metafield values. Available rules depend on
                                    the value_type.
                                  example:
                                    choices:
                                      - cotton
                                      - polyester
                                      - silk
                                      - wool
                                      - linen
                                      - bamboo
                                    max: 50
                                    min: 2
                                  type:
                                    - object
                                    - 'null'
                                owner_resource:
                                  description: >-
                                    The type of resource (model class name) that
                                    metafields using this definition can be
                                    attached to. Must match the polymorphic
                                    owner_type.
                                  example: Product
                                  type: string
                                pinned:
                                  description: >-
                                    Whether this definition should be
                                    prominently displayed or prioritized in
                                    admin interfaces and forms.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                position:
                                  default: 0
                                  description: >-
                                    Sort order for displaying this definition
                                    relative to others in the same category and
                                    owner_resource. Lower numbers appear first.
                                  example: 1
                                  type:
                                    - integer
                                    - 'null'
                                locked:
                                  description: >-
                                    Whether this metafield definition is locked,
                                    preventing direct updates or deletions of
                                    metafields using this definition.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                created_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    created.
                                  example: '2024-01-15T10:30:00Z'
                                  type: string
                                  format: date-time
                                updated_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    last updated.
                                  example: '2024-02-20T14:45:00Z'
                                  type: string
                                  format: date-time
                                list_type:
                                  description: >-
                                    Whether this definition is for list-type
                                    metafields that store arrays of values.
                                  example: false
                                  type: boolean
                                reference_type:
                                  description: >-
                                    Whether this definition is for
                                    reference-type metafields that store
                                    references to other resources.
                                  example: false
                                  type: boolean
                                supported_validations:
                                  description: >-
                                    Array of validation rule names that are
                                    supported for this value_type.
                                  example:
                                    - min
                                    - max
                                    - choices
                                    - regex
                                  type: array
                                validation_description:
                                  description: >-
                                    Human-readable description of what the
                                    value_type represents and its constraints.
                                  example: Single line text up to 5000 characters
                                  type: string
                                category_ids:
                                  description: >-
                                    Array of category IDs that this metafield
                                    definition is associated with for
                                    organizational purposes.
                                  example:
                                    - 1
                                    - 2
                                    - 3
                                  items:
                                    type: integer
                                  type: array
                              required:
                                - id
                                - company_id
                                - namespace
                                - key
                                - name
                                - value_type
                                - owner_resource
                                - created_at
                                - updated_at
                                - list_type
                                - reference_type
                                - supported_validations
                                - validation_description
                                - category_ids
                          required:
                            - id
                            - namespace
                            - key
                            - value
                            - value_type
                            - owner_type
                            - owner_id
                            - created_at
                            - updated_at
                    required:
                      - id
                      - price_in_currency
                      - options
                      - product_id
                      - active
                      - allow_subscription
                      - subscription_only
                      - shipping_included_in_price
                      - inventory_quantity
                      - option_attrs
                      - buyable
                      - images
                      - inventory_levels
                      - limit_quantity_per_customer
                      - variant_countries
                      - metafields
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - variant
                  - meta
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                required:
                  - message
        '404':
          description: Product not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: Missing required parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                variant:
                  type: object
                  properties:
                    product_id:
                      type: integer
                      not:
                        type: 'null'
                    option_attrs:
                      type: array
                      items:
                        type: string
                    sku:
                      type: string
                    is_master:
                      type: boolean
                    title:
                      type: string
                    track_quantity:
                      type: boolean
                    bar_code:
                      type: string
                    limit_subscription:
                      type: boolean
                    subscription_max_qty:
                      type: integer
                    customer_limit:
                      type: integer
                    keep_selling:
                      type: boolean
                    active:
                      type: boolean
                    shipping_included_in_price:
                      type: boolean
                    subscription_only:
                      type: boolean
                    physical:
                      type: boolean
                    country_of_origin_id:
                      type: integer
                    unit_of_size:
                      type: string
                    height:
                      type: number
                    width:
                      type: number
                    length:
                      type: number
                    unit_of_weight:
                      type: string
                    weight:
                      type: string
                    hs_code:
                      type: string
                    images_attributes:
                      type: array
                      items:
                        type: object
                        properties:
                          position:
                            type: integer
                          image_url:
                            type: string
                        required:
                          - position
                          - image_url
                    inventory_levels_attributes:
                      type: array
                      items:
                        type: object
                        properties:
                          warehouse_id:
                            type: integer
                            not:
                              type: 'null'
                          available:
                            type: integer
                            not:
                              type: 'null'
                          committed:
                            type: integer
                            not:
                              type: 'null'
                          on_hand:
                            type: integer
                            not:
                              type: 'null'
                          unavailable:
                            type: integer
                            not:
                              type: 'null'
                        required: []
                    variant_countries_attributes:
                      type: array
                      items:
                        type: object
                        properties:
                          active:
                            type: boolean
                          country_id:
                            type: integer
                          price:
                            type: number
                          subscription_price:
                            type: number
                          wholesale:
                            type: number
                          wholesale_subscription_price:
                            type: number
                          compare_price:
                            type: number
                          cv:
                            type: integer
                          qv:
                            type: integer
                          pc_cv:
                            type: integer
                          pc_qv:
                            type: integer
                          points:
                            type: integer
                          cost_of_goods_sold:
                            type: number
                          shipping:
                            type: number
                          tax:
                            type: number
                        required:
                          - active
                          - country_id
                          - price
                    metafields_attributes:
                      type: array
                      items:
                        type: object
                        properties:
                          namespace:
                            type: string
                          key:
                            type: string
                          value:
                            not:
                              type: 'null'
                          value_type:
                            type: string
                        required:
                          - namespace
                          - key
                          - value
                          - value_type
                  required:
                    - product_id
                    - variant_countries_attributes
              required:
                - variant
        description: >-
          Variant parameters for creating a new variant with pricing, inventory,
          attribute data, and metafields
  /api/company/v1/variants/{id}:
    get:
      summary: Show variant
      tags:
        - Variants
      description: Retrieve a specific variant by ID
      operationId: showVariant
      security:
        - bearer_auth: []
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  variant:
                    title: Variant
                    type: object
                    properties:
                      id:
                        type: integer
                      title:
                        example: Variant 1
                        type:
                          - string
                          - 'null'
                      image_url:
                        example: https://via.placeholder.com/150
                        type:
                          - string
                          - 'null'
                      image_path:
                        example: https://via.placeholder.com/150
                        type:
                          - string
                          - 'null'
                      sku:
                        example: SKU-123456
                        type:
                          - string
                          - 'null'
                      primary_image:
                        example: https://via.placeholder.com/150
                        type:
                          - string
                          - 'null'
                      price:
                        example: 100
                        type:
                          - number
                          - string
                          - 'null'
                      price_in_currency:
                        example: USD 100.00
                        type: string
                      options:
                        items:
                          type: object
                          properties:
                            title:
                              type: string
                              example: Size
                            value:
                              type: string
                              example: XL
                        type: array
                      physical:
                        type:
                          - boolean
                          - 'null'
                      unit_of_size:
                        example: cm
                        type:
                          - string
                          - 'null'
                      height:
                        example: '13'
                        type:
                          - number
                          - 'null'
                      width:
                        example: '6'
                        type:
                          - number
                          - 'null'
                      length:
                        example: '12'
                        type:
                          - number
                          - 'null'
                      unit_of_weight:
                        example: kg
                        type:
                          - string
                          - 'null'
                      weight:
                        example: '3.2'
                        type:
                          - string
                          - 'null'
                      hs_code:
                        example: '3.2'
                        type:
                          - string
                          - 'null'
                      product_id:
                        example: 1
                        type: integer
                      is_master:
                        type:
                          - boolean
                          - 'null'
                        default: false
                      track_quantity:
                        type:
                          - boolean
                          - 'null'
                        default: false
                      bar_code:
                        type:
                          - string
                          - 'null'
                      limit_subscription:
                        type:
                          - boolean
                          - 'null'
                        default: false
                      subscription_max_qty:
                        type:
                          - integer
                          - 'null'
                      customer_limit:
                        type:
                          - integer
                          - 'null'
                        default: 0
                        minimum: 0
                      keep_selling:
                        type:
                          - boolean
                          - 'null'
                        default: false
                      active:
                        default: true
                        type: boolean
                      allow_subscription:
                        default: true
                        type: boolean
                      subscription_only:
                        default: false
                        type: boolean
                      shipping_included_in_price:
                        default: false
                        type: boolean
                      inventory_quantity:
                        default: 0
                        type: integer
                      option_attrs:
                        type: array
                      buyable:
                        type: boolean
                      images:
                        type: array
                      inventory_levels:
                        type: array
                      limit_quantity_per_customer:
                        type: boolean
                      country_of_origin:
                        title: Country
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                          name:
                            example: United States
                            type: string
                          iso:
                            description: 2-letter country code (ISO 3166-1 alpha-2)
                            example: US
                            type: string
                        required:
                          - id
                          - name
                          - iso
                      variant_countries:
                        type: array
                        items:
                          title: VariantCountry
                          type: object
                          properties:
                            id:
                              type: integer
                            variant_id:
                              type: integer
                            active:
                              type:
                                - boolean
                                - 'null'
                              default: true
                            currency_code:
                              type:
                                - string
                                - 'null'
                            price:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                              minimum: 0
                              maximum: 99999999
                            shipping:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                            shipping_time:
                              type:
                                - string
                                - 'null'
                            subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                            wholesale:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                            wholesale_subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                            cost_of_goods_sold:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                            compare_price:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                            points:
                              type: integer
                              default: 0
                              minimum: 0
                            country_code:
                              type: string
                            display_price:
                              type: string
                            display_subscription_price:
                              type: string
                            display_wholesale:
                              type: string
                            display_wholesale_subscription_price:
                              type: string
                            cv:
                              type:
                                - integer
                                - 'null'
                              default: 0
                            qv:
                              type:
                                - integer
                                - 'null'
                              default: 0
                            pc_cv:
                              type:
                                - integer
                                - 'null'
                            pc_qv:
                              type:
                                - integer
                                - 'null'
                          required:
                            - id
                            - variant_id
                            - points
                            - country_code
                            - display_price
                            - display_subscription_price
                            - display_wholesale
                            - display_wholesale_subscription_price
                      metafields:
                        type: array
                        items:
                          title: LegacyMetafield
                          type: object
                          properties:
                            id:
                              type: integer
                            namespace:
                              description: >-
                                A container for related metafields. Commonly
                                used to group metafields by app or
                                functionality.
                              example: custom
                              type: string
                              maxLength: 20
                              pattern: ^[a-zA-Z0-9_]+$
                            key:
                              description: >-
                                The unique identifier for the metafield within
                                its namespace. Must be unique per namespace and
                                owner.
                              example: material
                              type: string
                              maxLength: 30
                              pattern: ^[a-zA-Z0-9_]+$
                            value:
                              description: >-
                                The actual data stored in the metafield. Type
                                depends on value_type.
                              example: cotton
                              type:
                                - string
                                - object
                            value_type:
                              description: >-
                                The data type that defines how the value should
                                be interpreted and validated.
                              example: single_line_text_field
                              type: string
                            description:
                              description: >-
                                Optional human-readable description explaining
                                the purpose of this metafield.
                              example: The primary material used in this product
                              type:
                                - string
                                - 'null'
                            owner_type:
                              description: >-
                                The type of resource that this metafield belongs
                                to (polymorphic association).
                              example: Product
                              type: string
                            owner_id:
                              description: >-
                                The ID of the specific resource that this
                                metafield belongs to.
                              example: 12345
                              type: integer
                            created_at:
                              description: Timestamp when the metafield was created.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            updated_at:
                              description: Timestamp when the metafield was last updated.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            metafield_definition:
                              title: MetafieldDefinition
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                company_id:
                                  description: >-
                                    The ID of the company that owns this
                                    metafield definition.
                                  example: 1
                                  type: integer
                                namespace:
                                  description: >-
                                    A container for related metafield
                                    definitions. Used to group definitions by
                                    app or functionality. Must be unique within
                                    company and owner_resource.
                                  example: product_details
                                  type: string
                                  maxLength: 20
                                  pattern: ^[a-zA-Z0-9_]+$
                                key:
                                  description: >-
                                    The unique identifier for the metafield
                                    definition within its namespace and
                                    owner_resource. Combined with namespace and
                                    owner_resource, this must be unique per
                                    company.
                                  example: material_type
                                  type: string
                                  maxLength: 30
                                  pattern: ^[a-zA-Z0-9_]+$
                                name:
                                  description: >-
                                    Human-readable display name for the
                                    metafield definition, shown in admin
                                    interfaces and forms.
                                  example: Material Type
                                  type: string
                                  maxLength: 100
                                description:
                                  description: >-
                                    Detailed explanation of what this metafield
                                    definition represents, how it should be
                                    used, and any special instructions for
                                    content creators.
                                  example: >-
                                    Specify the primary material composition of
                                    the product (e.g., cotton, polyester, silk).
                                    This will be displayed on the product detail
                                    page.
                                  type:
                                    - string
                                    - 'null'
                                value_type:
                                  description: >-
                                    The data type that defines how metafield
                                    values should be validated, stored, and
                                    displayed. Determines which validation rules
                                    are available.
                                  example: single_line_text_field
                                  type: string
                                validation_rules:
                                  description: >-
                                    JSON object containing validation
                                    constraints that will be applied to
                                    metafield values. Available rules depend on
                                    the value_type.
                                  example:
                                    choices:
                                      - cotton
                                      - polyester
                                      - silk
                                      - wool
                                      - linen
                                      - bamboo
                                    max: 50
                                    min: 2
                                  type:
                                    - object
                                    - 'null'
                                owner_resource:
                                  description: >-
                                    The type of resource (model class name) that
                                    metafields using this definition can be
                                    attached to. Must match the polymorphic
                                    owner_type.
                                  example: Product
                                  type: string
                                pinned:
                                  description: >-
                                    Whether this definition should be
                                    prominently displayed or prioritized in
                                    admin interfaces and forms.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                position:
                                  default: 0
                                  description: >-
                                    Sort order for displaying this definition
                                    relative to others in the same category and
                                    owner_resource. Lower numbers appear first.
                                  example: 1
                                  type:
                                    - integer
                                    - 'null'
                                locked:
                                  description: >-
                                    Whether this metafield definition is locked,
                                    preventing direct updates or deletions of
                                    metafields using this definition.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                created_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    created.
                                  example: '2024-01-15T10:30:00Z'
                                  type: string
                                  format: date-time
                                updated_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    last updated.
                                  example: '2024-02-20T14:45:00Z'
                                  type: string
                                  format: date-time
                                list_type:
                                  description: >-
                                    Whether this definition is for list-type
                                    metafields that store arrays of values.
                                  example: false
                                  type: boolean
                                reference_type:
                                  description: >-
                                    Whether this definition is for
                                    reference-type metafields that store
                                    references to other resources.
                                  example: false
                                  type: boolean
                                supported_validations:
                                  description: >-
                                    Array of validation rule names that are
                                    supported for this value_type.
                                  example:
                                    - min
                                    - max
                                    - choices
                                    - regex
                                  type: array
                                validation_description:
                                  description: >-
                                    Human-readable description of what the
                                    value_type represents and its constraints.
                                  example: Single line text up to 5000 characters
                                  type: string
                                category_ids:
                                  description: >-
                                    Array of category IDs that this metafield
                                    definition is associated with for
                                    organizational purposes.
                                  example:
                                    - 1
                                    - 2
                                    - 3
                                  items:
                                    type: integer
                                  type: array
                              required:
                                - id
                                - company_id
                                - namespace
                                - key
                                - name
                                - value_type
                                - owner_resource
                                - created_at
                                - updated_at
                                - list_type
                                - reference_type
                                - supported_validations
                                - validation_description
                                - category_ids
                          required:
                            - id
                            - namespace
                            - key
                            - value
                            - value_type
                            - owner_type
                            - owner_id
                            - created_at
                            - updated_at
                    required:
                      - id
                      - price_in_currency
                      - options
                      - product_id
                      - active
                      - allow_subscription
                      - subscription_only
                      - shipping_included_in_price
                      - inventory_quantity
                      - option_attrs
                      - buyable
                      - images
                      - inventory_levels
                      - limit_quantity_per_customer
                      - variant_countries
                      - metafields
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - variant
                  - meta
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                required:
                  - message
        '404':
          description: Variant not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
    put:
      summary: Update variant
      tags:
        - Variants
      description: >-
        Update a specific variant with pricing, inventory, attribute data, and
        metafields
      operationId: updateVariant
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: Variant updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  variant:
                    title: Variant
                    type: object
                    properties:
                      id:
                        type: integer
                      title:
                        example: Variant 1
                        type:
                          - string
                          - 'null'
                      image_url:
                        example: https://via.placeholder.com/150
                        type:
                          - string
                          - 'null'
                      image_path:
                        example: https://via.placeholder.com/150
                        type:
                          - string
                          - 'null'
                      sku:
                        example: SKU-123456
                        type:
                          - string
                          - 'null'
                      primary_image:
                        example: https://via.placeholder.com/150
                        type:
                          - string
                          - 'null'
                      price:
                        example: 100
                        type:
                          - number
                          - string
                          - 'null'
                      price_in_currency:
                        example: USD 100.00
                        type: string
                      options:
                        items:
                          type: object
                          properties:
                            title:
                              type: string
                              example: Size
                            value:
                              type: string
                              example: XL
                        type: array
                      physical:
                        type:
                          - boolean
                          - 'null'
                      unit_of_size:
                        example: cm
                        type:
                          - string
                          - 'null'
                      height:
                        example: '13'
                        type:
                          - number
                          - 'null'
                      width:
                        example: '6'
                        type:
                          - number
                          - 'null'
                      length:
                        example: '12'
                        type:
                          - number
                          - 'null'
                      unit_of_weight:
                        example: kg
                        type:
                          - string
                          - 'null'
                      weight:
                        example: '3.2'
                        type:
                          - string
                          - 'null'
                      hs_code:
                        example: '3.2'
                        type:
                          - string
                          - 'null'
                      product_id:
                        example: 1
                        type: integer
                      is_master:
                        type:
                          - boolean
                          - 'null'
                        default: false
                      track_quantity:
                        type:
                          - boolean
                          - 'null'
                        default: false
                      bar_code:
                        type:
                          - string
                          - 'null'
                      limit_subscription:
                        type:
                          - boolean
                          - 'null'
                        default: false
                      subscription_max_qty:
                        type:
                          - integer
                          - 'null'
                      customer_limit:
                        type:
                          - integer
                          - 'null'
                        default: 0
                        minimum: 0
                      keep_selling:
                        type:
                          - boolean
                          - 'null'
                        default: false
                      active:
                        default: true
                        type: boolean
                      allow_subscription:
                        default: true
                        type: boolean
                      subscription_only:
                        default: false
                        type: boolean
                      shipping_included_in_price:
                        default: false
                        type: boolean
                      inventory_quantity:
                        default: 0
                        type: integer
                      option_attrs:
                        type: array
                      buyable:
                        type: boolean
                      images:
                        type: array
                      inventory_levels:
                        type: array
                      limit_quantity_per_customer:
                        type: boolean
                      country_of_origin:
                        title: Country
                        type:
                          - object
                          - 'null'
                        properties:
                          id:
                            type: integer
                          name:
                            example: United States
                            type: string
                          iso:
                            description: 2-letter country code (ISO 3166-1 alpha-2)
                            example: US
                            type: string
                        required:
                          - id
                          - name
                          - iso
                      variant_countries:
                        type: array
                        items:
                          title: VariantCountry
                          type: object
                          properties:
                            id:
                              type: integer
                            variant_id:
                              type: integer
                            active:
                              type:
                                - boolean
                                - 'null'
                              default: true
                            currency_code:
                              type:
                                - string
                                - 'null'
                            price:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                              minimum: 0
                              maximum: 99999999
                            shipping:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                            shipping_time:
                              type:
                                - string
                                - 'null'
                            subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                            wholesale:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                            wholesale_subscription_price:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                            cost_of_goods_sold:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                            compare_price:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                            points:
                              type: integer
                              default: 0
                              minimum: 0
                            country_code:
                              type: string
                            display_price:
                              type: string
                            display_subscription_price:
                              type: string
                            display_wholesale:
                              type: string
                            display_wholesale_subscription_price:
                              type: string
                            cv:
                              type:
                                - integer
                                - 'null'
                              default: 0
                            qv:
                              type:
                                - integer
                                - 'null'
                              default: 0
                            pc_cv:
                              type:
                                - integer
                                - 'null'
                            pc_qv:
                              type:
                                - integer
                                - 'null'
                          required:
                            - id
                            - variant_id
                            - points
                            - country_code
                            - display_price
                            - display_subscription_price
                            - display_wholesale
                            - display_wholesale_subscription_price
                      metafields:
                        type: array
                        items:
                          title: LegacyMetafield
                          type: object
                          properties:
                            id:
                              type: integer
                            namespace:
                              description: >-
                                A container for related metafields. Commonly
                                used to group metafields by app or
                                functionality.
                              example: custom
                              type: string
                              maxLength: 20
                              pattern: ^[a-zA-Z0-9_]+$
                            key:
                              description: >-
                                The unique identifier for the metafield within
                                its namespace. Must be unique per namespace and
                                owner.
                              example: material
                              type: string
                              maxLength: 30
                              pattern: ^[a-zA-Z0-9_]+$
                            value:
                              description: >-
                                The actual data stored in the metafield. Type
                                depends on value_type.
                              example: cotton
                              type:
                                - string
                                - object
                            value_type:
                              description: >-
                                The data type that defines how the value should
                                be interpreted and validated.
                              example: single_line_text_field
                              type: string
                            description:
                              description: >-
                                Optional human-readable description explaining
                                the purpose of this metafield.
                              example: The primary material used in this product
                              type:
                                - string
                                - 'null'
                            owner_type:
                              description: >-
                                The type of resource that this metafield belongs
                                to (polymorphic association).
                              example: Product
                              type: string
                            owner_id:
                              description: >-
                                The ID of the specific resource that this
                                metafield belongs to.
                              example: 12345
                              type: integer
                            created_at:
                              description: Timestamp when the metafield was created.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            updated_at:
                              description: Timestamp when the metafield was last updated.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            metafield_definition:
                              title: MetafieldDefinition
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                company_id:
                                  description: >-
                                    The ID of the company that owns this
                                    metafield definition.
                                  example: 1
                                  type: integer
                                namespace:
                                  description: >-
                                    A container for related metafield
                                    definitions. Used to group definitions by
                                    app or functionality. Must be unique within
                                    company and owner_resource.
                                  example: product_details
                                  type: string
                                  maxLength: 20
                                  pattern: ^[a-zA-Z0-9_]+$
                                key:
                                  description: >-
                                    The unique identifier for the metafield
                                    definition within its namespace and
                                    owner_resource. Combined with namespace and
                                    owner_resource, this must be unique per
                                    company.
                                  example: material_type
                                  type: string
                                  maxLength: 30
                                  pattern: ^[a-zA-Z0-9_]+$
                                name:
                                  description: >-
                                    Human-readable display name for the
                                    metafield definition, shown in admin
                                    interfaces and forms.
                                  example: Material Type
                                  type: string
                                  maxLength: 100
                                description:
                                  description: >-
                                    Detailed explanation of what this metafield
                                    definition represents, how it should be
                                    used, and any special instructions for
                                    content creators.
                                  example: >-
                                    Specify the primary material composition of
                                    the product (e.g., cotton, polyester, silk).
                                    This will be displayed on the product detail
                                    page.
                                  type:
                                    - string
                                    - 'null'
                                value_type:
                                  description: >-
                                    The data type that defines how metafield
                                    values should be validated, stored, and
                                    displayed. Determines which validation rules
                                    are available.
                                  example: single_line_text_field
                                  type: string
                                validation_rules:
                                  description: >-
                                    JSON object containing validation
                                    constraints that will be applied to
                                    metafield values. Available rules depend on
                                    the value_type.
                                  example:
                                    choices:
                                      - cotton
                                      - polyester
                                      - silk
                                      - wool
                                      - linen
                                      - bamboo
                                    max: 50
                                    min: 2
                                  type:
                                    - object
                                    - 'null'
                                owner_resource:
                                  description: >-
                                    The type of resource (model class name) that
                                    metafields using this definition can be
                                    attached to. Must match the polymorphic
                                    owner_type.
                                  example: Product
                                  type: string
                                pinned:
                                  description: >-
                                    Whether this definition should be
                                    prominently displayed or prioritized in
                                    admin interfaces and forms.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                position:
                                  default: 0
                                  description: >-
                                    Sort order for displaying this definition
                                    relative to others in the same category and
                                    owner_resource. Lower numbers appear first.
                                  example: 1
                                  type:
                                    - integer
                                    - 'null'
                                locked:
                                  description: >-
                                    Whether this metafield definition is locked,
                                    preventing direct updates or deletions of
                                    metafields using this definition.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                created_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    created.
                                  example: '2024-01-15T10:30:00Z'
                                  type: string
                                  format: date-time
                                updated_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    last updated.
                                  example: '2024-02-20T14:45:00Z'
                                  type: string
                                  format: date-time
                                list_type:
                                  description: >-
                                    Whether this definition is for list-type
                                    metafields that store arrays of values.
                                  example: false
                                  type: boolean
                                reference_type:
                                  description: >-
                                    Whether this definition is for
                                    reference-type metafields that store
                                    references to other resources.
                                  example: false
                                  type: boolean
                                supported_validations:
                                  description: >-
                                    Array of validation rule names that are
                                    supported for this value_type.
                                  example:
                                    - min
                                    - max
                                    - choices
                                    - regex
                                  type: array
                                validation_description:
                                  description: >-
                                    Human-readable description of what the
                                    value_type represents and its constraints.
                                  example: Single line text up to 5000 characters
                                  type: string
                                category_ids:
                                  description: >-
                                    Array of category IDs that this metafield
                                    definition is associated with for
                                    organizational purposes.
                                  example:
                                    - 1
                                    - 2
                                    - 3
                                  items:
                                    type: integer
                                  type: array
                              required:
                                - id
                                - company_id
                                - namespace
                                - key
                                - name
                                - value_type
                                - owner_resource
                                - created_at
                                - updated_at
                                - list_type
                                - reference_type
                                - supported_validations
                                - validation_description
                                - category_ids
                          required:
                            - id
                            - namespace
                            - key
                            - value
                            - value_type
                            - owner_type
                            - owner_id
                            - created_at
                            - updated_at
                    required:
                      - id
                      - price_in_currency
                      - options
                      - product_id
                      - active
                      - allow_subscription
                      - subscription_only
                      - shipping_included_in_price
                      - inventory_quantity
                      - option_attrs
                      - buyable
                      - images
                      - inventory_levels
                      - limit_quantity_per_customer
                      - variant_countries
                      - metafields
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - variant
                  - meta
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                required:
                  - message
        '404':
          description: Variant not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: Missing required parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                variant:
                  type: object
                  properties:
                    option_attrs:
                      type: array
                      items:
                        type: string
                      description: Variant option attributes
                    sku:
                      type: string
                      description: Stock keeping unit
                    is_master:
                      type: boolean
                      description: Whether this is the master variant
                    title:
                      type: string
                      description: Variant title
                    track_quantity:
                      type: boolean
                      description: Whether to track inventory quantity
                    bar_code:
                      type: string
                      description: Product barcode
                    limit_subscription:
                      type: boolean
                      description: Whether to limit subscription purchases
                    subscription_max_qty:
                      type: integer
                      description: Maximum subscription quantity
                    customer_limit:
                      type: integer
                      description: Customer purchase limit
                    keep_selling:
                      type: boolean
                      description: Continue selling when out of stock
                    active:
                      type: boolean
                      description: Whether variant is active
                    allow_subscription:
                      type: boolean
                      description: Whether subscription is allowed
                    shipping_included_in_price:
                      type: boolean
                      description: Whether shipping is included in price
                    subscription_only:
                      type: boolean
                      description: Whether variant is subscription only
                    physical:
                      type: boolean
                      description: Whether the variant is a physical product
                    country_of_origin_id:
                      type: integer
                      description: ID of the country where the product originates
                    unit_of_size:
                      type: string
                      description: Unit of measurement for dimensions (e.g., cm, in)
                    height:
                      type: number
                      format: float
                      description: Product height
                    width:
                      type: number
                      format: float
                      description: Product width
                    length:
                      type: number
                      format: float
                      description: Product length
                    unit_of_weight:
                      type: string
                      description: Unit of measurement for weight (e.g., lb, kg)
                    weight:
                      type: string
                      description: Product weight
                    hs_code:
                      type: string
                      description: Harmonized System code for international trade
                    images_attributes:
                      type: array
                      description: Image attachments for the variant
                      items:
                        type: object
                        properties:
                          id:
                            type: integer
                            description: Image ID (for updates)
                          position:
                            type: integer
                            description: Image position/order
                          image_url:
                            type: string
                            description: Image URL
                          _destroy:
                            type: boolean
                            description: Mark for deletion
                        required:
                          - position
                          - image_url
                    inventory_levels_attributes:
                      type: array
                      description: Inventory levels for different warehouses
                      items:
                        type: object
                        properties:
                          id:
                            type: integer
                            description: Inventory level ID (for updates)
                          warehouse_id:
                            type: integer
                            description: Warehouse ID
                          available:
                            type: integer
                            description: Available quantity
                          committed:
                            type: integer
                            description: Committed quantity
                          on_hand:
                            type: integer
                            description: On hand quantity
                          unavailable:
                            type: integer
                            description: Unavailable quantity
                          _destroy:
                            type: boolean
                            description: Mark for deletion
                        required:
                          - warehouse_id
                    variant_countries_attributes:
                      type: array
                      description: Country-specific pricing and settings
                      items:
                        type: object
                        properties:
                          id:
                            type: integer
                            description: Variant country ID (for updates)
                          active:
                            type: boolean
                            description: Whether variant is active in country
                          country_id:
                            type: integer
                            description: Country ID
                          price:
                            type: number
                            format: decimal
                            description: Base price
                          wholesale:
                            type: number
                            format: decimal
                            description: Wholesale price
                          compare_price:
                            type: number
                            format: decimal
                            description: Compare at price
                          cv:
                            type: integer
                            description: Commission value
                          qv:
                            type: integer
                            description: Qualification value
                          pc_cv:
                            type: integer
                            description: Personal customer CV
                          pc_qv:
                            type: integer
                            description: Personal customer QV
                          points:
                            type: integer
                            description: Points associated with the variant
                          cost_of_goods_sold:
                            type: number
                            format: decimal
                            description: Cost of goods sold
                          shipping:
                            type: number
                            format: decimal
                            description: Shipping cost
                          tax:
                            type: number
                            format: decimal
                            description: Tax amount
                          _destroy:
                            type: boolean
                            description: Mark for deletion
                        required:
                          - active
                          - country_id
                          - price
                    metafields_attributes:
                      type: array
                      description: Metafields for custom data storage
                      items:
                        type: object
                        properties:
                          id:
                            type: integer
                            description: Metafield ID (for updates)
                          namespace:
                            type: string
                            description: Namespace for the metafield
                          key:
                            type: string
                            description: Key for the metafield
                          value:
                            description: >-
                              Value for the metafield (type depends on
                              value_type)
                          value_type:
                            type: string
                            description: Type of the metafield value
                            enum:
                              - single_line_text_field
                              - multi_line_text_field
                              - rich_text_field
                              - number_integer
                              - number_decimal
                              - date
                              - date_time
                              - boolean
                              - json
                              - color
                              - url
                              - weight
                              - volume
                              - dimension
                              - rating
                              - money
                              - file_reference
                              - page_reference
                              - product_reference
                              - variant_reference
                              - collection_reference
                              - mixed_reference
                              - list.single_line_text_field
                              - list.number_integer
                              - list.number_decimal
                              - list.date
                              - list.date_time
                              - list.color
                              - list.url
                              - list.file_reference
                              - list.page_reference
                              - list.product_reference
                              - list.variant_reference
                              - list.collection_reference
                              - list.mixed_reference
                          _destroy:
                            type: boolean
                            description: Mark for deletion
                  required:
                    - variant_countries_attributes
              required:
                - variant
    parameters:
      - name: id
        in: path
        description: Variant ID
        required: true
        schema:
          type: integer
  /api/company/v1/variants/bulk_update:
    put:
      summary: Update Variants
      tags:
        - Variants
      description: Bulk update variants by ID
      operationId: bulkUpdateVariant
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  variants:
                    type: array
                    items:
                      title: Variant
                      type: object
                      properties:
                        id:
                          type: integer
                        title:
                          example: Variant 1
                          type:
                            - string
                            - 'null'
                        image_url:
                          example: https://via.placeholder.com/150
                          type:
                            - string
                            - 'null'
                        image_path:
                          example: https://via.placeholder.com/150
                          type:
                            - string
                            - 'null'
                        sku:
                          example: SKU-123456
                          type:
                            - string
                            - 'null'
                        primary_image:
                          example: https://via.placeholder.com/150
                          type:
                            - string
                            - 'null'
                        price:
                          example: 100
                          type:
                            - number
                            - string
                            - 'null'
                        price_in_currency:
                          example: USD 100.00
                          type: string
                        options:
                          items:
                            type: object
                            properties:
                              title:
                                type: string
                                example: Size
                              value:
                                type: string
                                example: XL
                          type: array
                      required:
                        - id
                        - price_in_currency
                        - options
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - variants
                  - meta
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                required:
                  - message
        '404':
          description: Variant not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: Invalid parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                ids:
                  type: array
                  items:
                    type: integer
                  description: Array of variant IDs
                variant:
                  type: object
                  properties:
                    track_quantity:
                      type: boolean
                    keep_selling:
                      type: boolean
              required:
                - ids
                - variant
  /api/company/products/{product_id}/variants/{id}:
    get:
      tags:
        - Variants
      summary: Get Product Variant Details
      description: Retrieves the variant for product with given id.
      operationId: getProductVariant
      parameters:
        - name: product_id
          in: path
          required: true
          schema:
            type: integer
          description: ID of the product
        - name: id
          in: path
          required: true
          schema:
            type: integer
          description: ID of the product variant
      responses:
        '200':
          description: ''
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
      deprecated: false
      security:
        - bearer: []
    put:
      tags:
        - Variants
      summary: Update Product Variant
      description: Updates a specific variant for a given product ID.
      operationId: updateProductVariant
      parameters:
        - name: product_id
          in: path
          required: true
          schema:
            type: integer
          description: ID of the product to update
        - name: id
          in: path
          required: true
          schema:
            type: integer
          description: ID of the variant to update
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/updaterequest13'
                - example:
                    variant:
                      sku: NSXM00000
                      inventory_quantity: 800
                      images_attributes:
                        - image_url: >-
                            https://m.media-amazon.com/images/M/MV5BMjExMTg5OTU0NF5BMl5BanBnXkFtZTcwMjMxMzMzMw@@._V1_.jpg
                      weight: 25
                      weight1: 35
                      weight2: 45
                      unit_of_weight1: kg
                      unit_of_weight2: lb
                      height: 4
                      width: 8
                      length: 5
                      unit_of_size: in
                      customs_information_shipping: true
                      country_of_origin: np
                      physical: true
                      unit_of_weight: kg
                      hs_code: '978978'
                      track_quantity: true
                      keep_selling: true
                      active: true
                      allow_subscription: true
                      bar_code: 788o798
                      variant_countries_attributes:
                        - country_id: 214
                          active: true
                          cv: 4
                          qv: 6
                          shipping: 10
                          tax: 12
                          price: 2000
                          subscription_price: 950
                          wholesale: 920
                          wholesale_subscription_price: 900
                          compare_price: 940
                          cost_of_goods_sold: 50
                        - country_id: 92
                          active: true
                          cv: 4
                          qv: 6
                          shipping: 10
                          tax: 12
                          price: 2000
                          subscription_price: 950
                          wholesale: 920
                          wholesale_subscription_price: 900
                          compare_price: 940
                          cost_of_goods_sold: 50
            example:
              variant:
                sku: NSXM00000
                inventory_quantity: 800
                images_attributes:
                  - image_url: >-
                      https://m.media-amazon.com/images/M/MV5BMjExMTg5OTU0NF5BMl5BanBnXkFtZTcwMjMxMzMzMw@@._V1_.jpg
                weight: 25
                weight1: 35
                weight2: 45
                unit_of_weight1: kg
                unit_of_weight2: lb
                height: 4
                width: 8
                length: 5
                unit_of_size: in
                customs_information_shipping: true
                country_of_origin: np
                physical: true
                unit_of_weight: kg
                hs_code: '978978'
                track_quantity: true
                keep_selling: true
                active: true
                allow_subscription: true
                bar_code: 788o798
                variant_countries_attributes:
                  - country_id: 214
                    active: true
                    cv: 4
                    qv: 6
                    shipping: 10
                    tax: 12
                    price: 2000
                    subscription_price: 950
                    wholesale: 920
                    wholesale_subscription_price: 900
                    compare_price: 940
                    cost_of_goods_sold: 50
                  - country_id: 92
                    active: true
                    cv: 4
                    qv: 6
                    shipping: 10
                    tax: 12
                    price: 2000
                    subscription_price: 950
                    wholesale: 920
                    wholesale_subscription_price: 900
                    compare_price: 940
                    cost_of_goods_sold: 50
        required: true
      responses:
        '200':
          description: ''
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
      deprecated: false
      security:
        - bearer: []
    delete:
      tags:
        - Variants
      summary: Delete Product Variant
      description: Deletes a specific variant of a product
      operationId: deleteProductVariant
      parameters:
        - name: product_id
          in: path
          required: true
          schema:
            type: integer
          description: ID of the product
        - name: id
          in: path
          required: true
          schema:
            type: integer
          description: ID of the variant to delete
      responses:
        '200':
          description: ''
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
      deprecated: false
      security:
        - bearer: []
  /api/company/products/{product_id}/variants:
    get:
      tags:
        - Variants
      summary: Get Product Variants
      description: Retrieves the variants for a specific product.
      operationId: getProductVariants
      parameters:
        - name: product_id
          in: path
          required: true
          schema:
            type: integer
          description: The ID of the product to retrieve variants for
      responses:
        '200':
          description: ''
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
      deprecated: false
      security:
        - bearer: []
    post:
      tags:
        - Variants
      summary: Create Product Variant
      description: >-
        Creates a new variant for a specific product identified by the product
        ID.
      operationId: createProductVariant
      parameters:
        - name: product_id
          in: path
          required: true
          schema:
            type: integer
          description: The unique identifier of the product for which to create a variant
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
                - $ref: '#/components/schemas/createrequest14'
                - example:
                    variant:
                      sku: NSXM10000
                      inventory_quantity: 8000
                      images_attributes:
                        - image_url: https://hello.com/noice.jpg
                      weight: 25
                      weight1: 35
                      weight2: 45
                      unit_of_weight1: kg
                      unit_of_weight2: lb
                      height: 4
                      width: 8
                      length: 5
                      unit_of_size: in
                      customs_information_shipping: true
                      country_of_origin: np
                      physical: true
                      unit_of_weight: kg
                      hs_code: '978978'
                      track_quantity: true
                      keep_selling: true
                      active: true
                      allow_subscription: true
                      bar_code: 788o798
                      options:
                        - name: Color
                          value: Yellow
                        - name: Size
                          value: Large
                      variant_countries_attributes:
                        - country_id: 214
                          active: true
                          cv: 4
                          qv: 6
                          shipping: 10
                          tax: 12
                          price: 1000
                          subscription_price: 950
                          wholesale: 920
                          wholesale_subscription_price: 900
                          compare_price: 940
                          cost_of_goods_sold: 50
            example:
              variant:
                sku: NSXM10000
                inventory_quantity: 8000
                images_attributes:
                  - image_url: https://hello.com/noice.jpg
                weight: 25
                weight1: 35
                weight2: 45
                unit_of_weight1: kg
                unit_of_weight2: lb
                height: 4
                width: 8
                length: 5
                unit_of_size: in
                customs_information_shipping: true
                country_of_origin: np
                physical: true
                unit_of_weight: kg
                hs_code: '978978'
                track_quantity: true
                keep_selling: true
                active: true
                allow_subscription: true
                bar_code: 788o798
                options:
                  - name: Color
                    value: Yellow
                  - name: Size
                    value: Large
                variant_countries_attributes:
                  - country_id: 214
                    active: true
                    cv: 4
                    qv: 6
                    shipping: 10
                    tax: 12
                    price: 1000
                    subscription_price: 950
                    wholesale: 920
                    wholesale_subscription_price: 900
                    compare_price: 940
                    cost_of_goods_sold: 50
        required: true
      responses:
        '200':
          description: ''
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
      deprecated: false
      security:
        - bearer: []
  /api/settings/warehouses:
    get:
      summary: List warehouses
      tags:
        - Warehouses
      security:
        - bearer_auth: []
      operationId: listWarehouses
      description: List all warehouses for the company.
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  warehouses:
                    type: array
                    items:
                      title: Warehouse
                      type: object
                      properties:
                        id:
                          type: integer
                        name:
                          example: Central Distribution Center
                          type: string
                        active:
                          example: true
                          type: boolean
                        external_id:
                          example: WH-12345
                          type:
                            - string
                            - 'null'
                        metadata:
                          example:
                            capacity:
                              total_square_feet: 50000
                            operations:
                              staff_count: 15
                              security_level: high
                          type: object
                        country:
                          example:
                            id: 1
                            iso: US
                          type: object
                        address:
                          example:
                            id: 123
                            name: Main Warehouse
                            address1: 123 Logistics Way
                            address2: Building A
                            address3: null
                            city: Portland
                            state: OR
                            postal_code: '97201'
                          type: object
                      required:
                        - id
                        - name
                        - active
                        - metadata
                        - country
                        - address
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
    post:
      summary: Create a warehouse
      tags:
        - Warehouses
      security:
        - bearer_auth: []
      operationId: createWarehouseSettings
      description: Create a new warehouse for the company.
      parameters: []
      responses:
        '201':
          description: warehouse created
          content:
            application/json:
              schema:
                type: object
                properties:
                  warehouse:
                    title: Warehouse
                    type: object
                    properties:
                      id:
                        type: integer
                      name:
                        example: Central Distribution Center
                        type: string
                      active:
                        example: true
                        type: boolean
                      external_id:
                        example: WH-12345
                        type:
                          - string
                          - 'null'
                      metadata:
                        example:
                          capacity:
                            total_square_feet: 50000
                          operations:
                            staff_count: 15
                            security_level: high
                        type: object
                      country:
                        example:
                          id: 1
                          iso: US
                        type: object
                      address:
                        example:
                          id: 123
                          name: Main Warehouse
                          address1: 123 Logistics Way
                          address2: Building A
                          address3: null
                          city: Portland
                          state: OR
                          postal_code: '97201'
                        type: object
                    required:
                      - id
                      - name
                      - active
                      - metadata
                      - country
                      - address
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                active:
                  type: boolean
                  not:
                    type: 'null'
                default:
                  type: boolean
                  not:
                    type: 'null'
                country:
                  type: object
                  properties:
                    id:
                      type: integer
                      not:
                        type: 'null'
                    iso:
                      type: string
                      minLength: 1
                  required: []
                address:
                  type: object
                  properties:
                    address1:
                      type: string
                      minLength: 1
                    city:
                      type: string
                      minLength: 1
                    state:
                      type: string
                      minLength: 1
                    postal_code:
                      type: string
                      minLength: 1
                    address2:
                      type:
                        - 'null'
                        - string
                  required: []
              required: []
  /api/settings/warehouses/{id}:
    get:
      summary: Show a warehouse
      tags:
        - Warehouses
      security:
        - bearer_auth: []
      operationId: showWarehouseSettings
      description: Show a warehouse by ID.
      responses:
        '200':
          description: warehouse shown
          content:
            application/json:
              schema:
                type: object
                properties:
                  warehouse:
                    title: Warehouse
                    type: object
                    properties:
                      id:
                        type: integer
                      name:
                        example: Central Distribution Center
                        type: string
                      active:
                        example: true
                        type: boolean
                      external_id:
                        example: WH-12345
                        type:
                          - string
                          - 'null'
                      metadata:
                        example:
                          capacity:
                            total_square_feet: 50000
                          operations:
                            staff_count: 15
                            security_level: high
                        type: object
                      country:
                        example:
                          id: 1
                          iso: US
                        type: object
                      address:
                        example:
                          id: 123
                          name: Main Warehouse
                          address1: 123 Logistics Way
                          address2: Building A
                          address3: null
                          city: Portland
                          state: OR
                          postal_code: '97201'
                        type: object
                    required:
                      - id
                      - name
                      - active
                      - metadata
                      - country
                      - address
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '404':
          description: warehouse not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
    put:
      summary: Update a warehouse
      tags:
        - Warehouses
      security:
        - bearer_auth: []
      operationId: updateWarehouseSettings
      description: Update a warehouse by ID.
      parameters: []
      responses:
        '200':
          description: warehouse updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  warehouse:
                    title: Warehouse
                    type: object
                    properties:
                      id:
                        type: integer
                      name:
                        example: Central Distribution Center
                        type: string
                      active:
                        example: true
                        type: boolean
                      external_id:
                        example: WH-12345
                        type:
                          - string
                          - 'null'
                      metadata:
                        example:
                          capacity:
                            total_square_feet: 50000
                          operations:
                            staff_count: 15
                            security_level: high
                        type: object
                      country:
                        example:
                          id: 1
                          iso: US
                        type: object
                      address:
                        example:
                          id: 123
                          name: Main Warehouse
                          address1: 123 Logistics Way
                          address2: Building A
                          address3: null
                          city: Portland
                          state: OR
                          postal_code: '97201'
                        type: object
                    required:
                      - id
                      - name
                      - active
                      - metadata
                      - country
                      - address
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '404':
          description: warehouse not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - error_message
                  - errors
                  - meta
        '422':
          description: invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: integer
                  not:
                    type: 'null'
                name:
                  type: string
                  minLength: 1
                active:
                  type: boolean
                  not:
                    type: 'null'
                default:
                  type: boolean
                  not:
                    type: 'null'
                country:
                  type: object
                  properties:
                    id:
                      type: integer
                      not:
                        type: 'null'
                    iso:
                      type: string
                      minLength: 1
                  required: []
                address:
                  type: object
                  properties:
                    address1:
                      type: string
                      minLength: 1
                    city:
                      type: string
                      minLength: 1
                    state:
                      type: string
                      minLength: 1
                    postal_code:
                      type: string
                      minLength: 1
                    address2:
                      type:
                        - 'null'
                        - string
                  required: []
              required:
                - id
    delete:
      summary: Delete a warehouse
      tags:
        - Warehouses
      security:
        - bearer_auth: []
      operationId: deleteWarehouseSettings
      description: Delete a warehouse by ID.
      responses:
        '200':
          description: warehouse deleted
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '404':
          description: warehouse not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: cannot delete warehouse
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
  /api/settings/warehouses/{id}/assign_to_country:
    patch:
      summary: Assign warehouse to country
      tags:
        - Warehouses
      security:
        - bearer_auth: []
      operationId: assignWarehouseToCountry
      description: Assign a warehouse to a country.
      parameters: []
      responses:
        '200':
          description: warehouse assigned to country with customs option
          content:
            application/json:
              schema:
                type: object
                properties:
                  warehouse:
                    title: Warehouse
                    type: object
                    properties:
                      id:
                        type: integer
                      name:
                        example: Central Distribution Center
                        type: string
                      active:
                        example: true
                        type: boolean
                      external_id:
                        example: WH-12345
                        type:
                          - string
                          - 'null'
                      metadata:
                        example:
                          capacity:
                            total_square_feet: 50000
                          operations:
                            staff_count: 15
                            security_level: high
                        type: object
                      country:
                        example:
                          id: 1
                          iso: US
                        type: object
                      address:
                        example:
                          id: 123
                          name: Main Warehouse
                          address1: 123 Logistics Way
                          address2: Building A
                          address3: null
                          city: Portland
                          state: OR
                          postal_code: '97201'
                        type: object
                    required:
                      - id
                      - name
                      - active
                      - metadata
                      - country
                      - address
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '404':
          description: country not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '422':
          description: cannot assign warehouse to country
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: integer
                  not:
                    type: 'null'
                country_code:
                  type: string
                  minLength: 1
                customs:
                  type: string
                  minLength: 1
              required:
                - id
                - country_code
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
  /api/settings/warehouses/{id}/append_metadata:
    patch:
      summary: Append metadata field
      tags:
        - Warehouses
      security:
        - bearer_auth: []
      operationId: appendMetadataField
      description: Append a metadata field to a warehouse.
      parameters:
        - name: id
          in: path
          required: true
          description: Warehouse's Id
          schema:
            type: integer
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  warehouse:
                    title: Warehouse
                    type: object
                    properties:
                      id:
                        type: integer
                      name:
                        example: Central Distribution Center
                        type: string
                      active:
                        example: true
                        type: boolean
                      external_id:
                        example: WH-12345
                        type:
                          - string
                          - 'null'
                      metadata:
                        example:
                          capacity:
                            total_square_feet: 50000
                          operations:
                            staff_count: 15
                            security_level: high
                        type: object
                      country:
                        example:
                          id: 1
                          iso: US
                        type: object
                      address:
                        example:
                          id: 123
                          name: Main Warehouse
                          address1: 123 Logistics Way
                          address2: Building A
                          address3: null
                          city: Portland
                          state: OR
                          postal_code: '97201'
                        type: object
                    required:
                      - id
                      - name
                      - active
                      - metadata
                      - country
                      - address
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
        '404':
          description: not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                        example:
                          - Warehouse not found
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                metadata:
                  type: object
                  description: >-
                    A JSON object that can store any custom data structure. When
                    provided, merges with existing metadata data.
                  example:
                    capacity:
                      total_square_feet: 50000
                    operations:
                      staff_count: 15
                      security_level: high
              required:
                - metadata
  /api/company/webhook_events:
    get:
      summary: List webhook events
      tags:
        - Webhook Events
      security:
        - bearer_auth: []
      parameters:
        - name: page
          in: query
          required: false
          description: Page number
          schema:
            type: integer
        - name: per_page
          in: query
          required: false
          description: Items per page
          schema:
            type: integer
        - name: status
          in: query
          required: false
          description: Filter by response status
          schema:
            type: string
        - name: name
          in: query
          required: false
          description: Filter by event name
          schema:
            type: string
        - name: start_date
          in: query
          required: false
          description: Filter events after this date
          schema:
            type: string
        - name: end_date
          in: query
          required: false
          description: Filter events before this date
          schema:
            type: string
      responses:
        '200':
          description: webhook events found
          content:
            application/json:
              schema:
                type: object
                properties:
                  webhook_events:
                    type: array
                    items:
                      title: WebhookEvent
                      type: object
                      properties:
                        id:
                          type: integer
                        identifier:
                          description: Unique identifier for the webhook event
                          example: cart_1234567890
                          type:
                            - string
                            - 'null'
                        name:
                          description: The name/type of the webhook event
                          example: cart_updated
                          type:
                            - string
                            - 'null'
                        response_status:
                          description: HTTP response status from the webhook call
                          example: '200'
                          type:
                            - string
                            - 'null'
                        eventable_type:
                          description: The type of object that triggered the event
                          example: Cart
                          type: string
                        eventable_id:
                          description: The ID of the object that triggered the event
                          example: 123
                          type: integer
                        company_id:
                          description: The ID of the company that the event belongs to
                          example: 1
                          type:
                            - integer
                            - 'null'
                        payload:
                          description: The payload sent to the webhook
                          example:
                            cart_id: 123
                            total: 99.99
                          type:
                            - object
                            - 'null'
                        response:
                          description: The response received from the webhook
                          example:
                            status: success
                            message: Webhook received
                          type:
                            - object
                            - 'null'
                        created_at:
                          description: The date and time the webhook event was created
                          example: '2021-01-01T00:00:00Z'
                          type: string
                          format: date-time
                        updated_at:
                          description: The date and time the webhook event was last updated
                          example: '2021-01-01T00:00:00Z'
                          type: string
                          format: date-time
                        status:
                          description: Derived status based on response_status
                          example: success
                          type: string
                        eventable_display_name:
                          description: Human-readable name for the eventable object
                          example: 'Cart #123'
                          type:
                            - string
                            - 'null'
                      required:
                        - id
                        - eventable_type
                        - eventable_id
                        - created_at
                        - updated_at
                        - status
                  meta:
                    type: object
                    properties:
                      pagination:
                        type: object
                        properties:
                          current_page:
                            type: integer
                          next_page:
                            type:
                              - integer
                              - 'null'
                          prev_page:
                            type:
                              - integer
                              - 'null'
                          total_pages:
                            type: integer
                          total_count:
                            type: integer
                          per_page:
                            type: integer
                      request_id:
                        type: string
                      timestamp:
                        type: string
  /api/company/webhook_events/{id}:
    get:
      summary: Show webhook event
      tags:
        - Webhook Events
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Webhook event ID
          schema:
            type: string
      responses:
        '200':
          description: webhook event found
          content:
            application/json:
              schema:
                type: object
                properties:
                  webhook_event:
                    title: WebhookEvent
                    type: object
                    properties:
                      id:
                        type: integer
                      identifier:
                        description: Unique identifier for the webhook event
                        example: cart_1234567890
                        type:
                          - string
                          - 'null'
                      name:
                        description: The name/type of the webhook event
                        example: cart_updated
                        type:
                          - string
                          - 'null'
                      response_status:
                        description: HTTP response status from the webhook call
                        example: '200'
                        type:
                          - string
                          - 'null'
                      eventable_type:
                        description: The type of object that triggered the event
                        example: Cart
                        type: string
                      eventable_id:
                        description: The ID of the object that triggered the event
                        example: 123
                        type: integer
                      company_id:
                        description: The ID of the company that the event belongs to
                        example: 1
                        type:
                          - integer
                          - 'null'
                      payload:
                        description: The payload sent to the webhook
                        example:
                          cart_id: 123
                          total: 99.99
                        type:
                          - object
                          - 'null'
                      response:
                        description: The response received from the webhook
                        example:
                          status: success
                          message: Webhook received
                        type:
                          - object
                          - 'null'
                      created_at:
                        description: The date and time the webhook event was created
                        example: '2021-01-01T00:00:00Z'
                        type: string
                        format: date-time
                      updated_at:
                        description: The date and time the webhook event was last updated
                        example: '2021-01-01T00:00:00Z'
                        type: string
                        format: date-time
                      status:
                        description: Derived status based on response_status
                        example: success
                        type: string
                      eventable_display_name:
                        description: Human-readable name for the eventable object
                        example: 'Cart #123'
                        type:
                          - string
                          - 'null'
                    required:
                      - id
                      - eventable_type
                      - eventable_id
                      - created_at
                      - updated_at
                      - status
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
        '404':
          description: webhook event not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
  /api/company/webhook_events/{id}/retrigger:
    post:
      summary: Retrigger webhook event
      tags:
        - Webhook Events
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          description: Webhook event ID
          schema:
            type: string
      responses:
        '200':
          description: webhook retriggered successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
        '404':
          description: webhook event not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      id:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
        '422':
          description: webhook configuration not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      webhook:
                        type: array
                        items:
                          type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
  /api/webhooks/schemas:
    get:
      summary: returns a list of webhook schemas
      tags:
        - Webhook Schemas
      security:
        - bearer_auth: []
      parameters:
        - name: event_identifier
          in: query
          required: false
          description: Filter schemas by event identifier
          schema:
            type: string
      responses:
        '200':
          description: returns a list of webhook schemas
          content:
            application/json:
              schema:
                type: object
                properties:
                  schemas:
                    type: array
                    items:
                      $ref: '#/components/schemas/WebhookSchema'
                  meta:
                    $ref: '#/components/schemas/Meta'
  /api/webhooks/schemas/{event_identifier}:
    get:
      summary: returns the latest schema for an event
      tags:
        - Webhook Schemas
      security:
        - bearer_auth: []
      parameters:
        - name: event_identifier
          in: path
          required: true
          description: The event identifier to get the schema for
          schema:
            type: string
      responses:
        '200':
          description: returns the latest schema for the event
          content:
            application/json:
              schema:
                type: object
                properties:
                  schema:
                    $ref: '#/components/schemas/WebhookSchema'
                  meta:
                    $ref: '#/components/schemas/Meta'
        '404':
          description: event identifier not found
  /api/company/webhooks:
    get:
      summary: An array of webhooks
      tags:
        - Webhooks
      operationId: indexWebhooks
      security:
        - bearer_auth: []
      parameters:
        - name: query
          in: query
          schema:
            type: object
            properties:
              page:
                type: integer
                exclusiveMinimum: 0
              per_page:
                type: integer
                exclusiveMinimum: 0
                maximum: 100
              active:
                type: boolean
              resource:
                type: string
            required: []
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  webhooks:
                    type: array
                    items:
                      title: Webhook
                      type: object
                      properties:
                        id:
                          type: integer
                        company_id:
                          description: The ID of the company that the resource belongs to
                          example: 1
                          type: integer
                        droplet_installation_uuid:
                          description: >-
                            The UUID of the droplet installation if the webhook
                            was created for a droplet
                          example: dri_1phkYdRcAWwms9iGwezxBbe1oDfvKiit3
                          type:
                            - string
                            - 'null'
                        url:
                          description: The URL the webhook events are sent to
                          example: https://example.com/webhook
                          type: string
                          pattern: |-
                            ^(?x-mi:
                                    ([a-zA-Z][\-+.a-zA-Z\d]*):                           (?# 1: scheme)
                                    (?:
                                       ((?:[\-_.!~*'()a-zA-Z\d;?:@&=+$,]|%[a-fA-F\d]{2})(?:[\-_.!~*'()a-zA-Z\d;\/?:@&=+$,\[\]]|%[a-fA-F\d]{2})*)                    (?# 2: opaque)
                                    |
                                       (?:(?:
                                         \/\/(?:
                                             (?:(?:((?:[\-_.!~*'()a-zA-Z\d;:&=+$,]|%[a-fA-F\d]{2})*)@)?        (?# 3: userinfo)
                                               (?:((?:(?:[a-zA-Z0-9\-.]|%\h\h)+|\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}|\[(?:(?:[a-fA-F\d]{1,4}:)*(?:[a-fA-F\d]{1,4}|\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})|(?:(?:[a-fA-F\d]{1,4}:)*[a-fA-F\d]{1,4})?::(?:(?:[a-fA-F\d]{1,4}:)*(?:[a-fA-F\d]{1,4}|\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}))?)\]))(?::(\d*))?))? (?# 4: host, 5: port)
                                           |
                                             ((?:[\-_.!~*'()a-zA-Z\d$,;:@&=+]|%[a-fA-F\d]{2})+)                 (?# 6: registry)
                                           )
                                         |
                                         (?!\/\/))                           (?# XXX: '\/\/' is the mark for hostport)
                                         (\/(?:[\-_.!~*'()a-zA-Z\d:@&=+$,]|%[a-fA-F\d]{2})*(?:;(?:[\-_.!~*'()a-zA-Z\d:@&=+$,]|%[a-fA-F\d]{2})*)*(?:\/(?:[\-_.!~*'()a-zA-Z\d:@&=+$,]|%[a-fA-F\d]{2})*(?:;(?:[\-_.!~*'()a-zA-Z\d:@&=+$,]|%[a-fA-F\d]{2})*)*)*)?                    (?# 7: path)
                                       )(?:\?((?:[\-_.!~*'()a-zA-Z\d;\/?:@&=+$,\[\]]|%[a-fA-F\d]{2})*))?                 (?# 8: query)
                                    )
                                    (?:\#((?:[\-_.!~*'()a-zA-Z\d;\/?:@&=+$,\[\]]|%[a-fA-F\d]{2})*))?                  (?# 9: fragment)
                                  )$
                        active:
                          description: Whether the webhook is currently active
                          example: true
                          type:
                            - boolean
                            - 'null'
                          default: true
                        resource:
                          description: The resource that the webhook is for
                          example: droplet
                          type: string
                        event:
                          description: The event that triggers the webhook
                          example: installed
                          type: string
                        event_identifier:
                          description: The identifier for the event
                          example: droplet_installed
                          type:
                            - string
                            - 'null'
                        http_method:
                          description: The HTTP method used to send the webhook event
                          example: post
                          type: string
                          enum:
                            - post
                            - put
                            - get
                        auth_token:
                          description: The authentication token used verify webhook events
                          example: abc123
                          type:
                            - string
                            - 'null'
                        created_at:
                          description: The date and time the webhook was created
                          example: '2021-01-01T00:00:00Z'
                          type: string
                          format: date-time
                        updated_at:
                          description: The date and time the webhook was last updated
                          example: '2021-01-01T00:00:00Z'
                          type: string
                          format: date-time
                      required:
                        - id
                        - company_id
                        - url
                        - resource
                        - event
                        - http_method
                        - created_at
                        - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                      pagination:
                        type: object
                        properties:
                          current_page:
                            type: integer
                            example: 1
                          total_pages:
                            type: integer
                            example: 10
                          total_count:
                            type: integer
                            example: 100
                          per_page:
                            type: integer
                            example: 10
                required:
                  - webhooks
                  - meta
    post:
      summary: Create a webhook
      tags:
        - Webhooks
      operationId: createWebhook
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '201':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  webhook:
                    title: Webhook
                    type: object
                    properties:
                      id:
                        type: integer
                      company_id:
                        description: The ID of the company that the resource belongs to
                        example: 1
                        type: integer
                      droplet_installation_uuid:
                        description: >-
                          The UUID of the droplet installation if the webhook
                          was created for a droplet
                        example: dri_1phkYdRcAWwms9iGwezxBbe1oDfvKiit3
                        type:
                          - string
                          - 'null'
                      url:
                        description: The URL the webhook events are sent to
                        example: https://example.com/webhook
                        type: string
                        pattern: |-
                          ^(?x-mi:
                                  ([a-zA-Z][\-+.a-zA-Z\d]*):                           (?# 1: scheme)
                                  (?:
                                     ((?:[\-_.!~*'()a-zA-Z\d;?:@&=+$,]|%[a-fA-F\d]{2})(?:[\-_.!~*'()a-zA-Z\d;\/?:@&=+$,\[\]]|%[a-fA-F\d]{2})*)                    (?# 2: opaque)
                                  |
                                     (?:(?:
                                       \/\/(?:
                                           (?:(?:((?:[\-_.!~*'()a-zA-Z\d;:&=+$,]|%[a-fA-F\d]{2})*)@)?        (?# 3: userinfo)
                                             (?:((?:(?:[a-zA-Z0-9\-.]|%\h\h)+|\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}|\[(?:(?:[a-fA-F\d]{1,4}:)*(?:[a-fA-F\d]{1,4}|\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})|(?:(?:[a-fA-F\d]{1,4}:)*[a-fA-F\d]{1,4})?::(?:(?:[a-fA-F\d]{1,4}:)*(?:[a-fA-F\d]{1,4}|\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}))?)\]))(?::(\d*))?))? (?# 4: host, 5: port)
                                         |
                                           ((?:[\-_.!~*'()a-zA-Z\d$,;:@&=+]|%[a-fA-F\d]{2})+)                 (?# 6: registry)
                                         )
                                       |
                                       (?!\/\/))                           (?# XXX: '\/\/' is the mark for hostport)
                                       (\/(?:[\-_.!~*'()a-zA-Z\d:@&=+$,]|%[a-fA-F\d]{2})*(?:;(?:[\-_.!~*'()a-zA-Z\d:@&=+$,]|%[a-fA-F\d]{2})*)*(?:\/(?:[\-_.!~*'()a-zA-Z\d:@&=+$,]|%[a-fA-F\d]{2})*(?:;(?:[\-_.!~*'()a-zA-Z\d:@&=+$,]|%[a-fA-F\d]{2})*)*)*)?                    (?# 7: path)
                                     )(?:\?((?:[\-_.!~*'()a-zA-Z\d;\/?:@&=+$,\[\]]|%[a-fA-F\d]{2})*))?                 (?# 8: query)
                                  )
                                  (?:\#((?:[\-_.!~*'()a-zA-Z\d;\/?:@&=+$,\[\]]|%[a-fA-F\d]{2})*))?                  (?# 9: fragment)
                                )$
                      active:
                        description: Whether the webhook is currently active
                        example: true
                        type:
                          - boolean
                          - 'null'
                        default: true
                      resource:
                        description: The resource that the webhook is for
                        example: droplet
                        type: string
                      event:
                        description: The event that triggers the webhook
                        example: installed
                        type: string
                      event_identifier:
                        description: The identifier for the event
                        example: droplet_installed
                        type:
                          - string
                          - 'null'
                      http_method:
                        description: The HTTP method used to send the webhook event
                        example: post
                        type: string
                        enum:
                          - post
                          - put
                          - get
                      auth_token:
                        description: The authentication token used verify webhook events
                        example: abc123
                        type:
                          - string
                          - 'null'
                      created_at:
                        description: The date and time the webhook was created
                        example: '2021-01-01T00:00:00Z'
                        type: string
                        format: date-time
                      updated_at:
                        description: The date and time the webhook was last updated
                        example: '2021-01-01T00:00:00Z'
                        type: string
                        format: date-time
                    required:
                      - id
                      - company_id
                      - url
                      - resource
                      - event
                      - http_method
                      - created_at
                      - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - webhook
                  - meta
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                webhook:
                  type: object
                  properties:
                    resource:
                      type: string
                    event:
                      type: string
                    url:
                      type: string
                    active:
                      type: boolean
                      not:
                        type: 'null'
                    auth_token:
                      type: string
                      minLength: 1
                    http_method:
                      type: string
                      minLength: 1
                  required:
                    - resource
                    - event
                    - url
              required:
                - webhook
  /api/company/webhooks/{id}:
    get:
      summary: Show a webhook
      tags:
        - Webhooks
      operationId: showWebhook
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  webhook:
                    title: Webhook
                    type: object
                    properties:
                      id:
                        type: integer
                      company_id:
                        description: The ID of the company that the resource belongs to
                        example: 1
                        type: integer
                      droplet_installation_uuid:
                        description: >-
                          The UUID of the droplet installation if the webhook
                          was created for a droplet
                        example: dri_1phkYdRcAWwms9iGwezxBbe1oDfvKiit3
                        type:
                          - string
                          - 'null'
                      url:
                        description: The URL the webhook events are sent to
                        example: https://example.com/webhook
                        type: string
                        pattern: |-
                          ^(?x-mi:
                                  ([a-zA-Z][\-+.a-zA-Z\d]*):                           (?# 1: scheme)
                                  (?:
                                     ((?:[\-_.!~*'()a-zA-Z\d;?:@&=+$,]|%[a-fA-F\d]{2})(?:[\-_.!~*'()a-zA-Z\d;\/?:@&=+$,\[\]]|%[a-fA-F\d]{2})*)                    (?# 2: opaque)
                                  |
                                     (?:(?:
                                       \/\/(?:
                                           (?:(?:((?:[\-_.!~*'()a-zA-Z\d;:&=+$,]|%[a-fA-F\d]{2})*)@)?        (?# 3: userinfo)
                                             (?:((?:(?:[a-zA-Z0-9\-.]|%\h\h)+|\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}|\[(?:(?:[a-fA-F\d]{1,4}:)*(?:[a-fA-F\d]{1,4}|\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})|(?:(?:[a-fA-F\d]{1,4}:)*[a-fA-F\d]{1,4})?::(?:(?:[a-fA-F\d]{1,4}:)*(?:[a-fA-F\d]{1,4}|\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}))?)\]))(?::(\d*))?))? (?# 4: host, 5: port)
                                         |
                                           ((?:[\-_.!~*'()a-zA-Z\d$,;:@&=+]|%[a-fA-F\d]{2})+)                 (?# 6: registry)
                                         )
                                       |
                                       (?!\/\/))                           (?# XXX: '\/\/' is the mark for hostport)
                                       (\/(?:[\-_.!~*'()a-zA-Z\d:@&=+$,]|%[a-fA-F\d]{2})*(?:;(?:[\-_.!~*'()a-zA-Z\d:@&=+$,]|%[a-fA-F\d]{2})*)*(?:\/(?:[\-_.!~*'()a-zA-Z\d:@&=+$,]|%[a-fA-F\d]{2})*(?:;(?:[\-_.!~*'()a-zA-Z\d:@&=+$,]|%[a-fA-F\d]{2})*)*)*)?                    (?# 7: path)
                                     )(?:\?((?:[\-_.!~*'()a-zA-Z\d;\/?:@&=+$,\[\]]|%[a-fA-F\d]{2})*))?                 (?# 8: query)
                                  )
                                  (?:\#((?:[\-_.!~*'()a-zA-Z\d;\/?:@&=+$,\[\]]|%[a-fA-F\d]{2})*))?                  (?# 9: fragment)
                                )$
                      active:
                        description: Whether the webhook is currently active
                        example: true
                        type:
                          - boolean
                          - 'null'
                        default: true
                      resource:
                        description: The resource that the webhook is for
                        example: droplet
                        type: string
                      event:
                        description: The event that triggers the webhook
                        example: installed
                        type: string
                      event_identifier:
                        description: The identifier for the event
                        example: droplet_installed
                        type:
                          - string
                          - 'null'
                      http_method:
                        description: The HTTP method used to send the webhook event
                        example: post
                        type: string
                        enum:
                          - post
                          - put
                          - get
                      auth_token:
                        description: The authentication token used verify webhook events
                        example: abc123
                        type:
                          - string
                          - 'null'
                      created_at:
                        description: The date and time the webhook was created
                        example: '2021-01-01T00:00:00Z'
                        type: string
                        format: date-time
                      updated_at:
                        description: The date and time the webhook was last updated
                        example: '2021-01-01T00:00:00Z'
                        type: string
                        format: date-time
                    required:
                      - id
                      - company_id
                      - url
                      - resource
                      - event
                      - http_method
                      - created_at
                      - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - webhook
                  - meta
        '404':
          description: not found
    put:
      summary: Update a webhook
      tags:
        - Webhooks
      operationId: updateWebhook
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  webhook:
                    title: Webhook
                    type: object
                    properties:
                      id:
                        type: integer
                      company_id:
                        description: The ID of the company that the resource belongs to
                        example: 1
                        type: integer
                      droplet_installation_uuid:
                        description: >-
                          The UUID of the droplet installation if the webhook
                          was created for a droplet
                        example: dri_1phkYdRcAWwms9iGwezxBbe1oDfvKiit3
                        type:
                          - string
                          - 'null'
                      url:
                        description: The URL the webhook events are sent to
                        example: https://example.com/webhook
                        type: string
                        pattern: |-
                          ^(?x-mi:
                                  ([a-zA-Z][\-+.a-zA-Z\d]*):                           (?# 1: scheme)
                                  (?:
                                     ((?:[\-_.!~*'()a-zA-Z\d;?:@&=+$,]|%[a-fA-F\d]{2})(?:[\-_.!~*'()a-zA-Z\d;\/?:@&=+$,\[\]]|%[a-fA-F\d]{2})*)                    (?# 2: opaque)
                                  |
                                     (?:(?:
                                       \/\/(?:
                                           (?:(?:((?:[\-_.!~*'()a-zA-Z\d;:&=+$,]|%[a-fA-F\d]{2})*)@)?        (?# 3: userinfo)
                                             (?:((?:(?:[a-zA-Z0-9\-.]|%\h\h)+|\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}|\[(?:(?:[a-fA-F\d]{1,4}:)*(?:[a-fA-F\d]{1,4}|\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3})|(?:(?:[a-fA-F\d]{1,4}:)*[a-fA-F\d]{1,4})?::(?:(?:[a-fA-F\d]{1,4}:)*(?:[a-fA-F\d]{1,4}|\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}))?)\]))(?::(\d*))?))? (?# 4: host, 5: port)
                                         |
                                           ((?:[\-_.!~*'()a-zA-Z\d$,;:@&=+]|%[a-fA-F\d]{2})+)                 (?# 6: registry)
                                         )
                                       |
                                       (?!\/\/))                           (?# XXX: '\/\/' is the mark for hostport)
                                       (\/(?:[\-_.!~*'()a-zA-Z\d:@&=+$,]|%[a-fA-F\d]{2})*(?:;(?:[\-_.!~*'()a-zA-Z\d:@&=+$,]|%[a-fA-F\d]{2})*)*(?:\/(?:[\-_.!~*'()a-zA-Z\d:@&=+$,]|%[a-fA-F\d]{2})*(?:;(?:[\-_.!~*'()a-zA-Z\d:@&=+$,]|%[a-fA-F\d]{2})*)*)*)?                    (?# 7: path)
                                     )(?:\?((?:[\-_.!~*'()a-zA-Z\d;\/?:@&=+$,\[\]]|%[a-fA-F\d]{2})*))?                 (?# 8: query)
                                  )
                                  (?:\#((?:[\-_.!~*'()a-zA-Z\d;\/?:@&=+$,\[\]]|%[a-fA-F\d]{2})*))?                  (?# 9: fragment)
                                )$
                      active:
                        description: Whether the webhook is currently active
                        example: true
                        type:
                          - boolean
                          - 'null'
                        default: true
                      resource:
                        description: The resource that the webhook is for
                        example: droplet
                        type: string
                      event:
                        description: The event that triggers the webhook
                        example: installed
                        type: string
                      event_identifier:
                        description: The identifier for the event
                        example: droplet_installed
                        type:
                          - string
                          - 'null'
                      http_method:
                        description: The HTTP method used to send the webhook event
                        example: post
                        type: string
                        enum:
                          - post
                          - put
                          - get
                      auth_token:
                        description: The authentication token used verify webhook events
                        example: abc123
                        type:
                          - string
                          - 'null'
                      created_at:
                        description: The date and time the webhook was created
                        example: '2021-01-01T00:00:00Z'
                        type: string
                        format: date-time
                      updated_at:
                        description: The date and time the webhook was last updated
                        example: '2021-01-01T00:00:00Z'
                        type: string
                        format: date-time
                    required:
                      - id
                      - company_id
                      - url
                      - resource
                      - event
                      - http_method
                      - created_at
                      - updated_at
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - webhook
                  - meta
        '404':
          description: not found
        '422':
          description: unprocessable entity
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                id:
                  type: string
                webhook:
                  type: object
                  properties:
                    url:
                      type: string
                      minLength: 1
                    active:
                      type: boolean
                      not:
                        type: 'null'
                    auth_token:
                      type: string
                      minLength: 1
                    http_method:
                      type: string
                      enum:
                        - post
                        - put
                        - get
                  required: []
              required:
                - id
                - webhook
    delete:
      summary: Delete a webhook
      tags:
        - Webhooks
      operationId: destroyWebhook
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          schema:
            type: string
          required: true
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  webhook:
                    title: Webhook
                    type: object
                    properties:
                      id:
                        type: integer
                    required:
                      - id
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - webhook
                  - meta
  /api/company/webhooks/bulk_delete:
    delete:
      summary: Bulk delete webhooks
      tags:
        - Webhooks
      operationId: bulkDeleteWebhooks
      security:
        - bearer_auth: []
      parameters: []
      responses:
        '200':
          description: success
          content:
            application/json:
              schema:
                type: object
                properties:
                  webhooks:
                    title: Webhook
                    type: object
                    properties:
                      webhook_ids:
                        description: The IDs of the webhooks that were deleted
                        example:
                          - 5
                          - 19
                          - 42
                          - 87
                        type: array
                      count:
                        description: The number of webhooks that were deleted
                        example: 4
                        type: integer
                    required:
                      - webhook_ids
                      - count
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
                required:
                  - webhooks
                  - meta
        '422':
          description: unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: status code based error message
                  errors:
                    type: object
                    example:
                      key_name:
                        - error message of the key
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                webhook_ids:
                  type: array
                  items:
                    type: integer
              required:
                - webhook_ids
  /api/company/webhooks/events/cart_abandoned:
    get:
      tags:
        - Webhooks
      summary: cart_abandoned
      operationId: cart_abandoned
      parameters: []
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/cart_abandoned'
                  - example:
                      id: 141
                      name: cart_abandoned
                      payload:
                        cart:
                          id: 10
                          card: null
                          type: regular
                          buyer:
                            email: null
                            token: 6bLgYHCSSGn2mshCPB91ZkuH
                            full_name: null
                            is_enrolled: false
                          email: null
                          token: YgSi6Xmn6H92MeW69x6hpYdL
                          country:
                            id: 214
                            iso: US
                            itn: false
                            iso3: USA
                            name: United States
                            state: true
                            active: true
                            default: true
                            numcode: 840
                            address3: false
                            iso_name: UNITED STATES
                            passport: false
                            tax_rate: 0
                            delimiter: ','
                            separator: .
                            created_at: '2023-12-26T04:48:23.479Z'
                            updated_at: '2023-12-26T04:48:23.479Z'
                            currency_code: USD
                            geo_entity_id: null
                            currency_symbol: $
                          ship_to: null
                          visitor: 6bLgYHCSSGn2mshCPB91ZkuH
                          wallets: []
                          cv_total: 0
                          sub_total: '99.91'
                          tax_total: '0.0'
                          cart_items:
                            - id: 15
                              price: '99.91'
                              cart_id: 10
                              external: true
                              quantity: 1
                              origin_url: >-
                                http://fluid.lvh.me:3000/home/shop/sleek-plastic-coat5
                              variant_id: 25
                              subscription: false
                          manual_tax: false
                          visitor_id: 3
                          fulfillment: ups
                          amount_total: '120.74'
                          order_number: null
                          repeat_order: false
                          currency_code: USD
                          display_price: $120.74 (USD)
                          shipping_total: '20.83'
                          currency_symbol: $
                          manual_shipping: false
                          shipping_options:
                            - id: 10
                              code: ups
                              name: UPS
                              price: 14
                              cart_id: 10
                              surcharge: '6.83'
                              created_at: '2023-12-27T11:39:08.018Z'
                              updated_at: '2023-12-27T11:39:08.018Z'
                              delivery_date: null
                            - id: 11
                              code: ups-surepost
                              name: UPS Surepost
                              price: 5
                              cart_id: 10
                              surcharge: '6.29'
                              created_at: '2023-12-27T11:39:08.022Z'
                              updated_at: '2023-12-27T11:39:08.022Z'
                              delivery_date: null
                          webhook_enabled?: true
                          applied_discounts:
                            amount: '0.0'
                            discount_codes: []
                          checkout_success_url: ''
                          hold_card_thirty_days: false
                          company_coupon_or_promo_code: true
                      timestamp: '2023-12-28T04:24:11.176Z'
                      identifier: cart-170373745110
              example:
                id: 141
                name: cart_abandoned
                payload:
                  cart:
                    id: 10
                    card: null
                    type: regular
                    buyer:
                      email: null
                      token: 6bLgYHCSSGn2mshCPB91ZkuH
                      full_name: null
                      is_enrolled: false
                    email: null
                    token: YgSi6Xmn6H92MeW69x6hpYdL
                    country:
                      id: 214
                      iso: US
                      itn: false
                      iso3: USA
                      name: United States
                      state: true
                      active: true
                      default: true
                      numcode: 840
                      address3: false
                      iso_name: UNITED STATES
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      created_at: '2023-12-26T04:48:23.479Z'
                      updated_at: '2023-12-26T04:48:23.479Z'
                      currency_code: USD
                      geo_entity_id: null
                      currency_symbol: $
                    ship_to: null
                    visitor: 6bLgYHCSSGn2mshCPB91ZkuH
                    wallets: []
                    cv_total: 0
                    sub_total: '99.91'
                    tax_total: '0.0'
                    cart_items:
                      - id: 15
                        price: '99.91'
                        cart_id: 10
                        external: true
                        quantity: 1
                        origin_url: http://fluid.lvh.me:3000/home/shop/sleek-plastic-coat5
                        variant_id: 25
                        subscription: false
                    manual_tax: false
                    visitor_id: 3
                    fulfillment: ups
                    amount_total: '120.74'
                    order_number: null
                    repeat_order: false
                    currency_code: USD
                    display_price: $120.74 (USD)
                    shipping_total: '20.83'
                    currency_symbol: $
                    manual_shipping: false
                    shipping_options:
                      - id: 10
                        code: ups
                        name: UPS
                        price: 14
                        cart_id: 10
                        surcharge: '6.83'
                        created_at: '2023-12-27T11:39:08.018Z'
                        updated_at: '2023-12-27T11:39:08.018Z'
                        delivery_date: null
                      - id: 11
                        code: ups-surepost
                        name: UPS Surepost
                        price: 5
                        cart_id: 10
                        surcharge: '6.29'
                        created_at: '2023-12-27T11:39:08.022Z'
                        updated_at: '2023-12-27T11:39:08.022Z'
                        delivery_date: null
                    webhook_enabled?: true
                    applied_discounts:
                      amount: '0.0'
                      discount_codes: []
                    checkout_success_url: ''
                    hold_card_thirty_days: false
                    company_coupon_or_promo_code: true
                timestamp: '2023-12-28T04:24:11.176Z'
                identifier: cart-170373745110
      deprecated: false
  /api/company/webhooks/events/cart_updated:
    get:
      tags:
        - Webhooks
      summary: cart_updated
      operationId: cart_updated
      parameters: []
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/cart_updated'
                  - example:
                      id: 138
                      name: cart_updated
                      payload:
                        cart:
                          id: 10
                          card: null
                          type: regular
                          buyer:
                            email: null
                            token: 6bLgYHCSSGn2mshCPB91ZkuH
                            full_name: null
                            is_enrolled: false
                          email: null
                          token: YgSi6Xmn6H92MeW69x6hpYdL
                          country:
                            id: 214
                            iso: US
                            itn: false
                            iso3: USA
                            name: United States
                            state: true
                            active: true
                            default: true
                            numcode: 840
                            address3: false
                            iso_name: UNITED STATES
                            passport: false
                            tax_rate: 0
                            delimiter: ','
                            separator: .
                            created_at: '2023-12-26T04:48:23.479Z'
                            updated_at: '2023-12-26T04:48:23.479Z'
                            currency_code: USD
                            geo_entity_id: null
                            currency_symbol: $
                          ship_to: null
                          visitor: 6bLgYHCSSGn2mshCPB91ZkuH
                          wallets: []
                          cv_total: 0
                          sub_total: '99.91'
                          tax_total: '0.0'
                          cart_items:
                            - id: 15
                              price: '99.91'
                              cart_id: 10
                              external: true
                              quantity: 1
                              origin_url: >-
                                http://fluid.lvh.me:3000/home/shop/sleek-plastic-coat5
                              variant_id: 25
                              subscription: false
                          manual_tax: false
                          visitor_id: 3
                          fulfillment: ups
                          amount_total: '120.74'
                          order_number: null
                          repeat_order: false
                          currency_code: USD
                          display_price: $120.74 (USD)
                          shipping_total: '20.83'
                          currency_symbol: $
                          manual_shipping: false
                          shipping_options:
                            - id: 10
                              code: ups
                              name: UPS
                              price: 14
                              cart_id: 10
                              surcharge: '6.83'
                              created_at: '2023-12-27T11:39:08.018Z'
                              updated_at: '2023-12-27T11:39:08.018Z'
                              delivery_date: null
                            - id: 11
                              code: ups-surepost
                              name: UPS Surepost
                              price: 5
                              cart_id: 10
                              surcharge: '6.29'
                              created_at: '2023-12-27T11:39:08.022Z'
                              updated_at: '2023-12-27T11:39:08.022Z'
                              delivery_date: null
                          webhook_enabled?: true
                          applied_discounts:
                            amount: '0.0'
                            discount_codes: []
                          checkout_success_url: ''
                          hold_card_thirty_days: false
                          company_coupon_or_promo_code: true
                      timestamp: '2023-12-28T04:17:03.561Z'
                      identifier: cart-170373702310
              example:
                id: 138
                name: cart_updated
                payload:
                  cart:
                    id: 10
                    card: null
                    type: regular
                    buyer:
                      email: null
                      token: 6bLgYHCSSGn2mshCPB91ZkuH
                      full_name: null
                      is_enrolled: false
                    email: null
                    token: YgSi6Xmn6H92MeW69x6hpYdL
                    country:
                      id: 214
                      iso: US
                      itn: false
                      iso3: USA
                      name: United States
                      state: true
                      active: true
                      default: true
                      numcode: 840
                      address3: false
                      iso_name: UNITED STATES
                      passport: false
                      tax_rate: 0
                      delimiter: ','
                      separator: .
                      created_at: '2023-12-26T04:48:23.479Z'
                      updated_at: '2023-12-26T04:48:23.479Z'
                      currency_code: USD
                      geo_entity_id: null
                      currency_symbol: $
                    ship_to: null
                    visitor: 6bLgYHCSSGn2mshCPB91ZkuH
                    wallets: []
                    cv_total: 0
                    sub_total: '99.91'
                    tax_total: '0.0'
                    cart_items:
                      - id: 15
                        price: '99.91'
                        cart_id: 10
                        external: true
                        quantity: 1
                        origin_url: http://fluid.lvh.me:3000/home/shop/sleek-plastic-coat5
                        variant_id: 25
                        subscription: false
                    manual_tax: false
                    visitor_id: 3
                    fulfillment: ups
                    amount_total: '120.74'
                    order_number: null
                    repeat_order: false
                    currency_code: USD
                    display_price: $120.74 (USD)
                    shipping_total: '20.83'
                    currency_symbol: $
                    manual_shipping: false
                    shipping_options:
                      - id: 10
                        code: ups
                        name: UPS
                        price: 14
                        cart_id: 10
                        surcharge: '6.83'
                        created_at: '2023-12-27T11:39:08.018Z'
                        updated_at: '2023-12-27T11:39:08.018Z'
                        delivery_date: null
                      - id: 11
                        code: ups-surepost
                        name: UPS Surepost
                        price: 5
                        cart_id: 10
                        surcharge: '6.29'
                        created_at: '2023-12-27T11:39:08.022Z'
                        updated_at: '2023-12-27T11:39:08.022Z'
                        delivery_date: null
                    webhook_enabled?: true
                    applied_discounts:
                      amount: '0.0'
                      discount_codes: []
                    checkout_success_url: ''
                    hold_card_thirty_days: false
                    company_coupon_or_promo_code: true
                timestamp: '2023-12-28T04:17:03.561Z'
                identifier: cart-170373702310
      deprecated: false
  /api/company/webhooks/events/contact_created:
    get:
      tags:
        - Webhooks
      summary: contact_created
      operationId: contact_created
      parameters: []
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/contact_created'
                  - example:
                      id: 143
                      name: contact_created
                      payload:
                        contact:
                          id: 25
                          ip: null
                          city: null
                          email: aaram@gmail.com
                          hours: null
                          phone: null
                          state: null
                          token: UbeDjowurUaFa5E9qgoaST6h
                          email2: null
                          income: null
                          invest: null
                          phone2: null
                          reason: null
                          status: new
                          address: null
                          address2: null
                          interest: null
                          phone_id: null
                          best_time: null
                          full_name: Rameshwor
                          last_name: ''
                          lead_type: Popup
                          time_zone: null
                          activities:
                            - id: 15
                              title: New Contact from Popup
                              read_at: null
                              user_id: 5
                              company_id: 980190962
                              created_at: '2023-12-28T04:18:57.808Z'
                              description: POPPY
                              relation_type: Contact
                          avatar_url: null
                          country_id: null
                          first_name: Rameshwor
                          language_id: null
                          postal_code: null
                          requested_at: null
                      timestamp: '2023-12-28T04:27:39.476Z'
                      identifier: contact-170373765925
              example:
                id: 143
                name: contact_created
                payload:
                  contact:
                    id: 25
                    ip: null
                    city: null
                    email: aaram@gmail.com
                    hours: null
                    phone: null
                    state: null
                    token: UbeDjowurUaFa5E9qgoaST6h
                    email2: null
                    income: null
                    invest: null
                    phone2: null
                    reason: null
                    status: new
                    address: null
                    address2: null
                    interest: null
                    phone_id: null
                    best_time: null
                    full_name: Rameshwor
                    last_name: ''
                    lead_type: Popup
                    time_zone: null
                    activities:
                      - id: 15
                        title: New Contact from Popup
                        read_at: null
                        user_id: 5
                        company_id: 980190962
                        created_at: '2023-12-28T04:18:57.808Z'
                        description: POPPY
                        relation_type: Contact
                    avatar_url: null
                    country_id: null
                    first_name: Rameshwor
                    language_id: null
                    postal_code: null
                    requested_at: null
                timestamp: '2023-12-28T04:27:39.476Z'
                identifier: contact-170373765925
      deprecated: false
  /api/company/webhooks/events/contact_updated:
    get:
      tags:
        - Webhooks
      summary: contact_updated
      operationId: contact_updated
      parameters: []
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/contact_updated'
                  - example:
                      id: 30
                      name: contact_updated
                      payload:
                        contact:
                          id: 20
                          ip: null
                          city: null
                          email: amir@danpheit.com
                          hours: null
                          phone: null
                          state: null
                          token: qgUpmwfwPpCiVmrQTnw6DZQR
                          email2: null
                          income: null
                          invest: null
                          phone2: null
                          reason: null
                          status: new
                          address: null
                          address2: null
                          interest: null
                          phone_id: null
                          best_time: null
                          full_name: amir@danpheit.com
                          last_name: null
                          lead_type: null
                          time_zone: null
                          activities:
                            - id: 7
                              title: >-
                                A customer with the email address
                                amir@danpheit.com has added items to their cart
                              read_at: null
                              user_id: 5
                              company_id: 980190962
                              created_at: '2023-12-26T08:36:49.185Z'
                              description: >-
                                Products in the cart:<br><a href =
                                'http://fluid.lvh.me:3000/32c44e/shop/aerodynamic-aluminum-bag9'>Aerodynamic
                                Aluminum </a>
                              relation_type: Cart
                            - id: 6
                              title: >-
                                A customer with the email address
                                amir@danpheit.com has added items to their cart
                              read_at: null
                              user_id: 5
                              company_id: 980190962
                              created_at: '2023-12-26T08:36:10.350Z'
                              description: >-
                                Products in the cart:<br><a href =
                                'http://fluid.lvh.me:3000/32c44e/shop/aerodynamic-aluminum-bag9'>Aerodynamic
                                Aluminum </a>
                              relation_type: Cart
                          avatar_url: null
                          country_id: null
                          first_name: null
                          language_id: null
                          postal_code: null
                          requested_at: null
                      timestamp: '2023-12-26T08:39:18.737Z'
                      identifier: contact-170357995820
              example:
                id: 30
                name: contact_updated
                payload:
                  contact:
                    id: 20
                    ip: null
                    city: null
                    email: amir@danpheit.com
                    hours: null
                    phone: null
                    state: null
                    token: qgUpmwfwPpCiVmrQTnw6DZQR
                    email2: null
                    income: null
                    invest: null
                    phone2: null
                    reason: null
                    status: new
                    address: null
                    address2: null
                    interest: null
                    phone_id: null
                    best_time: null
                    full_name: amir@danpheit.com
                    last_name: null
                    lead_type: null
                    time_zone: null
                    activities:
                      - id: 7
                        title: >-
                          A customer with the email address amir@danpheit.com
                          has added items to their cart
                        read_at: null
                        user_id: 5
                        company_id: 980190962
                        created_at: '2023-12-26T08:36:49.185Z'
                        description: >-
                          Products in the cart:<br><a href =
                          'http://fluid.lvh.me:3000/32c44e/shop/aerodynamic-aluminum-bag9'>Aerodynamic
                          Aluminum </a>
                        relation_type: Cart
                      - id: 6
                        title: >-
                          A customer with the email address amir@danpheit.com
                          has added items to their cart
                        read_at: null
                        user_id: 5
                        company_id: 980190962
                        created_at: '2023-12-26T08:36:10.350Z'
                        description: >-
                          Products in the cart:<br><a href =
                          'http://fluid.lvh.me:3000/32c44e/shop/aerodynamic-aluminum-bag9'>Aerodynamic
                          Aluminum </a>
                        relation_type: Cart
                    avatar_url: null
                    country_id: null
                    first_name: null
                    language_id: null
                    postal_code: null
                    requested_at: null
                timestamp: '2023-12-26T08:39:18.737Z'
                identifier: contact-170357995820
      deprecated: false
  /api/company/webhooks/events/event_created:
    get:
      tags:
        - Webhooks
      summary: event_created
      operationId: event_created
      parameters: []
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/event_created'
                  - example:
                      id: 145
                      name: event_created
                      payload:
                        event:
                          id: 1
                          end: '2024-01-01T12:20:00.000Z'
                          url: www.fluid.app
                          alert: true
                          color: '#EF1A65'
                          start: '2024-01-01T11:50:00.000Z'
                          title: Happy New Year
                          active: true
                          time_zone: '-12'
                          description:
                            id: 132
                            body: >-
                              <div>Wishing everyone on Fluid a Happy New
                              Year</div>
                            name: description
                            record_id: 1
                            created_at: '2023-12-28T04:35:43.198Z'
                            updated_at: '2023-12-28T04:35:43.198Z'
                            record_type: Event
                      timestamp: '2023-12-28T04:35:43.296Z'
                      identifier: event-17037381431
              example:
                id: 145
                name: event_created
                payload:
                  event:
                    id: 1
                    end: '2024-01-01T12:20:00.000Z'
                    url: www.fluid.app
                    alert: true
                    color: '#EF1A65'
                    start: '2024-01-01T11:50:00.000Z'
                    title: Happy New Year
                    active: true
                    time_zone: '-12'
                    description:
                      id: 132
                      body: <div>Wishing everyone on Fluid a Happy New Year</div>
                      name: description
                      record_id: 1
                      created_at: '2023-12-28T04:35:43.198Z'
                      updated_at: '2023-12-28T04:35:43.198Z'
                      record_type: Event
                timestamp: '2023-12-28T04:35:43.296Z'
                identifier: event-17037381431
      deprecated: false
  /api/company/webhooks/events/event_deleted:
    get:
      tags:
        - Webhooks
      summary: event_deleted
      operationId: event_deleted
      parameters: []
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/event_deleted'
                  - example:
                      id: 149
                      name: event_deleted
                      payload:
                        event:
                          id: 1
                          end: '2024-01-01T12:20:00.000Z'
                          url: www.fluid.app
                          alert: true
                          color: '#EF1A65'
                          start: '2024-01-01T11:50:00.000Z'
                          title: Happy New Year
                          active: true
                          time_zone: '-12'
                          description:
                            id: 132
                            body: >-
                              <div>Wishing everyone on Fluid a Happy New
                              Year</div>
                            name: description
                            record_id: 1
                            created_at: '2023-12-28T04:35:43.198Z'
                            updated_at: '2023-12-28T04:35:43.198Z'
                            record_type: Event
                      timestamp: '2023-12-28T04:39:54.989Z'
                      identifier: event-17037383941
              example:
                id: 149
                name: event_deleted
                payload:
                  event:
                    id: 1
                    end: '2024-01-01T12:20:00.000Z'
                    url: www.fluid.app
                    alert: true
                    color: '#EF1A65'
                    start: '2024-01-01T11:50:00.000Z'
                    title: Happy New Year
                    active: true
                    time_zone: '-12'
                    description:
                      id: 132
                      body: <div>Wishing everyone on Fluid a Happy New Year</div>
                      name: description
                      record_id: 1
                      created_at: '2023-12-28T04:35:43.198Z'
                      updated_at: '2023-12-28T04:35:43.198Z'
                      record_type: Event
                timestamp: '2023-12-28T04:39:54.989Z'
                identifier: event-17037383941
      deprecated: false
  /api/company/webhooks/events/event_updated:
    get:
      tags:
        - Webhooks
      summary: event_updated
      operationId: event_updated
      parameters: []
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/event_updated'
                  - example:
                      id: 147
                      name: event_updated
                      payload:
                        event:
                          id: 1
                          end: '2024-01-01T12:20:00.000Z'
                          url: www.fluid.app
                          alert: true
                          color: '#EF1A65'
                          start: '2024-01-01T11:50:00.000Z'
                          title: Happy New Year
                          active: true
                          time_zone: '-12'
                          description:
                            id: 132
                            body: >-
                              <div>Wishing everyone on Fluid a Happy New
                              Year</div>
                            name: description
                            record_id: 1
                            created_at: '2023-12-28T04:35:43.198Z'
                            updated_at: '2023-12-28T04:35:43.198Z'
                            record_type: Event
                      timestamp: '2023-12-28T04:36:57.434Z'
                      identifier: event-17037382171
              example:
                id: 147
                name: event_updated
                payload:
                  event:
                    id: 1
                    end: '2024-01-01T12:20:00.000Z'
                    url: www.fluid.app
                    alert: true
                    color: '#EF1A65'
                    start: '2024-01-01T11:50:00.000Z'
                    title: Happy New Year
                    active: true
                    time_zone: '-12'
                    description:
                      id: 132
                      body: <div>Wishing everyone on Fluid a Happy New Year</div>
                      name: description
                      record_id: 1
                      created_at: '2023-12-28T04:35:43.198Z'
                      updated_at: '2023-12-28T04:35:43.198Z'
                      record_type: Event
                timestamp: '2023-12-28T04:36:57.434Z'
                identifier: event-17037382171
      deprecated: false
  /api/company/webhooks/events/order_cancelled:
    get:
      tags:
        - Webhooks
      summary: order_cancelled
      operationId: order_cancelled
      parameters: []
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/order_cancelled'
                  - example:
                      id: 112
                      name: order_cancelled
                      payload:
                        order:
                          cv: 97
                          id: 52
                          qv: 0
                          tax: '0.0'
                          type: null
                          email: ram@gmail.com
                          items:
                            - id: 2
                              sku: QDPF7N2XOR
                              price: 17.32
                              product:
                                id: 113
                                sku: QDPF7N2XOR
                                image:
                                  full: >-
                                    https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                                  mini: >-
                                    https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                                  detail: >-
                                    https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                                leads: 0
                                price: '17.32'
                                title: Aerodynamic Aluminum aaa
                                views: 0
                                active: true
                                images: []
                                public: true
                                vendor: null
                                enrolls: []
                                options: []
                                prompts: []
                                in_stock: true
                                shipping: '0.03'
                                stripped: Optimized clear-thinking access
                                variants:
                                  - id: 113
                                    title: Default Variant
                                    buyable: true
                                    image_url: null
                                    option_value_ids: []
                                    variant_countries:
                                      - id: 686
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 214
                                          iso: US
                                          iso3: USA
                                          name: United States
                                          iso_name: UNITED STATES
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: US
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 687
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 65
                                          iso: FO
                                          iso3: FRO
                                          name: Faroe Islands
                                          iso_name: FAROE ISLANDS
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: FO
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 688
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 92
                                          iso: IN
                                          iso3: IND
                                          name: India
                                          iso_name: INDIA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: IN
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 689
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 146
                                          iso: NI
                                          iso3: NIC
                                          name: Nicaragua
                                          iso_name: NICARAGUA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: NI
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 690
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 172
                                          iso: LC
                                          iso3: LCA
                                          name: Saint Lucia
                                          iso_name: SAINT LUCIA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: LC
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 691
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 66
                                          iso: FJ
                                          iso3: FJI
                                          name: Fiji
                                          iso_name: FIJI
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: FJ
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 692
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 93
                                          iso: ID
                                          iso3: IDN
                                          name: Indonesia
                                          iso_name: INDONESIA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: ID
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 693
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 147
                                          iso: NE
                                          iso3: NER
                                          name: Niger
                                          iso_name: NIGER
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: NE
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 694
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 67
                                          iso: FI
                                          iso3: FIN
                                          name: Finland
                                          iso_name: FINLAND
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: FI
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 695
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 148
                                          iso: NG
                                          iso3: NGA
                                          name: Nigeria
                                          iso_name: NIGERIA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: NG
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                    allow_subscription: true
                                countries:
                                  - id: 214
                                    iso: US
                                    itn: false
                                    iso3: USA
                                    name: United States
                                    state: true
                                    active: true
                                    numcode: 840
                                    address3: false
                                    iso_name: UNITED STATES
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: USD
                                    currency_symbol: $
                                  - id: 65
                                    iso: FO
                                    itn: false
                                    iso3: FRO
                                    name: Faroe Islands
                                    state: true
                                    active: true
                                    numcode: 234
                                    address3: false
                                    iso_name: FAROE ISLANDS
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: DKK
                                    currency_symbol: kr.
                                  - id: 92
                                    iso: IN
                                    itn: false
                                    iso3: IND
                                    name: India
                                    state: true
                                    active: true
                                    numcode: 356
                                    address3: false
                                    iso_name: INDIA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: INR
                                    currency_symbol: ₹
                                  - id: 146
                                    iso: NI
                                    itn: false
                                    iso3: NIC
                                    name: Nicaragua
                                    state: true
                                    active: true
                                    numcode: 558
                                    address3: false
                                    iso_name: NICARAGUA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: NIO
                                    currency_symbol: C$
                                  - id: 172
                                    iso: LC
                                    itn: false
                                    iso3: LCA
                                    name: Saint Lucia
                                    state: true
                                    active: true
                                    numcode: 662
                                    address3: false
                                    iso_name: SAINT LUCIA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: XCD
                                    currency_symbol: $
                                  - id: 66
                                    iso: FJ
                                    itn: false
                                    iso3: FJI
                                    name: Fiji
                                    state: true
                                    active: true
                                    numcode: 242
                                    address3: false
                                    iso_name: FIJI
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: FJD
                                    currency_symbol: $
                                  - id: 93
                                    iso: ID
                                    itn: false
                                    iso3: IDN
                                    name: Indonesia
                                    state: true
                                    active: true
                                    numcode: 360
                                    address3: false
                                    iso_name: INDONESIA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: IDR
                                    currency_symbol: Rp
                                  - id: 147
                                    iso: NE
                                    itn: false
                                    iso3: NER
                                    name: Niger
                                    state: true
                                    active: true
                                    numcode: 562
                                    address3: false
                                    iso_name: NIGER
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: XOF
                                    currency_symbol: Fr
                                  - id: 67
                                    iso: FI
                                    itn: false
                                    iso3: FIN
                                    name: Finland
                                    state: true
                                    active: true
                                    numcode: 246
                                    address3: false
                                    iso_name: FINLAND
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 148
                                    iso: NG
                                    itn: false
                                    iso3: NGA
                                    name: Nigeria
                                    state: true
                                    active: true
                                    numcode: 566
                                    address3: false
                                    iso_name: NIGERIA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: NGN
                                    currency_symbol: ₦
                                  - id: 174
                                    iso: VC
                                    itn: false
                                    iso3: VCT
                                    name: Saint Vincent and the Grenadines
                                    state: true
                                    active: true
                                    numcode: 670
                                    address3: false
                                    iso_name: SAINT VINCENT AND THE GRENADINES
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: XCD
                                    currency_symbol: $
                                  - id: 68
                                    iso: FR
                                    itn: false
                                    iso3: FRA
                                    name: France
                                    state: true
                                    active: true
                                    numcode: 250
                                    address3: false
                                    iso_name: FRANCE
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 94
                                    iso: IR
                                    itn: false
                                    iso3: IRN
                                    name: Iran, Islamic Republic of
                                    state: true
                                    active: true
                                    numcode: 364
                                    address3: false
                                    iso_name: IRAN, ISLAMIC REPUBLIC OF
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: IRR
                                    currency_symbol: ﷼
                                  - id: 149
                                    iso: NU
                                    itn: false
                                    iso3: NIU
                                    name: Niue
                                    state: true
                                    active: true
                                    numcode: 570
                                    address3: false
                                    iso_name: NIUE
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: NZD
                                    currency_symbol: $
                                  - id: 175
                                    iso: WS
                                    itn: false
                                    iso3: WSM
                                    name: Samoa
                                    state: true
                                    active: true
                                    numcode: 882
                                    address3: false
                                    iso_name: SAMOA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: WST
                                    currency_symbol: T
                                  - id: 69
                                    iso: GF
                                    itn: false
                                    iso3: GUF
                                    name: French Guiana
                                    state: true
                                    active: true
                                    numcode: 254
                                    address3: false
                                    iso_name: FRENCH GUIANA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 95
                                    iso: IQ
                                    itn: false
                                    iso3: IRQ
                                    name: Iraq
                                    state: true
                                    active: true
                                    numcode: 368
                                    address3: false
                                    iso_name: IRAQ
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: IQD
                                    currency_symbol: ع.د
                                  - id: 176
                                    iso: SM
                                    itn: false
                                    iso3: SMR
                                    name: San Marino
                                    state: true
                                    active: true
                                    numcode: 674
                                    address3: false
                                    iso_name: SAN MARINO
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 96
                                    iso: IE
                                    itn: false
                                    iso3: IRL
                                    name: Ireland
                                    state: true
                                    active: true
                                    numcode: 372
                                    address3: false
                                    iso_name: IRELAND
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 177
                                    iso: ST
                                    itn: false
                                    iso3: STP
                                    name: Sao Tome and Principe
                                    state: true
                                    active: true
                                    numcode: 678
                                    address3: false
                                    iso_name: SAO TOME AND PRINCIPE
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: STD
                                    currency_symbol: Db
                                  - id: 39
                                    iso: TD
                                    itn: false
                                    iso3: TCD
                                    name: Chad
                                    state: true
                                    active: true
                                    numcode: 148
                                    address3: false
                                    iso_name: CHAD
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: XAF
                                    currency_symbol: CFA
                                  - id: 173
                                    iso: PM
                                    itn: false
                                    iso3: SPM
                                    name: Saint Pierre and Miquelon
                                    state: true
                                    active: true
                                    numcode: 666
                                    address3: false
                                    iso_name: SAINT PIERRE AND MIQUELON
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                image_url: >-
                                  https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                                commission: '10.0'
                                country_id: null
                                share_link: null
                                shopify_id: null
                                description:
                                  id: 122
                                  body: <div>Optimized clear-thinking access</div>
                                  name: description
                                  record_id: 113
                                  created_at: '2023-12-26T04:49:52.800Z'
                                  updated_at: '2023-12-26T06:37:59.551Z'
                                  record_type: Product
                                price_range:
                                  - $17.32
                                  - $17.32
                                country_code: td
                                currency_code: USD
                                display_price: $17.32 (USD)
                                option_values: {}
                                average_rating: 0
                                shopify_handle: null
                                currency_symbol: $
                                default_variant:
                                  id: 113
                                  sku: QDPF7N2XOR
                                  size: 4cm
                                  price: null
                                  title: Default Variant
                                  width: null
                                  active: true
                                  height: null
                                  length: null
                                  weight: 10 kg
                                  hs_code: null
                                  taxable: true
                                  bar_code: null
                                  physical: null
                                  position: 1
                                  image_url: null
                                  is_master: true
                                  created_at: '2023-12-26T04:49:52.811Z'
                                  image_path: null
                                  product_id: 113
                                  shopify_id: null
                                  updated_at: '2023-12-26T08:32:24.878Z'
                                  external_id: null
                                  discarded_at: null
                                  keep_selling: false
                                  option_attrs: []
                                  unit_of_size: null
                                  track_quantity: true
                                  unit_of_weight: null
                                  inventory_policy: none
                                  country_of_origin: null
                                  allow_subscription: true
                                  inventory_quantity: 100
                                  variant_country_id: null
                                  customs_information_shipping: null
                                enroll_products: []
                                wholesale_price: '0.0'
                                subscription_price: '17.32'
                                unlimited_inventory: false
                                publish_to_rep_store: true
                                publish_to_share_tab: true
                                price_range_formatted: $17.32
                                display_wholesale_price: $0.00 (USD)
                                publish_to_retail_store: true
                                display_subscription_price: $17.32 (USD)
                                wholesale_subscription_price: '0.0'
                                display_wholesale_subscription_price: $0.00 (USD)
                              quantity: 1
                              ordered_variant: ''
                          phone: null
                          amount: '13.32'
                          rating: 5
                          review: null
                          status: awaiting_shipment
                          contact:
                            id: 17
                            ip: null
                            city: null
                            email: ram@gmail.com
                            hours: null
                            phone: null
                            state: null
                            token: bqy3h61S3bBFSR8QUzocghn4
                            email2: null
                            income: null
                            invest: null
                            phone2: null
                            reason: null
                            status: new
                            address: null
                            address2: null
                            interest: null
                            phone_id: null
                            best_time: null
                            full_name: Ram Khanka
                            last_name: Khanka
                            lead_type: null
                            time_zone: null
                            avatar_url: null
                            country_id: null
                            first_name: Ram
                            language_id: null
                            postal_code: null
                            requested_at: null
                          ship_to:
                            id: 980190965
                            city: x
                            name: Ram Khanka
                            state: Alaska
                            country:
                              id: 214
                              iso: US
                              itn: false
                              iso3: USA
                              name: United States
                              state: true
                              active: true
                              default: true
                              numcode: 840
                              address3: false
                              iso_name: UNITED STATES
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              created_at: '2023-12-26T04:48:23.479Z'
                              updated_at: '2023-12-26T04:48:23.479Z'
                              currency_code: USD
                              geo_entity_id: null
                              currency_symbol: $
                            default: false
                            address1: a
                            address2: b
                            address3: null
                            postal_code: '11111'
                            country_code: null
                          referrer: null
                          shipping: '0.0'
                          subtotal: '17.32'
                          tracking: null
                          last_name: Khanka
                          sale_date: '2023-12-26T00:00:00.000Z'
                          created_at: '2023-12-26T08:28:26.141Z'
                          first_name: Rama
                          order_type: purchased
                          refundable: true
                          display_tax: $0.00 (USD)
                          order_number: F17227665844
                          currency_code: USD
                          display_amount: $13.32 (USD)
                          currency_symbol: $
                          display_refunds: (3 CV, 0 QV) -$4.00 (USD)
                          friendly_status: paid
                          order_thumbnail: >-
                            https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                          display_discount: $0.00 (USD)
                          display_shipping: $0.00 (USD)
                          display_subtotal: $17.32 (USD)
                          max_refundable_tax: '0.0'
                          recognized_ship_date: null
                          max_refundable_amount: '13.32'
                          tracking_informations: []
                          max_refundable_shipping: '0.0'
                          max_refundable_product_price: '13.32'
                      timestamp: '2023-12-27T12:37:52.385Z'
                      identifier: order-170368067252
              example:
                id: 112
                name: order_cancelled
                payload:
                  order:
                    cv: 97
                    id: 52
                    qv: 0
                    tax: '0.0'
                    type: null
                    email: ram@gmail.com
                    items:
                      - id: 2
                        sku: QDPF7N2XOR
                        price: 17.32
                        product:
                          id: 113
                          sku: QDPF7N2XOR
                          image:
                            full: >-
                              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                            mini: >-
                              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                            detail: >-
                              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                          leads: 0
                          price: '17.32'
                          title: Aerodynamic Aluminum aaa
                          views: 0
                          active: true
                          images: []
                          public: true
                          vendor: null
                          enrolls: []
                          options: []
                          prompts: []
                          in_stock: true
                          shipping: '0.03'
                          stripped: Optimized clear-thinking access
                          variants:
                            - id: 113
                              title: Default Variant
                              buyable: true
                              image_url: null
                              option_value_ids: []
                              variant_countries:
                                - id: 686
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 214
                                    iso: US
                                    iso3: USA
                                    name: United States
                                    iso_name: UNITED STATES
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: US
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 687
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 65
                                    iso: FO
                                    iso3: FRO
                                    name: Faroe Islands
                                    iso_name: FAROE ISLANDS
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: FO
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 688
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 92
                                    iso: IN
                                    iso3: IND
                                    name: India
                                    iso_name: INDIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: IN
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 689
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 146
                                    iso: NI
                                    iso3: NIC
                                    name: Nicaragua
                                    iso_name: NICARAGUA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: NI
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 690
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 172
                                    iso: LC
                                    iso3: LCA
                                    name: Saint Lucia
                                    iso_name: SAINT LUCIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: LC
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 691
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 66
                                    iso: FJ
                                    iso3: FJI
                                    name: Fiji
                                    iso_name: FIJI
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: FJ
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 692
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 93
                                    iso: ID
                                    iso3: IDN
                                    name: Indonesia
                                    iso_name: INDONESIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: ID
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 693
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 147
                                    iso: NE
                                    iso3: NER
                                    name: Niger
                                    iso_name: NIGER
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: NE
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 694
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 67
                                    iso: FI
                                    iso3: FIN
                                    name: Finland
                                    iso_name: FINLAND
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: FI
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 695
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 148
                                    iso: NG
                                    iso3: NGA
                                    name: Nigeria
                                    iso_name: NIGERIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: NG
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                              allow_subscription: true
                          countries:
                            - id: 214
                              iso: US
                              itn: false
                              iso3: USA
                              name: United States
                              state: true
                              active: true
                              numcode: 840
                              address3: false
                              iso_name: UNITED STATES
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: USD
                              currency_symbol: $
                            - id: 65
                              iso: FO
                              itn: false
                              iso3: FRO
                              name: Faroe Islands
                              state: true
                              active: true
                              numcode: 234
                              address3: false
                              iso_name: FAROE ISLANDS
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: DKK
                              currency_symbol: kr.
                            - id: 92
                              iso: IN
                              itn: false
                              iso3: IND
                              name: India
                              state: true
                              active: true
                              numcode: 356
                              address3: false
                              iso_name: INDIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: INR
                              currency_symbol: ₹
                            - id: 146
                              iso: NI
                              itn: false
                              iso3: NIC
                              name: Nicaragua
                              state: true
                              active: true
                              numcode: 558
                              address3: false
                              iso_name: NICARAGUA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: NIO
                              currency_symbol: C$
                            - id: 172
                              iso: LC
                              itn: false
                              iso3: LCA
                              name: Saint Lucia
                              state: true
                              active: true
                              numcode: 662
                              address3: false
                              iso_name: SAINT LUCIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XCD
                              currency_symbol: $
                            - id: 66
                              iso: FJ
                              itn: false
                              iso3: FJI
                              name: Fiji
                              state: true
                              active: true
                              numcode: 242
                              address3: false
                              iso_name: FIJI
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: FJD
                              currency_symbol: $
                            - id: 93
                              iso: ID
                              itn: false
                              iso3: IDN
                              name: Indonesia
                              state: true
                              active: true
                              numcode: 360
                              address3: false
                              iso_name: INDONESIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: IDR
                              currency_symbol: Rp
                            - id: 147
                              iso: NE
                              itn: false
                              iso3: NER
                              name: Niger
                              state: true
                              active: true
                              numcode: 562
                              address3: false
                              iso_name: NIGER
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XOF
                              currency_symbol: Fr
                            - id: 67
                              iso: FI
                              itn: false
                              iso3: FIN
                              name: Finland
                              state: true
                              active: true
                              numcode: 246
                              address3: false
                              iso_name: FINLAND
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 148
                              iso: NG
                              itn: false
                              iso3: NGA
                              name: Nigeria
                              state: true
                              active: true
                              numcode: 566
                              address3: false
                              iso_name: NIGERIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: NGN
                              currency_symbol: ₦
                            - id: 174
                              iso: VC
                              itn: false
                              iso3: VCT
                              name: Saint Vincent and the Grenadines
                              state: true
                              active: true
                              numcode: 670
                              address3: false
                              iso_name: SAINT VINCENT AND THE GRENADINES
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XCD
                              currency_symbol: $
                            - id: 68
                              iso: FR
                              itn: false
                              iso3: FRA
                              name: France
                              state: true
                              active: true
                              numcode: 250
                              address3: false
                              iso_name: FRANCE
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 94
                              iso: IR
                              itn: false
                              iso3: IRN
                              name: Iran, Islamic Republic of
                              state: true
                              active: true
                              numcode: 364
                              address3: false
                              iso_name: IRAN, ISLAMIC REPUBLIC OF
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: IRR
                              currency_symbol: ﷼
                            - id: 149
                              iso: NU
                              itn: false
                              iso3: NIU
                              name: Niue
                              state: true
                              active: true
                              numcode: 570
                              address3: false
                              iso_name: NIUE
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: NZD
                              currency_symbol: $
                            - id: 175
                              iso: WS
                              itn: false
                              iso3: WSM
                              name: Samoa
                              state: true
                              active: true
                              numcode: 882
                              address3: false
                              iso_name: SAMOA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: WST
                              currency_symbol: T
                            - id: 69
                              iso: GF
                              itn: false
                              iso3: GUF
                              name: French Guiana
                              state: true
                              active: true
                              numcode: 254
                              address3: false
                              iso_name: FRENCH GUIANA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 95
                              iso: IQ
                              itn: false
                              iso3: IRQ
                              name: Iraq
                              state: true
                              active: true
                              numcode: 368
                              address3: false
                              iso_name: IRAQ
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: IQD
                              currency_symbol: ع.د
                            - id: 176
                              iso: SM
                              itn: false
                              iso3: SMR
                              name: San Marino
                              state: true
                              active: true
                              numcode: 674
                              address3: false
                              iso_name: SAN MARINO
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 96
                              iso: IE
                              itn: false
                              iso3: IRL
                              name: Ireland
                              state: true
                              active: true
                              numcode: 372
                              address3: false
                              iso_name: IRELAND
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 177
                              iso: ST
                              itn: false
                              iso3: STP
                              name: Sao Tome and Principe
                              state: true
                              active: true
                              numcode: 678
                              address3: false
                              iso_name: SAO TOME AND PRINCIPE
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: STD
                              currency_symbol: Db
                            - id: 39
                              iso: TD
                              itn: false
                              iso3: TCD
                              name: Chad
                              state: true
                              active: true
                              numcode: 148
                              address3: false
                              iso_name: CHAD
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XAF
                              currency_symbol: CFA
                            - id: 173
                              iso: PM
                              itn: false
                              iso3: SPM
                              name: Saint Pierre and Miquelon
                              state: true
                              active: true
                              numcode: 666
                              address3: false
                              iso_name: SAINT PIERRE AND MIQUELON
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                          image_url: >-
                            https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                          commission: '10.0'
                          country_id: null
                          share_link: null
                          shopify_id: null
                          description:
                            id: 122
                            body: <div>Optimized clear-thinking access</div>
                            name: description
                            record_id: 113
                            created_at: '2023-12-26T04:49:52.800Z'
                            updated_at: '2023-12-26T06:37:59.551Z'
                            record_type: Product
                          price_range:
                            - $17.32
                            - $17.32
                          country_code: td
                          currency_code: USD
                          display_price: $17.32 (USD)
                          option_values: {}
                          average_rating: 0
                          shopify_handle: null
                          currency_symbol: $
                          default_variant:
                            id: 113
                            sku: QDPF7N2XOR
                            size: 4cm
                            price: null
                            title: Default Variant
                            width: null
                            active: true
                            height: null
                            length: null
                            weight: 10 kg
                            hs_code: null
                            taxable: true
                            bar_code: null
                            physical: null
                            position: 1
                            image_url: null
                            is_master: true
                            created_at: '2023-12-26T04:49:52.811Z'
                            image_path: null
                            product_id: 113
                            shopify_id: null
                            updated_at: '2023-12-26T08:32:24.878Z'
                            external_id: null
                            discarded_at: null
                            keep_selling: false
                            option_attrs: []
                            unit_of_size: null
                            track_quantity: true
                            unit_of_weight: null
                            inventory_policy: none
                            country_of_origin: null
                            allow_subscription: true
                            inventory_quantity: 100
                            variant_country_id: null
                            customs_information_shipping: null
                          enroll_products: []
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          unlimited_inventory: false
                          publish_to_rep_store: true
                          publish_to_share_tab: true
                          price_range_formatted: $17.32
                          display_wholesale_price: $0.00 (USD)
                          publish_to_retail_store: true
                          display_subscription_price: $17.32 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        quantity: 1
                        ordered_variant: ''
                    phone: null
                    amount: '13.32'
                    rating: 5
                    review: null
                    status: awaiting_shipment
                    contact:
                      id: 17
                      ip: null
                      city: null
                      email: ram@gmail.com
                      hours: null
                      phone: null
                      state: null
                      token: bqy3h61S3bBFSR8QUzocghn4
                      email2: null
                      income: null
                      invest: null
                      phone2: null
                      reason: null
                      status: new
                      address: null
                      address2: null
                      interest: null
                      phone_id: null
                      best_time: null
                      full_name: Ram Khanka
                      last_name: Khanka
                      lead_type: null
                      time_zone: null
                      avatar_url: null
                      country_id: null
                      first_name: Ram
                      language_id: null
                      postal_code: null
                      requested_at: null
                    ship_to:
                      id: 980190965
                      city: x
                      name: Ram Khanka
                      state: Alaska
                      country:
                        id: 214
                        iso: US
                        itn: false
                        iso3: USA
                        name: United States
                        state: true
                        active: true
                        default: true
                        numcode: 840
                        address3: false
                        iso_name: UNITED STATES
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        created_at: '2023-12-26T04:48:23.479Z'
                        updated_at: '2023-12-26T04:48:23.479Z'
                        currency_code: USD
                        geo_entity_id: null
                        currency_symbol: $
                      default: false
                      address1: a
                      address2: b
                      address3: null
                      postal_code: '11111'
                      country_code: null
                    referrer: null
                    shipping: '0.0'
                    subtotal: '17.32'
                    tracking: null
                    last_name: Khanka
                    sale_date: '2023-12-26T00:00:00.000Z'
                    created_at: '2023-12-26T08:28:26.141Z'
                    first_name: Rama
                    order_type: purchased
                    refundable: true
                    display_tax: $0.00 (USD)
                    order_number: F17227665844
                    currency_code: USD
                    display_amount: $13.32 (USD)
                    currency_symbol: $
                    display_refunds: (3 CV, 0 QV) -$4.00 (USD)
                    friendly_status: paid
                    order_thumbnail: >-
                      https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                    display_discount: $0.00 (USD)
                    display_shipping: $0.00 (USD)
                    display_subtotal: $17.32 (USD)
                    max_refundable_tax: '0.0'
                    recognized_ship_date: null
                    max_refundable_amount: '13.32'
                    tracking_informations: []
                    max_refundable_shipping: '0.0'
                    max_refundable_product_price: '13.32'
                timestamp: '2023-12-27T12:37:52.385Z'
                identifier: order-170368067252
      deprecated: false
  /api/company/webhooks/events/order_completed:
    get:
      tags:
        - Webhooks
      summary: order_completed
      operationId: order_completed
      parameters: []
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/order_completed'
                  - example:
                      id: 114
                      name: order_completed
                      payload:
                        order:
                          cv: 97
                          id: 52
                          qv: 0
                          tax: '0.0'
                          type: null
                          email: ram@gmail.com
                          items:
                            - id: 2
                              sku: QDPF7N2XOR
                              price: 17.32
                              product:
                                id: 113
                                sku: QDPF7N2XOR
                                image:
                                  full: >-
                                    https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                                  mini: >-
                                    https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                                  detail: >-
                                    https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                                leads: 0
                                price: '17.32'
                                title: Aerodynamic Aluminum aaa
                                views: 0
                                active: true
                                images: []
                                public: true
                                vendor: null
                                enrolls: []
                                options: []
                                prompts: []
                                in_stock: true
                                shipping: '0.03'
                                stripped: Optimized clear-thinking access
                                variants:
                                  - id: 113
                                    title: Default Variant
                                    buyable: true
                                    image_url: null
                                    option_value_ids: []
                                    variant_countries:
                                      - id: 686
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 214
                                          iso: US
                                          iso3: USA
                                          name: United States
                                          iso_name: UNITED STATES
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: US
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 687
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 65
                                          iso: FO
                                          iso3: FRO
                                          name: Faroe Islands
                                          iso_name: FAROE ISLANDS
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: FO
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 688
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 92
                                          iso: IN
                                          iso3: IND
                                          name: India
                                          iso_name: INDIA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: IN
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 689
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 146
                                          iso: NI
                                          iso3: NIC
                                          name: Nicaragua
                                          iso_name: NICARAGUA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: NI
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 690
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 172
                                          iso: LC
                                          iso3: LCA
                                          name: Saint Lucia
                                          iso_name: SAINT LUCIA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: LC
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 691
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 66
                                          iso: FJ
                                          iso3: FJI
                                          name: Fiji
                                          iso_name: FIJI
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: FJ
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 692
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 93
                                          iso: ID
                                          iso3: IDN
                                          name: Indonesia
                                          iso_name: INDONESIA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: ID
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 693
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 147
                                          iso: NE
                                          iso3: NER
                                          name: Niger
                                          iso_name: NIGER
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: NE
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 694
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 67
                                          iso: FI
                                          iso3: FIN
                                          name: Finland
                                          iso_name: FINLAND
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: FI
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 695
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 148
                                          iso: NG
                                          iso3: NGA
                                          name: Nigeria
                                          iso_name: NIGERIA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: NG
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                    allow_subscription: true
                                countries:
                                  - id: 214
                                    iso: US
                                    itn: false
                                    iso3: USA
                                    name: United States
                                    state: true
                                    active: true
                                    numcode: 840
                                    address3: false
                                    iso_name: UNITED STATES
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: USD
                                    currency_symbol: $
                                  - id: 65
                                    iso: FO
                                    itn: false
                                    iso3: FRO
                                    name: Faroe Islands
                                    state: true
                                    active: true
                                    numcode: 234
                                    address3: false
                                    iso_name: FAROE ISLANDS
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: DKK
                                    currency_symbol: kr.
                                  - id: 92
                                    iso: IN
                                    itn: false
                                    iso3: IND
                                    name: India
                                    state: true
                                    active: true
                                    numcode: 356
                                    address3: false
                                    iso_name: INDIA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: INR
                                    currency_symbol: ₹
                                  - id: 146
                                    iso: NI
                                    itn: false
                                    iso3: NIC
                                    name: Nicaragua
                                    state: true
                                    active: true
                                    numcode: 558
                                    address3: false
                                    iso_name: NICARAGUA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: NIO
                                    currency_symbol: C$
                                  - id: 172
                                    iso: LC
                                    itn: false
                                    iso3: LCA
                                    name: Saint Lucia
                                    state: true
                                    active: true
                                    numcode: 662
                                    address3: false
                                    iso_name: SAINT LUCIA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: XCD
                                    currency_symbol: $
                                  - id: 66
                                    iso: FJ
                                    itn: false
                                    iso3: FJI
                                    name: Fiji
                                    state: true
                                    active: true
                                    numcode: 242
                                    address3: false
                                    iso_name: FIJI
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: FJD
                                    currency_symbol: $
                                  - id: 93
                                    iso: ID
                                    itn: false
                                    iso3: IDN
                                    name: Indonesia
                                    state: true
                                    active: true
                                    numcode: 360
                                    address3: false
                                    iso_name: INDONESIA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: IDR
                                    currency_symbol: Rp
                                  - id: 147
                                    iso: NE
                                    itn: false
                                    iso3: NER
                                    name: Niger
                                    state: true
                                    active: true
                                    numcode: 562
                                    address3: false
                                    iso_name: NIGER
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: XOF
                                    currency_symbol: Fr
                                  - id: 67
                                    iso: FI
                                    itn: false
                                    iso3: FIN
                                    name: Finland
                                    state: true
                                    active: true
                                    numcode: 246
                                    address3: false
                                    iso_name: FINLAND
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 148
                                    iso: NG
                                    itn: false
                                    iso3: NGA
                                    name: Nigeria
                                    state: true
                                    active: true
                                    numcode: 566
                                    address3: false
                                    iso_name: NIGERIA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: NGN
                                    currency_symbol: ₦
                                  - id: 174
                                    iso: VC
                                    itn: false
                                    iso3: VCT
                                    name: Saint Vincent and the Grenadines
                                    state: true
                                    active: true
                                    numcode: 670
                                    address3: false
                                    iso_name: SAINT VINCENT AND THE GRENADINES
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: XCD
                                    currency_symbol: $
                                  - id: 68
                                    iso: FR
                                    itn: false
                                    iso3: FRA
                                    name: France
                                    state: true
                                    active: true
                                    numcode: 250
                                    address3: false
                                    iso_name: FRANCE
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 94
                                    iso: IR
                                    itn: false
                                    iso3: IRN
                                    name: Iran, Islamic Republic of
                                    state: true
                                    active: true
                                    numcode: 364
                                    address3: false
                                    iso_name: IRAN, ISLAMIC REPUBLIC OF
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: IRR
                                    currency_symbol: ﷼
                                  - id: 149
                                    iso: NU
                                    itn: false
                                    iso3: NIU
                                    name: Niue
                                    state: true
                                    active: true
                                    numcode: 570
                                    address3: false
                                    iso_name: NIUE
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: NZD
                                    currency_symbol: $
                                  - id: 175
                                    iso: WS
                                    itn: false
                                    iso3: WSM
                                    name: Samoa
                                    state: true
                                    active: true
                                    numcode: 882
                                    address3: false
                                    iso_name: SAMOA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: WST
                                    currency_symbol: T
                                  - id: 69
                                    iso: GF
                                    itn: false
                                    iso3: GUF
                                    name: French Guiana
                                    state: true
                                    active: true
                                    numcode: 254
                                    address3: false
                                    iso_name: FRENCH GUIANA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 95
                                    iso: IQ
                                    itn: false
                                    iso3: IRQ
                                    name: Iraq
                                    state: true
                                    active: true
                                    numcode: 368
                                    address3: false
                                    iso_name: IRAQ
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: IQD
                                    currency_symbol: ع.د
                                  - id: 176
                                    iso: SM
                                    itn: false
                                    iso3: SMR
                                    name: San Marino
                                    state: true
                                    active: true
                                    numcode: 674
                                    address3: false
                                    iso_name: SAN MARINO
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 96
                                    iso: IE
                                    itn: false
                                    iso3: IRL
                                    name: Ireland
                                    state: true
                                    active: true
                                    numcode: 372
                                    address3: false
                                    iso_name: IRELAND
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 177
                                    iso: ST
                                    itn: false
                                    iso3: STP
                                    name: Sao Tome and Principe
                                    state: true
                                    active: true
                                    numcode: 678
                                    address3: false
                                    iso_name: SAO TOME AND PRINCIPE
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: STD
                                    currency_symbol: Db
                                  - id: 39
                                    iso: TD
                                    itn: false
                                    iso3: TCD
                                    name: Chad
                                    state: true
                                    active: true
                                    numcode: 148
                                    address3: false
                                    iso_name: CHAD
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: XAF
                                    currency_symbol: CFA
                                  - id: 173
                                    iso: PM
                                    itn: false
                                    iso3: SPM
                                    name: Saint Pierre and Miquelon
                                    state: true
                                    active: true
                                    numcode: 666
                                    address3: false
                                    iso_name: SAINT PIERRE AND MIQUELON
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                image_url: >-
                                  https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                                commission: '10.0'
                                country_id: null
                                share_link: null
                                shopify_id: null
                                description:
                                  id: 122
                                  body: <div>Optimized clear-thinking access</div>
                                  name: description
                                  record_id: 113
                                  created_at: '2023-12-26T04:49:52.800Z'
                                  updated_at: '2023-12-26T06:37:59.551Z'
                                  record_type: Product
                                price_range:
                                  - $17.32
                                  - $17.32
                                country_code: td
                                currency_code: USD
                                display_price: $17.32 (USD)
                                option_values: {}
                                average_rating: 0
                                shopify_handle: null
                                currency_symbol: $
                                default_variant:
                                  id: 113
                                  sku: QDPF7N2XOR
                                  size: 4cm
                                  price: null
                                  title: Default Variant
                                  width: null
                                  active: true
                                  height: null
                                  length: null
                                  weight: 10 kg
                                  hs_code: null
                                  taxable: true
                                  bar_code: null
                                  physical: null
                                  position: 1
                                  image_url: null
                                  is_master: true
                                  created_at: '2023-12-26T04:49:52.811Z'
                                  image_path: null
                                  product_id: 113
                                  shopify_id: null
                                  updated_at: '2023-12-26T08:32:24.878Z'
                                  external_id: null
                                  discarded_at: null
                                  keep_selling: false
                                  option_attrs: []
                                  unit_of_size: null
                                  track_quantity: true
                                  unit_of_weight: null
                                  inventory_policy: none
                                  country_of_origin: null
                                  allow_subscription: true
                                  inventory_quantity: 100
                                  variant_country_id: null
                                  customs_information_shipping: null
                                enroll_products: []
                                wholesale_price: '0.0'
                                subscription_price: '17.32'
                                unlimited_inventory: false
                                publish_to_rep_store: true
                                publish_to_share_tab: true
                                price_range_formatted: $17.32
                                display_wholesale_price: $0.00 (USD)
                                publish_to_retail_store: true
                                display_subscription_price: $17.32 (USD)
                                wholesale_subscription_price: '0.0'
                                display_wholesale_subscription_price: $0.00 (USD)
                              quantity: 1
                              ordered_variant: ''
                          phone: null
                          amount: '13.32'
                          rating: 4
                          review: null
                          status: awaiting_shipment
                          contact:
                            id: 17
                            ip: null
                            city: null
                            email: ram@gmail.com
                            hours: null
                            phone: null
                            state: null
                            token: bqy3h61S3bBFSR8QUzocghn4
                            email2: null
                            income: null
                            invest: null
                            phone2: null
                            reason: null
                            status: new
                            address: null
                            address2: null
                            interest: null
                            phone_id: null
                            best_time: null
                            full_name: Ram Khanka
                            last_name: Khanka
                            lead_type: null
                            time_zone: null
                            avatar_url: null
                            country_id: null
                            first_name: Ram
                            language_id: null
                            postal_code: null
                            requested_at: null
                          ship_to:
                            id: 980190965
                            city: x
                            name: Ram Khanka
                            state: Alaska
                            country:
                              id: 214
                              iso: US
                              itn: false
                              iso3: USA
                              name: United States
                              state: true
                              active: true
                              default: true
                              numcode: 840
                              address3: false
                              iso_name: UNITED STATES
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              created_at: '2023-12-26T04:48:23.479Z'
                              updated_at: '2023-12-26T04:48:23.479Z'
                              currency_code: USD
                              geo_entity_id: null
                              currency_symbol: $
                            default: false
                            address1: a
                            address2: b
                            address3: null
                            postal_code: '11111'
                            country_code: null
                          referrer: null
                          shipping: '0.0'
                          subtotal: '17.32'
                          tracking: null
                          last_name: Khanka
                          sale_date: '2023-12-26T00:00:00.000Z'
                          created_at: '2023-12-26T08:28:26.141Z'
                          first_name: Rama
                          order_type: purchased
                          refundable: true
                          display_tax: $0.00 (USD)
                          order_number: F17227665844
                          currency_code: USD
                          display_amount: $13.32 (USD)
                          currency_symbol: $
                          display_refunds: (3 CV, 0 QV) -$4.00 (USD)
                          friendly_status: paid
                          order_thumbnail: >-
                            https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                          display_discount: $0.00 (USD)
                          display_shipping: $0.00 (USD)
                          display_subtotal: $17.32 (USD)
                          max_refundable_tax: '0.0'
                          recognized_ship_date: null
                          max_refundable_amount: '13.32'
                          tracking_informations: []
                          max_refundable_shipping: '0.0'
                          max_refundable_product_price: '13.32'
                      timestamp: '2023-12-27T12:39:26.144Z'
                      identifier: order-170368076652
              example:
                id: 114
                name: order_completed
                payload:
                  order:
                    cv: 97
                    id: 52
                    qv: 0
                    tax: '0.0'
                    type: null
                    email: ram@gmail.com
                    items:
                      - id: 2
                        sku: QDPF7N2XOR
                        price: 17.32
                        product:
                          id: 113
                          sku: QDPF7N2XOR
                          image:
                            full: >-
                              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                            mini: >-
                              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                            detail: >-
                              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                          leads: 0
                          price: '17.32'
                          title: Aerodynamic Aluminum aaa
                          views: 0
                          active: true
                          images: []
                          public: true
                          vendor: null
                          enrolls: []
                          options: []
                          prompts: []
                          in_stock: true
                          shipping: '0.03'
                          stripped: Optimized clear-thinking access
                          variants:
                            - id: 113
                              title: Default Variant
                              buyable: true
                              image_url: null
                              option_value_ids: []
                              variant_countries:
                                - id: 686
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 214
                                    iso: US
                                    iso3: USA
                                    name: United States
                                    iso_name: UNITED STATES
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: US
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 687
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 65
                                    iso: FO
                                    iso3: FRO
                                    name: Faroe Islands
                                    iso_name: FAROE ISLANDS
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: FO
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 688
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 92
                                    iso: IN
                                    iso3: IND
                                    name: India
                                    iso_name: INDIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: IN
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 689
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 146
                                    iso: NI
                                    iso3: NIC
                                    name: Nicaragua
                                    iso_name: NICARAGUA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: NI
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 690
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 172
                                    iso: LC
                                    iso3: LCA
                                    name: Saint Lucia
                                    iso_name: SAINT LUCIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: LC
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 691
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 66
                                    iso: FJ
                                    iso3: FJI
                                    name: Fiji
                                    iso_name: FIJI
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: FJ
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 692
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 93
                                    iso: ID
                                    iso3: IDN
                                    name: Indonesia
                                    iso_name: INDONESIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: ID
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 693
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 147
                                    iso: NE
                                    iso3: NER
                                    name: Niger
                                    iso_name: NIGER
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: NE
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 694
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 67
                                    iso: FI
                                    iso3: FIN
                                    name: Finland
                                    iso_name: FINLAND
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: FI
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 695
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 148
                                    iso: NG
                                    iso3: NGA
                                    name: Nigeria
                                    iso_name: NIGERIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: NG
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                              allow_subscription: true
                          countries:
                            - id: 214
                              iso: US
                              itn: false
                              iso3: USA
                              name: United States
                              state: true
                              active: true
                              numcode: 840
                              address3: false
                              iso_name: UNITED STATES
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: USD
                              currency_symbol: $
                            - id: 65
                              iso: FO
                              itn: false
                              iso3: FRO
                              name: Faroe Islands
                              state: true
                              active: true
                              numcode: 234
                              address3: false
                              iso_name: FAROE ISLANDS
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: DKK
                              currency_symbol: kr.
                            - id: 92
                              iso: IN
                              itn: false
                              iso3: IND
                              name: India
                              state: true
                              active: true
                              numcode: 356
                              address3: false
                              iso_name: INDIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: INR
                              currency_symbol: ₹
                            - id: 146
                              iso: NI
                              itn: false
                              iso3: NIC
                              name: Nicaragua
                              state: true
                              active: true
                              numcode: 558
                              address3: false
                              iso_name: NICARAGUA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: NIO
                              currency_symbol: C$
                            - id: 172
                              iso: LC
                              itn: false
                              iso3: LCA
                              name: Saint Lucia
                              state: true
                              active: true
                              numcode: 662
                              address3: false
                              iso_name: SAINT LUCIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XCD
                              currency_symbol: $
                            - id: 66
                              iso: FJ
                              itn: false
                              iso3: FJI
                              name: Fiji
                              state: true
                              active: true
                              numcode: 242
                              address3: false
                              iso_name: FIJI
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: FJD
                              currency_symbol: $
                            - id: 93
                              iso: ID
                              itn: false
                              iso3: IDN
                              name: Indonesia
                              state: true
                              active: true
                              numcode: 360
                              address3: false
                              iso_name: INDONESIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: IDR
                              currency_symbol: Rp
                            - id: 147
                              iso: NE
                              itn: false
                              iso3: NER
                              name: Niger
                              state: true
                              active: true
                              numcode: 562
                              address3: false
                              iso_name: NIGER
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XOF
                              currency_symbol: Fr
                            - id: 67
                              iso: FI
                              itn: false
                              iso3: FIN
                              name: Finland
                              state: true
                              active: true
                              numcode: 246
                              address3: false
                              iso_name: FINLAND
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 148
                              iso: NG
                              itn: false
                              iso3: NGA
                              name: Nigeria
                              state: true
                              active: true
                              numcode: 566
                              address3: false
                              iso_name: NIGERIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: NGN
                              currency_symbol: ₦
                            - id: 174
                              iso: VC
                              itn: false
                              iso3: VCT
                              name: Saint Vincent and the Grenadines
                              state: true
                              active: true
                              numcode: 670
                              address3: false
                              iso_name: SAINT VINCENT AND THE GRENADINES
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XCD
                              currency_symbol: $
                            - id: 68
                              iso: FR
                              itn: false
                              iso3: FRA
                              name: France
                              state: true
                              active: true
                              numcode: 250
                              address3: false
                              iso_name: FRANCE
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 94
                              iso: IR
                              itn: false
                              iso3: IRN
                              name: Iran, Islamic Republic of
                              state: true
                              active: true
                              numcode: 364
                              address3: false
                              iso_name: IRAN, ISLAMIC REPUBLIC OF
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: IRR
                              currency_symbol: ﷼
                            - id: 149
                              iso: NU
                              itn: false
                              iso3: NIU
                              name: Niue
                              state: true
                              active: true
                              numcode: 570
                              address3: false
                              iso_name: NIUE
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: NZD
                              currency_symbol: $
                            - id: 175
                              iso: WS
                              itn: false
                              iso3: WSM
                              name: Samoa
                              state: true
                              active: true
                              numcode: 882
                              address3: false
                              iso_name: SAMOA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: WST
                              currency_symbol: T
                            - id: 69
                              iso: GF
                              itn: false
                              iso3: GUF
                              name: French Guiana
                              state: true
                              active: true
                              numcode: 254
                              address3: false
                              iso_name: FRENCH GUIANA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 95
                              iso: IQ
                              itn: false
                              iso3: IRQ
                              name: Iraq
                              state: true
                              active: true
                              numcode: 368
                              address3: false
                              iso_name: IRAQ
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: IQD
                              currency_symbol: ع.د
                            - id: 176
                              iso: SM
                              itn: false
                              iso3: SMR
                              name: San Marino
                              state: true
                              active: true
                              numcode: 674
                              address3: false
                              iso_name: SAN MARINO
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 96
                              iso: IE
                              itn: false
                              iso3: IRL
                              name: Ireland
                              state: true
                              active: true
                              numcode: 372
                              address3: false
                              iso_name: IRELAND
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 177
                              iso: ST
                              itn: false
                              iso3: STP
                              name: Sao Tome and Principe
                              state: true
                              active: true
                              numcode: 678
                              address3: false
                              iso_name: SAO TOME AND PRINCIPE
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: STD
                              currency_symbol: Db
                            - id: 39
                              iso: TD
                              itn: false
                              iso3: TCD
                              name: Chad
                              state: true
                              active: true
                              numcode: 148
                              address3: false
                              iso_name: CHAD
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XAF
                              currency_symbol: CFA
                            - id: 173
                              iso: PM
                              itn: false
                              iso3: SPM
                              name: Saint Pierre and Miquelon
                              state: true
                              active: true
                              numcode: 666
                              address3: false
                              iso_name: SAINT PIERRE AND MIQUELON
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                          image_url: >-
                            https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                          commission: '10.0'
                          country_id: null
                          share_link: null
                          shopify_id: null
                          description:
                            id: 122
                            body: <div>Optimized clear-thinking access</div>
                            name: description
                            record_id: 113
                            created_at: '2023-12-26T04:49:52.800Z'
                            updated_at: '2023-12-26T06:37:59.551Z'
                            record_type: Product
                          price_range:
                            - $17.32
                            - $17.32
                          country_code: td
                          currency_code: USD
                          display_price: $17.32 (USD)
                          option_values: {}
                          average_rating: 0
                          shopify_handle: null
                          currency_symbol: $
                          default_variant:
                            id: 113
                            sku: QDPF7N2XOR
                            size: 4cm
                            price: null
                            title: Default Variant
                            width: null
                            active: true
                            height: null
                            length: null
                            weight: 10 kg
                            hs_code: null
                            taxable: true
                            bar_code: null
                            physical: null
                            position: 1
                            image_url: null
                            is_master: true
                            created_at: '2023-12-26T04:49:52.811Z'
                            image_path: null
                            product_id: 113
                            shopify_id: null
                            updated_at: '2023-12-26T08:32:24.878Z'
                            external_id: null
                            discarded_at: null
                            keep_selling: false
                            option_attrs: []
                            unit_of_size: null
                            track_quantity: true
                            unit_of_weight: null
                            inventory_policy: none
                            country_of_origin: null
                            allow_subscription: true
                            inventory_quantity: 100
                            variant_country_id: null
                            customs_information_shipping: null
                          enroll_products: []
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          unlimited_inventory: false
                          publish_to_rep_store: true
                          publish_to_share_tab: true
                          price_range_formatted: $17.32
                          display_wholesale_price: $0.00 (USD)
                          publish_to_retail_store: true
                          display_subscription_price: $17.32 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        quantity: 1
                        ordered_variant: ''
                    phone: null
                    amount: '13.32'
                    rating: 4
                    review: null
                    status: awaiting_shipment
                    contact:
                      id: 17
                      ip: null
                      city: null
                      email: ram@gmail.com
                      hours: null
                      phone: null
                      state: null
                      token: bqy3h61S3bBFSR8QUzocghn4
                      email2: null
                      income: null
                      invest: null
                      phone2: null
                      reason: null
                      status: new
                      address: null
                      address2: null
                      interest: null
                      phone_id: null
                      best_time: null
                      full_name: Ram Khanka
                      last_name: Khanka
                      lead_type: null
                      time_zone: null
                      avatar_url: null
                      country_id: null
                      first_name: Ram
                      language_id: null
                      postal_code: null
                      requested_at: null
                    ship_to:
                      id: 980190965
                      city: x
                      name: Ram Khanka
                      state: Alaska
                      country:
                        id: 214
                        iso: US
                        itn: false
                        iso3: USA
                        name: United States
                        state: true
                        active: true
                        default: true
                        numcode: 840
                        address3: false
                        iso_name: UNITED STATES
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        created_at: '2023-12-26T04:48:23.479Z'
                        updated_at: '2023-12-26T04:48:23.479Z'
                        currency_code: USD
                        geo_entity_id: null
                        currency_symbol: $
                      default: false
                      address1: a
                      address2: b
                      address3: null
                      postal_code: '11111'
                      country_code: null
                    referrer: null
                    shipping: '0.0'
                    subtotal: '17.32'
                    tracking: null
                    last_name: Khanka
                    sale_date: '2023-12-26T00:00:00.000Z'
                    created_at: '2023-12-26T08:28:26.141Z'
                    first_name: Rama
                    order_type: purchased
                    refundable: true
                    display_tax: $0.00 (USD)
                    order_number: F17227665844
                    currency_code: USD
                    display_amount: $13.32 (USD)
                    currency_symbol: $
                    display_refunds: (3 CV, 0 QV) -$4.00 (USD)
                    friendly_status: paid
                    order_thumbnail: >-
                      https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                    display_discount: $0.00 (USD)
                    display_shipping: $0.00 (USD)
                    display_subtotal: $17.32 (USD)
                    max_refundable_tax: '0.0'
                    recognized_ship_date: null
                    max_refundable_amount: '13.32'
                    tracking_informations: []
                    max_refundable_shipping: '0.0'
                    max_refundable_product_price: '13.32'
                timestamp: '2023-12-27T12:39:26.144Z'
                identifier: order-170368076652
      deprecated: false
  /api/company/webhooks/events/order_updated:
    get:
      tags:
        - Webhooks
      summary: order_updated
      operationId: order_updated
      parameters: []
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/order_updated'
                  - example:
                      id: 31
                      name: order_updated
                      payload:
                        order:
                          cv: 0
                          id: 52
                          qv: 0
                          tax: '0.0'
                          type: null
                          email: ram@gmail.com
                          items:
                            - id: 2
                              sku: QDPF7N2XOR
                              price: 17.32
                              product:
                                id: 113
                                sku: QDPF7N2XOR
                                image:
                                  full: >-
                                    https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                                  mini: >-
                                    https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                                  detail: >-
                                    https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                                leads: 0
                                price: '17.32'
                                title: 'Aerodynamic Aluminum '
                                views: 0
                                active: true
                                images: []
                                public: true
                                vendor: null
                                enrolls: []
                                options: []
                                prompts: []
                                in_stock: true
                                shipping: '0.03'
                                stripped: Optimized clear-thinking access
                                variants:
                                  - id: 113
                                    title: Default Variant
                                    buyable: true
                                    image_url: null
                                    option_value_ids: []
                                    variant_countries:
                                      - id: 686
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 214
                                          iso: US
                                          iso3: USA
                                          name: United States
                                          iso_name: UNITED STATES
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: US
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 687
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 65
                                          iso: FO
                                          iso3: FRO
                                          name: Faroe Islands
                                          iso_name: FAROE ISLANDS
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: FO
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 688
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 92
                                          iso: IN
                                          iso3: IND
                                          name: India
                                          iso_name: INDIA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: IN
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 689
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 146
                                          iso: NI
                                          iso3: NIC
                                          name: Nicaragua
                                          iso_name: NICARAGUA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: NI
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 690
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 172
                                          iso: LC
                                          iso3: LCA
                                          name: Saint Lucia
                                          iso_name: SAINT LUCIA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: LC
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 691
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 66
                                          iso: FJ
                                          iso3: FJI
                                          name: Fiji
                                          iso_name: FIJI
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: FJ
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 692
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 93
                                          iso: ID
                                          iso3: IDN
                                          name: Indonesia
                                          iso_name: INDONESIA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: ID
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 693
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 147
                                          iso: NE
                                          iso3: NER
                                          name: Niger
                                          iso_name: NIGER
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: NE
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 694
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 67
                                          iso: FI
                                          iso3: FIN
                                          name: Finland
                                          iso_name: FINLAND
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: FI
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 695
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 148
                                          iso: NG
                                          iso3: NGA
                                          name: Nigeria
                                          iso_name: NIGERIA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: NG
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                    allow_subscription: true
                                countries:
                                  - id: 214
                                    iso: US
                                    itn: false
                                    iso3: USA
                                    name: United States
                                    state: true
                                    active: true
                                    numcode: 840
                                    address3: false
                                    iso_name: UNITED STATES
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: USD
                                    currency_symbol: $
                                  - id: 65
                                    iso: FO
                                    itn: false
                                    iso3: FRO
                                    name: Faroe Islands
                                    state: true
                                    active: true
                                    numcode: 234
                                    address3: false
                                    iso_name: FAROE ISLANDS
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: DKK
                                    currency_symbol: kr.
                                  - id: 92
                                    iso: IN
                                    itn: false
                                    iso3: IND
                                    name: India
                                    state: true
                                    active: true
                                    numcode: 356
                                    address3: false
                                    iso_name: INDIA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: INR
                                    currency_symbol: ₹
                                  - id: 146
                                    iso: NI
                                    itn: false
                                    iso3: NIC
                                    name: Nicaragua
                                    state: true
                                    active: true
                                    numcode: 558
                                    address3: false
                                    iso_name: NICARAGUA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: NIO
                                    currency_symbol: C$
                                  - id: 172
                                    iso: LC
                                    itn: false
                                    iso3: LCA
                                    name: Saint Lucia
                                    state: true
                                    active: true
                                    numcode: 662
                                    address3: false
                                    iso_name: SAINT LUCIA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: XCD
                                    currency_symbol: $
                                  - id: 66
                                    iso: FJ
                                    itn: false
                                    iso3: FJI
                                    name: Fiji
                                    state: true
                                    active: true
                                    numcode: 242
                                    address3: false
                                    iso_name: FIJI
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: FJD
                                    currency_symbol: $
                                  - id: 93
                                    iso: ID
                                    itn: false
                                    iso3: IDN
                                    name: Indonesia
                                    state: true
                                    active: true
                                    numcode: 360
                                    address3: false
                                    iso_name: INDONESIA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: IDR
                                    currency_symbol: Rp
                                  - id: 147
                                    iso: NE
                                    itn: false
                                    iso3: NER
                                    name: Niger
                                    state: true
                                    active: true
                                    numcode: 562
                                    address3: false
                                    iso_name: NIGER
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: XOF
                                    currency_symbol: Fr
                                  - id: 67
                                    iso: FI
                                    itn: false
                                    iso3: FIN
                                    name: Finland
                                    state: true
                                    active: true
                                    numcode: 246
                                    address3: false
                                    iso_name: FINLAND
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 148
                                    iso: NG
                                    itn: false
                                    iso3: NGA
                                    name: Nigeria
                                    state: true
                                    active: true
                                    numcode: 566
                                    address3: false
                                    iso_name: NIGERIA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: NGN
                                    currency_symbol: ₦
                                  - id: 174
                                    iso: VC
                                    itn: false
                                    iso3: VCT
                                    name: Saint Vincent and the Grenadines
                                    state: true
                                    active: true
                                    numcode: 670
                                    address3: false
                                    iso_name: SAINT VINCENT AND THE GRENADINES
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: XCD
                                    currency_symbol: $
                                  - id: 68
                                    iso: FR
                                    itn: false
                                    iso3: FRA
                                    name: France
                                    state: true
                                    active: true
                                    numcode: 250
                                    address3: false
                                    iso_name: FRANCE
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 94
                                    iso: IR
                                    itn: false
                                    iso3: IRN
                                    name: Iran, Islamic Republic of
                                    state: true
                                    active: true
                                    numcode: 364
                                    address3: false
                                    iso_name: IRAN, ISLAMIC REPUBLIC OF
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: IRR
                                    currency_symbol: ﷼
                                  - id: 149
                                    iso: NU
                                    itn: false
                                    iso3: NIU
                                    name: Niue
                                    state: true
                                    active: true
                                    numcode: 570
                                    address3: false
                                    iso_name: NIUE
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: NZD
                                    currency_symbol: $
                                  - id: 175
                                    iso: WS
                                    itn: false
                                    iso3: WSM
                                    name: Samoa
                                    state: true
                                    active: true
                                    numcode: 882
                                    address3: false
                                    iso_name: SAMOA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: WST
                                    currency_symbol: T
                                  - id: 69
                                    iso: GF
                                    itn: false
                                    iso3: GUF
                                    name: French Guiana
                                    state: true
                                    active: true
                                    numcode: 254
                                    address3: false
                                    iso_name: FRENCH GUIANA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 95
                                    iso: IQ
                                    itn: false
                                    iso3: IRQ
                                    name: Iraq
                                    state: true
                                    active: true
                                    numcode: 368
                                    address3: false
                                    iso_name: IRAQ
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: IQD
                                    currency_symbol: ع.د
                                  - id: 176
                                    iso: SM
                                    itn: false
                                    iso3: SMR
                                    name: San Marino
                                    state: true
                                    active: true
                                    numcode: 674
                                    address3: false
                                    iso_name: SAN MARINO
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 96
                                    iso: IE
                                    itn: false
                                    iso3: IRL
                                    name: Ireland
                                    state: true
                                    active: true
                                    numcode: 372
                                    address3: false
                                    iso_name: IRELAND
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 177
                                    iso: ST
                                    itn: false
                                    iso3: STP
                                    name: Sao Tome and Principe
                                    state: true
                                    active: true
                                    numcode: 678
                                    address3: false
                                    iso_name: SAO TOME AND PRINCIPE
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: STD
                                    currency_symbol: Db
                                  - id: 39
                                    iso: TD
                                    itn: false
                                    iso3: TCD
                                    name: Chad
                                    state: true
                                    active: true
                                    numcode: 148
                                    address3: false
                                    iso_name: CHAD
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: XAF
                                    currency_symbol: CFA
                                  - id: 173
                                    iso: PM
                                    itn: false
                                    iso3: SPM
                                    name: Saint Pierre and Miquelon
                                    state: true
                                    active: true
                                    numcode: 666
                                    address3: false
                                    iso_name: SAINT PIERRE AND MIQUELON
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                image_url: >-
                                  https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                                commission: '10.0'
                                country_id: null
                                share_link: null
                                shopify_id: null
                                description:
                                  id: 122
                                  body: <div>Optimized clear-thinking access</div>
                                  name: description
                                  record_id: 113
                                  created_at: '2023-12-26T04:49:52.800Z'
                                  updated_at: '2023-12-26T06:37:59.551Z'
                                  record_type: Product
                                price_range:
                                  - $17.32
                                  - $17.32
                                country_code: td
                                currency_code: USD
                                display_price: $17.32 (USD)
                                option_values: {}
                                average_rating: 0
                                shopify_handle: null
                                currency_symbol: $
                                default_variant:
                                  id: 113
                                  sku: QDPF7N2XOR
                                  size: 4cm
                                  price: null
                                  title: Default Variant
                                  width: null
                                  active: true
                                  height: null
                                  length: null
                                  weight: 10 kg
                                  hs_code: null
                                  taxable: true
                                  bar_code: null
                                  physical: null
                                  position: 1
                                  image_url: null
                                  is_master: true
                                  created_at: '2023-12-26T04:49:52.811Z'
                                  image_path: null
                                  product_id: 113
                                  shopify_id: null
                                  updated_at: '2023-12-26T08:32:24.878Z'
                                  external_id: null
                                  discarded_at: null
                                  keep_selling: false
                                  option_attrs: []
                                  unit_of_size: null
                                  track_quantity: true
                                  unit_of_weight: null
                                  inventory_policy: none
                                  country_of_origin: null
                                  allow_subscription: true
                                  inventory_quantity: 100
                                  variant_country_id: null
                                  customs_information_shipping: null
                                enroll_products: []
                                wholesale_price: '0.0'
                                subscription_price: '17.32'
                                unlimited_inventory: false
                                publish_to_rep_store: true
                                publish_to_share_tab: true
                                price_range_formatted: $17.32
                                display_wholesale_price: $0.00 (USD)
                                publish_to_retail_store: true
                                display_subscription_price: $17.32 (USD)
                                wholesale_subscription_price: '0.0'
                                display_wholesale_subscription_price: $0.00 (USD)
                              quantity: 1
                              ordered_variant: ''
                          phone: null
                          amount: '17.32'
                          rating: 3
                          review: null
                          status: awaiting_shipment
                          contact:
                            id: 17
                            ip: null
                            city: null
                            email: ram@gmail.com
                            hours: null
                            phone: null
                            state: null
                            token: bqy3h61S3bBFSR8QUzocghn4
                            email2: null
                            income: null
                            invest: null
                            phone2: null
                            reason: null
                            status: new
                            address: null
                            address2: null
                            interest: null
                            phone_id: null
                            best_time: null
                            full_name: Ram Khanka
                            last_name: Khanka
                            lead_type: null
                            time_zone: null
                            avatar_url: null
                            country_id: null
                            first_name: Ram
                            language_id: null
                            postal_code: null
                            requested_at: null
                          ship_to:
                            id: 980190965
                            city: x
                            name: Ram Khanka
                            state: Alaska
                            country:
                              id: 214
                              iso: US
                              itn: false
                              iso3: USA
                              name: United States
                              state: true
                              active: true
                              default: true
                              numcode: 840
                              address3: false
                              iso_name: UNITED STATES
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              created_at: '2023-12-26T04:48:23.479Z'
                              updated_at: '2023-12-26T04:48:23.479Z'
                              currency_code: USD
                              geo_entity_id: null
                              currency_symbol: $
                            default: false
                            address1: a
                            address2: b
                            address3: null
                            postal_code: '11111'
                            country_code: null
                          referrer: null
                          shipping: '0.0'
                          subtotal: '17.32'
                          tracking: null
                          last_name: Khanka
                          sale_date: '2023-12-26T00:00:00.000Z'
                          created_at: '2023-12-26T08:28:26.141Z'
                          first_name: Rama
                          order_type: purchased
                          refundable: true
                          display_tax: $0.00 (USD)
                          order_number: F17227665844
                          currency_code: USD
                          display_amount: $17.32 (USD)
                          currency_symbol: $
                          display_refunds: (0 CV, 0 QV) -$0.00 (USD)
                          friendly_status: paid
                          order_thumbnail: >-
                            https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                          display_discount: $0.00 (USD)
                          display_shipping: $0.00 (USD)
                          display_subtotal: $17.32 (USD)
                          max_refundable_tax: '0.0'
                          recognized_ship_date: null
                          max_refundable_amount: '17.32'
                          tracking_informations: []
                          max_refundable_shipping: '0.0'
                          max_refundable_product_price: '17.32'
                      timestamp: '2023-12-26T08:40:36.551Z'
                      identifier: order-170358003652
              example:
                id: 31
                name: order_updated
                payload:
                  order:
                    cv: 0
                    id: 52
                    qv: 0
                    tax: '0.0'
                    type: null
                    email: ram@gmail.com
                    items:
                      - id: 2
                        sku: QDPF7N2XOR
                        price: 17.32
                        product:
                          id: 113
                          sku: QDPF7N2XOR
                          image:
                            full: >-
                              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                            mini: >-
                              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                            detail: >-
                              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                          leads: 0
                          price: '17.32'
                          title: 'Aerodynamic Aluminum '
                          views: 0
                          active: true
                          images: []
                          public: true
                          vendor: null
                          enrolls: []
                          options: []
                          prompts: []
                          in_stock: true
                          shipping: '0.03'
                          stripped: Optimized clear-thinking access
                          variants:
                            - id: 113
                              title: Default Variant
                              buyable: true
                              image_url: null
                              option_value_ids: []
                              variant_countries:
                                - id: 686
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 214
                                    iso: US
                                    iso3: USA
                                    name: United States
                                    iso_name: UNITED STATES
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: US
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 687
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 65
                                    iso: FO
                                    iso3: FRO
                                    name: Faroe Islands
                                    iso_name: FAROE ISLANDS
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: FO
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 688
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 92
                                    iso: IN
                                    iso3: IND
                                    name: India
                                    iso_name: INDIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: IN
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 689
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 146
                                    iso: NI
                                    iso3: NIC
                                    name: Nicaragua
                                    iso_name: NICARAGUA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: NI
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 690
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 172
                                    iso: LC
                                    iso3: LCA
                                    name: Saint Lucia
                                    iso_name: SAINT LUCIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: LC
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 691
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 66
                                    iso: FJ
                                    iso3: FJI
                                    name: Fiji
                                    iso_name: FIJI
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: FJ
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 692
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 93
                                    iso: ID
                                    iso3: IDN
                                    name: Indonesia
                                    iso_name: INDONESIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: ID
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 693
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 147
                                    iso: NE
                                    iso3: NER
                                    name: Niger
                                    iso_name: NIGER
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: NE
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 694
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 67
                                    iso: FI
                                    iso3: FIN
                                    name: Finland
                                    iso_name: FINLAND
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: FI
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 695
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 148
                                    iso: NG
                                    iso3: NGA
                                    name: Nigeria
                                    iso_name: NIGERIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: NG
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                              allow_subscription: true
                          countries:
                            - id: 214
                              iso: US
                              itn: false
                              iso3: USA
                              name: United States
                              state: true
                              active: true
                              numcode: 840
                              address3: false
                              iso_name: UNITED STATES
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: USD
                              currency_symbol: $
                            - id: 65
                              iso: FO
                              itn: false
                              iso3: FRO
                              name: Faroe Islands
                              state: true
                              active: true
                              numcode: 234
                              address3: false
                              iso_name: FAROE ISLANDS
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: DKK
                              currency_symbol: kr.
                            - id: 92
                              iso: IN
                              itn: false
                              iso3: IND
                              name: India
                              state: true
                              active: true
                              numcode: 356
                              address3: false
                              iso_name: INDIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: INR
                              currency_symbol: ₹
                            - id: 146
                              iso: NI
                              itn: false
                              iso3: NIC
                              name: Nicaragua
                              state: true
                              active: true
                              numcode: 558
                              address3: false
                              iso_name: NICARAGUA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: NIO
                              currency_symbol: C$
                            - id: 172
                              iso: LC
                              itn: false
                              iso3: LCA
                              name: Saint Lucia
                              state: true
                              active: true
                              numcode: 662
                              address3: false
                              iso_name: SAINT LUCIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XCD
                              currency_symbol: $
                            - id: 66
                              iso: FJ
                              itn: false
                              iso3: FJI
                              name: Fiji
                              state: true
                              active: true
                              numcode: 242
                              address3: false
                              iso_name: FIJI
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: FJD
                              currency_symbol: $
                            - id: 93
                              iso: ID
                              itn: false
                              iso3: IDN
                              name: Indonesia
                              state: true
                              active: true
                              numcode: 360
                              address3: false
                              iso_name: INDONESIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: IDR
                              currency_symbol: Rp
                            - id: 147
                              iso: NE
                              itn: false
                              iso3: NER
                              name: Niger
                              state: true
                              active: true
                              numcode: 562
                              address3: false
                              iso_name: NIGER
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XOF
                              currency_symbol: Fr
                            - id: 67
                              iso: FI
                              itn: false
                              iso3: FIN
                              name: Finland
                              state: true
                              active: true
                              numcode: 246
                              address3: false
                              iso_name: FINLAND
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 148
                              iso: NG
                              itn: false
                              iso3: NGA
                              name: Nigeria
                              state: true
                              active: true
                              numcode: 566
                              address3: false
                              iso_name: NIGERIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: NGN
                              currency_symbol: ₦
                            - id: 174
                              iso: VC
                              itn: false
                              iso3: VCT
                              name: Saint Vincent and the Grenadines
                              state: true
                              active: true
                              numcode: 670
                              address3: false
                              iso_name: SAINT VINCENT AND THE GRENADINES
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XCD
                              currency_symbol: $
                            - id: 68
                              iso: FR
                              itn: false
                              iso3: FRA
                              name: France
                              state: true
                              active: true
                              numcode: 250
                              address3: false
                              iso_name: FRANCE
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 94
                              iso: IR
                              itn: false
                              iso3: IRN
                              name: Iran, Islamic Republic of
                              state: true
                              active: true
                              numcode: 364
                              address3: false
                              iso_name: IRAN, ISLAMIC REPUBLIC OF
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: IRR
                              currency_symbol: ﷼
                            - id: 149
                              iso: NU
                              itn: false
                              iso3: NIU
                              name: Niue
                              state: true
                              active: true
                              numcode: 570
                              address3: false
                              iso_name: NIUE
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: NZD
                              currency_symbol: $
                            - id: 175
                              iso: WS
                              itn: false
                              iso3: WSM
                              name: Samoa
                              state: true
                              active: true
                              numcode: 882
                              address3: false
                              iso_name: SAMOA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: WST
                              currency_symbol: T
                            - id: 69
                              iso: GF
                              itn: false
                              iso3: GUF
                              name: French Guiana
                              state: true
                              active: true
                              numcode: 254
                              address3: false
                              iso_name: FRENCH GUIANA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 95
                              iso: IQ
                              itn: false
                              iso3: IRQ
                              name: Iraq
                              state: true
                              active: true
                              numcode: 368
                              address3: false
                              iso_name: IRAQ
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: IQD
                              currency_symbol: ع.د
                            - id: 176
                              iso: SM
                              itn: false
                              iso3: SMR
                              name: San Marino
                              state: true
                              active: true
                              numcode: 674
                              address3: false
                              iso_name: SAN MARINO
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 96
                              iso: IE
                              itn: false
                              iso3: IRL
                              name: Ireland
                              state: true
                              active: true
                              numcode: 372
                              address3: false
                              iso_name: IRELAND
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 177
                              iso: ST
                              itn: false
                              iso3: STP
                              name: Sao Tome and Principe
                              state: true
                              active: true
                              numcode: 678
                              address3: false
                              iso_name: SAO TOME AND PRINCIPE
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: STD
                              currency_symbol: Db
                            - id: 39
                              iso: TD
                              itn: false
                              iso3: TCD
                              name: Chad
                              state: true
                              active: true
                              numcode: 148
                              address3: false
                              iso_name: CHAD
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XAF
                              currency_symbol: CFA
                            - id: 173
                              iso: PM
                              itn: false
                              iso3: SPM
                              name: Saint Pierre and Miquelon
                              state: true
                              active: true
                              numcode: 666
                              address3: false
                              iso_name: SAINT PIERRE AND MIQUELON
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                          image_url: >-
                            https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                          commission: '10.0'
                          country_id: null
                          share_link: null
                          shopify_id: null
                          description:
                            id: 122
                            body: <div>Optimized clear-thinking access</div>
                            name: description
                            record_id: 113
                            created_at: '2023-12-26T04:49:52.800Z'
                            updated_at: '2023-12-26T06:37:59.551Z'
                            record_type: Product
                          price_range:
                            - $17.32
                            - $17.32
                          country_code: td
                          currency_code: USD
                          display_price: $17.32 (USD)
                          option_values: {}
                          average_rating: 0
                          shopify_handle: null
                          currency_symbol: $
                          default_variant:
                            id: 113
                            sku: QDPF7N2XOR
                            size: 4cm
                            price: null
                            title: Default Variant
                            width: null
                            active: true
                            height: null
                            length: null
                            weight: 10 kg
                            hs_code: null
                            taxable: true
                            bar_code: null
                            physical: null
                            position: 1
                            image_url: null
                            is_master: true
                            created_at: '2023-12-26T04:49:52.811Z'
                            image_path: null
                            product_id: 113
                            shopify_id: null
                            updated_at: '2023-12-26T08:32:24.878Z'
                            external_id: null
                            discarded_at: null
                            keep_selling: false
                            option_attrs: []
                            unit_of_size: null
                            track_quantity: true
                            unit_of_weight: null
                            inventory_policy: none
                            country_of_origin: null
                            allow_subscription: true
                            inventory_quantity: 100
                            variant_country_id: null
                            customs_information_shipping: null
                          enroll_products: []
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          unlimited_inventory: false
                          publish_to_rep_store: true
                          publish_to_share_tab: true
                          price_range_formatted: $17.32
                          display_wholesale_price: $0.00 (USD)
                          publish_to_retail_store: true
                          display_subscription_price: $17.32 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        quantity: 1
                        ordered_variant: ''
                    phone: null
                    amount: '17.32'
                    rating: 3
                    review: null
                    status: awaiting_shipment
                    contact:
                      id: 17
                      ip: null
                      city: null
                      email: ram@gmail.com
                      hours: null
                      phone: null
                      state: null
                      token: bqy3h61S3bBFSR8QUzocghn4
                      email2: null
                      income: null
                      invest: null
                      phone2: null
                      reason: null
                      status: new
                      address: null
                      address2: null
                      interest: null
                      phone_id: null
                      best_time: null
                      full_name: Ram Khanka
                      last_name: Khanka
                      lead_type: null
                      time_zone: null
                      avatar_url: null
                      country_id: null
                      first_name: Ram
                      language_id: null
                      postal_code: null
                      requested_at: null
                    ship_to:
                      id: 980190965
                      city: x
                      name: Ram Khanka
                      state: Alaska
                      country:
                        id: 214
                        iso: US
                        itn: false
                        iso3: USA
                        name: United States
                        state: true
                        active: true
                        default: true
                        numcode: 840
                        address3: false
                        iso_name: UNITED STATES
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        created_at: '2023-12-26T04:48:23.479Z'
                        updated_at: '2023-12-26T04:48:23.479Z'
                        currency_code: USD
                        geo_entity_id: null
                        currency_symbol: $
                      default: false
                      address1: a
                      address2: b
                      address3: null
                      postal_code: '11111'
                      country_code: null
                    referrer: null
                    shipping: '0.0'
                    subtotal: '17.32'
                    tracking: null
                    last_name: Khanka
                    sale_date: '2023-12-26T00:00:00.000Z'
                    created_at: '2023-12-26T08:28:26.141Z'
                    first_name: Rama
                    order_type: purchased
                    refundable: true
                    display_tax: $0.00 (USD)
                    order_number: F17227665844
                    currency_code: USD
                    display_amount: $17.32 (USD)
                    currency_symbol: $
                    display_refunds: (0 CV, 0 QV) -$0.00 (USD)
                    friendly_status: paid
                    order_thumbnail: >-
                      https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                    display_discount: $0.00 (USD)
                    display_shipping: $0.00 (USD)
                    display_subtotal: $17.32 (USD)
                    max_refundable_tax: '0.0'
                    recognized_ship_date: null
                    max_refundable_amount: '17.32'
                    tracking_informations: []
                    max_refundable_shipping: '0.0'
                    max_refundable_product_price: '17.32'
                timestamp: '2023-12-26T08:40:36.551Z'
                identifier: order-170358003652
      deprecated: false
  /api/company/webhooks/events/order_shipped:
    get:
      tags:
        - Webhooks
      summary: order_shipped
      operationId: order_shipped
      parameters: []
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/order_shipped'
                  - example:
                      id: 111
                      name: order_shipped
                      payload:
                        order:
                          cv: 97
                          id: 52
                          qv: 0
                          tax: '0.0'
                          type: null
                          email: ram@gmail.com
                          items:
                            - id: 2
                              sku: QDPF7N2XOR
                              price: 17.32
                              product:
                                id: 113
                                sku: QDPF7N2XOR
                                image:
                                  full: >-
                                    https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                                  mini: >-
                                    https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                                  detail: >-
                                    https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                                leads: 0
                                price: '17.32'
                                title: Aerodynamic Aluminum aaa
                                views: 0
                                active: true
                                images: []
                                public: true
                                vendor: null
                                enrolls: []
                                options: []
                                prompts: []
                                in_stock: true
                                shipping: '0.03'
                                stripped: Optimized clear-thinking access
                                variants:
                                  - id: 113
                                    title: Default Variant
                                    buyable: true
                                    image_url: null
                                    option_value_ids: []
                                    variant_countries:
                                      - id: 686
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 214
                                          iso: US
                                          iso3: USA
                                          name: United States
                                          iso_name: UNITED STATES
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: US
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 687
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 65
                                          iso: FO
                                          iso3: FRO
                                          name: Faroe Islands
                                          iso_name: FAROE ISLANDS
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: FO
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 688
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 92
                                          iso: IN
                                          iso3: IND
                                          name: India
                                          iso_name: INDIA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: IN
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 689
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 146
                                          iso: NI
                                          iso3: NIC
                                          name: Nicaragua
                                          iso_name: NICARAGUA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: NI
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 690
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 172
                                          iso: LC
                                          iso3: LCA
                                          name: Saint Lucia
                                          iso_name: SAINT LUCIA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: LC
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 691
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 66
                                          iso: FJ
                                          iso3: FJI
                                          name: Fiji
                                          iso_name: FIJI
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: FJ
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 692
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 93
                                          iso: ID
                                          iso3: IDN
                                          name: Indonesia
                                          iso_name: INDONESIA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: ID
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 693
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 147
                                          iso: NE
                                          iso3: NER
                                          name: Niger
                                          iso_name: NIGER
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: NE
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 694
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 67
                                          iso: FI
                                          iso3: FIN
                                          name: Finland
                                          iso_name: FINLAND
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: FI
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 695
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 148
                                          iso: NG
                                          iso3: NGA
                                          name: Nigeria
                                          iso_name: NIGERIA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: NG
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                    allow_subscription: true
                                countries:
                                  - id: 214
                                    iso: US
                                    itn: false
                                    iso3: USA
                                    name: United States
                                    state: true
                                    active: true
                                    numcode: 840
                                    address3: false
                                    iso_name: UNITED STATES
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: USD
                                    currency_symbol: $
                                  - id: 65
                                    iso: FO
                                    itn: false
                                    iso3: FRO
                                    name: Faroe Islands
                                    state: true
                                    active: true
                                    numcode: 234
                                    address3: false
                                    iso_name: FAROE ISLANDS
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: DKK
                                    currency_symbol: kr.
                                  - id: 92
                                    iso: IN
                                    itn: false
                                    iso3: IND
                                    name: India
                                    state: true
                                    active: true
                                    numcode: 356
                                    address3: false
                                    iso_name: INDIA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: INR
                                    currency_symbol: ₹
                                  - id: 146
                                    iso: NI
                                    itn: false
                                    iso3: NIC
                                    name: Nicaragua
                                    state: true
                                    active: true
                                    numcode: 558
                                    address3: false
                                    iso_name: NICARAGUA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: NIO
                                    currency_symbol: C$
                                  - id: 172
                                    iso: LC
                                    itn: false
                                    iso3: LCA
                                    name: Saint Lucia
                                    state: true
                                    active: true
                                    numcode: 662
                                    address3: false
                                    iso_name: SAINT LUCIA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: XCD
                                    currency_symbol: $
                                  - id: 66
                                    iso: FJ
                                    itn: false
                                    iso3: FJI
                                    name: Fiji
                                    state: true
                                    active: true
                                    numcode: 242
                                    address3: false
                                    iso_name: FIJI
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: FJD
                                    currency_symbol: $
                                  - id: 93
                                    iso: ID
                                    itn: false
                                    iso3: IDN
                                    name: Indonesia
                                    state: true
                                    active: true
                                    numcode: 360
                                    address3: false
                                    iso_name: INDONESIA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: IDR
                                    currency_symbol: Rp
                                  - id: 147
                                    iso: NE
                                    itn: false
                                    iso3: NER
                                    name: Niger
                                    state: true
                                    active: true
                                    numcode: 562
                                    address3: false
                                    iso_name: NIGER
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: XOF
                                    currency_symbol: Fr
                                  - id: 67
                                    iso: FI
                                    itn: false
                                    iso3: FIN
                                    name: Finland
                                    state: true
                                    active: true
                                    numcode: 246
                                    address3: false
                                    iso_name: FINLAND
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 148
                                    iso: NG
                                    itn: false
                                    iso3: NGA
                                    name: Nigeria
                                    state: true
                                    active: true
                                    numcode: 566
                                    address3: false
                                    iso_name: NIGERIA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: NGN
                                    currency_symbol: ₦
                                  - id: 174
                                    iso: VC
                                    itn: false
                                    iso3: VCT
                                    name: Saint Vincent and the Grenadines
                                    state: true
                                    active: true
                                    numcode: 670
                                    address3: false
                                    iso_name: SAINT VINCENT AND THE GRENADINES
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: XCD
                                    currency_symbol: $
                                  - id: 68
                                    iso: FR
                                    itn: false
                                    iso3: FRA
                                    name: France
                                    state: true
                                    active: true
                                    numcode: 250
                                    address3: false
                                    iso_name: FRANCE
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 94
                                    iso: IR
                                    itn: false
                                    iso3: IRN
                                    name: Iran, Islamic Republic of
                                    state: true
                                    active: true
                                    numcode: 364
                                    address3: false
                                    iso_name: IRAN, ISLAMIC REPUBLIC OF
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: IRR
                                    currency_symbol: ﷼
                                  - id: 149
                                    iso: NU
                                    itn: false
                                    iso3: NIU
                                    name: Niue
                                    state: true
                                    active: true
                                    numcode: 570
                                    address3: false
                                    iso_name: NIUE
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: NZD
                                    currency_symbol: $
                                  - id: 175
                                    iso: WS
                                    itn: false
                                    iso3: WSM
                                    name: Samoa
                                    state: true
                                    active: true
                                    numcode: 882
                                    address3: false
                                    iso_name: SAMOA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: WST
                                    currency_symbol: T
                                  - id: 69
                                    iso: GF
                                    itn: false
                                    iso3: GUF
                                    name: French Guiana
                                    state: true
                                    active: true
                                    numcode: 254
                                    address3: false
                                    iso_name: FRENCH GUIANA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 95
                                    iso: IQ
                                    itn: false
                                    iso3: IRQ
                                    name: Iraq
                                    state: true
                                    active: true
                                    numcode: 368
                                    address3: false
                                    iso_name: IRAQ
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: IQD
                                    currency_symbol: ع.د
                                  - id: 176
                                    iso: SM
                                    itn: false
                                    iso3: SMR
                                    name: San Marino
                                    state: true
                                    active: true
                                    numcode: 674
                                    address3: false
                                    iso_name: SAN MARINO
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 96
                                    iso: IE
                                    itn: false
                                    iso3: IRL
                                    name: Ireland
                                    state: true
                                    active: true
                                    numcode: 372
                                    address3: false
                                    iso_name: IRELAND
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 177
                                    iso: ST
                                    itn: false
                                    iso3: STP
                                    name: Sao Tome and Principe
                                    state: true
                                    active: true
                                    numcode: 678
                                    address3: false
                                    iso_name: SAO TOME AND PRINCIPE
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: STD
                                    currency_symbol: Db
                                  - id: 39
                                    iso: TD
                                    itn: false
                                    iso3: TCD
                                    name: Chad
                                    state: true
                                    active: true
                                    numcode: 148
                                    address3: false
                                    iso_name: CHAD
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: XAF
                                    currency_symbol: CFA
                                  - id: 173
                                    iso: PM
                                    itn: false
                                    iso3: SPM
                                    name: Saint Pierre and Miquelon
                                    state: true
                                    active: true
                                    numcode: 666
                                    address3: false
                                    iso_name: SAINT PIERRE AND MIQUELON
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                image_url: >-
                                  https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                                commission: '10.0'
                                country_id: null
                                share_link: null
                                shopify_id: null
                                description:
                                  id: 122
                                  body: <div>Optimized clear-thinking access</div>
                                  name: description
                                  record_id: 113
                                  created_at: '2023-12-26T04:49:52.800Z'
                                  updated_at: '2023-12-26T06:37:59.551Z'
                                  record_type: Product
                                price_range:
                                  - $17.32
                                  - $17.32
                                country_code: td
                                currency_code: USD
                                display_price: $17.32 (USD)
                                option_values: {}
                                average_rating: 0
                                shopify_handle: null
                                currency_symbol: $
                                default_variant:
                                  id: 113
                                  sku: QDPF7N2XOR
                                  size: 4cm
                                  price: null
                                  title: Default Variant
                                  width: null
                                  active: true
                                  height: null
                                  length: null
                                  weight: 10 kg
                                  hs_code: null
                                  taxable: true
                                  bar_code: null
                                  physical: null
                                  position: 1
                                  image_url: null
                                  is_master: true
                                  created_at: '2023-12-26T04:49:52.811Z'
                                  image_path: null
                                  product_id: 113
                                  shopify_id: null
                                  updated_at: '2023-12-26T08:32:24.878Z'
                                  external_id: null
                                  discarded_at: null
                                  keep_selling: false
                                  option_attrs: []
                                  unit_of_size: null
                                  track_quantity: true
                                  unit_of_weight: null
                                  inventory_policy: none
                                  country_of_origin: null
                                  allow_subscription: true
                                  inventory_quantity: 100
                                  variant_country_id: null
                                  customs_information_shipping: null
                                enroll_products: []
                                wholesale_price: '0.0'
                                subscription_price: '17.32'
                                unlimited_inventory: false
                                publish_to_rep_store: true
                                publish_to_share_tab: true
                                price_range_formatted: $17.32
                                display_wholesale_price: $0.00 (USD)
                                publish_to_retail_store: true
                                display_subscription_price: $17.32 (USD)
                                wholesale_subscription_price: '0.0'
                                display_wholesale_subscription_price: $0.00 (USD)
                              quantity: 1
                              ordered_variant: ''
                          phone: null
                          amount: '13.32'
                          rating: 2
                          review: null
                          status: awaiting_shipment
                          contact:
                            id: 17
                            ip: null
                            city: null
                            email: ram@gmail.com
                            hours: null
                            phone: null
                            state: null
                            token: bqy3h61S3bBFSR8QUzocghn4
                            email2: null
                            income: null
                            invest: null
                            phone2: null
                            reason: null
                            status: new
                            address: null
                            address2: null
                            interest: null
                            phone_id: null
                            best_time: null
                            full_name: Ram Khanka
                            last_name: Khanka
                            lead_type: null
                            time_zone: null
                            avatar_url: null
                            country_id: null
                            first_name: Ram
                            language_id: null
                            postal_code: null
                            requested_at: null
                          ship_to:
                            id: 980190965
                            city: x
                            name: Ram Khanka
                            state: Alaska
                            country:
                              id: 214
                              iso: US
                              itn: false
                              iso3: USA
                              name: United States
                              state: true
                              active: true
                              default: true
                              numcode: 840
                              address3: false
                              iso_name: UNITED STATES
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              created_at: '2023-12-26T04:48:23.479Z'
                              updated_at: '2023-12-26T04:48:23.479Z'
                              currency_code: USD
                              geo_entity_id: null
                              currency_symbol: $
                            default: false
                            address1: a
                            address2: b
                            address3: null
                            postal_code: '11111'
                            country_code: null
                          referrer: null
                          shipping: '0.0'
                          subtotal: '17.32'
                          tracking: null
                          last_name: Khanka
                          sale_date: '2023-12-26T00:00:00.000Z'
                          created_at: '2023-12-26T08:28:26.141Z'
                          first_name: Rama
                          order_type: purchased
                          refundable: true
                          display_tax: $0.00 (USD)
                          order_number: F17227665844
                          currency_code: USD
                          display_amount: $13.32 (USD)
                          currency_symbol: $
                          display_refunds: (3 CV, 0 QV) -$4.00 (USD)
                          friendly_status: paid
                          order_thumbnail: >-
                            https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                          display_discount: $0.00 (USD)
                          display_shipping: $0.00 (USD)
                          display_subtotal: $17.32 (USD)
                          max_refundable_tax: '0.0'
                          recognized_ship_date: null
                          max_refundable_amount: '13.32'
                          tracking_informations: []
                          max_refundable_shipping: '0.0'
                          max_refundable_product_price: '13.32'
                      timestamp: '2023-12-27T12:37:34.409Z'
                      identifier: order-170368065452
              example:
                id: 111
                name: order_shipped
                payload:
                  order:
                    cv: 97
                    id: 52
                    qv: 0
                    tax: '0.0'
                    type: null
                    email: ram@gmail.com
                    items:
                      - id: 2
                        sku: QDPF7N2XOR
                        price: 17.32
                        product:
                          id: 113
                          sku: QDPF7N2XOR
                          image:
                            full: >-
                              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                            mini: >-
                              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                            detail: >-
                              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                          leads: 0
                          price: '17.32'
                          title: Aerodynamic Aluminum aaa
                          views: 0
                          active: true
                          images: []
                          public: true
                          vendor: null
                          enrolls: []
                          options: []
                          prompts: []
                          in_stock: true
                          shipping: '0.03'
                          stripped: Optimized clear-thinking access
                          variants:
                            - id: 113
                              title: Default Variant
                              buyable: true
                              image_url: null
                              option_value_ids: []
                              variant_countries:
                                - id: 686
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 214
                                    iso: US
                                    iso3: USA
                                    name: United States
                                    iso_name: UNITED STATES
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: US
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 687
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 65
                                    iso: FO
                                    iso3: FRO
                                    name: Faroe Islands
                                    iso_name: FAROE ISLANDS
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: FO
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 688
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 92
                                    iso: IN
                                    iso3: IND
                                    name: India
                                    iso_name: INDIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: IN
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 689
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 146
                                    iso: NI
                                    iso3: NIC
                                    name: Nicaragua
                                    iso_name: NICARAGUA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: NI
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 690
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 172
                                    iso: LC
                                    iso3: LCA
                                    name: Saint Lucia
                                    iso_name: SAINT LUCIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: LC
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 691
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 66
                                    iso: FJ
                                    iso3: FJI
                                    name: Fiji
                                    iso_name: FIJI
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: FJ
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 692
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 93
                                    iso: ID
                                    iso3: IDN
                                    name: Indonesia
                                    iso_name: INDONESIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: ID
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 693
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 147
                                    iso: NE
                                    iso3: NER
                                    name: Niger
                                    iso_name: NIGER
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: NE
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 694
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 67
                                    iso: FI
                                    iso3: FIN
                                    name: Finland
                                    iso_name: FINLAND
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: FI
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 695
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 148
                                    iso: NG
                                    iso3: NGA
                                    name: Nigeria
                                    iso_name: NIGERIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: NG
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                              allow_subscription: true
                          countries:
                            - id: 214
                              iso: US
                              itn: false
                              iso3: USA
                              name: United States
                              state: true
                              active: true
                              numcode: 840
                              address3: false
                              iso_name: UNITED STATES
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: USD
                              currency_symbol: $
                            - id: 65
                              iso: FO
                              itn: false
                              iso3: FRO
                              name: Faroe Islands
                              state: true
                              active: true
                              numcode: 234
                              address3: false
                              iso_name: FAROE ISLANDS
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: DKK
                              currency_symbol: kr.
                            - id: 92
                              iso: IN
                              itn: false
                              iso3: IND
                              name: India
                              state: true
                              active: true
                              numcode: 356
                              address3: false
                              iso_name: INDIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: INR
                              currency_symbol: ₹
                            - id: 146
                              iso: NI
                              itn: false
                              iso3: NIC
                              name: Nicaragua
                              state: true
                              active: true
                              numcode: 558
                              address3: false
                              iso_name: NICARAGUA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: NIO
                              currency_symbol: C$
                            - id: 172
                              iso: LC
                              itn: false
                              iso3: LCA
                              name: Saint Lucia
                              state: true
                              active: true
                              numcode: 662
                              address3: false
                              iso_name: SAINT LUCIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XCD
                              currency_symbol: $
                            - id: 66
                              iso: FJ
                              itn: false
                              iso3: FJI
                              name: Fiji
                              state: true
                              active: true
                              numcode: 242
                              address3: false
                              iso_name: FIJI
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: FJD
                              currency_symbol: $
                            - id: 93
                              iso: ID
                              itn: false
                              iso3: IDN
                              name: Indonesia
                              state: true
                              active: true
                              numcode: 360
                              address3: false
                              iso_name: INDONESIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: IDR
                              currency_symbol: Rp
                            - id: 147
                              iso: NE
                              itn: false
                              iso3: NER
                              name: Niger
                              state: true
                              active: true
                              numcode: 562
                              address3: false
                              iso_name: NIGER
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XOF
                              currency_symbol: Fr
                            - id: 67
                              iso: FI
                              itn: false
                              iso3: FIN
                              name: Finland
                              state: true
                              active: true
                              numcode: 246
                              address3: false
                              iso_name: FINLAND
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 148
                              iso: NG
                              itn: false
                              iso3: NGA
                              name: Nigeria
                              state: true
                              active: true
                              numcode: 566
                              address3: false
                              iso_name: NIGERIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: NGN
                              currency_symbol: ₦
                            - id: 174
                              iso: VC
                              itn: false
                              iso3: VCT
                              name: Saint Vincent and the Grenadines
                              state: true
                              active: true
                              numcode: 670
                              address3: false
                              iso_name: SAINT VINCENT AND THE GRENADINES
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XCD
                              currency_symbol: $
                            - id: 68
                              iso: FR
                              itn: false
                              iso3: FRA
                              name: France
                              state: true
                              active: true
                              numcode: 250
                              address3: false
                              iso_name: FRANCE
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 94
                              iso: IR
                              itn: false
                              iso3: IRN
                              name: Iran, Islamic Republic of
                              state: true
                              active: true
                              numcode: 364
                              address3: false
                              iso_name: IRAN, ISLAMIC REPUBLIC OF
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: IRR
                              currency_symbol: ﷼
                            - id: 149
                              iso: NU
                              itn: false
                              iso3: NIU
                              name: Niue
                              state: true
                              active: true
                              numcode: 570
                              address3: false
                              iso_name: NIUE
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: NZD
                              currency_symbol: $
                            - id: 175
                              iso: WS
                              itn: false
                              iso3: WSM
                              name: Samoa
                              state: true
                              active: true
                              numcode: 882
                              address3: false
                              iso_name: SAMOA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: WST
                              currency_symbol: T
                            - id: 69
                              iso: GF
                              itn: false
                              iso3: GUF
                              name: French Guiana
                              state: true
                              active: true
                              numcode: 254
                              address3: false
                              iso_name: FRENCH GUIANA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 95
                              iso: IQ
                              itn: false
                              iso3: IRQ
                              name: Iraq
                              state: true
                              active: true
                              numcode: 368
                              address3: false
                              iso_name: IRAQ
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: IQD
                              currency_symbol: ع.د
                            - id: 176
                              iso: SM
                              itn: false
                              iso3: SMR
                              name: San Marino
                              state: true
                              active: true
                              numcode: 674
                              address3: false
                              iso_name: SAN MARINO
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 96
                              iso: IE
                              itn: false
                              iso3: IRL
                              name: Ireland
                              state: true
                              active: true
                              numcode: 372
                              address3: false
                              iso_name: IRELAND
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 177
                              iso: ST
                              itn: false
                              iso3: STP
                              name: Sao Tome and Principe
                              state: true
                              active: true
                              numcode: 678
                              address3: false
                              iso_name: SAO TOME AND PRINCIPE
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: STD
                              currency_symbol: Db
                            - id: 39
                              iso: TD
                              itn: false
                              iso3: TCD
                              name: Chad
                              state: true
                              active: true
                              numcode: 148
                              address3: false
                              iso_name: CHAD
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XAF
                              currency_symbol: CFA
                            - id: 173
                              iso: PM
                              itn: false
                              iso3: SPM
                              name: Saint Pierre and Miquelon
                              state: true
                              active: true
                              numcode: 666
                              address3: false
                              iso_name: SAINT PIERRE AND MIQUELON
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                          image_url: >-
                            https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                          commission: '10.0'
                          country_id: null
                          share_link: null
                          shopify_id: null
                          description:
                            id: 122
                            body: <div>Optimized clear-thinking access</div>
                            name: description
                            record_id: 113
                            created_at: '2023-12-26T04:49:52.800Z'
                            updated_at: '2023-12-26T06:37:59.551Z'
                            record_type: Product
                          price_range:
                            - $17.32
                            - $17.32
                          country_code: td
                          currency_code: USD
                          display_price: $17.32 (USD)
                          option_values: {}
                          average_rating: 0
                          shopify_handle: null
                          currency_symbol: $
                          default_variant:
                            id: 113
                            sku: QDPF7N2XOR
                            size: 4cm
                            price: null
                            title: Default Variant
                            width: null
                            active: true
                            height: null
                            length: null
                            weight: 10 kg
                            hs_code: null
                            taxable: true
                            bar_code: null
                            physical: null
                            position: 1
                            image_url: null
                            is_master: true
                            created_at: '2023-12-26T04:49:52.811Z'
                            image_path: null
                            product_id: 113
                            shopify_id: null
                            updated_at: '2023-12-26T08:32:24.878Z'
                            external_id: null
                            discarded_at: null
                            keep_selling: false
                            option_attrs: []
                            unit_of_size: null
                            track_quantity: true
                            unit_of_weight: null
                            inventory_policy: none
                            country_of_origin: null
                            allow_subscription: true
                            inventory_quantity: 100
                            variant_country_id: null
                            customs_information_shipping: null
                          enroll_products: []
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          unlimited_inventory: false
                          publish_to_rep_store: true
                          publish_to_share_tab: true
                          price_range_formatted: $17.32
                          display_wholesale_price: $0.00 (USD)
                          publish_to_retail_store: true
                          display_subscription_price: $17.32 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        quantity: 1
                        ordered_variant: ''
                    phone: null
                    amount: '13.32'
                    rating: 2
                    review: null
                    status: awaiting_shipment
                    contact:
                      id: 17
                      ip: null
                      city: null
                      email: ram@gmail.com
                      hours: null
                      phone: null
                      state: null
                      token: bqy3h61S3bBFSR8QUzocghn4
                      email2: null
                      income: null
                      invest: null
                      phone2: null
                      reason: null
                      status: new
                      address: null
                      address2: null
                      interest: null
                      phone_id: null
                      best_time: null
                      full_name: Ram Khanka
                      last_name: Khanka
                      lead_type: null
                      time_zone: null
                      avatar_url: null
                      country_id: null
                      first_name: Ram
                      language_id: null
                      postal_code: null
                      requested_at: null
                    ship_to:
                      id: 980190965
                      city: x
                      name: Ram Khanka
                      state: Alaska
                      country:
                        id: 214
                        iso: US
                        itn: false
                        iso3: USA
                        name: United States
                        state: true
                        active: true
                        default: true
                        numcode: 840
                        address3: false
                        iso_name: UNITED STATES
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        created_at: '2023-12-26T04:48:23.479Z'
                        updated_at: '2023-12-26T04:48:23.479Z'
                        currency_code: USD
                        geo_entity_id: null
                        currency_symbol: $
                      default: false
                      address1: a
                      address2: b
                      address3: null
                      postal_code: '11111'
                      country_code: null
                    referrer: null
                    shipping: '0.0'
                    subtotal: '17.32'
                    tracking: null
                    last_name: Khanka
                    sale_date: '2023-12-26T00:00:00.000Z'
                    created_at: '2023-12-26T08:28:26.141Z'
                    first_name: Rama
                    order_type: purchased
                    refundable: true
                    display_tax: $0.00 (USD)
                    order_number: F17227665844
                    currency_code: USD
                    display_amount: $13.32 (USD)
                    currency_symbol: $
                    display_refunds: (3 CV, 0 QV) -$4.00 (USD)
                    friendly_status: paid
                    order_thumbnail: >-
                      https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                    display_discount: $0.00 (USD)
                    display_shipping: $0.00 (USD)
                    display_subtotal: $17.32 (USD)
                    max_refundable_tax: '0.0'
                    recognized_ship_date: null
                    max_refundable_amount: '13.32'
                    tracking_informations: []
                    max_refundable_shipping: '0.0'
                    max_refundable_product_price: '13.32'
                timestamp: '2023-12-27T12:37:34.409Z'
                identifier: order-170368065452
      deprecated: false
  /api/company/webhooks/events/order_refunded:
    get:
      tags:
        - Webhooks
      summary: order_refunded
      operationId: order_refunded
      parameters: []
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/order_refunded'
                  - example:
                      id: 113
                      name: order_refunded
                      payload:
                        order:
                          cv: 97
                          id: 52
                          qv: 0
                          tax: '0.0'
                          type: null
                          email: ram@gmail.com
                          items:
                            - id: 2
                              sku: QDPF7N2XOR
                              price: 17.32
                              product:
                                id: 113
                                sku: QDPF7N2XOR
                                image:
                                  full: >-
                                    https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                                  mini: >-
                                    https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                                  detail: >-
                                    https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                                leads: 0
                                price: '17.32'
                                title: Aerodynamic Aluminum aaa
                                views: 0
                                active: true
                                images: []
                                public: true
                                vendor: null
                                enrolls: []
                                options: []
                                prompts: []
                                in_stock: true
                                shipping: '0.03'
                                stripped: Optimized clear-thinking access
                                variants:
                                  - id: 113
                                    title: Default Variant
                                    buyable: true
                                    image_url: null
                                    option_value_ids: []
                                    variant_countries:
                                      - id: 686
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 214
                                          iso: US
                                          iso3: USA
                                          name: United States
                                          iso_name: UNITED STATES
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: US
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 687
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 65
                                          iso: FO
                                          iso3: FRO
                                          name: Faroe Islands
                                          iso_name: FAROE ISLANDS
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: FO
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 688
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 92
                                          iso: IN
                                          iso3: IND
                                          name: India
                                          iso_name: INDIA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: IN
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 689
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 146
                                          iso: NI
                                          iso3: NIC
                                          name: Nicaragua
                                          iso_name: NICARAGUA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: NI
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 690
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 172
                                          iso: LC
                                          iso3: LCA
                                          name: Saint Lucia
                                          iso_name: SAINT LUCIA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: LC
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 691
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 66
                                          iso: FJ
                                          iso3: FJI
                                          name: Fiji
                                          iso_name: FIJI
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: FJ
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 692
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 93
                                          iso: ID
                                          iso3: IDN
                                          name: Indonesia
                                          iso_name: INDONESIA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: ID
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 693
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 147
                                          iso: NE
                                          iso3: NER
                                          name: Niger
                                          iso_name: NIGER
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: NE
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 694
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 67
                                          iso: FI
                                          iso3: FIN
                                          name: Finland
                                          iso_name: FINLAND
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: FI
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 695
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 148
                                          iso: NG
                                          iso3: NGA
                                          name: Nigeria
                                          iso_name: NIGERIA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: NG
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                    allow_subscription: true
                                countries:
                                  - id: 214
                                    iso: US
                                    itn: false
                                    iso3: USA
                                    name: United States
                                    state: true
                                    active: true
                                    numcode: 840
                                    address3: false
                                    iso_name: UNITED STATES
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: USD
                                    currency_symbol: $
                                  - id: 65
                                    iso: FO
                                    itn: false
                                    iso3: FRO
                                    name: Faroe Islands
                                    state: true
                                    active: true
                                    numcode: 234
                                    address3: false
                                    iso_name: FAROE ISLANDS
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: DKK
                                    currency_symbol: kr.
                                  - id: 92
                                    iso: IN
                                    itn: false
                                    iso3: IND
                                    name: India
                                    state: true
                                    active: true
                                    numcode: 356
                                    address3: false
                                    iso_name: INDIA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: INR
                                    currency_symbol: ₹
                                  - id: 146
                                    iso: NI
                                    itn: false
                                    iso3: NIC
                                    name: Nicaragua
                                    state: true
                                    active: true
                                    numcode: 558
                                    address3: false
                                    iso_name: NICARAGUA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: NIO
                                    currency_symbol: C$
                                  - id: 172
                                    iso: LC
                                    itn: false
                                    iso3: LCA
                                    name: Saint Lucia
                                    state: true
                                    active: true
                                    numcode: 662
                                    address3: false
                                    iso_name: SAINT LUCIA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: XCD
                                    currency_symbol: $
                                  - id: 66
                                    iso: FJ
                                    itn: false
                                    iso3: FJI
                                    name: Fiji
                                    state: true
                                    active: true
                                    numcode: 242
                                    address3: false
                                    iso_name: FIJI
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: FJD
                                    currency_symbol: $
                                  - id: 93
                                    iso: ID
                                    itn: false
                                    iso3: IDN
                                    name: Indonesia
                                    state: true
                                    active: true
                                    numcode: 360
                                    address3: false
                                    iso_name: INDONESIA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: IDR
                                    currency_symbol: Rp
                                  - id: 147
                                    iso: NE
                                    itn: false
                                    iso3: NER
                                    name: Niger
                                    state: true
                                    active: true
                                    numcode: 562
                                    address3: false
                                    iso_name: NIGER
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: XOF
                                    currency_symbol: Fr
                                  - id: 67
                                    iso: FI
                                    itn: false
                                    iso3: FIN
                                    name: Finland
                                    state: true
                                    active: true
                                    numcode: 246
                                    address3: false
                                    iso_name: FINLAND
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 148
                                    iso: NG
                                    itn: false
                                    iso3: NGA
                                    name: Nigeria
                                    state: true
                                    active: true
                                    numcode: 566
                                    address3: false
                                    iso_name: NIGERIA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: NGN
                                    currency_symbol: ₦
                                  - id: 174
                                    iso: VC
                                    itn: false
                                    iso3: VCT
                                    name: Saint Vincent and the Grenadines
                                    state: true
                                    active: true
                                    numcode: 670
                                    address3: false
                                    iso_name: SAINT VINCENT AND THE GRENADINES
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: XCD
                                    currency_symbol: $
                                  - id: 68
                                    iso: FR
                                    itn: false
                                    iso3: FRA
                                    name: France
                                    state: true
                                    active: true
                                    numcode: 250
                                    address3: false
                                    iso_name: FRANCE
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 94
                                    iso: IR
                                    itn: false
                                    iso3: IRN
                                    name: Iran, Islamic Republic of
                                    state: true
                                    active: true
                                    numcode: 364
                                    address3: false
                                    iso_name: IRAN, ISLAMIC REPUBLIC OF
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: IRR
                                    currency_symbol: ﷼
                                  - id: 149
                                    iso: NU
                                    itn: false
                                    iso3: NIU
                                    name: Niue
                                    state: true
                                    active: true
                                    numcode: 570
                                    address3: false
                                    iso_name: NIUE
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: NZD
                                    currency_symbol: $
                                  - id: 175
                                    iso: WS
                                    itn: false
                                    iso3: WSM
                                    name: Samoa
                                    state: true
                                    active: true
                                    numcode: 882
                                    address3: false
                                    iso_name: SAMOA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: WST
                                    currency_symbol: T
                                  - id: 69
                                    iso: GF
                                    itn: false
                                    iso3: GUF
                                    name: French Guiana
                                    state: true
                                    active: true
                                    numcode: 254
                                    address3: false
                                    iso_name: FRENCH GUIANA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 95
                                    iso: IQ
                                    itn: false
                                    iso3: IRQ
                                    name: Iraq
                                    state: true
                                    active: true
                                    numcode: 368
                                    address3: false
                                    iso_name: IRAQ
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: IQD
                                    currency_symbol: ع.د
                                  - id: 176
                                    iso: SM
                                    itn: false
                                    iso3: SMR
                                    name: San Marino
                                    state: true
                                    active: true
                                    numcode: 674
                                    address3: false
                                    iso_name: SAN MARINO
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 96
                                    iso: IE
                                    itn: false
                                    iso3: IRL
                                    name: Ireland
                                    state: true
                                    active: true
                                    numcode: 372
                                    address3: false
                                    iso_name: IRELAND
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 177
                                    iso: ST
                                    itn: false
                                    iso3: STP
                                    name: Sao Tome and Principe
                                    state: true
                                    active: true
                                    numcode: 678
                                    address3: false
                                    iso_name: SAO TOME AND PRINCIPE
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: STD
                                    currency_symbol: Db
                                  - id: 39
                                    iso: TD
                                    itn: false
                                    iso3: TCD
                                    name: Chad
                                    state: true
                                    active: true
                                    numcode: 148
                                    address3: false
                                    iso_name: CHAD
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: XAF
                                    currency_symbol: CFA
                                  - id: 173
                                    iso: PM
                                    itn: false
                                    iso3: SPM
                                    name: Saint Pierre and Miquelon
                                    state: true
                                    active: true
                                    numcode: 666
                                    address3: false
                                    iso_name: SAINT PIERRE AND MIQUELON
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                image_url: >-
                                  https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                                commission: '10.0'
                                country_id: null
                                share_link: null
                                shopify_id: null
                                description:
                                  id: 122
                                  body: <div>Optimized clear-thinking access</div>
                                  name: description
                                  record_id: 113
                                  created_at: '2023-12-26T04:49:52.800Z'
                                  updated_at: '2023-12-26T06:37:59.551Z'
                                  record_type: Product
                                price_range:
                                  - $17.32
                                  - $17.32
                                country_code: td
                                currency_code: USD
                                display_price: $17.32 (USD)
                                option_values: {}
                                average_rating: 0
                                shopify_handle: null
                                currency_symbol: $
                                default_variant:
                                  id: 113
                                  sku: QDPF7N2XOR
                                  size: 4cm
                                  price: null
                                  title: Default Variant
                                  width: null
                                  active: true
                                  height: null
                                  length: null
                                  weight: 10 kg
                                  hs_code: null
                                  taxable: true
                                  bar_code: null
                                  physical: null
                                  position: 1
                                  image_url: null
                                  is_master: true
                                  created_at: '2023-12-26T04:49:52.811Z'
                                  image_path: null
                                  product_id: 113
                                  shopify_id: null
                                  updated_at: '2023-12-26T08:32:24.878Z'
                                  external_id: null
                                  discarded_at: null
                                  keep_selling: false
                                  option_attrs: []
                                  unit_of_size: null
                                  track_quantity: true
                                  unit_of_weight: null
                                  inventory_policy: none
                                  country_of_origin: null
                                  allow_subscription: true
                                  inventory_quantity: 100
                                  variant_country_id: null
                                  customs_information_shipping: null
                                enroll_products: []
                                wholesale_price: '0.0'
                                subscription_price: '17.32'
                                unlimited_inventory: false
                                publish_to_rep_store: true
                                publish_to_share_tab: true
                                price_range_formatted: $17.32
                                display_wholesale_price: $0.00 (USD)
                                publish_to_retail_store: true
                                display_subscription_price: $17.32 (USD)
                                wholesale_subscription_price: '0.0'
                                display_wholesale_subscription_price: $0.00 (USD)
                              quantity: 1
                              ordered_variant: ''
                          phone: null
                          amount: '13.32'
                          rating: 4
                          review: null
                          status: awaiting_shipment
                          contact:
                            id: 17
                            ip: null
                            city: null
                            email: ram@gmail.com
                            hours: null
                            phone: null
                            state: null
                            token: bqy3h61S3bBFSR8QUzocghn4
                            email2: null
                            income: null
                            invest: null
                            phone2: null
                            reason: null
                            status: new
                            address: null
                            address2: null
                            interest: null
                            phone_id: null
                            best_time: null
                            full_name: Ram Khanka
                            last_name: Khanka
                            lead_type: null
                            time_zone: null
                            avatar_url: null
                            country_id: null
                            first_name: Ram
                            language_id: null
                            postal_code: null
                            requested_at: null
                          ship_to:
                            id: 980190965
                            city: x
                            name: Ram Khanka
                            state: Alaska
                            country:
                              id: 214
                              iso: US
                              itn: false
                              iso3: USA
                              name: United States
                              state: true
                              active: true
                              default: true
                              numcode: 840
                              address3: false
                              iso_name: UNITED STATES
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              created_at: '2023-12-26T04:48:23.479Z'
                              updated_at: '2023-12-26T04:48:23.479Z'
                              currency_code: USD
                              geo_entity_id: null
                              currency_symbol: $
                            default: false
                            address1: a
                            address2: b
                            address3: null
                            postal_code: '11111'
                            country_code: null
                          referrer: null
                          shipping: '0.0'
                          subtotal: '17.32'
                          tracking: null
                          last_name: Khanka
                          sale_date: '2023-12-26T00:00:00.000Z'
                          created_at: '2023-12-26T08:28:26.141Z'
                          first_name: Rama
                          order_type: purchased
                          refundable: true
                          display_tax: $0.00 (USD)
                          order_number: F17227665844
                          currency_code: USD
                          display_amount: $13.32 (USD)
                          currency_symbol: $
                          display_refunds: (3 CV, 0 QV) -$4.00 (USD)
                          friendly_status: paid
                          order_thumbnail: >-
                            https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                          display_discount: $0.00 (USD)
                          display_shipping: $0.00 (USD)
                          display_subtotal: $17.32 (USD)
                          max_refundable_tax: '0.0'
                          recognized_ship_date: null
                          max_refundable_amount: '13.32'
                          tracking_informations: []
                          max_refundable_shipping: '0.0'
                          max_refundable_product_price: '13.32'
                      timestamp: '2023-12-27T12:38:13.187Z'
                      identifier: order-170368069352
              example:
                id: 113
                name: order_refunded
                payload:
                  order:
                    cv: 97
                    id: 52
                    qv: 0
                    tax: '0.0'
                    type: null
                    email: ram@gmail.com
                    items:
                      - id: 2
                        sku: QDPF7N2XOR
                        price: 17.32
                        product:
                          id: 113
                          sku: QDPF7N2XOR
                          image:
                            full: >-
                              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                            mini: >-
                              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                            detail: >-
                              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                          leads: 0
                          price: '17.32'
                          title: Aerodynamic Aluminum aaa
                          views: 0
                          active: true
                          images: []
                          public: true
                          vendor: null
                          enrolls: []
                          options: []
                          prompts: []
                          in_stock: true
                          shipping: '0.03'
                          stripped: Optimized clear-thinking access
                          variants:
                            - id: 113
                              title: Default Variant
                              buyable: true
                              image_url: null
                              option_value_ids: []
                              variant_countries:
                                - id: 686
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 214
                                    iso: US
                                    iso3: USA
                                    name: United States
                                    iso_name: UNITED STATES
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: US
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 687
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 65
                                    iso: FO
                                    iso3: FRO
                                    name: Faroe Islands
                                    iso_name: FAROE ISLANDS
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: FO
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 688
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 92
                                    iso: IN
                                    iso3: IND
                                    name: India
                                    iso_name: INDIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: IN
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 689
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 146
                                    iso: NI
                                    iso3: NIC
                                    name: Nicaragua
                                    iso_name: NICARAGUA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: NI
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 690
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 172
                                    iso: LC
                                    iso3: LCA
                                    name: Saint Lucia
                                    iso_name: SAINT LUCIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: LC
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 691
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 66
                                    iso: FJ
                                    iso3: FJI
                                    name: Fiji
                                    iso_name: FIJI
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: FJ
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 692
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 93
                                    iso: ID
                                    iso3: IDN
                                    name: Indonesia
                                    iso_name: INDONESIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: ID
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 693
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 147
                                    iso: NE
                                    iso3: NER
                                    name: Niger
                                    iso_name: NIGER
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: NE
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 694
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 67
                                    iso: FI
                                    iso3: FIN
                                    name: Finland
                                    iso_name: FINLAND
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: FI
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 695
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 148
                                    iso: NG
                                    iso3: NGA
                                    name: Nigeria
                                    iso_name: NIGERIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: NG
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                              allow_subscription: true
                          countries:
                            - id: 214
                              iso: US
                              itn: false
                              iso3: USA
                              name: United States
                              state: true
                              active: true
                              numcode: 840
                              address3: false
                              iso_name: UNITED STATES
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: USD
                              currency_symbol: $
                            - id: 65
                              iso: FO
                              itn: false
                              iso3: FRO
                              name: Faroe Islands
                              state: true
                              active: true
                              numcode: 234
                              address3: false
                              iso_name: FAROE ISLANDS
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: DKK
                              currency_symbol: kr.
                            - id: 92
                              iso: IN
                              itn: false
                              iso3: IND
                              name: India
                              state: true
                              active: true
                              numcode: 356
                              address3: false
                              iso_name: INDIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: INR
                              currency_symbol: ₹
                            - id: 146
                              iso: NI
                              itn: false
                              iso3: NIC
                              name: Nicaragua
                              state: true
                              active: true
                              numcode: 558
                              address3: false
                              iso_name: NICARAGUA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: NIO
                              currency_symbol: C$
                            - id: 172
                              iso: LC
                              itn: false
                              iso3: LCA
                              name: Saint Lucia
                              state: true
                              active: true
                              numcode: 662
                              address3: false
                              iso_name: SAINT LUCIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XCD
                              currency_symbol: $
                            - id: 66
                              iso: FJ
                              itn: false
                              iso3: FJI
                              name: Fiji
                              state: true
                              active: true
                              numcode: 242
                              address3: false
                              iso_name: FIJI
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: FJD
                              currency_symbol: $
                            - id: 93
                              iso: ID
                              itn: false
                              iso3: IDN
                              name: Indonesia
                              state: true
                              active: true
                              numcode: 360
                              address3: false
                              iso_name: INDONESIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: IDR
                              currency_symbol: Rp
                            - id: 147
                              iso: NE
                              itn: false
                              iso3: NER
                              name: Niger
                              state: true
                              active: true
                              numcode: 562
                              address3: false
                              iso_name: NIGER
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XOF
                              currency_symbol: Fr
                            - id: 67
                              iso: FI
                              itn: false
                              iso3: FIN
                              name: Finland
                              state: true
                              active: true
                              numcode: 246
                              address3: false
                              iso_name: FINLAND
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 148
                              iso: NG
                              itn: false
                              iso3: NGA
                              name: Nigeria
                              state: true
                              active: true
                              numcode: 566
                              address3: false
                              iso_name: NIGERIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: NGN
                              currency_symbol: ₦
                            - id: 174
                              iso: VC
                              itn: false
                              iso3: VCT
                              name: Saint Vincent and the Grenadines
                              state: true
                              active: true
                              numcode: 670
                              address3: false
                              iso_name: SAINT VINCENT AND THE GRENADINES
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XCD
                              currency_symbol: $
                            - id: 68
                              iso: FR
                              itn: false
                              iso3: FRA
                              name: France
                              state: true
                              active: true
                              numcode: 250
                              address3: false
                              iso_name: FRANCE
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 94
                              iso: IR
                              itn: false
                              iso3: IRN
                              name: Iran, Islamic Republic of
                              state: true
                              active: true
                              numcode: 364
                              address3: false
                              iso_name: IRAN, ISLAMIC REPUBLIC OF
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: IRR
                              currency_symbol: ﷼
                            - id: 149
                              iso: NU
                              itn: false
                              iso3: NIU
                              name: Niue
                              state: true
                              active: true
                              numcode: 570
                              address3: false
                              iso_name: NIUE
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: NZD
                              currency_symbol: $
                            - id: 175
                              iso: WS
                              itn: false
                              iso3: WSM
                              name: Samoa
                              state: true
                              active: true
                              numcode: 882
                              address3: false
                              iso_name: SAMOA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: WST
                              currency_symbol: T
                            - id: 69
                              iso: GF
                              itn: false
                              iso3: GUF
                              name: French Guiana
                              state: true
                              active: true
                              numcode: 254
                              address3: false
                              iso_name: FRENCH GUIANA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 95
                              iso: IQ
                              itn: false
                              iso3: IRQ
                              name: Iraq
                              state: true
                              active: true
                              numcode: 368
                              address3: false
                              iso_name: IRAQ
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: IQD
                              currency_symbol: ع.د
                            - id: 176
                              iso: SM
                              itn: false
                              iso3: SMR
                              name: San Marino
                              state: true
                              active: true
                              numcode: 674
                              address3: false
                              iso_name: SAN MARINO
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 96
                              iso: IE
                              itn: false
                              iso3: IRL
                              name: Ireland
                              state: true
                              active: true
                              numcode: 372
                              address3: false
                              iso_name: IRELAND
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 177
                              iso: ST
                              itn: false
                              iso3: STP
                              name: Sao Tome and Principe
                              state: true
                              active: true
                              numcode: 678
                              address3: false
                              iso_name: SAO TOME AND PRINCIPE
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: STD
                              currency_symbol: Db
                            - id: 39
                              iso: TD
                              itn: false
                              iso3: TCD
                              name: Chad
                              state: true
                              active: true
                              numcode: 148
                              address3: false
                              iso_name: CHAD
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XAF
                              currency_symbol: CFA
                            - id: 173
                              iso: PM
                              itn: false
                              iso3: SPM
                              name: Saint Pierre and Miquelon
                              state: true
                              active: true
                              numcode: 666
                              address3: false
                              iso_name: SAINT PIERRE AND MIQUELON
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                          image_url: >-
                            https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                          commission: '10.0'
                          country_id: null
                          share_link: null
                          shopify_id: null
                          description:
                            id: 122
                            body: <div>Optimized clear-thinking access</div>
                            name: description
                            record_id: 113
                            created_at: '2023-12-26T04:49:52.800Z'
                            updated_at: '2023-12-26T06:37:59.551Z'
                            record_type: Product
                          price_range:
                            - $17.32
                            - $17.32
                          country_code: td
                          currency_code: USD
                          display_price: $17.32 (USD)
                          option_values: {}
                          average_rating: 0
                          shopify_handle: null
                          currency_symbol: $
                          default_variant:
                            id: 113
                            sku: QDPF7N2XOR
                            size: 4cm
                            price: null
                            title: Default Variant
                            width: null
                            active: true
                            height: null
                            length: null
                            weight: 10 kg
                            hs_code: null
                            taxable: true
                            bar_code: null
                            physical: null
                            position: 1
                            image_url: null
                            is_master: true
                            created_at: '2023-12-26T04:49:52.811Z'
                            image_path: null
                            product_id: 113
                            shopify_id: null
                            updated_at: '2023-12-26T08:32:24.878Z'
                            external_id: null
                            discarded_at: null
                            keep_selling: false
                            option_attrs: []
                            unit_of_size: null
                            track_quantity: true
                            unit_of_weight: null
                            inventory_policy: none
                            country_of_origin: null
                            allow_subscription: true
                            inventory_quantity: 100
                            variant_country_id: null
                            customs_information_shipping: null
                          enroll_products: []
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          unlimited_inventory: false
                          publish_to_rep_store: true
                          publish_to_share_tab: true
                          price_range_formatted: $17.32
                          display_wholesale_price: $0.00 (USD)
                          publish_to_retail_store: true
                          display_subscription_price: $17.32 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        quantity: 1
                        ordered_variant: ''
                    phone: null
                    amount: '13.32'
                    rating: 4
                    review: null
                    status: awaiting_shipment
                    contact:
                      id: 17
                      ip: null
                      city: null
                      email: ram@gmail.com
                      hours: null
                      phone: null
                      state: null
                      token: bqy3h61S3bBFSR8QUzocghn4
                      email2: null
                      income: null
                      invest: null
                      phone2: null
                      reason: null
                      status: new
                      address: null
                      address2: null
                      interest: null
                      phone_id: null
                      best_time: null
                      full_name: Ram Khanka
                      last_name: Khanka
                      lead_type: null
                      time_zone: null
                      avatar_url: null
                      country_id: null
                      first_name: Ram
                      language_id: null
                      postal_code: null
                      requested_at: null
                    ship_to:
                      id: 980190965
                      city: x
                      name: Ram Khanka
                      state: Alaska
                      country:
                        id: 214
                        iso: US
                        itn: false
                        iso3: USA
                        name: United States
                        state: true
                        active: true
                        default: true
                        numcode: 840
                        address3: false
                        iso_name: UNITED STATES
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        created_at: '2023-12-26T04:48:23.479Z'
                        updated_at: '2023-12-26T04:48:23.479Z'
                        currency_code: USD
                        geo_entity_id: null
                        currency_symbol: $
                      default: false
                      address1: a
                      address2: b
                      address3: null
                      postal_code: '11111'
                      country_code: null
                    referrer: null
                    shipping: '0.0'
                    subtotal: '17.32'
                    tracking: null
                    last_name: Khanka
                    sale_date: '2023-12-26T00:00:00.000Z'
                    created_at: '2023-12-26T08:28:26.141Z'
                    first_name: Rama
                    order_type: purchased
                    refundable: true
                    display_tax: $0.00 (USD)
                    order_number: F17227665844
                    currency_code: USD
                    display_amount: $13.32 (USD)
                    currency_symbol: $
                    display_refunds: (3 CV, 0 QV) -$4.00 (USD)
                    friendly_status: paid
                    order_thumbnail: >-
                      https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                    display_discount: $0.00 (USD)
                    display_shipping: $0.00 (USD)
                    display_subtotal: $17.32 (USD)
                    max_refundable_tax: '0.0'
                    recognized_ship_date: null
                    max_refundable_amount: '13.32'
                    tracking_informations: []
                    max_refundable_shipping: '0.0'
                    max_refundable_product_price: '13.32'
                timestamp: '2023-12-27T12:38:13.187Z'
                identifier: order-170368069352
      deprecated: false
  /api/company/webhooks/events/popup_submitted:
    get:
      tags:
        - Webhooks
      summary: popup_submitted
      operationId: popup_submitted
      parameters: []
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/popup_submitted'
                  - example:
                      id: 140
                      name: popup_submitted
                      payload:
                        popup:
                          id: 1
                          event: timer
                          title: POPPY
                          active: true
                          global: false
                          header: null
                          seconds: 1
                          image_url: ''
                          followable: null
                          popup_type: modal
                          description:
                            id: 130
                            body: <div>THIS IS A POPUP</div>
                            name: description
                            record_id: 1
                            created_at: '2023-12-28T04:10:22.836Z'
                            updated_at: '2023-12-28T04:10:22.836Z'
                            record_type: Popup
                      timestamp: '2023-12-28T04:19:58.261Z'
                      identifier: popup-17037371981
              example:
                id: 140
                name: popup_submitted
                payload:
                  popup:
                    id: 1
                    event: timer
                    title: POPPY
                    active: true
                    global: false
                    header: null
                    seconds: 1
                    image_url: ''
                    followable: null
                    popup_type: modal
                    description:
                      id: 130
                      body: <div>THIS IS A POPUP</div>
                      name: description
                      record_id: 1
                      created_at: '2023-12-28T04:10:22.836Z'
                      updated_at: '2023-12-28T04:10:22.836Z'
                      record_type: Popup
                timestamp: '2023-12-28T04:19:58.261Z'
                identifier: popup-17037371981
      deprecated: false
  /api/company/webhooks/events/product_created:
    get:
      tags:
        - Webhooks
      summary: product_created
      operationId: product_created
      parameters: []
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/product_created'
                  - example:
                      id: 165
                      name: product_created
                      payload:
                        product:
                          id: 115
                          sku: HTPGX14SE7
                          image:
                            full: >-
                              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                            mini: >-
                              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                            detail: >-
                              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                          leads: 0
                          price: null
                          title: Awesome Copper Computer45
                          views: 0
                          active: false
                          images: []
                          public: true
                          vendor: null
                          enrolls: []
                          options: []
                          prompts: []
                          in_stock: true
                          shipping: '4.7'
                          stripped: Reactive intermediate moderator
                          variants:
                            - id: 115
                              title: Default Variant
                              buyable: true
                              image_url: null
                              option_value_ids: []
                              variant_countries:
                                - id: 706
                                  tax: '0.0'
                                  price: '22.27'
                                  country:
                                    id: 214
                                    iso: US
                                    iso3: USA
                                    name: United States
                                    iso_name: UNITED STATES
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: US
                                  currency_code: USD
                                  display_price: $22.27 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '22.27'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 707
                                  tax: '0.0'
                                  price: '22.27'
                                  country:
                                    id: 65
                                    iso: FO
                                    iso3: FRO
                                    name: Faroe Islands
                                    iso_name: FAROE ISLANDS
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: FO
                                  currency_code: USD
                                  display_price: $22.27 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '22.27'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 708
                                  tax: '0.0'
                                  price: '22.27'
                                  country:
                                    id: 92
                                    iso: IN
                                    iso3: IND
                                    name: India
                                    iso_name: INDIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: IN
                                  currency_code: USD
                                  display_price: $22.27 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '22.27'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 709
                                  tax: '0.0'
                                  price: '22.27'
                                  country:
                                    id: 146
                                    iso: NI
                                    iso3: NIC
                                    name: Nicaragua
                                    iso_name: NICARAGUA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: NI
                                  currency_code: USD
                                  display_price: $22.27 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '22.27'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 710
                                  tax: '0.0'
                                  price: '22.27'
                                  country:
                                    id: 172
                                    iso: LC
                                    iso3: LCA
                                    name: Saint Lucia
                                    iso_name: SAINT LUCIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: LC
                                  currency_code: USD
                                  display_price: $22.27 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '22.27'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 711
                                  tax: '0.0'
                                  price: '22.27'
                                  country:
                                    id: 66
                                    iso: FJ
                                    iso3: FJI
                                    name: Fiji
                                    iso_name: FIJI
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: FJ
                                  currency_code: USD
                                  display_price: $22.27 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '22.27'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 712
                                  tax: '0.0'
                                  price: '22.27'
                                  country:
                                    id: 93
                                    iso: ID
                                    iso3: IDN
                                    name: Indonesia
                                    iso_name: INDONESIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: ID
                                  currency_code: USD
                                  display_price: $22.27 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '22.27'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 713
                                  tax: '0.0'
                                  price: '22.27'
                                  country:
                                    id: 147
                                    iso: NE
                                    iso3: NER
                                    name: Niger
                                    iso_name: NIGER
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: NE
                                  currency_code: USD
                                  display_price: $22.27 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '22.27'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 714
                                  tax: '0.0'
                                  price: '22.27'
                                  country:
                                    id: 67
                                    iso: FI
                                    iso3: FIN
                                    name: Finland
                                    iso_name: FINLAND
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: FI
                                  currency_code: USD
                                  display_price: $22.27 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '22.27'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                              allow_subscription: true
                          countries:
                            - id: 214
                              iso: US
                              itn: false
                              iso3: USA
                              name: United States
                              state: true
                              active: true
                              numcode: 840
                              address3: false
                              iso_name: UNITED STATES
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: USD
                              currency_symbol: $
                          image_url: >-
                            https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                          commission: '10.0'
                          country_id: null
                          share_link: null
                          shopify_id: null
                          description:
                            id: 124
                            body: Reactive intermediate moderator
                            name: description
                            record_id: 115
                            created_at: '2023-12-26T04:49:52.800Z'
                            updated_at: '2023-12-26T04:49:52.800Z'
                            record_type: Product
                          price_range:
                            - $22.27
                            - $22.27
                          country_code: us
                          currency_code: USD
                          display_price: ''
                          option_values: null
                          average_rating: 0
                          shopify_handle: null
                          currency_symbol: $
                          default_variant:
                            id: 115
                            sku: HTPGX14SE7
                            size: 2 cm
                            price: null
                            title: Default Variant
                            width: null
                            active: true
                            height: null
                            length: null
                            weight: 20 kg
                            hs_code: null
                            taxable: true
                            bar_code: null
                            physical: null
                            position: 1
                            image_url: null
                            is_master: true
                            created_at: '2023-12-26T04:49:52.811Z'
                            image_path: null
                            product_id: 115
                            shopify_id: null
                            updated_at: '2023-12-26T04:49:52.811Z'
                            external_id: null
                            discarded_at: null
                            keep_selling: false
                            option_attrs: []
                            unit_of_size: null
                            track_quantity: true
                            unit_of_weight: null
                            inventory_policy: none
                            country_of_origin: null
                            allow_subscription: true
                            inventory_quantity: 1
                            variant_country_id: null
                            customs_information_shipping: null
                          enroll_products: []
                          wholesale_price: null
                          subscription_price: null
                          unlimited_inventory: false
                          publish_to_rep_store: true
                          publish_to_share_tab: true
                          price_range_formatted: $22.27
                          display_wholesale_price: ''
                          publish_to_retail_store: true
                          display_subscription_price: null
                          wholesale_subscription_price: null
                          display_wholesale_subscription_price: null
                      timestamp: '2023-12-28T06:55:37.833Z'
                      identifier: product-1703746537115
              example:
                id: 165
                name: product_created
                payload:
                  product:
                    id: 115
                    sku: HTPGX14SE7
                    image:
                      full: >-
                        https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                      mini: >-
                        https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                      detail: >-
                        https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                    leads: 0
                    price: null
                    title: Awesome Copper Computer45
                    views: 0
                    active: false
                    images: []
                    public: true
                    vendor: null
                    enrolls: []
                    options: []
                    prompts: []
                    in_stock: true
                    shipping: '4.7'
                    stripped: Reactive intermediate moderator
                    variants:
                      - id: 115
                        title: Default Variant
                        buyable: true
                        image_url: null
                        option_value_ids: []
                        variant_countries:
                          - id: 706
                            tax: '0.0'
                            price: '22.27'
                            country:
                              id: 214
                              iso: US
                              iso3: USA
                              name: United States
                              iso_name: UNITED STATES
                              tax_rate: 0
                            shipping: '0.0'
                            country_iso: US
                            currency_code: USD
                            display_price: $22.27 (USD)
                            currency_symbol: $
                            wholesale_price: '0.0'
                            subscription_price: '22.27'
                            display_wholesale_price: $0.00 (USD)
                            wholesale_subscription_price: '0.0'
                            display_wholesale_subscription_price: $0.00 (USD)
                          - id: 707
                            tax: '0.0'
                            price: '22.27'
                            country:
                              id: 65
                              iso: FO
                              iso3: FRO
                              name: Faroe Islands
                              iso_name: FAROE ISLANDS
                              tax_rate: 0
                            shipping: '0.0'
                            country_iso: FO
                            currency_code: USD
                            display_price: $22.27 (USD)
                            currency_symbol: $
                            wholesale_price: '0.0'
                            subscription_price: '22.27'
                            display_wholesale_price: $0.00 (USD)
                            wholesale_subscription_price: '0.0'
                            display_wholesale_subscription_price: $0.00 (USD)
                          - id: 708
                            tax: '0.0'
                            price: '22.27'
                            country:
                              id: 92
                              iso: IN
                              iso3: IND
                              name: India
                              iso_name: INDIA
                              tax_rate: 0
                            shipping: '0.0'
                            country_iso: IN
                            currency_code: USD
                            display_price: $22.27 (USD)
                            currency_symbol: $
                            wholesale_price: '0.0'
                            subscription_price: '22.27'
                            display_wholesale_price: $0.00 (USD)
                            wholesale_subscription_price: '0.0'
                            display_wholesale_subscription_price: $0.00 (USD)
                          - id: 709
                            tax: '0.0'
                            price: '22.27'
                            country:
                              id: 146
                              iso: NI
                              iso3: NIC
                              name: Nicaragua
                              iso_name: NICARAGUA
                              tax_rate: 0
                            shipping: '0.0'
                            country_iso: NI
                            currency_code: USD
                            display_price: $22.27 (USD)
                            currency_symbol: $
                            wholesale_price: '0.0'
                            subscription_price: '22.27'
                            display_wholesale_price: $0.00 (USD)
                            wholesale_subscription_price: '0.0'
                            display_wholesale_subscription_price: $0.00 (USD)
                          - id: 710
                            tax: '0.0'
                            price: '22.27'
                            country:
                              id: 172
                              iso: LC
                              iso3: LCA
                              name: Saint Lucia
                              iso_name: SAINT LUCIA
                              tax_rate: 0
                            shipping: '0.0'
                            country_iso: LC
                            currency_code: USD
                            display_price: $22.27 (USD)
                            currency_symbol: $
                            wholesale_price: '0.0'
                            subscription_price: '22.27'
                            display_wholesale_price: $0.00 (USD)
                            wholesale_subscription_price: '0.0'
                            display_wholesale_subscription_price: $0.00 (USD)
                          - id: 711
                            tax: '0.0'
                            price: '22.27'
                            country:
                              id: 66
                              iso: FJ
                              iso3: FJI
                              name: Fiji
                              iso_name: FIJI
                              tax_rate: 0
                            shipping: '0.0'
                            country_iso: FJ
                            currency_code: USD
                            display_price: $22.27 (USD)
                            currency_symbol: $
                            wholesale_price: '0.0'
                            subscription_price: '22.27'
                            display_wholesale_price: $0.00 (USD)
                            wholesale_subscription_price: '0.0'
                            display_wholesale_subscription_price: $0.00 (USD)
                          - id: 712
                            tax: '0.0'
                            price: '22.27'
                            country:
                              id: 93
                              iso: ID
                              iso3: IDN
                              name: Indonesia
                              iso_name: INDONESIA
                              tax_rate: 0
                            shipping: '0.0'
                            country_iso: ID
                            currency_code: USD
                            display_price: $22.27 (USD)
                            currency_symbol: $
                            wholesale_price: '0.0'
                            subscription_price: '22.27'
                            display_wholesale_price: $0.00 (USD)
                            wholesale_subscription_price: '0.0'
                            display_wholesale_subscription_price: $0.00 (USD)
                          - id: 713
                            tax: '0.0'
                            price: '22.27'
                            country:
                              id: 147
                              iso: NE
                              iso3: NER
                              name: Niger
                              iso_name: NIGER
                              tax_rate: 0
                            shipping: '0.0'
                            country_iso: NE
                            currency_code: USD
                            display_price: $22.27 (USD)
                            currency_symbol: $
                            wholesale_price: '0.0'
                            subscription_price: '22.27'
                            display_wholesale_price: $0.00 (USD)
                            wholesale_subscription_price: '0.0'
                            display_wholesale_subscription_price: $0.00 (USD)
                          - id: 714
                            tax: '0.0'
                            price: '22.27'
                            country:
                              id: 67
                              iso: FI
                              iso3: FIN
                              name: Finland
                              iso_name: FINLAND
                              tax_rate: 0
                            shipping: '0.0'
                            country_iso: FI
                            currency_code: USD
                            display_price: $22.27 (USD)
                            currency_symbol: $
                            wholesale_price: '0.0'
                            subscription_price: '22.27'
                            display_wholesale_price: $0.00 (USD)
                            wholesale_subscription_price: '0.0'
                            display_wholesale_subscription_price: $0.00 (USD)
                        allow_subscription: true
                    countries:
                      - id: 214
                        iso: US
                        itn: false
                        iso3: USA
                        name: United States
                        state: true
                        active: true
                        numcode: 840
                        address3: false
                        iso_name: UNITED STATES
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: USD
                        currency_symbol: $
                    image_url: >-
                      https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                    commission: '10.0'
                    country_id: null
                    share_link: null
                    shopify_id: null
                    description:
                      id: 124
                      body: Reactive intermediate moderator
                      name: description
                      record_id: 115
                      created_at: '2023-12-26T04:49:52.800Z'
                      updated_at: '2023-12-26T04:49:52.800Z'
                      record_type: Product
                    price_range:
                      - $22.27
                      - $22.27
                    country_code: us
                    currency_code: USD
                    display_price: ''
                    option_values: null
                    average_rating: 0
                    shopify_handle: null
                    currency_symbol: $
                    default_variant:
                      id: 115
                      sku: HTPGX14SE7
                      size: 2 cm
                      price: null
                      title: Default Variant
                      width: null
                      active: true
                      height: null
                      length: null
                      weight: 20 kg
                      hs_code: null
                      taxable: true
                      bar_code: null
                      physical: null
                      position: 1
                      image_url: null
                      is_master: true
                      created_at: '2023-12-26T04:49:52.811Z'
                      image_path: null
                      product_id: 115
                      shopify_id: null
                      updated_at: '2023-12-26T04:49:52.811Z'
                      external_id: null
                      discarded_at: null
                      keep_selling: false
                      option_attrs: []
                      unit_of_size: null
                      track_quantity: true
                      unit_of_weight: null
                      inventory_policy: none
                      country_of_origin: null
                      allow_subscription: true
                      inventory_quantity: 1
                      variant_country_id: null
                      customs_information_shipping: null
                    enroll_products: []
                    wholesale_price: null
                    subscription_price: null
                    unlimited_inventory: false
                    publish_to_rep_store: true
                    publish_to_share_tab: true
                    price_range_formatted: $22.27
                    display_wholesale_price: ''
                    publish_to_retail_store: true
                    display_subscription_price: null
                    wholesale_subscription_price: null
                    display_wholesale_subscription_price: null
                timestamp: '2023-12-28T06:55:37.833Z'
                identifier: product-1703746537115
      deprecated: false
  /api/company/webhooks/events/product_updated:
    get:
      tags:
        - Webhooks
      summary: product_updated
      operationId: product_updated
      parameters: []
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/product_updated'
                  - example:
                      id: 29
                      name: product_updated
                      payload:
                        product:
                          id: 113
                          sku: QDPF7N2XOR
                          image:
                            full: >-
                              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                            mini: >-
                              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                            detail: >-
                              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                          leads: 0
                          price: null
                          title: 'Aerodynamic Aluminum '
                          views: 0
                          active: true
                          images: []
                          public: true
                          vendor: null
                          enrolls: []
                          options: []
                          prompts: []
                          in_stock: true
                          shipping: '0.03'
                          stripped: Optimized clear-thinking access
                          variants:
                            - id: 113
                              title: Default Variant
                              buyable: true
                              image_url: null
                              option_value_ids: []
                              variant_countries:
                                - id: 686
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 214
                                    iso: US
                                    iso3: USA
                                    name: United States
                                    iso_name: UNITED STATES
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: US
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 687
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 65
                                    iso: FO
                                    iso3: FRO
                                    name: Faroe Islands
                                    iso_name: FAROE ISLANDS
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: FO
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 688
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 92
                                    iso: IN
                                    iso3: IND
                                    name: India
                                    iso_name: INDIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: IN
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 689
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 146
                                    iso: NI
                                    iso3: NIC
                                    name: Nicaragua
                                    iso_name: NICARAGUA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: NI
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 690
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 172
                                    iso: LC
                                    iso3: LCA
                                    name: Saint Lucia
                                    iso_name: SAINT LUCIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: LC
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 691
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 66
                                    iso: FJ
                                    iso3: FJI
                                    name: Fiji
                                    iso_name: FIJI
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: FJ
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 692
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 93
                                    iso: ID
                                    iso3: IDN
                                    name: Indonesia
                                    iso_name: INDONESIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: ID
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 693
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 147
                                    iso: NE
                                    iso3: NER
                                    name: Niger
                                    iso_name: NIGER
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: NE
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 694
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 67
                                    iso: FI
                                    iso3: FIN
                                    name: Finland
                                    iso_name: FINLAND
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: FI
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 695
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 148
                                    iso: NG
                                    iso3: NGA
                                    name: Nigeria
                                    iso_name: NIGERIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: NG
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                              allow_subscription: true
                          countries:
                            - id: 214
                              iso: US
                              itn: false
                              iso3: USA
                              name: United States
                              state: true
                              active: true
                              numcode: 840
                              address3: false
                              iso_name: UNITED STATES
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: USD
                              currency_symbol: $
                            - id: 65
                              iso: FO
                              itn: false
                              iso3: FRO
                              name: Faroe Islands
                              state: true
                              active: true
                              numcode: 234
                              address3: false
                              iso_name: FAROE ISLANDS
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: DKK
                              currency_symbol: kr.
                            - id: 92
                              iso: IN
                              itn: false
                              iso3: IND
                              name: India
                              state: true
                              active: true
                              numcode: 356
                              address3: false
                              iso_name: INDIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: INR
                              currency_symbol: ₹
                            - id: 146
                              iso: NI
                              itn: false
                              iso3: NIC
                              name: Nicaragua
                              state: true
                              active: true
                              numcode: 558
                              address3: false
                              iso_name: NICARAGUA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: NIO
                              currency_symbol: C$
                            - id: 172
                              iso: LC
                              itn: false
                              iso3: LCA
                              name: Saint Lucia
                              state: true
                              active: true
                              numcode: 662
                              address3: false
                              iso_name: SAINT LUCIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XCD
                              currency_symbol: $
                            - id: 66
                              iso: FJ
                              itn: false
                              iso3: FJI
                              name: Fiji
                              state: true
                              active: true
                              numcode: 242
                              address3: false
                              iso_name: FIJI
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: FJD
                              currency_symbol: $
                            - id: 93
                              iso: ID
                              itn: false
                              iso3: IDN
                              name: Indonesia
                              state: true
                              active: true
                              numcode: 360
                              address3: false
                              iso_name: INDONESIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: IDR
                              currency_symbol: Rp
                            - id: 147
                              iso: NE
                              itn: false
                              iso3: NER
                              name: Niger
                              state: true
                              active: true
                              numcode: 562
                              address3: false
                              iso_name: NIGER
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XOF
                              currency_symbol: Fr
                            - id: 67
                              iso: FI
                              itn: false
                              iso3: FIN
                              name: Finland
                              state: true
                              active: true
                              numcode: 246
                              address3: false
                              iso_name: FINLAND
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 148
                              iso: NG
                              itn: false
                              iso3: NGA
                              name: Nigeria
                              state: true
                              active: true
                              numcode: 566
                              address3: false
                              iso_name: NIGERIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: NGN
                              currency_symbol: ₦
                            - id: 174
                              iso: VC
                              itn: false
                              iso3: VCT
                              name: Saint Vincent and the Grenadines
                              state: true
                              active: true
                              numcode: 670
                              address3: false
                              iso_name: SAINT VINCENT AND THE GRENADINES
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XCD
                              currency_symbol: $
                            - id: 68
                              iso: FR
                              itn: false
                              iso3: FRA
                              name: France
                              state: true
                              active: true
                              numcode: 250
                              address3: false
                              iso_name: FRANCE
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 94
                              iso: IR
                              itn: false
                              iso3: IRN
                              name: Iran, Islamic Republic of
                              state: true
                              active: true
                              numcode: 364
                              address3: false
                              iso_name: IRAN, ISLAMIC REPUBLIC OF
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: IRR
                              currency_symbol: ﷼
                            - id: 149
                              iso: NU
                              itn: false
                              iso3: NIU
                              name: Niue
                              state: true
                              active: true
                              numcode: 570
                              address3: false
                              iso_name: NIUE
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: NZD
                              currency_symbol: $
                            - id: 175
                              iso: WS
                              itn: false
                              iso3: WSM
                              name: Samoa
                              state: true
                              active: true
                              numcode: 882
                              address3: false
                              iso_name: SAMOA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: WST
                              currency_symbol: T
                            - id: 69
                              iso: GF
                              itn: false
                              iso3: GUF
                              name: French Guiana
                              state: true
                              active: true
                              numcode: 254
                              address3: false
                              iso_name: FRENCH GUIANA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 95
                              iso: IQ
                              itn: false
                              iso3: IRQ
                              name: Iraq
                              state: true
                              active: true
                              numcode: 368
                              address3: false
                              iso_name: IRAQ
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: IQD
                              currency_symbol: ع.د
                            - id: 176
                              iso: SM
                              itn: false
                              iso3: SMR
                              name: San Marino
                              state: true
                              active: true
                              numcode: 674
                              address3: false
                              iso_name: SAN MARINO
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 96
                              iso: IE
                              itn: false
                              iso3: IRL
                              name: Ireland
                              state: true
                              active: true
                              numcode: 372
                              address3: false
                              iso_name: IRELAND
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 177
                              iso: ST
                              itn: false
                              iso3: STP
                              name: Sao Tome and Principe
                              state: true
                              active: true
                              numcode: 678
                              address3: false
                              iso_name: SAO TOME AND PRINCIPE
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: STD
                              currency_symbol: Db
                            - id: 39
                              iso: TD
                              itn: false
                              iso3: TCD
                              name: Chad
                              state: true
                              active: true
                              numcode: 148
                              address3: false
                              iso_name: CHAD
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XAF
                              currency_symbol: CFA
                            - id: 173
                              iso: PM
                              itn: false
                              iso3: SPM
                              name: Saint Pierre and Miquelon
                              state: true
                              active: true
                              numcode: 666
                              address3: false
                              iso_name: SAINT PIERRE AND MIQUELON
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                          image_url: >-
                            https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                          commission: '10.0'
                          country_id: null
                          share_link: null
                          shopify_id: null
                          description:
                            id: 122
                            body: <div>Optimized clear-thinking access</div>
                            name: description
                            record_id: 113
                            created_at: '2023-12-26T04:49:52.800Z'
                            updated_at: '2023-12-26T06:37:59.551Z'
                            record_type: Product
                          price_range:
                            - $17.32
                            - $17.32
                          country_code: td
                          currency_code: USD
                          display_price: ''
                          option_values: null
                          average_rating: 0
                          shopify_handle: null
                          currency_symbol: $
                          default_variant:
                            id: 113
                            sku: QDPF7N2XOR
                            size: 4cm
                            price: null
                            title: Default Variant
                            width: null
                            active: true
                            height: null
                            length: null
                            weight: 10 kg
                            hs_code: null
                            taxable: true
                            bar_code: null
                            physical: null
                            position: 1
                            image_url: null
                            is_master: true
                            created_at: '2023-12-26T04:49:52.811Z'
                            image_path: null
                            product_id: 113
                            shopify_id: null
                            updated_at: '2023-12-26T08:32:24.878Z'
                            external_id: null
                            discarded_at: null
                            keep_selling: false
                            option_attrs: []
                            unit_of_size: null
                            track_quantity: true
                            unit_of_weight: null
                            inventory_policy: none
                            country_of_origin: null
                            allow_subscription: true
                            inventory_quantity: 100
                            variant_country_id: null
                            customs_information_shipping: null
                          enroll_products: []
                          wholesale_price: null
                          subscription_price: null
                          unlimited_inventory: false
                          publish_to_rep_store: true
                          publish_to_share_tab: true
                          price_range_formatted: $17.32
                          display_wholesale_price: ''
                          publish_to_retail_store: true
                          display_subscription_price: null
                          wholesale_subscription_price: null
                          display_wholesale_subscription_price: null
                      timestamp: '2023-12-26T08:32:25.284Z'
                      identifier: product-1703579545113
              example:
                id: 29
                name: product_updated
                payload:
                  product:
                    id: 113
                    sku: QDPF7N2XOR
                    image:
                      full: >-
                        https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                      mini: >-
                        https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                      detail: >-
                        https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                    leads: 0
                    price: null
                    title: 'Aerodynamic Aluminum '
                    views: 0
                    active: true
                    images: []
                    public: true
                    vendor: null
                    enrolls: []
                    options: []
                    prompts: []
                    in_stock: true
                    shipping: '0.03'
                    stripped: Optimized clear-thinking access
                    variants:
                      - id: 113
                        title: Default Variant
                        buyable: true
                        image_url: null
                        option_value_ids: []
                        variant_countries:
                          - id: 686
                            tax: '0.0'
                            price: '17.32'
                            country:
                              id: 214
                              iso: US
                              iso3: USA
                              name: United States
                              iso_name: UNITED STATES
                              tax_rate: 0
                            shipping: '0.0'
                            country_iso: US
                            currency_code: USD
                            display_price: $17.32 (USD)
                            currency_symbol: $
                            wholesale_price: '0.0'
                            subscription_price: '17.32'
                            display_wholesale_price: $0.00 (USD)
                            wholesale_subscription_price: '0.0'
                            display_wholesale_subscription_price: $0.00 (USD)
                          - id: 687
                            tax: '0.0'
                            price: '17.32'
                            country:
                              id: 65
                              iso: FO
                              iso3: FRO
                              name: Faroe Islands
                              iso_name: FAROE ISLANDS
                              tax_rate: 0
                            shipping: '0.0'
                            country_iso: FO
                            currency_code: USD
                            display_price: $17.32 (USD)
                            currency_symbol: $
                            wholesale_price: '0.0'
                            subscription_price: '17.32'
                            display_wholesale_price: $0.00 (USD)
                            wholesale_subscription_price: '0.0'
                            display_wholesale_subscription_price: $0.00 (USD)
                          - id: 688
                            tax: '0.0'
                            price: '17.32'
                            country:
                              id: 92
                              iso: IN
                              iso3: IND
                              name: India
                              iso_name: INDIA
                              tax_rate: 0
                            shipping: '0.0'
                            country_iso: IN
                            currency_code: USD
                            display_price: $17.32 (USD)
                            currency_symbol: $
                            wholesale_price: '0.0'
                            subscription_price: '17.32'
                            display_wholesale_price: $0.00 (USD)
                            wholesale_subscription_price: '0.0'
                            display_wholesale_subscription_price: $0.00 (USD)
                          - id: 689
                            tax: '0.0'
                            price: '17.32'
                            country:
                              id: 146
                              iso: NI
                              iso3: NIC
                              name: Nicaragua
                              iso_name: NICARAGUA
                              tax_rate: 0
                            shipping: '0.0'
                            country_iso: NI
                            currency_code: USD
                            display_price: $17.32 (USD)
                            currency_symbol: $
                            wholesale_price: '0.0'
                            subscription_price: '17.32'
                            display_wholesale_price: $0.00 (USD)
                            wholesale_subscription_price: '0.0'
                            display_wholesale_subscription_price: $0.00 (USD)
                          - id: 690
                            tax: '0.0'
                            price: '17.32'
                            country:
                              id: 172
                              iso: LC
                              iso3: LCA
                              name: Saint Lucia
                              iso_name: SAINT LUCIA
                              tax_rate: 0
                            shipping: '0.0'
                            country_iso: LC
                            currency_code: USD
                            display_price: $17.32 (USD)
                            currency_symbol: $
                            wholesale_price: '0.0'
                            subscription_price: '17.32'
                            display_wholesale_price: $0.00 (USD)
                            wholesale_subscription_price: '0.0'
                            display_wholesale_subscription_price: $0.00 (USD)
                          - id: 691
                            tax: '0.0'
                            price: '17.32'
                            country:
                              id: 66
                              iso: FJ
                              iso3: FJI
                              name: Fiji
                              iso_name: FIJI
                              tax_rate: 0
                            shipping: '0.0'
                            country_iso: FJ
                            currency_code: USD
                            display_price: $17.32 (USD)
                            currency_symbol: $
                            wholesale_price: '0.0'
                            subscription_price: '17.32'
                            display_wholesale_price: $0.00 (USD)
                            wholesale_subscription_price: '0.0'
                            display_wholesale_subscription_price: $0.00 (USD)
                          - id: 692
                            tax: '0.0'
                            price: '17.32'
                            country:
                              id: 93
                              iso: ID
                              iso3: IDN
                              name: Indonesia
                              iso_name: INDONESIA
                              tax_rate: 0
                            shipping: '0.0'
                            country_iso: ID
                            currency_code: USD
                            display_price: $17.32 (USD)
                            currency_symbol: $
                            wholesale_price: '0.0'
                            subscription_price: '17.32'
                            display_wholesale_price: $0.00 (USD)
                            wholesale_subscription_price: '0.0'
                            display_wholesale_subscription_price: $0.00 (USD)
                          - id: 693
                            tax: '0.0'
                            price: '17.32'
                            country:
                              id: 147
                              iso: NE
                              iso3: NER
                              name: Niger
                              iso_name: NIGER
                              tax_rate: 0
                            shipping: '0.0'
                            country_iso: NE
                            currency_code: USD
                            display_price: $17.32 (USD)
                            currency_symbol: $
                            wholesale_price: '0.0'
                            subscription_price: '17.32'
                            display_wholesale_price: $0.00 (USD)
                            wholesale_subscription_price: '0.0'
                            display_wholesale_subscription_price: $0.00 (USD)
                          - id: 694
                            tax: '0.0'
                            price: '17.32'
                            country:
                              id: 67
                              iso: FI
                              iso3: FIN
                              name: Finland
                              iso_name: FINLAND
                              tax_rate: 0
                            shipping: '0.0'
                            country_iso: FI
                            currency_code: USD
                            display_price: $17.32 (USD)
                            currency_symbol: $
                            wholesale_price: '0.0'
                            subscription_price: '17.32'
                            display_wholesale_price: $0.00 (USD)
                            wholesale_subscription_price: '0.0'
                            display_wholesale_subscription_price: $0.00 (USD)
                          - id: 695
                            tax: '0.0'
                            price: '17.32'
                            country:
                              id: 148
                              iso: NG
                              iso3: NGA
                              name: Nigeria
                              iso_name: NIGERIA
                              tax_rate: 0
                            shipping: '0.0'
                            country_iso: NG
                            currency_code: USD
                            display_price: $17.32 (USD)
                            currency_symbol: $
                            wholesale_price: '0.0'
                            subscription_price: '17.32'
                            display_wholesale_price: $0.00 (USD)
                            wholesale_subscription_price: '0.0'
                            display_wholesale_subscription_price: $0.00 (USD)
                        allow_subscription: true
                    countries:
                      - id: 214
                        iso: US
                        itn: false
                        iso3: USA
                        name: United States
                        state: true
                        active: true
                        numcode: 840
                        address3: false
                        iso_name: UNITED STATES
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: USD
                        currency_symbol: $
                      - id: 65
                        iso: FO
                        itn: false
                        iso3: FRO
                        name: Faroe Islands
                        state: true
                        active: true
                        numcode: 234
                        address3: false
                        iso_name: FAROE ISLANDS
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: DKK
                        currency_symbol: kr.
                      - id: 92
                        iso: IN
                        itn: false
                        iso3: IND
                        name: India
                        state: true
                        active: true
                        numcode: 356
                        address3: false
                        iso_name: INDIA
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: INR
                        currency_symbol: ₹
                      - id: 146
                        iso: NI
                        itn: false
                        iso3: NIC
                        name: Nicaragua
                        state: true
                        active: true
                        numcode: 558
                        address3: false
                        iso_name: NICARAGUA
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: NIO
                        currency_symbol: C$
                      - id: 172
                        iso: LC
                        itn: false
                        iso3: LCA
                        name: Saint Lucia
                        state: true
                        active: true
                        numcode: 662
                        address3: false
                        iso_name: SAINT LUCIA
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: XCD
                        currency_symbol: $
                      - id: 66
                        iso: FJ
                        itn: false
                        iso3: FJI
                        name: Fiji
                        state: true
                        active: true
                        numcode: 242
                        address3: false
                        iso_name: FIJI
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: FJD
                        currency_symbol: $
                      - id: 93
                        iso: ID
                        itn: false
                        iso3: IDN
                        name: Indonesia
                        state: true
                        active: true
                        numcode: 360
                        address3: false
                        iso_name: INDONESIA
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: IDR
                        currency_symbol: Rp
                      - id: 147
                        iso: NE
                        itn: false
                        iso3: NER
                        name: Niger
                        state: true
                        active: true
                        numcode: 562
                        address3: false
                        iso_name: NIGER
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: XOF
                        currency_symbol: Fr
                      - id: 67
                        iso: FI
                        itn: false
                        iso3: FIN
                        name: Finland
                        state: true
                        active: true
                        numcode: 246
                        address3: false
                        iso_name: FINLAND
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: EUR
                        currency_symbol: €
                      - id: 148
                        iso: NG
                        itn: false
                        iso3: NGA
                        name: Nigeria
                        state: true
                        active: true
                        numcode: 566
                        address3: false
                        iso_name: NIGERIA
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: NGN
                        currency_symbol: ₦
                      - id: 174
                        iso: VC
                        itn: false
                        iso3: VCT
                        name: Saint Vincent and the Grenadines
                        state: true
                        active: true
                        numcode: 670
                        address3: false
                        iso_name: SAINT VINCENT AND THE GRENADINES
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: XCD
                        currency_symbol: $
                      - id: 68
                        iso: FR
                        itn: false
                        iso3: FRA
                        name: France
                        state: true
                        active: true
                        numcode: 250
                        address3: false
                        iso_name: FRANCE
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: EUR
                        currency_symbol: €
                      - id: 94
                        iso: IR
                        itn: false
                        iso3: IRN
                        name: Iran, Islamic Republic of
                        state: true
                        active: true
                        numcode: 364
                        address3: false
                        iso_name: IRAN, ISLAMIC REPUBLIC OF
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: IRR
                        currency_symbol: ﷼
                      - id: 149
                        iso: NU
                        itn: false
                        iso3: NIU
                        name: Niue
                        state: true
                        active: true
                        numcode: 570
                        address3: false
                        iso_name: NIUE
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: NZD
                        currency_symbol: $
                      - id: 175
                        iso: WS
                        itn: false
                        iso3: WSM
                        name: Samoa
                        state: true
                        active: true
                        numcode: 882
                        address3: false
                        iso_name: SAMOA
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: WST
                        currency_symbol: T
                      - id: 69
                        iso: GF
                        itn: false
                        iso3: GUF
                        name: French Guiana
                        state: true
                        active: true
                        numcode: 254
                        address3: false
                        iso_name: FRENCH GUIANA
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: EUR
                        currency_symbol: €
                      - id: 95
                        iso: IQ
                        itn: false
                        iso3: IRQ
                        name: Iraq
                        state: true
                        active: true
                        numcode: 368
                        address3: false
                        iso_name: IRAQ
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: IQD
                        currency_symbol: ع.د
                      - id: 176
                        iso: SM
                        itn: false
                        iso3: SMR
                        name: San Marino
                        state: true
                        active: true
                        numcode: 674
                        address3: false
                        iso_name: SAN MARINO
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: EUR
                        currency_symbol: €
                      - id: 96
                        iso: IE
                        itn: false
                        iso3: IRL
                        name: Ireland
                        state: true
                        active: true
                        numcode: 372
                        address3: false
                        iso_name: IRELAND
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: EUR
                        currency_symbol: €
                      - id: 177
                        iso: ST
                        itn: false
                        iso3: STP
                        name: Sao Tome and Principe
                        state: true
                        active: true
                        numcode: 678
                        address3: false
                        iso_name: SAO TOME AND PRINCIPE
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: STD
                        currency_symbol: Db
                      - id: 39
                        iso: TD
                        itn: false
                        iso3: TCD
                        name: Chad
                        state: true
                        active: true
                        numcode: 148
                        address3: false
                        iso_name: CHAD
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: XAF
                        currency_symbol: CFA
                      - id: 173
                        iso: PM
                        itn: false
                        iso3: SPM
                        name: Saint Pierre and Miquelon
                        state: true
                        active: true
                        numcode: 666
                        address3: false
                        iso_name: SAINT PIERRE AND MIQUELON
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: EUR
                        currency_symbol: €
                    image_url: >-
                      https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                    commission: '10.0'
                    country_id: null
                    share_link: null
                    shopify_id: null
                    description:
                      id: 122
                      body: <div>Optimized clear-thinking access</div>
                      name: description
                      record_id: 113
                      created_at: '2023-12-26T04:49:52.800Z'
                      updated_at: '2023-12-26T06:37:59.551Z'
                      record_type: Product
                    price_range:
                      - $17.32
                      - $17.32
                    country_code: td
                    currency_code: USD
                    display_price: ''
                    option_values: null
                    average_rating: 0
                    shopify_handle: null
                    currency_symbol: $
                    default_variant:
                      id: 113
                      sku: QDPF7N2XOR
                      size: 4cm
                      price: null
                      title: Default Variant
                      width: null
                      active: true
                      height: null
                      length: null
                      weight: 10 kg
                      hs_code: null
                      taxable: true
                      bar_code: null
                      physical: null
                      position: 1
                      image_url: null
                      is_master: true
                      created_at: '2023-12-26T04:49:52.811Z'
                      image_path: null
                      product_id: 113
                      shopify_id: null
                      updated_at: '2023-12-26T08:32:24.878Z'
                      external_id: null
                      discarded_at: null
                      keep_selling: false
                      option_attrs: []
                      unit_of_size: null
                      track_quantity: true
                      unit_of_weight: null
                      inventory_policy: none
                      country_of_origin: null
                      allow_subscription: true
                      inventory_quantity: 100
                      variant_country_id: null
                      customs_information_shipping: null
                    enroll_products: []
                    wholesale_price: null
                    subscription_price: null
                    unlimited_inventory: false
                    publish_to_rep_store: true
                    publish_to_share_tab: true
                    price_range_formatted: $17.32
                    display_wholesale_price: ''
                    publish_to_retail_store: true
                    display_subscription_price: null
                    wholesale_subscription_price: null
                    display_wholesale_subscription_price: null
                timestamp: '2023-12-26T08:32:25.284Z'
                identifier: product-1703579545113
      deprecated: false
  /api/company/webhooks/events/product_destroyed:
    get:
      tags:
        - Webhooks
      summary: product_destroyed
      operationId: product_destroyed
      parameters: []
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/product_destroyed'
                  - example:
                      id: 105
                      name: product_destroyed
                      payload:
                        product:
                          id: 115
                          sku: HTPGX14SE7
                          image:
                            full: >-
                              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                            mini: >-
                              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                            detail: >-
                              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                          leads: 0
                          price: null
                          title: Awesome Copper Computer45
                          views: 0
                          active: false
                          images: []
                          public: true
                          vendor: null
                          enrolls: []
                          options: []
                          prompts: []
                          in_stock: true
                          shipping: '4.7'
                          stripped: Reactive intermediate moderator
                          variants:
                            - id: 115
                              title: Default Variant
                              buyable: true
                              image_url: null
                              option_value_ids: []
                              variant_countries:
                                - id: 706
                                  tax: '0.0'
                                  price: '22.27'
                                  country:
                                    id: 214
                                    iso: US
                                    iso3: USA
                                    name: United States
                                    iso_name: UNITED STATES
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: US
                                  currency_code: USD
                                  display_price: $22.27 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '22.27'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 707
                                  tax: '0.0'
                                  price: '22.27'
                                  country:
                                    id: 65
                                    iso: FO
                                    iso3: FRO
                                    name: Faroe Islands
                                    iso_name: FAROE ISLANDS
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: FO
                                  currency_code: USD
                                  display_price: $22.27 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '22.27'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 708
                                  tax: '0.0'
                                  price: '22.27'
                                  country:
                                    id: 92
                                    iso: IN
                                    iso3: IND
                                    name: India
                                    iso_name: INDIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: IN
                                  currency_code: USD
                                  display_price: $22.27 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '22.27'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 709
                                  tax: '0.0'
                                  price: '22.27'
                                  country:
                                    id: 146
                                    iso: NI
                                    iso3: NIC
                                    name: Nicaragua
                                    iso_name: NICARAGUA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: NI
                                  currency_code: USD
                                  display_price: $22.27 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '22.27'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 710
                                  tax: '0.0'
                                  price: '22.27'
                                  country:
                                    id: 172
                                    iso: LC
                                    iso3: LCA
                                    name: Saint Lucia
                                    iso_name: SAINT LUCIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: LC
                                  currency_code: USD
                                  display_price: $22.27 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '22.27'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 711
                                  tax: '0.0'
                                  price: '22.27'
                                  country:
                                    id: 66
                                    iso: FJ
                                    iso3: FJI
                                    name: Fiji
                                    iso_name: FIJI
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: FJ
                                  currency_code: USD
                                  display_price: $22.27 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '22.27'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 712
                                  tax: '0.0'
                                  price: '22.27'
                                  country:
                                    id: 93
                                    iso: ID
                                    iso3: IDN
                                    name: Indonesia
                                    iso_name: INDONESIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: ID
                                  currency_code: USD
                                  display_price: $22.27 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '22.27'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 713
                                  tax: '0.0'
                                  price: '22.27'
                                  country:
                                    id: 147
                                    iso: NE
                                    iso3: NER
                                    name: Niger
                                    iso_name: NIGER
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: NE
                                  currency_code: USD
                                  display_price: $22.27 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '22.27'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 714
                                  tax: '0.0'
                                  price: '22.27'
                                  country:
                                    id: 67
                                    iso: FI
                                    iso3: FIN
                                    name: Finland
                                    iso_name: FINLAND
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: FI
                                  currency_code: USD
                                  display_price: $22.27 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '22.27'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                              allow_subscription: true
                          countries:
                            - id: 214
                              iso: US
                              itn: false
                              iso3: USA
                              name: United States
                              state: true
                              active: true
                              numcode: 840
                              address3: false
                              iso_name: UNITED STATES
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: USD
                              currency_symbol: $
                            - id: 65
                              iso: FO
                              itn: false
                              iso3: FRO
                              name: Faroe Islands
                              state: true
                              active: true
                              numcode: 234
                              address3: false
                              iso_name: FAROE ISLANDS
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: DKK
                              currency_symbol: kr.
                            - id: 92
                              iso: IN
                              itn: false
                              iso3: IND
                              name: India
                              state: true
                              active: true
                              numcode: 356
                              address3: false
                              iso_name: INDIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: INR
                              currency_symbol: ₹
                            - id: 146
                              iso: NI
                              itn: false
                              iso3: NIC
                              name: Nicaragua
                              state: true
                              active: true
                              numcode: 558
                              address3: false
                              iso_name: NICARAGUA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: NIO
                              currency_symbol: C$
                            - id: 172
                              iso: LC
                              itn: false
                              iso3: LCA
                              name: Saint Lucia
                              state: true
                              active: true
                              numcode: 662
                              address3: false
                              iso_name: SAINT LUCIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XCD
                              currency_symbol: $
                            - id: 66
                              iso: FJ
                              itn: false
                              iso3: FJI
                              name: Fiji
                              state: true
                              active: true
                              numcode: 242
                              address3: false
                              iso_name: FIJI
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: FJD
                              currency_symbol: $
                            - id: 93
                              iso: ID
                              itn: false
                              iso3: IDN
                              name: Indonesia
                              state: true
                              active: true
                              numcode: 360
                              address3: false
                              iso_name: INDONESIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: IDR
                              currency_symbol: Rp
                            - id: 147
                              iso: NE
                              itn: false
                              iso3: NER
                              name: Niger
                              state: true
                              active: true
                              numcode: 562
                              address3: false
                              iso_name: NIGER
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XOF
                              currency_symbol: Fr
                            - id: 67
                              iso: FI
                              itn: false
                              iso3: FIN
                              name: Finland
                              state: true
                              active: true
                              numcode: 246
                              address3: false
                              iso_name: FINLAND
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 148
                              iso: NG
                              itn: false
                              iso3: NGA
                              name: Nigeria
                              state: true
                              active: true
                              numcode: 566
                              address3: false
                              iso_name: NIGERIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: NGN
                              currency_symbol: ₦
                            - id: 174
                              iso: VC
                              itn: false
                              iso3: VCT
                              name: Saint Vincent and the Grenadines
                              state: true
                              active: true
                              numcode: 670
                              address3: false
                              iso_name: SAINT VINCENT AND THE GRENADINES
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XCD
                              currency_symbol: $
                            - id: 68
                              iso: FR
                              itn: false
                              iso3: FRA
                              name: France
                              state: true
                              active: true
                              numcode: 250
                              address3: false
                              iso_name: FRANCE
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 94
                              iso: IR
                              itn: false
                              iso3: IRN
                              name: Iran, Islamic Republic of
                              state: true
                              active: true
                              numcode: 364
                              address3: false
                              iso_name: IRAN, ISLAMIC REPUBLIC OF
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: IRR
                              currency_symbol: ﷼
                            - id: 149
                              iso: NU
                              itn: false
                              iso3: NIU
                              name: Niue
                              state: true
                              active: true
                              numcode: 570
                              address3: false
                              iso_name: NIUE
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: NZD
                              currency_symbol: $
                            - id: 175
                              iso: WS
                              itn: false
                              iso3: WSM
                              name: Samoa
                              state: true
                              active: true
                              numcode: 882
                              address3: false
                              iso_name: SAMOA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: WST
                              currency_symbol: T
                            - id: 69
                              iso: GF
                              itn: false
                              iso3: GUF
                              name: French Guiana
                              state: true
                              active: true
                              numcode: 254
                              address3: false
                              iso_name: FRENCH GUIANA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 95
                              iso: IQ
                              itn: false
                              iso3: IRQ
                              name: Iraq
                              state: true
                              active: true
                              numcode: 368
                              address3: false
                              iso_name: IRAQ
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: IQD
                              currency_symbol: ع.د
                            - id: 176
                              iso: SM
                              itn: false
                              iso3: SMR
                              name: San Marino
                              state: true
                              active: true
                              numcode: 674
                              address3: false
                              iso_name: SAN MARINO
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 96
                              iso: IE
                              itn: false
                              iso3: IRL
                              name: Ireland
                              state: true
                              active: true
                              numcode: 372
                              address3: false
                              iso_name: IRELAND
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 177
                              iso: ST
                              itn: false
                              iso3: STP
                              name: Sao Tome and Principe
                              state: true
                              active: true
                              numcode: 678
                              address3: false
                              iso_name: SAO TOME AND PRINCIPE
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: STD
                              currency_symbol: Db
                            - id: 39
                              iso: TD
                              itn: false
                              iso3: TCD
                              name: Chad
                              state: true
                              active: true
                              numcode: 148
                              address3: false
                              iso_name: CHAD
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XAF
                              currency_symbol: CFA
                            - id: 173
                              iso: PM
                              itn: false
                              iso3: SPM
                              name: Saint Pierre and Miquelon
                              state: true
                              active: true
                              numcode: 666
                              address3: false
                              iso_name: SAINT PIERRE AND MIQUELON
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                          image_url: >-
                            https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                          commission: '10.0'
                          country_id: null
                          share_link: null
                          shopify_id: null
                          description:
                            id: 124
                            body: Reactive intermediate moderator
                            name: description
                            record_id: 115
                            created_at: '2023-12-26T04:49:52.800Z'
                            updated_at: '2023-12-26T04:49:52.800Z'
                            record_type: Product
                          price_range:
                            - $22.27
                            - $22.27
                          country_code: td
                          currency_code: USD
                          display_price: ''
                          option_values: null
                          average_rating: 0
                          shopify_handle: null
                          currency_symbol: $
                          default_variant:
                            id: 115
                            sku: HTPGX14SE7
                            size: 2 cm
                            price: null
                            title: Default Variant
                            width: null
                            active: true
                            height: null
                            length: null
                            weight: 20 kg
                            hs_code: null
                            taxable: true
                            bar_code: null
                            physical: null
                            position: 1
                            image_url: null
                            is_master: true
                            created_at: '2023-12-26T04:49:52.811Z'
                            image_path: null
                            product_id: 115
                            shopify_id: null
                            updated_at: '2023-12-26T04:49:52.811Z'
                            external_id: null
                            discarded_at: null
                            keep_selling: false
                            option_attrs: []
                            unit_of_size: null
                            track_quantity: true
                            unit_of_weight: null
                            inventory_policy: none
                            country_of_origin: null
                            allow_subscription: true
                            inventory_quantity: 1
                            variant_country_id: null
                            customs_information_shipping: null
                          enroll_products: []
                          wholesale_price: null
                          subscription_price: null
                          unlimited_inventory: false
                          publish_to_rep_store: true
                          publish_to_share_tab: true
                          price_range_formatted: $22.27
                          display_wholesale_price: ''
                          publish_to_retail_store: true
                          display_subscription_price: null
                          wholesale_subscription_price: null
                          display_wholesale_subscription_price: null
                      timestamp: '2023-12-27T12:22:18.523Z'
                      identifier: product-1703679738115
              example:
                id: 105
                name: product_destroyed
                payload:
                  product:
                    id: 115
                    sku: HTPGX14SE7
                    image:
                      full: >-
                        https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                      mini: >-
                        https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                      detail: >-
                        https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                    leads: 0
                    price: null
                    title: Awesome Copper Computer45
                    views: 0
                    active: false
                    images: []
                    public: true
                    vendor: null
                    enrolls: []
                    options: []
                    prompts: []
                    in_stock: true
                    shipping: '4.7'
                    stripped: Reactive intermediate moderator
                    variants:
                      - id: 115
                        title: Default Variant
                        buyable: true
                        image_url: null
                        option_value_ids: []
                        variant_countries:
                          - id: 706
                            tax: '0.0'
                            price: '22.27'
                            country:
                              id: 214
                              iso: US
                              iso3: USA
                              name: United States
                              iso_name: UNITED STATES
                              tax_rate: 0
                            shipping: '0.0'
                            country_iso: US
                            currency_code: USD
                            display_price: $22.27 (USD)
                            currency_symbol: $
                            wholesale_price: '0.0'
                            subscription_price: '22.27'
                            display_wholesale_price: $0.00 (USD)
                            wholesale_subscription_price: '0.0'
                            display_wholesale_subscription_price: $0.00 (USD)
                          - id: 707
                            tax: '0.0'
                            price: '22.27'
                            country:
                              id: 65
                              iso: FO
                              iso3: FRO
                              name: Faroe Islands
                              iso_name: FAROE ISLANDS
                              tax_rate: 0
                            shipping: '0.0'
                            country_iso: FO
                            currency_code: USD
                            display_price: $22.27 (USD)
                            currency_symbol: $
                            wholesale_price: '0.0'
                            subscription_price: '22.27'
                            display_wholesale_price: $0.00 (USD)
                            wholesale_subscription_price: '0.0'
                            display_wholesale_subscription_price: $0.00 (USD)
                          - id: 708
                            tax: '0.0'
                            price: '22.27'
                            country:
                              id: 92
                              iso: IN
                              iso3: IND
                              name: India
                              iso_name: INDIA
                              tax_rate: 0
                            shipping: '0.0'
                            country_iso: IN
                            currency_code: USD
                            display_price: $22.27 (USD)
                            currency_symbol: $
                            wholesale_price: '0.0'
                            subscription_price: '22.27'
                            display_wholesale_price: $0.00 (USD)
                            wholesale_subscription_price: '0.0'
                            display_wholesale_subscription_price: $0.00 (USD)
                          - id: 709
                            tax: '0.0'
                            price: '22.27'
                            country:
                              id: 146
                              iso: NI
                              iso3: NIC
                              name: Nicaragua
                              iso_name: NICARAGUA
                              tax_rate: 0
                            shipping: '0.0'
                            country_iso: NI
                            currency_code: USD
                            display_price: $22.27 (USD)
                            currency_symbol: $
                            wholesale_price: '0.0'
                            subscription_price: '22.27'
                            display_wholesale_price: $0.00 (USD)
                            wholesale_subscription_price: '0.0'
                            display_wholesale_subscription_price: $0.00 (USD)
                          - id: 710
                            tax: '0.0'
                            price: '22.27'
                            country:
                              id: 172
                              iso: LC
                              iso3: LCA
                              name: Saint Lucia
                              iso_name: SAINT LUCIA
                              tax_rate: 0
                            shipping: '0.0'
                            country_iso: LC
                            currency_code: USD
                            display_price: $22.27 (USD)
                            currency_symbol: $
                            wholesale_price: '0.0'
                            subscription_price: '22.27'
                            display_wholesale_price: $0.00 (USD)
                            wholesale_subscription_price: '0.0'
                            display_wholesale_subscription_price: $0.00 (USD)
                          - id: 711
                            tax: '0.0'
                            price: '22.27'
                            country:
                              id: 66
                              iso: FJ
                              iso3: FJI
                              name: Fiji
                              iso_name: FIJI
                              tax_rate: 0
                            shipping: '0.0'
                            country_iso: FJ
                            currency_code: USD
                            display_price: $22.27 (USD)
                            currency_symbol: $
                            wholesale_price: '0.0'
                            subscription_price: '22.27'
                            display_wholesale_price: $0.00 (USD)
                            wholesale_subscription_price: '0.0'
                            display_wholesale_subscription_price: $0.00 (USD)
                          - id: 712
                            tax: '0.0'
                            price: '22.27'
                            country:
                              id: 93
                              iso: ID
                              iso3: IDN
                              name: Indonesia
                              iso_name: INDONESIA
                              tax_rate: 0
                            shipping: '0.0'
                            country_iso: ID
                            currency_code: USD
                            display_price: $22.27 (USD)
                            currency_symbol: $
                            wholesale_price: '0.0'
                            subscription_price: '22.27'
                            display_wholesale_price: $0.00 (USD)
                            wholesale_subscription_price: '0.0'
                            display_wholesale_subscription_price: $0.00 (USD)
                          - id: 713
                            tax: '0.0'
                            price: '22.27'
                            country:
                              id: 147
                              iso: NE
                              iso3: NER
                              name: Niger
                              iso_name: NIGER
                              tax_rate: 0
                            shipping: '0.0'
                            country_iso: NE
                            currency_code: USD
                            display_price: $22.27 (USD)
                            currency_symbol: $
                            wholesale_price: '0.0'
                            subscription_price: '22.27'
                            display_wholesale_price: $0.00 (USD)
                            wholesale_subscription_price: '0.0'
                            display_wholesale_subscription_price: $0.00 (USD)
                          - id: 714
                            tax: '0.0'
                            price: '22.27'
                            country:
                              id: 67
                              iso: FI
                              iso3: FIN
                              name: Finland
                              iso_name: FINLAND
                              tax_rate: 0
                            shipping: '0.0'
                            country_iso: FI
                            currency_code: USD
                            display_price: $22.27 (USD)
                            currency_symbol: $
                            wholesale_price: '0.0'
                            subscription_price: '22.27'
                            display_wholesale_price: $0.00 (USD)
                            wholesale_subscription_price: '0.0'
                            display_wholesale_subscription_price: $0.00 (USD)
                        allow_subscription: true
                    countries:
                      - id: 214
                        iso: US
                        itn: false
                        iso3: USA
                        name: United States
                        state: true
                        active: true
                        numcode: 840
                        address3: false
                        iso_name: UNITED STATES
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: USD
                        currency_symbol: $
                      - id: 65
                        iso: FO
                        itn: false
                        iso3: FRO
                        name: Faroe Islands
                        state: true
                        active: true
                        numcode: 234
                        address3: false
                        iso_name: FAROE ISLANDS
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: DKK
                        currency_symbol: kr.
                      - id: 92
                        iso: IN
                        itn: false
                        iso3: IND
                        name: India
                        state: true
                        active: true
                        numcode: 356
                        address3: false
                        iso_name: INDIA
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: INR
                        currency_symbol: ₹
                      - id: 146
                        iso: NI
                        itn: false
                        iso3: NIC
                        name: Nicaragua
                        state: true
                        active: true
                        numcode: 558
                        address3: false
                        iso_name: NICARAGUA
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: NIO
                        currency_symbol: C$
                      - id: 172
                        iso: LC
                        itn: false
                        iso3: LCA
                        name: Saint Lucia
                        state: true
                        active: true
                        numcode: 662
                        address3: false
                        iso_name: SAINT LUCIA
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: XCD
                        currency_symbol: $
                      - id: 66
                        iso: FJ
                        itn: false
                        iso3: FJI
                        name: Fiji
                        state: true
                        active: true
                        numcode: 242
                        address3: false
                        iso_name: FIJI
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: FJD
                        currency_symbol: $
                      - id: 93
                        iso: ID
                        itn: false
                        iso3: IDN
                        name: Indonesia
                        state: true
                        active: true
                        numcode: 360
                        address3: false
                        iso_name: INDONESIA
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: IDR
                        currency_symbol: Rp
                      - id: 147
                        iso: NE
                        itn: false
                        iso3: NER
                        name: Niger
                        state: true
                        active: true
                        numcode: 562
                        address3: false
                        iso_name: NIGER
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: XOF
                        currency_symbol: Fr
                      - id: 67
                        iso: FI
                        itn: false
                        iso3: FIN
                        name: Finland
                        state: true
                        active: true
                        numcode: 246
                        address3: false
                        iso_name: FINLAND
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: EUR
                        currency_symbol: €
                      - id: 148
                        iso: NG
                        itn: false
                        iso3: NGA
                        name: Nigeria
                        state: true
                        active: true
                        numcode: 566
                        address3: false
                        iso_name: NIGERIA
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: NGN
                        currency_symbol: ₦
                      - id: 174
                        iso: VC
                        itn: false
                        iso3: VCT
                        name: Saint Vincent and the Grenadines
                        state: true
                        active: true
                        numcode: 670
                        address3: false
                        iso_name: SAINT VINCENT AND THE GRENADINES
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: XCD
                        currency_symbol: $
                      - id: 68
                        iso: FR
                        itn: false
                        iso3: FRA
                        name: France
                        state: true
                        active: true
                        numcode: 250
                        address3: false
                        iso_name: FRANCE
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: EUR
                        currency_symbol: €
                      - id: 94
                        iso: IR
                        itn: false
                        iso3: IRN
                        name: Iran, Islamic Republic of
                        state: true
                        active: true
                        numcode: 364
                        address3: false
                        iso_name: IRAN, ISLAMIC REPUBLIC OF
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: IRR
                        currency_symbol: ﷼
                      - id: 149
                        iso: NU
                        itn: false
                        iso3: NIU
                        name: Niue
                        state: true
                        active: true
                        numcode: 570
                        address3: false
                        iso_name: NIUE
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: NZD
                        currency_symbol: $
                      - id: 175
                        iso: WS
                        itn: false
                        iso3: WSM
                        name: Samoa
                        state: true
                        active: true
                        numcode: 882
                        address3: false
                        iso_name: SAMOA
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: WST
                        currency_symbol: T
                      - id: 69
                        iso: GF
                        itn: false
                        iso3: GUF
                        name: French Guiana
                        state: true
                        active: true
                        numcode: 254
                        address3: false
                        iso_name: FRENCH GUIANA
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: EUR
                        currency_symbol: €
                      - id: 95
                        iso: IQ
                        itn: false
                        iso3: IRQ
                        name: Iraq
                        state: true
                        active: true
                        numcode: 368
                        address3: false
                        iso_name: IRAQ
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: IQD
                        currency_symbol: ع.د
                      - id: 176
                        iso: SM
                        itn: false
                        iso3: SMR
                        name: San Marino
                        state: true
                        active: true
                        numcode: 674
                        address3: false
                        iso_name: SAN MARINO
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: EUR
                        currency_symbol: €
                      - id: 96
                        iso: IE
                        itn: false
                        iso3: IRL
                        name: Ireland
                        state: true
                        active: true
                        numcode: 372
                        address3: false
                        iso_name: IRELAND
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: EUR
                        currency_symbol: €
                      - id: 177
                        iso: ST
                        itn: false
                        iso3: STP
                        name: Sao Tome and Principe
                        state: true
                        active: true
                        numcode: 678
                        address3: false
                        iso_name: SAO TOME AND PRINCIPE
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: STD
                        currency_symbol: Db
                      - id: 39
                        iso: TD
                        itn: false
                        iso3: TCD
                        name: Chad
                        state: true
                        active: true
                        numcode: 148
                        address3: false
                        iso_name: CHAD
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: XAF
                        currency_symbol: CFA
                      - id: 173
                        iso: PM
                        itn: false
                        iso3: SPM
                        name: Saint Pierre and Miquelon
                        state: true
                        active: true
                        numcode: 666
                        address3: false
                        iso_name: SAINT PIERRE AND MIQUELON
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        currency_code: EUR
                        currency_symbol: €
                    image_url: >-
                      https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                    commission: '10.0'
                    country_id: null
                    share_link: null
                    shopify_id: null
                    description:
                      id: 124
                      body: Reactive intermediate moderator
                      name: description
                      record_id: 115
                      created_at: '2023-12-26T04:49:52.800Z'
                      updated_at: '2023-12-26T04:49:52.800Z'
                      record_type: Product
                    price_range:
                      - $22.27
                      - $22.27
                    country_code: td
                    currency_code: USD
                    display_price: ''
                    option_values: null
                    average_rating: 0
                    shopify_handle: null
                    currency_symbol: $
                    default_variant:
                      id: 115
                      sku: HTPGX14SE7
                      size: 2 cm
                      price: null
                      title: Default Variant
                      width: null
                      active: true
                      height: null
                      length: null
                      weight: 20 kg
                      hs_code: null
                      taxable: true
                      bar_code: null
                      physical: null
                      position: 1
                      image_url: null
                      is_master: true
                      created_at: '2023-12-26T04:49:52.811Z'
                      image_path: null
                      product_id: 115
                      shopify_id: null
                      updated_at: '2023-12-26T04:49:52.811Z'
                      external_id: null
                      discarded_at: null
                      keep_selling: false
                      option_attrs: []
                      unit_of_size: null
                      track_quantity: true
                      unit_of_weight: null
                      inventory_policy: none
                      country_of_origin: null
                      allow_subscription: true
                      inventory_quantity: 1
                      variant_country_id: null
                      customs_information_shipping: null
                    enroll_products: []
                    wholesale_price: null
                    subscription_price: null
                    unlimited_inventory: false
                    publish_to_rep_store: true
                    publish_to_share_tab: true
                    price_range_formatted: $22.27
                    display_wholesale_price: ''
                    publish_to_retail_store: true
                    display_subscription_price: null
                    wholesale_subscription_price: null
                    display_wholesale_subscription_price: null
                timestamp: '2023-12-27T12:22:18.523Z'
                identifier: product-1703679738115
      deprecated: false
  /api/company/webhooks/events/subscription_started:
    get:
      tags:
        - Webhooks
      summary: subscription_started
      operationId: subscription_started
      parameters: []
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/subscription_started'
                  - example:
                      id: 131
                      name: subscription_started
                      payload:
                        subsctiption_order:
                          cv: 0
                          id: 53
                          qv: 0
                          tax: '0.0'
                          type: SubscriptionOrder
                          email: ram@fluid.com
                          items:
                            - id: 3
                              sku: QDPF7N2XOR
                              price: 17.32
                              product:
                                id: 113
                                sku: QDPF7N2XOR
                                image:
                                  full: >-
                                    https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                                  mini: >-
                                    https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                                  detail: >-
                                    https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                                leads: 0
                                price: '17.32'
                                title: Aerodynamic Aluminum aaa
                                views: 0
                                active: true
                                images: []
                                public: true
                                vendor: null
                                enrolls: []
                                options: []
                                prompts: []
                                in_stock: true
                                shipping: '0.03'
                                stripped: Optimized clear-thinking access
                                variants:
                                  - id: 113
                                    title: Default Variant
                                    buyable: true
                                    image_url: null
                                    option_value_ids: []
                                    variant_countries:
                                      - id: 686
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 214
                                          iso: US
                                          iso3: USA
                                          name: United States
                                          iso_name: UNITED STATES
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: US
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 687
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 65
                                          iso: FO
                                          iso3: FRO
                                          name: Faroe Islands
                                          iso_name: FAROE ISLANDS
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: FO
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 688
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 92
                                          iso: IN
                                          iso3: IND
                                          name: India
                                          iso_name: INDIA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: IN
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 689
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 146
                                          iso: NI
                                          iso3: NIC
                                          name: Nicaragua
                                          iso_name: NICARAGUA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: NI
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 690
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 172
                                          iso: LC
                                          iso3: LCA
                                          name: Saint Lucia
                                          iso_name: SAINT LUCIA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: LC
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 691
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 66
                                          iso: FJ
                                          iso3: FJI
                                          name: Fiji
                                          iso_name: FIJI
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: FJ
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 692
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 93
                                          iso: ID
                                          iso3: IDN
                                          name: Indonesia
                                          iso_name: INDONESIA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: ID
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 693
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 147
                                          iso: NE
                                          iso3: NER
                                          name: Niger
                                          iso_name: NIGER
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: NE
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 694
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 67
                                          iso: FI
                                          iso3: FIN
                                          name: Finland
                                          iso_name: FINLAND
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: FI
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 695
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 148
                                          iso: NG
                                          iso3: NGA
                                          name: Nigeria
                                          iso_name: NIGERIA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: NG
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                    allow_subscription: true
                                countries:
                                  - id: 214
                                    iso: US
                                    itn: false
                                    iso3: USA
                                    name: United States
                                    state: true
                                    active: true
                                    numcode: 840
                                    address3: false
                                    iso_name: UNITED STATES
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: USD
                                    currency_symbol: $
                                  - id: 65
                                    iso: FO
                                    itn: false
                                    iso3: FRO
                                    name: Faroe Islands
                                    state: true
                                    active: true
                                    numcode: 234
                                    address3: false
                                    iso_name: FAROE ISLANDS
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: DKK
                                    currency_symbol: kr.
                                  - id: 92
                                    iso: IN
                                    itn: false
                                    iso3: IND
                                    name: India
                                    state: true
                                    active: true
                                    numcode: 356
                                    address3: false
                                    iso_name: INDIA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: INR
                                    currency_symbol: ₹
                                  - id: 146
                                    iso: NI
                                    itn: false
                                    iso3: NIC
                                    name: Nicaragua
                                    state: true
                                    active: true
                                    numcode: 558
                                    address3: false
                                    iso_name: NICARAGUA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: NIO
                                    currency_symbol: C$
                                  - id: 172
                                    iso: LC
                                    itn: false
                                    iso3: LCA
                                    name: Saint Lucia
                                    state: true
                                    active: true
                                    numcode: 662
                                    address3: false
                                    iso_name: SAINT LUCIA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: XCD
                                    currency_symbol: $
                                  - id: 66
                                    iso: FJ
                                    itn: false
                                    iso3: FJI
                                    name: Fiji
                                    state: true
                                    active: true
                                    numcode: 242
                                    address3: false
                                    iso_name: FIJI
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: FJD
                                    currency_symbol: $
                                  - id: 93
                                    iso: ID
                                    itn: false
                                    iso3: IDN
                                    name: Indonesia
                                    state: true
                                    active: true
                                    numcode: 360
                                    address3: false
                                    iso_name: INDONESIA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: IDR
                                    currency_symbol: Rp
                                  - id: 147
                                    iso: NE
                                    itn: false
                                    iso3: NER
                                    name: Niger
                                    state: true
                                    active: true
                                    numcode: 562
                                    address3: false
                                    iso_name: NIGER
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: XOF
                                    currency_symbol: Fr
                                  - id: 67
                                    iso: FI
                                    itn: false
                                    iso3: FIN
                                    name: Finland
                                    state: true
                                    active: true
                                    numcode: 246
                                    address3: false
                                    iso_name: FINLAND
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 148
                                    iso: NG
                                    itn: false
                                    iso3: NGA
                                    name: Nigeria
                                    state: true
                                    active: true
                                    numcode: 566
                                    address3: false
                                    iso_name: NIGERIA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: NGN
                                    currency_symbol: ₦
                                  - id: 174
                                    iso: VC
                                    itn: false
                                    iso3: VCT
                                    name: Saint Vincent and the Grenadines
                                    state: true
                                    active: true
                                    numcode: 670
                                    address3: false
                                    iso_name: SAINT VINCENT AND THE GRENADINES
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: XCD
                                    currency_symbol: $
                                  - id: 68
                                    iso: FR
                                    itn: false
                                    iso3: FRA
                                    name: France
                                    state: true
                                    active: true
                                    numcode: 250
                                    address3: false
                                    iso_name: FRANCE
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 94
                                    iso: IR
                                    itn: false
                                    iso3: IRN
                                    name: Iran, Islamic Republic of
                                    state: true
                                    active: true
                                    numcode: 364
                                    address3: false
                                    iso_name: IRAN, ISLAMIC REPUBLIC OF
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: IRR
                                    currency_symbol: ﷼
                                  - id: 149
                                    iso: NU
                                    itn: false
                                    iso3: NIU
                                    name: Niue
                                    state: true
                                    active: true
                                    numcode: 570
                                    address3: false
                                    iso_name: NIUE
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: NZD
                                    currency_symbol: $
                                  - id: 175
                                    iso: WS
                                    itn: false
                                    iso3: WSM
                                    name: Samoa
                                    state: true
                                    active: true
                                    numcode: 882
                                    address3: false
                                    iso_name: SAMOA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: WST
                                    currency_symbol: T
                                  - id: 69
                                    iso: GF
                                    itn: false
                                    iso3: GUF
                                    name: French Guiana
                                    state: true
                                    active: true
                                    numcode: 254
                                    address3: false
                                    iso_name: FRENCH GUIANA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 95
                                    iso: IQ
                                    itn: false
                                    iso3: IRQ
                                    name: Iraq
                                    state: true
                                    active: true
                                    numcode: 368
                                    address3: false
                                    iso_name: IRAQ
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: IQD
                                    currency_symbol: ع.د
                                  - id: 176
                                    iso: SM
                                    itn: false
                                    iso3: SMR
                                    name: San Marino
                                    state: true
                                    active: true
                                    numcode: 674
                                    address3: false
                                    iso_name: SAN MARINO
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 96
                                    iso: IE
                                    itn: false
                                    iso3: IRL
                                    name: Ireland
                                    state: true
                                    active: true
                                    numcode: 372
                                    address3: false
                                    iso_name: IRELAND
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 177
                                    iso: ST
                                    itn: false
                                    iso3: STP
                                    name: Sao Tome and Principe
                                    state: true
                                    active: true
                                    numcode: 678
                                    address3: false
                                    iso_name: SAO TOME AND PRINCIPE
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: STD
                                    currency_symbol: Db
                                  - id: 39
                                    iso: TD
                                    itn: false
                                    iso3: TCD
                                    name: Chad
                                    state: true
                                    active: true
                                    numcode: 148
                                    address3: false
                                    iso_name: CHAD
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: XAF
                                    currency_symbol: CFA
                                  - id: 173
                                    iso: PM
                                    itn: false
                                    iso3: SPM
                                    name: Saint Pierre and Miquelon
                                    state: true
                                    active: true
                                    numcode: 666
                                    address3: false
                                    iso_name: SAINT PIERRE AND MIQUELON
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                image_url: >-
                                  https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                                commission: '10.0'
                                country_id: null
                                share_link: null
                                shopify_id: null
                                description:
                                  id: 122
                                  body: <div>Optimized clear-thinking access</div>
                                  name: description
                                  record_id: 113
                                  created_at: '2023-12-26T04:49:52.800Z'
                                  updated_at: '2023-12-26T06:37:59.551Z'
                                  record_type: Product
                                price_range:
                                  - $17.32
                                  - $17.32
                                country_code: td
                                currency_code: USD
                                display_price: $17.32 (USD)
                                option_values: {}
                                average_rating: 0
                                shopify_handle: null
                                currency_symbol: $
                                default_variant:
                                  id: 113
                                  sku: QDPF7N2XOR
                                  size: 4cm
                                  price: null
                                  title: Default Variant
                                  width: null
                                  active: true
                                  height: null
                                  length: null
                                  weight: 10 kg
                                  hs_code: null
                                  taxable: true
                                  bar_code: null
                                  physical: null
                                  position: 1
                                  image_url: null
                                  is_master: true
                                  created_at: '2023-12-26T04:49:52.811Z'
                                  image_path: null
                                  product_id: 113
                                  shopify_id: null
                                  updated_at: '2023-12-27T12:48:04.588Z'
                                  external_id: null
                                  discarded_at: null
                                  keep_selling: false
                                  option_attrs: []
                                  unit_of_size: null
                                  track_quantity: true
                                  unit_of_weight: null
                                  inventory_policy: none
                                  country_of_origin: null
                                  allow_subscription: true
                                  inventory_quantity: 99
                                  variant_country_id: null
                                  customs_information_shipping: null
                                enroll_products: []
                                wholesale_price: '0.0'
                                subscription_price: '17.32'
                                unlimited_inventory: false
                                publish_to_rep_store: true
                                publish_to_share_tab: true
                                price_range_formatted: $17.32
                                display_wholesale_price: $0.00 (USD)
                                publish_to_retail_store: true
                                display_subscription_price: $17.32 (USD)
                                wholesale_subscription_price: '0.0'
                                display_wholesale_subscription_price: $0.00 (USD)
                              quantity: 1
                              ordered_variant: ''
                          phone: null
                          amount: '17.32'
                          rating: 5
                          review: ''
                          status: awaiting_payment
                          contact:
                            id: 20
                            ip: null
                            city: null
                            email: amir@danpheit.com
                            hours: null
                            phone: null
                            state: null
                            token: qgUpmwfwPpCiVmrQTnw6DZQR
                            email2: null
                            income: null
                            invest: null
                            phone2: null
                            reason: null
                            status: new
                            address: null
                            address2: null
                            interest: null
                            phone_id: null
                            best_time: null
                            full_name: a
                            last_name: ''
                            lead_type: null
                            time_zone: null
                            avatar_url: null
                            country_id: null
                            first_name: a
                            language_id: null
                            postal_code: null
                            requested_at: null
                          ship_to:
                            id: 980190974
                            city: a
                            name: a
                            state: Alaska
                            country:
                              id: 214
                              iso: US
                              itn: false
                              iso3: USA
                              name: United States
                              state: true
                              active: true
                              default: true
                              numcode: 840
                              address3: false
                              iso_name: UNITED STATES
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              created_at: '2023-12-26T04:48:23.479Z'
                              updated_at: '2023-12-26T04:48:23.479Z'
                              currency_code: USD
                              geo_entity_id: null
                              currency_symbol: $
                            default: false
                            address1: a
                            address2: a
                            address3: null
                            postal_code: '11111'
                            country_code: null
                          referrer: Maritzaa Gutkowski
                          shipping: '0.0'
                          subtotal: '17.32'
                          tracking: null
                          last_name: ''
                          sale_date: '2023-12-27T12:47:59.832Z'
                          created_at: '2023-12-27T12:47:59.832Z'
                          first_name: a
                          order_type: null
                          refundable: false
                          display_tax: $0.00 (USD)
                          order_number: F53375259023
                          currency_code: USD
                          display_amount: $17.32 (USD)
                          currency_symbol: $
                          display_refunds: (0 CV, 0 QV) -$0.00 (USD)
                          friendly_status: pending
                          order_thumbnail: >-
                            https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                          display_discount: $0.00 (USD)
                          display_shipping: $0.00 (USD)
                          display_subtotal: $17.32 (USD)
                          max_refundable_tax: '0.0'
                          recognized_ship_date: '2024-01-27'
                          max_refundable_amount: '17.32'
                          tracking_informations: []
                          max_refundable_shipping: '0.0'
                          max_refundable_product_price: '17.32'
                      timestamp: '2023-12-27T12:50:30.039Z'
                      identifier: subscriptionorder-170368143053
              example:
                id: 131
                name: subscription_started
                payload:
                  subsctiption_order:
                    cv: 0
                    id: 53
                    qv: 0
                    tax: '0.0'
                    type: SubscriptionOrder
                    email: ram@fluid.com
                    items:
                      - id: 3
                        sku: QDPF7N2XOR
                        price: 17.32
                        product:
                          id: 113
                          sku: QDPF7N2XOR
                          image:
                            full: >-
                              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                            mini: >-
                              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                            detail: >-
                              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                          leads: 0
                          price: '17.32'
                          title: Aerodynamic Aluminum aaa
                          views: 0
                          active: true
                          images: []
                          public: true
                          vendor: null
                          enrolls: []
                          options: []
                          prompts: []
                          in_stock: true
                          shipping: '0.03'
                          stripped: Optimized clear-thinking access
                          variants:
                            - id: 113
                              title: Default Variant
                              buyable: true
                              image_url: null
                              option_value_ids: []
                              variant_countries:
                                - id: 686
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 214
                                    iso: US
                                    iso3: USA
                                    name: United States
                                    iso_name: UNITED STATES
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: US
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 687
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 65
                                    iso: FO
                                    iso3: FRO
                                    name: Faroe Islands
                                    iso_name: FAROE ISLANDS
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: FO
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 688
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 92
                                    iso: IN
                                    iso3: IND
                                    name: India
                                    iso_name: INDIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: IN
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 689
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 146
                                    iso: NI
                                    iso3: NIC
                                    name: Nicaragua
                                    iso_name: NICARAGUA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: NI
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 690
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 172
                                    iso: LC
                                    iso3: LCA
                                    name: Saint Lucia
                                    iso_name: SAINT LUCIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: LC
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 691
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 66
                                    iso: FJ
                                    iso3: FJI
                                    name: Fiji
                                    iso_name: FIJI
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: FJ
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 692
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 93
                                    iso: ID
                                    iso3: IDN
                                    name: Indonesia
                                    iso_name: INDONESIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: ID
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 693
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 147
                                    iso: NE
                                    iso3: NER
                                    name: Niger
                                    iso_name: NIGER
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: NE
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 694
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 67
                                    iso: FI
                                    iso3: FIN
                                    name: Finland
                                    iso_name: FINLAND
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: FI
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 695
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 148
                                    iso: NG
                                    iso3: NGA
                                    name: Nigeria
                                    iso_name: NIGERIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: NG
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                              allow_subscription: true
                          countries:
                            - id: 214
                              iso: US
                              itn: false
                              iso3: USA
                              name: United States
                              state: true
                              active: true
                              numcode: 840
                              address3: false
                              iso_name: UNITED STATES
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: USD
                              currency_symbol: $
                            - id: 65
                              iso: FO
                              itn: false
                              iso3: FRO
                              name: Faroe Islands
                              state: true
                              active: true
                              numcode: 234
                              address3: false
                              iso_name: FAROE ISLANDS
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: DKK
                              currency_symbol: kr.
                            - id: 92
                              iso: IN
                              itn: false
                              iso3: IND
                              name: India
                              state: true
                              active: true
                              numcode: 356
                              address3: false
                              iso_name: INDIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: INR
                              currency_symbol: ₹
                            - id: 146
                              iso: NI
                              itn: false
                              iso3: NIC
                              name: Nicaragua
                              state: true
                              active: true
                              numcode: 558
                              address3: false
                              iso_name: NICARAGUA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: NIO
                              currency_symbol: C$
                            - id: 172
                              iso: LC
                              itn: false
                              iso3: LCA
                              name: Saint Lucia
                              state: true
                              active: true
                              numcode: 662
                              address3: false
                              iso_name: SAINT LUCIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XCD
                              currency_symbol: $
                            - id: 66
                              iso: FJ
                              itn: false
                              iso3: FJI
                              name: Fiji
                              state: true
                              active: true
                              numcode: 242
                              address3: false
                              iso_name: FIJI
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: FJD
                              currency_symbol: $
                            - id: 93
                              iso: ID
                              itn: false
                              iso3: IDN
                              name: Indonesia
                              state: true
                              active: true
                              numcode: 360
                              address3: false
                              iso_name: INDONESIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: IDR
                              currency_symbol: Rp
                            - id: 147
                              iso: NE
                              itn: false
                              iso3: NER
                              name: Niger
                              state: true
                              active: true
                              numcode: 562
                              address3: false
                              iso_name: NIGER
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XOF
                              currency_symbol: Fr
                            - id: 67
                              iso: FI
                              itn: false
                              iso3: FIN
                              name: Finland
                              state: true
                              active: true
                              numcode: 246
                              address3: false
                              iso_name: FINLAND
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 148
                              iso: NG
                              itn: false
                              iso3: NGA
                              name: Nigeria
                              state: true
                              active: true
                              numcode: 566
                              address3: false
                              iso_name: NIGERIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: NGN
                              currency_symbol: ₦
                            - id: 174
                              iso: VC
                              itn: false
                              iso3: VCT
                              name: Saint Vincent and the Grenadines
                              state: true
                              active: true
                              numcode: 670
                              address3: false
                              iso_name: SAINT VINCENT AND THE GRENADINES
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XCD
                              currency_symbol: $
                            - id: 68
                              iso: FR
                              itn: false
                              iso3: FRA
                              name: France
                              state: true
                              active: true
                              numcode: 250
                              address3: false
                              iso_name: FRANCE
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 94
                              iso: IR
                              itn: false
                              iso3: IRN
                              name: Iran, Islamic Republic of
                              state: true
                              active: true
                              numcode: 364
                              address3: false
                              iso_name: IRAN, ISLAMIC REPUBLIC OF
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: IRR
                              currency_symbol: ﷼
                            - id: 149
                              iso: NU
                              itn: false
                              iso3: NIU
                              name: Niue
                              state: true
                              active: true
                              numcode: 570
                              address3: false
                              iso_name: NIUE
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: NZD
                              currency_symbol: $
                            - id: 175
                              iso: WS
                              itn: false
                              iso3: WSM
                              name: Samoa
                              state: true
                              active: true
                              numcode: 882
                              address3: false
                              iso_name: SAMOA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: WST
                              currency_symbol: T
                            - id: 69
                              iso: GF
                              itn: false
                              iso3: GUF
                              name: French Guiana
                              state: true
                              active: true
                              numcode: 254
                              address3: false
                              iso_name: FRENCH GUIANA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 95
                              iso: IQ
                              itn: false
                              iso3: IRQ
                              name: Iraq
                              state: true
                              active: true
                              numcode: 368
                              address3: false
                              iso_name: IRAQ
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: IQD
                              currency_symbol: ع.د
                            - id: 176
                              iso: SM
                              itn: false
                              iso3: SMR
                              name: San Marino
                              state: true
                              active: true
                              numcode: 674
                              address3: false
                              iso_name: SAN MARINO
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 96
                              iso: IE
                              itn: false
                              iso3: IRL
                              name: Ireland
                              state: true
                              active: true
                              numcode: 372
                              address3: false
                              iso_name: IRELAND
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 177
                              iso: ST
                              itn: false
                              iso3: STP
                              name: Sao Tome and Principe
                              state: true
                              active: true
                              numcode: 678
                              address3: false
                              iso_name: SAO TOME AND PRINCIPE
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: STD
                              currency_symbol: Db
                            - id: 39
                              iso: TD
                              itn: false
                              iso3: TCD
                              name: Chad
                              state: true
                              active: true
                              numcode: 148
                              address3: false
                              iso_name: CHAD
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XAF
                              currency_symbol: CFA
                            - id: 173
                              iso: PM
                              itn: false
                              iso3: SPM
                              name: Saint Pierre and Miquelon
                              state: true
                              active: true
                              numcode: 666
                              address3: false
                              iso_name: SAINT PIERRE AND MIQUELON
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                          image_url: >-
                            https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                          commission: '10.0'
                          country_id: null
                          share_link: null
                          shopify_id: null
                          description:
                            id: 122
                            body: <div>Optimized clear-thinking access</div>
                            name: description
                            record_id: 113
                            created_at: '2023-12-26T04:49:52.800Z'
                            updated_at: '2023-12-26T06:37:59.551Z'
                            record_type: Product
                          price_range:
                            - $17.32
                            - $17.32
                          country_code: td
                          currency_code: USD
                          display_price: $17.32 (USD)
                          option_values: {}
                          average_rating: 0
                          shopify_handle: null
                          currency_symbol: $
                          default_variant:
                            id: 113
                            sku: QDPF7N2XOR
                            size: 4cm
                            price: null
                            title: Default Variant
                            width: null
                            active: true
                            height: null
                            length: null
                            weight: 10 kg
                            hs_code: null
                            taxable: true
                            bar_code: null
                            physical: null
                            position: 1
                            image_url: null
                            is_master: true
                            created_at: '2023-12-26T04:49:52.811Z'
                            image_path: null
                            product_id: 113
                            shopify_id: null
                            updated_at: '2023-12-27T12:48:04.588Z'
                            external_id: null
                            discarded_at: null
                            keep_selling: false
                            option_attrs: []
                            unit_of_size: null
                            track_quantity: true
                            unit_of_weight: null
                            inventory_policy: none
                            country_of_origin: null
                            allow_subscription: true
                            inventory_quantity: 99
                            variant_country_id: null
                            customs_information_shipping: null
                          enroll_products: []
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          unlimited_inventory: false
                          publish_to_rep_store: true
                          publish_to_share_tab: true
                          price_range_formatted: $17.32
                          display_wholesale_price: $0.00 (USD)
                          publish_to_retail_store: true
                          display_subscription_price: $17.32 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        quantity: 1
                        ordered_variant: ''
                    phone: null
                    amount: '17.32'
                    rating: 5
                    review: ''
                    status: awaiting_payment
                    contact:
                      id: 20
                      ip: null
                      city: null
                      email: amir@danpheit.com
                      hours: null
                      phone: null
                      state: null
                      token: qgUpmwfwPpCiVmrQTnw6DZQR
                      email2: null
                      income: null
                      invest: null
                      phone2: null
                      reason: null
                      status: new
                      address: null
                      address2: null
                      interest: null
                      phone_id: null
                      best_time: null
                      full_name: a
                      last_name: ''
                      lead_type: null
                      time_zone: null
                      avatar_url: null
                      country_id: null
                      first_name: a
                      language_id: null
                      postal_code: null
                      requested_at: null
                    ship_to:
                      id: 980190974
                      city: a
                      name: a
                      state: Alaska
                      country:
                        id: 214
                        iso: US
                        itn: false
                        iso3: USA
                        name: United States
                        state: true
                        active: true
                        default: true
                        numcode: 840
                        address3: false
                        iso_name: UNITED STATES
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        created_at: '2023-12-26T04:48:23.479Z'
                        updated_at: '2023-12-26T04:48:23.479Z'
                        currency_code: USD
                        geo_entity_id: null
                        currency_symbol: $
                      default: false
                      address1: a
                      address2: a
                      address3: null
                      postal_code: '11111'
                      country_code: null
                    referrer: Maritzaa Gutkowski
                    shipping: '0.0'
                    subtotal: '17.32'
                    tracking: null
                    last_name: ''
                    sale_date: '2023-12-27T12:47:59.832Z'
                    created_at: '2023-12-27T12:47:59.832Z'
                    first_name: a
                    order_type: null
                    refundable: false
                    display_tax: $0.00 (USD)
                    order_number: F53375259023
                    currency_code: USD
                    display_amount: $17.32 (USD)
                    currency_symbol: $
                    display_refunds: (0 CV, 0 QV) -$0.00 (USD)
                    friendly_status: pending
                    order_thumbnail: >-
                      https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                    display_discount: $0.00 (USD)
                    display_shipping: $0.00 (USD)
                    display_subtotal: $17.32 (USD)
                    max_refundable_tax: '0.0'
                    recognized_ship_date: '2024-01-27'
                    max_refundable_amount: '17.32'
                    tracking_informations: []
                    max_refundable_shipping: '0.0'
                    max_refundable_product_price: '17.32'
                timestamp: '2023-12-27T12:50:30.039Z'
                identifier: subscriptionorder-170368143053
      deprecated: false
  /api/company/webhooks/events/subscription_paused:
    get:
      tags:
        - Webhooks
      summary: subscription_paused
      operationId: subscription_paused
      parameters: []
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/subscription_paused'
                  - example:
                      id: 132
                      name: subscription_paused
                      payload:
                        subsctiption_order:
                          cv: 0
                          id: 53
                          qv: 0
                          tax: '0.0'
                          type: SubscriptionOrder
                          email: ram@fluid.com
                          items:
                            - id: 3
                              sku: QDPF7N2XOR
                              price: 17.32
                              product:
                                id: 113
                                sku: QDPF7N2XOR
                                image:
                                  full: >-
                                    https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                                  mini: >-
                                    https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                                  detail: >-
                                    https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                                leads: 0
                                price: '17.32'
                                title: Aerodynamic Aluminum aaa
                                views: 0
                                active: true
                                images: []
                                public: true
                                vendor: null
                                enrolls: []
                                options: []
                                prompts: []
                                in_stock: true
                                shipping: '0.03'
                                stripped: Optimized clear-thinking access
                                variants:
                                  - id: 113
                                    title: Default Variant
                                    buyable: true
                                    image_url: null
                                    option_value_ids: []
                                    variant_countries:
                                      - id: 686
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 214
                                          iso: US
                                          iso3: USA
                                          name: United States
                                          iso_name: UNITED STATES
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: US
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 687
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 65
                                          iso: FO
                                          iso3: FRO
                                          name: Faroe Islands
                                          iso_name: FAROE ISLANDS
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: FO
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 688
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 92
                                          iso: IN
                                          iso3: IND
                                          name: India
                                          iso_name: INDIA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: IN
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 689
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 146
                                          iso: NI
                                          iso3: NIC
                                          name: Nicaragua
                                          iso_name: NICARAGUA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: NI
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 690
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 172
                                          iso: LC
                                          iso3: LCA
                                          name: Saint Lucia
                                          iso_name: SAINT LUCIA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: LC
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 691
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 66
                                          iso: FJ
                                          iso3: FJI
                                          name: Fiji
                                          iso_name: FIJI
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: FJ
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 692
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 93
                                          iso: ID
                                          iso3: IDN
                                          name: Indonesia
                                          iso_name: INDONESIA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: ID
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 693
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 147
                                          iso: NE
                                          iso3: NER
                                          name: Niger
                                          iso_name: NIGER
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: NE
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 694
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 67
                                          iso: FI
                                          iso3: FIN
                                          name: Finland
                                          iso_name: FINLAND
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: FI
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 695
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 148
                                          iso: NG
                                          iso3: NGA
                                          name: Nigeria
                                          iso_name: NIGERIA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: NG
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                    allow_subscription: true
                                countries:
                                  - id: 214
                                    iso: US
                                    itn: false
                                    iso3: USA
                                    name: United States
                                    state: true
                                    active: true
                                    numcode: 840
                                    address3: false
                                    iso_name: UNITED STATES
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: USD
                                    currency_symbol: $
                                  - id: 65
                                    iso: FO
                                    itn: false
                                    iso3: FRO
                                    name: Faroe Islands
                                    state: true
                                    active: true
                                    numcode: 234
                                    address3: false
                                    iso_name: FAROE ISLANDS
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: DKK
                                    currency_symbol: kr.
                                  - id: 92
                                    iso: IN
                                    itn: false
                                    iso3: IND
                                    name: India
                                    state: true
                                    active: true
                                    numcode: 356
                                    address3: false
                                    iso_name: INDIA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: INR
                                    currency_symbol: ₹
                                  - id: 146
                                    iso: NI
                                    itn: false
                                    iso3: NIC
                                    name: Nicaragua
                                    state: true
                                    active: true
                                    numcode: 558
                                    address3: false
                                    iso_name: NICARAGUA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: NIO
                                    currency_symbol: C$
                                  - id: 172
                                    iso: LC
                                    itn: false
                                    iso3: LCA
                                    name: Saint Lucia
                                    state: true
                                    active: true
                                    numcode: 662
                                    address3: false
                                    iso_name: SAINT LUCIA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: XCD
                                    currency_symbol: $
                                  - id: 66
                                    iso: FJ
                                    itn: false
                                    iso3: FJI
                                    name: Fiji
                                    state: true
                                    active: true
                                    numcode: 242
                                    address3: false
                                    iso_name: FIJI
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: FJD
                                    currency_symbol: $
                                  - id: 93
                                    iso: ID
                                    itn: false
                                    iso3: IDN
                                    name: Indonesia
                                    state: true
                                    active: true
                                    numcode: 360
                                    address3: false
                                    iso_name: INDONESIA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: IDR
                                    currency_symbol: Rp
                                  - id: 147
                                    iso: NE
                                    itn: false
                                    iso3: NER
                                    name: Niger
                                    state: true
                                    active: true
                                    numcode: 562
                                    address3: false
                                    iso_name: NIGER
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: XOF
                                    currency_symbol: Fr
                                  - id: 67
                                    iso: FI
                                    itn: false
                                    iso3: FIN
                                    name: Finland
                                    state: true
                                    active: true
                                    numcode: 246
                                    address3: false
                                    iso_name: FINLAND
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 148
                                    iso: NG
                                    itn: false
                                    iso3: NGA
                                    name: Nigeria
                                    state: true
                                    active: true
                                    numcode: 566
                                    address3: false
                                    iso_name: NIGERIA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: NGN
                                    currency_symbol: ₦
                                  - id: 174
                                    iso: VC
                                    itn: false
                                    iso3: VCT
                                    name: Saint Vincent and the Grenadines
                                    state: true
                                    active: true
                                    numcode: 670
                                    address3: false
                                    iso_name: SAINT VINCENT AND THE GRENADINES
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: XCD
                                    currency_symbol: $
                                  - id: 68
                                    iso: FR
                                    itn: false
                                    iso3: FRA
                                    name: France
                                    state: true
                                    active: true
                                    numcode: 250
                                    address3: false
                                    iso_name: FRANCE
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 94
                                    iso: IR
                                    itn: false
                                    iso3: IRN
                                    name: Iran, Islamic Republic of
                                    state: true
                                    active: true
                                    numcode: 364
                                    address3: false
                                    iso_name: IRAN, ISLAMIC REPUBLIC OF
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: IRR
                                    currency_symbol: ﷼
                                  - id: 149
                                    iso: NU
                                    itn: false
                                    iso3: NIU
                                    name: Niue
                                    state: true
                                    active: true
                                    numcode: 570
                                    address3: false
                                    iso_name: NIUE
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: NZD
                                    currency_symbol: $
                                  - id: 175
                                    iso: WS
                                    itn: false
                                    iso3: WSM
                                    name: Samoa
                                    state: true
                                    active: true
                                    numcode: 882
                                    address3: false
                                    iso_name: SAMOA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: WST
                                    currency_symbol: T
                                  - id: 69
                                    iso: GF
                                    itn: false
                                    iso3: GUF
                                    name: French Guiana
                                    state: true
                                    active: true
                                    numcode: 254
                                    address3: false
                                    iso_name: FRENCH GUIANA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 95
                                    iso: IQ
                                    itn: false
                                    iso3: IRQ
                                    name: Iraq
                                    state: true
                                    active: true
                                    numcode: 368
                                    address3: false
                                    iso_name: IRAQ
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: IQD
                                    currency_symbol: ع.د
                                  - id: 176
                                    iso: SM
                                    itn: false
                                    iso3: SMR
                                    name: San Marino
                                    state: true
                                    active: true
                                    numcode: 674
                                    address3: false
                                    iso_name: SAN MARINO
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 96
                                    iso: IE
                                    itn: false
                                    iso3: IRL
                                    name: Ireland
                                    state: true
                                    active: true
                                    numcode: 372
                                    address3: false
                                    iso_name: IRELAND
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 177
                                    iso: ST
                                    itn: false
                                    iso3: STP
                                    name: Sao Tome and Principe
                                    state: true
                                    active: true
                                    numcode: 678
                                    address3: false
                                    iso_name: SAO TOME AND PRINCIPE
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: STD
                                    currency_symbol: Db
                                  - id: 39
                                    iso: TD
                                    itn: false
                                    iso3: TCD
                                    name: Chad
                                    state: true
                                    active: true
                                    numcode: 148
                                    address3: false
                                    iso_name: CHAD
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: XAF
                                    currency_symbol: CFA
                                  - id: 173
                                    iso: PM
                                    itn: false
                                    iso3: SPM
                                    name: Saint Pierre and Miquelon
                                    state: true
                                    active: true
                                    numcode: 666
                                    address3: false
                                    iso_name: SAINT PIERRE AND MIQUELON
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                image_url: >-
                                  https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                                commission: '10.0'
                                country_id: null
                                share_link: null
                                shopify_id: null
                                description:
                                  id: 122
                                  body: <div>Optimized clear-thinking access</div>
                                  name: description
                                  record_id: 113
                                  created_at: '2023-12-26T04:49:52.800Z'
                                  updated_at: '2023-12-26T06:37:59.551Z'
                                  record_type: Product
                                price_range:
                                  - $17.32
                                  - $17.32
                                country_code: td
                                currency_code: USD
                                display_price: $17.32 (USD)
                                option_values: {}
                                average_rating: 0
                                shopify_handle: null
                                currency_symbol: $
                                default_variant:
                                  id: 113
                                  sku: QDPF7N2XOR
                                  size: 4cm
                                  price: null
                                  title: Default Variant
                                  width: null
                                  active: true
                                  height: null
                                  length: null
                                  weight: 10 kg
                                  hs_code: null
                                  taxable: true
                                  bar_code: null
                                  physical: null
                                  position: 1
                                  image_url: null
                                  is_master: true
                                  created_at: '2023-12-26T04:49:52.811Z'
                                  image_path: null
                                  product_id: 113
                                  shopify_id: null
                                  updated_at: '2023-12-27T12:48:04.588Z'
                                  external_id: null
                                  discarded_at: null
                                  keep_selling: false
                                  option_attrs: []
                                  unit_of_size: null
                                  track_quantity: true
                                  unit_of_weight: null
                                  inventory_policy: none
                                  country_of_origin: null
                                  allow_subscription: true
                                  inventory_quantity: 99
                                  variant_country_id: null
                                  customs_information_shipping: null
                                enroll_products: []
                                wholesale_price: '0.0'
                                subscription_price: '17.32'
                                unlimited_inventory: false
                                publish_to_rep_store: true
                                publish_to_share_tab: true
                                price_range_formatted: $17.32
                                display_wholesale_price: $0.00 (USD)
                                publish_to_retail_store: true
                                display_subscription_price: $17.32 (USD)
                                wholesale_subscription_price: '0.0'
                                display_wholesale_subscription_price: $0.00 (USD)
                              quantity: 1
                              ordered_variant: ''
                          phone: null
                          amount: '17.32'
                          rating: 5
                          review: >-
                            Lorem Ipsum is simply dummy text of the printing and
                            typesetting industry. Lorem Ipsum has been the
                            industry's standard dummy text ever since the 1500s,
                            when an unknown printer took a galley of type and
                            scrambled it to make a type specimen book. It has
                            survived not only five centuries, but also the leap
                            into electronic typesetting, remaining essentially
                            unchanged.
                          status: awaiting_payment
                          contact:
                            id: 20
                            ip: null
                            city: null
                            email: amir@danpheit.com
                            hours: null
                            phone: null
                            state: null
                            token: qgUpmwfwPpCiVmrQTnw6DZQR
                            email2: null
                            income: null
                            invest: null
                            phone2: null
                            reason: null
                            status: new
                            address: null
                            address2: null
                            interest: null
                            phone_id: null
                            best_time: null
                            full_name: a
                            last_name: ''
                            lead_type: null
                            time_zone: null
                            avatar_url: null
                            country_id: null
                            first_name: a
                            language_id: null
                            postal_code: null
                            requested_at: null
                          ship_to:
                            id: 980190974
                            city: a
                            name: a
                            state: Alaska
                            country:
                              id: 214
                              iso: US
                              itn: false
                              iso3: USA
                              name: United States
                              state: true
                              active: true
                              default: true
                              numcode: 840
                              address3: false
                              iso_name: UNITED STATES
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              created_at: '2023-12-26T04:48:23.479Z'
                              updated_at: '2023-12-26T04:48:23.479Z'
                              currency_code: USD
                              geo_entity_id: null
                              currency_symbol: $
                            default: false
                            address1: a
                            address2: a
                            address3: null
                            postal_code: '11111'
                            country_code: null
                          referrer: Maritzaa Gutkowski
                          shipping: '0.0'
                          subtotal: '17.32'
                          tracking: null
                          last_name: ''
                          sale_date: '2023-12-27T12:47:59.832Z'
                          created_at: '2023-12-27T12:47:59.832Z'
                          first_name: a
                          order_type: null
                          refundable: false
                          display_tax: $0.00 (USD)
                          order_number: F53375259023
                          currency_code: USD
                          display_amount: $17.32 (USD)
                          currency_symbol: $
                          display_refunds: (0 CV, 0 QV) -$0.00 (USD)
                          friendly_status: pending
                          order_thumbnail: >-
                            https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                          display_discount: $0.00 (USD)
                          display_shipping: $0.00 (USD)
                          display_subtotal: $17.32 (USD)
                          max_refundable_tax: '0.0'
                          recognized_ship_date: '2024-01-27'
                          max_refundable_amount: '17.32'
                          tracking_informations: []
                          max_refundable_shipping: '0.0'
                          max_refundable_product_price: '17.32'
                      timestamp: '2023-12-28T04:02:39.337Z'
                      identifier: subscriptionorder-170373615953
              example:
                id: 132
                name: subscription_paused
                payload:
                  subsctiption_order:
                    cv: 0
                    id: 53
                    qv: 0
                    tax: '0.0'
                    type: SubscriptionOrder
                    email: ram@fluid.com
                    items:
                      - id: 3
                        sku: QDPF7N2XOR
                        price: 17.32
                        product:
                          id: 113
                          sku: QDPF7N2XOR
                          image:
                            full: >-
                              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                            mini: >-
                              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                            detail: >-
                              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                          leads: 0
                          price: '17.32'
                          title: Aerodynamic Aluminum aaa
                          views: 0
                          active: true
                          images: []
                          public: true
                          vendor: null
                          enrolls: []
                          options: []
                          prompts: []
                          in_stock: true
                          shipping: '0.03'
                          stripped: Optimized clear-thinking access
                          variants:
                            - id: 113
                              title: Default Variant
                              buyable: true
                              image_url: null
                              option_value_ids: []
                              variant_countries:
                                - id: 686
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 214
                                    iso: US
                                    iso3: USA
                                    name: United States
                                    iso_name: UNITED STATES
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: US
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 687
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 65
                                    iso: FO
                                    iso3: FRO
                                    name: Faroe Islands
                                    iso_name: FAROE ISLANDS
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: FO
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 688
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 92
                                    iso: IN
                                    iso3: IND
                                    name: India
                                    iso_name: INDIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: IN
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 689
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 146
                                    iso: NI
                                    iso3: NIC
                                    name: Nicaragua
                                    iso_name: NICARAGUA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: NI
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 690
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 172
                                    iso: LC
                                    iso3: LCA
                                    name: Saint Lucia
                                    iso_name: SAINT LUCIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: LC
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 691
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 66
                                    iso: FJ
                                    iso3: FJI
                                    name: Fiji
                                    iso_name: FIJI
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: FJ
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 692
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 93
                                    iso: ID
                                    iso3: IDN
                                    name: Indonesia
                                    iso_name: INDONESIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: ID
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 693
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 147
                                    iso: NE
                                    iso3: NER
                                    name: Niger
                                    iso_name: NIGER
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: NE
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 694
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 67
                                    iso: FI
                                    iso3: FIN
                                    name: Finland
                                    iso_name: FINLAND
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: FI
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 695
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 148
                                    iso: NG
                                    iso3: NGA
                                    name: Nigeria
                                    iso_name: NIGERIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: NG
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                              allow_subscription: true
                          countries:
                            - id: 214
                              iso: US
                              itn: false
                              iso3: USA
                              name: United States
                              state: true
                              active: true
                              numcode: 840
                              address3: false
                              iso_name: UNITED STATES
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: USD
                              currency_symbol: $
                            - id: 65
                              iso: FO
                              itn: false
                              iso3: FRO
                              name: Faroe Islands
                              state: true
                              active: true
                              numcode: 234
                              address3: false
                              iso_name: FAROE ISLANDS
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: DKK
                              currency_symbol: kr.
                            - id: 92
                              iso: IN
                              itn: false
                              iso3: IND
                              name: India
                              state: true
                              active: true
                              numcode: 356
                              address3: false
                              iso_name: INDIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: INR
                              currency_symbol: ₹
                            - id: 146
                              iso: NI
                              itn: false
                              iso3: NIC
                              name: Nicaragua
                              state: true
                              active: true
                              numcode: 558
                              address3: false
                              iso_name: NICARAGUA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: NIO
                              currency_symbol: C$
                            - id: 172
                              iso: LC
                              itn: false
                              iso3: LCA
                              name: Saint Lucia
                              state: true
                              active: true
                              numcode: 662
                              address3: false
                              iso_name: SAINT LUCIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XCD
                              currency_symbol: $
                            - id: 66
                              iso: FJ
                              itn: false
                              iso3: FJI
                              name: Fiji
                              state: true
                              active: true
                              numcode: 242
                              address3: false
                              iso_name: FIJI
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: FJD
                              currency_symbol: $
                            - id: 93
                              iso: ID
                              itn: false
                              iso3: IDN
                              name: Indonesia
                              state: true
                              active: true
                              numcode: 360
                              address3: false
                              iso_name: INDONESIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: IDR
                              currency_symbol: Rp
                            - id: 147
                              iso: NE
                              itn: false
                              iso3: NER
                              name: Niger
                              state: true
                              active: true
                              numcode: 562
                              address3: false
                              iso_name: NIGER
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XOF
                              currency_symbol: Fr
                            - id: 67
                              iso: FI
                              itn: false
                              iso3: FIN
                              name: Finland
                              state: true
                              active: true
                              numcode: 246
                              address3: false
                              iso_name: FINLAND
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 148
                              iso: NG
                              itn: false
                              iso3: NGA
                              name: Nigeria
                              state: true
                              active: true
                              numcode: 566
                              address3: false
                              iso_name: NIGERIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: NGN
                              currency_symbol: ₦
                            - id: 174
                              iso: VC
                              itn: false
                              iso3: VCT
                              name: Saint Vincent and the Grenadines
                              state: true
                              active: true
                              numcode: 670
                              address3: false
                              iso_name: SAINT VINCENT AND THE GRENADINES
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XCD
                              currency_symbol: $
                            - id: 68
                              iso: FR
                              itn: false
                              iso3: FRA
                              name: France
                              state: true
                              active: true
                              numcode: 250
                              address3: false
                              iso_name: FRANCE
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 94
                              iso: IR
                              itn: false
                              iso3: IRN
                              name: Iran, Islamic Republic of
                              state: true
                              active: true
                              numcode: 364
                              address3: false
                              iso_name: IRAN, ISLAMIC REPUBLIC OF
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: IRR
                              currency_symbol: ﷼
                            - id: 149
                              iso: NU
                              itn: false
                              iso3: NIU
                              name: Niue
                              state: true
                              active: true
                              numcode: 570
                              address3: false
                              iso_name: NIUE
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: NZD
                              currency_symbol: $
                            - id: 175
                              iso: WS
                              itn: false
                              iso3: WSM
                              name: Samoa
                              state: true
                              active: true
                              numcode: 882
                              address3: false
                              iso_name: SAMOA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: WST
                              currency_symbol: T
                            - id: 69
                              iso: GF
                              itn: false
                              iso3: GUF
                              name: French Guiana
                              state: true
                              active: true
                              numcode: 254
                              address3: false
                              iso_name: FRENCH GUIANA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 95
                              iso: IQ
                              itn: false
                              iso3: IRQ
                              name: Iraq
                              state: true
                              active: true
                              numcode: 368
                              address3: false
                              iso_name: IRAQ
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: IQD
                              currency_symbol: ع.د
                            - id: 176
                              iso: SM
                              itn: false
                              iso3: SMR
                              name: San Marino
                              state: true
                              active: true
                              numcode: 674
                              address3: false
                              iso_name: SAN MARINO
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 96
                              iso: IE
                              itn: false
                              iso3: IRL
                              name: Ireland
                              state: true
                              active: true
                              numcode: 372
                              address3: false
                              iso_name: IRELAND
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 177
                              iso: ST
                              itn: false
                              iso3: STP
                              name: Sao Tome and Principe
                              state: true
                              active: true
                              numcode: 678
                              address3: false
                              iso_name: SAO TOME AND PRINCIPE
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: STD
                              currency_symbol: Db
                            - id: 39
                              iso: TD
                              itn: false
                              iso3: TCD
                              name: Chad
                              state: true
                              active: true
                              numcode: 148
                              address3: false
                              iso_name: CHAD
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XAF
                              currency_symbol: CFA
                            - id: 173
                              iso: PM
                              itn: false
                              iso3: SPM
                              name: Saint Pierre and Miquelon
                              state: true
                              active: true
                              numcode: 666
                              address3: false
                              iso_name: SAINT PIERRE AND MIQUELON
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                          image_url: >-
                            https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                          commission: '10.0'
                          country_id: null
                          share_link: null
                          shopify_id: null
                          description:
                            id: 122
                            body: <div>Optimized clear-thinking access</div>
                            name: description
                            record_id: 113
                            created_at: '2023-12-26T04:49:52.800Z'
                            updated_at: '2023-12-26T06:37:59.551Z'
                            record_type: Product
                          price_range:
                            - $17.32
                            - $17.32
                          country_code: td
                          currency_code: USD
                          display_price: $17.32 (USD)
                          option_values: {}
                          average_rating: 0
                          shopify_handle: null
                          currency_symbol: $
                          default_variant:
                            id: 113
                            sku: QDPF7N2XOR
                            size: 4cm
                            price: null
                            title: Default Variant
                            width: null
                            active: true
                            height: null
                            length: null
                            weight: 10 kg
                            hs_code: null
                            taxable: true
                            bar_code: null
                            physical: null
                            position: 1
                            image_url: null
                            is_master: true
                            created_at: '2023-12-26T04:49:52.811Z'
                            image_path: null
                            product_id: 113
                            shopify_id: null
                            updated_at: '2023-12-27T12:48:04.588Z'
                            external_id: null
                            discarded_at: null
                            keep_selling: false
                            option_attrs: []
                            unit_of_size: null
                            track_quantity: true
                            unit_of_weight: null
                            inventory_policy: none
                            country_of_origin: null
                            allow_subscription: true
                            inventory_quantity: 99
                            variant_country_id: null
                            customs_information_shipping: null
                          enroll_products: []
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          unlimited_inventory: false
                          publish_to_rep_store: true
                          publish_to_share_tab: true
                          price_range_formatted: $17.32
                          display_wholesale_price: $0.00 (USD)
                          publish_to_retail_store: true
                          display_subscription_price: $17.32 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        quantity: 1
                        ordered_variant: ''
                    phone: null
                    amount: '17.32'
                    rating: 5
                    review: >-
                      Lorem Ipsum is simply dummy text of the printing and
                      typesetting industry. Lorem Ipsum has been the industry's
                      standard dummy text ever since the 1500s, when an unknown
                      printer took a galley of type and scrambled it to make a
                      type specimen book. It has survived not only five
                      centuries, but also the leap into electronic typesetting,
                      remaining essentially unchanged.
                    status: awaiting_payment
                    contact:
                      id: 20
                      ip: null
                      city: null
                      email: amir@danpheit.com
                      hours: null
                      phone: null
                      state: null
                      token: qgUpmwfwPpCiVmrQTnw6DZQR
                      email2: null
                      income: null
                      invest: null
                      phone2: null
                      reason: null
                      status: new
                      address: null
                      address2: null
                      interest: null
                      phone_id: null
                      best_time: null
                      full_name: a
                      last_name: ''
                      lead_type: null
                      time_zone: null
                      avatar_url: null
                      country_id: null
                      first_name: a
                      language_id: null
                      postal_code: null
                      requested_at: null
                    ship_to:
                      id: 980190974
                      city: a
                      name: a
                      state: Alaska
                      country:
                        id: 214
                        iso: US
                        itn: false
                        iso3: USA
                        name: United States
                        state: true
                        active: true
                        default: true
                        numcode: 840
                        address3: false
                        iso_name: UNITED STATES
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        created_at: '2023-12-26T04:48:23.479Z'
                        updated_at: '2023-12-26T04:48:23.479Z'
                        currency_code: USD
                        geo_entity_id: null
                        currency_symbol: $
                      default: false
                      address1: a
                      address2: a
                      address3: null
                      postal_code: '11111'
                      country_code: null
                    referrer: Maritzaa Gutkowski
                    shipping: '0.0'
                    subtotal: '17.32'
                    tracking: null
                    last_name: ''
                    sale_date: '2023-12-27T12:47:59.832Z'
                    created_at: '2023-12-27T12:47:59.832Z'
                    first_name: a
                    order_type: null
                    refundable: false
                    display_tax: $0.00 (USD)
                    order_number: F53375259023
                    currency_code: USD
                    display_amount: $17.32 (USD)
                    currency_symbol: $
                    display_refunds: (0 CV, 0 QV) -$0.00 (USD)
                    friendly_status: pending
                    order_thumbnail: >-
                      https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                    display_discount: $0.00 (USD)
                    display_shipping: $0.00 (USD)
                    display_subtotal: $17.32 (USD)
                    max_refundable_tax: '0.0'
                    recognized_ship_date: '2024-01-27'
                    max_refundable_amount: '17.32'
                    tracking_informations: []
                    max_refundable_shipping: '0.0'
                    max_refundable_product_price: '17.32'
                timestamp: '2023-12-28T04:02:39.337Z'
                identifier: subscriptionorder-170373615953
      deprecated: false
  /api/company/webhooks/events/subscription_cancelled:
    get:
      tags:
        - Webhooks
      summary: subscription_cancelled
      operationId: subscription_cancelled
      parameters: []
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/subscription_cancelled'
                  - example:
                      id: 133
                      name: subscription_cancelled
                      payload:
                        subsctiption_order:
                          cv: 0
                          id: 53
                          qv: 0
                          tax: '0.0'
                          type: SubscriptionOrder
                          email: ram@fluid.com
                          items:
                            - id: 3
                              sku: QDPF7N2XOR
                              price: 17.32
                              product:
                                id: 113
                                sku: QDPF7N2XOR
                                image:
                                  full: >-
                                    https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                                  mini: >-
                                    https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                                  detail: >-
                                    https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                                leads: 0
                                price: '17.32'
                                title: Aerodynamic Aluminum aaa
                                views: 0
                                active: true
                                images: []
                                public: true
                                vendor: null
                                enrolls: []
                                options: []
                                prompts: []
                                in_stock: true
                                shipping: '0.03'
                                stripped: Optimized clear-thinking access
                                variants:
                                  - id: 113
                                    title: Default Variant
                                    buyable: true
                                    image_url: null
                                    option_value_ids: []
                                    variant_countries:
                                      - id: 686
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 214
                                          iso: US
                                          iso3: USA
                                          name: United States
                                          iso_name: UNITED STATES
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: US
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 687
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 65
                                          iso: FO
                                          iso3: FRO
                                          name: Faroe Islands
                                          iso_name: FAROE ISLANDS
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: FO
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 688
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 92
                                          iso: IN
                                          iso3: IND
                                          name: India
                                          iso_name: INDIA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: IN
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 689
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 146
                                          iso: NI
                                          iso3: NIC
                                          name: Nicaragua
                                          iso_name: NICARAGUA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: NI
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 690
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 172
                                          iso: LC
                                          iso3: LCA
                                          name: Saint Lucia
                                          iso_name: SAINT LUCIA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: LC
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 691
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 66
                                          iso: FJ
                                          iso3: FJI
                                          name: Fiji
                                          iso_name: FIJI
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: FJ
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 692
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 93
                                          iso: ID
                                          iso3: IDN
                                          name: Indonesia
                                          iso_name: INDONESIA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: ID
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 693
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 147
                                          iso: NE
                                          iso3: NER
                                          name: Niger
                                          iso_name: NIGER
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: NE
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 694
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 67
                                          iso: FI
                                          iso3: FIN
                                          name: Finland
                                          iso_name: FINLAND
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: FI
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                      - id: 695
                                        tax: '0.0'
                                        price: '17.32'
                                        country:
                                          id: 148
                                          iso: NG
                                          iso3: NGA
                                          name: Nigeria
                                          iso_name: NIGERIA
                                          tax_rate: 0
                                        shipping: '0.0'
                                        country_iso: NG
                                        currency_code: USD
                                        display_price: $17.32 (USD)
                                        currency_symbol: $
                                        wholesale_price: '0.0'
                                        subscription_price: '17.32'
                                        display_wholesale_price: $0.00 (USD)
                                        wholesale_subscription_price: '0.0'
                                        display_wholesale_subscription_price: $0.00 (USD)
                                    allow_subscription: true
                                countries:
                                  - id: 214
                                    iso: US
                                    itn: false
                                    iso3: USA
                                    name: United States
                                    state: true
                                    active: true
                                    numcode: 840
                                    address3: false
                                    iso_name: UNITED STATES
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: USD
                                    currency_symbol: $
                                  - id: 65
                                    iso: FO
                                    itn: false
                                    iso3: FRO
                                    name: Faroe Islands
                                    state: true
                                    active: true
                                    numcode: 234
                                    address3: false
                                    iso_name: FAROE ISLANDS
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: DKK
                                    currency_symbol: kr.
                                  - id: 92
                                    iso: IN
                                    itn: false
                                    iso3: IND
                                    name: India
                                    state: true
                                    active: true
                                    numcode: 356
                                    address3: false
                                    iso_name: INDIA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: INR
                                    currency_symbol: ₹
                                  - id: 146
                                    iso: NI
                                    itn: false
                                    iso3: NIC
                                    name: Nicaragua
                                    state: true
                                    active: true
                                    numcode: 558
                                    address3: false
                                    iso_name: NICARAGUA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: NIO
                                    currency_symbol: C$
                                  - id: 172
                                    iso: LC
                                    itn: false
                                    iso3: LCA
                                    name: Saint Lucia
                                    state: true
                                    active: true
                                    numcode: 662
                                    address3: false
                                    iso_name: SAINT LUCIA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: XCD
                                    currency_symbol: $
                                  - id: 66
                                    iso: FJ
                                    itn: false
                                    iso3: FJI
                                    name: Fiji
                                    state: true
                                    active: true
                                    numcode: 242
                                    address3: false
                                    iso_name: FIJI
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: FJD
                                    currency_symbol: $
                                  - id: 93
                                    iso: ID
                                    itn: false
                                    iso3: IDN
                                    name: Indonesia
                                    state: true
                                    active: true
                                    numcode: 360
                                    address3: false
                                    iso_name: INDONESIA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: IDR
                                    currency_symbol: Rp
                                  - id: 147
                                    iso: NE
                                    itn: false
                                    iso3: NER
                                    name: Niger
                                    state: true
                                    active: true
                                    numcode: 562
                                    address3: false
                                    iso_name: NIGER
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: XOF
                                    currency_symbol: Fr
                                  - id: 67
                                    iso: FI
                                    itn: false
                                    iso3: FIN
                                    name: Finland
                                    state: true
                                    active: true
                                    numcode: 246
                                    address3: false
                                    iso_name: FINLAND
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 148
                                    iso: NG
                                    itn: false
                                    iso3: NGA
                                    name: Nigeria
                                    state: true
                                    active: true
                                    numcode: 566
                                    address3: false
                                    iso_name: NIGERIA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: NGN
                                    currency_symbol: ₦
                                  - id: 174
                                    iso: VC
                                    itn: false
                                    iso3: VCT
                                    name: Saint Vincent and the Grenadines
                                    state: true
                                    active: true
                                    numcode: 670
                                    address3: false
                                    iso_name: SAINT VINCENT AND THE GRENADINES
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: XCD
                                    currency_symbol: $
                                  - id: 68
                                    iso: FR
                                    itn: false
                                    iso3: FRA
                                    name: France
                                    state: true
                                    active: true
                                    numcode: 250
                                    address3: false
                                    iso_name: FRANCE
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 94
                                    iso: IR
                                    itn: false
                                    iso3: IRN
                                    name: Iran, Islamic Republic of
                                    state: true
                                    active: true
                                    numcode: 364
                                    address3: false
                                    iso_name: IRAN, ISLAMIC REPUBLIC OF
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: IRR
                                    currency_symbol: ﷼
                                  - id: 149
                                    iso: NU
                                    itn: false
                                    iso3: NIU
                                    name: Niue
                                    state: true
                                    active: true
                                    numcode: 570
                                    address3: false
                                    iso_name: NIUE
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: NZD
                                    currency_symbol: $
                                  - id: 175
                                    iso: WS
                                    itn: false
                                    iso3: WSM
                                    name: Samoa
                                    state: true
                                    active: true
                                    numcode: 882
                                    address3: false
                                    iso_name: SAMOA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: WST
                                    currency_symbol: T
                                  - id: 69
                                    iso: GF
                                    itn: false
                                    iso3: GUF
                                    name: French Guiana
                                    state: true
                                    active: true
                                    numcode: 254
                                    address3: false
                                    iso_name: FRENCH GUIANA
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 95
                                    iso: IQ
                                    itn: false
                                    iso3: IRQ
                                    name: Iraq
                                    state: true
                                    active: true
                                    numcode: 368
                                    address3: false
                                    iso_name: IRAQ
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: IQD
                                    currency_symbol: ع.د
                                  - id: 176
                                    iso: SM
                                    itn: false
                                    iso3: SMR
                                    name: San Marino
                                    state: true
                                    active: true
                                    numcode: 674
                                    address3: false
                                    iso_name: SAN MARINO
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 96
                                    iso: IE
                                    itn: false
                                    iso3: IRL
                                    name: Ireland
                                    state: true
                                    active: true
                                    numcode: 372
                                    address3: false
                                    iso_name: IRELAND
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                  - id: 177
                                    iso: ST
                                    itn: false
                                    iso3: STP
                                    name: Sao Tome and Principe
                                    state: true
                                    active: true
                                    numcode: 678
                                    address3: false
                                    iso_name: SAO TOME AND PRINCIPE
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: STD
                                    currency_symbol: Db
                                  - id: 39
                                    iso: TD
                                    itn: false
                                    iso3: TCD
                                    name: Chad
                                    state: true
                                    active: true
                                    numcode: 148
                                    address3: false
                                    iso_name: CHAD
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: XAF
                                    currency_symbol: CFA
                                  - id: 173
                                    iso: PM
                                    itn: false
                                    iso3: SPM
                                    name: Saint Pierre and Miquelon
                                    state: true
                                    active: true
                                    numcode: 666
                                    address3: false
                                    iso_name: SAINT PIERRE AND MIQUELON
                                    passport: false
                                    tax_rate: 0
                                    delimiter: ','
                                    separator: .
                                    currency_code: EUR
                                    currency_symbol: €
                                image_url: >-
                                  https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                                commission: '10.0'
                                country_id: null
                                share_link: null
                                shopify_id: null
                                description:
                                  id: 122
                                  body: <div>Optimized clear-thinking access</div>
                                  name: description
                                  record_id: 113
                                  created_at: '2023-12-26T04:49:52.800Z'
                                  updated_at: '2023-12-26T06:37:59.551Z'
                                  record_type: Product
                                price_range:
                                  - $17.32
                                  - $17.32
                                country_code: td
                                currency_code: USD
                                display_price: $17.32 (USD)
                                option_values: {}
                                average_rating: 0
                                shopify_handle: null
                                currency_symbol: $
                                default_variant:
                                  id: 113
                                  sku: QDPF7N2XOR
                                  size: 4cm
                                  price: null
                                  title: Default Variant
                                  width: null
                                  active: true
                                  height: null
                                  length: null
                                  weight: 10 kg
                                  hs_code: null
                                  taxable: true
                                  bar_code: null
                                  physical: null
                                  position: 1
                                  image_url: null
                                  is_master: true
                                  created_at: '2023-12-26T04:49:52.811Z'
                                  image_path: null
                                  product_id: 113
                                  shopify_id: null
                                  updated_at: '2023-12-27T12:48:04.588Z'
                                  external_id: null
                                  discarded_at: null
                                  keep_selling: false
                                  option_attrs: []
                                  unit_of_size: null
                                  track_quantity: true
                                  unit_of_weight: null
                                  inventory_policy: none
                                  country_of_origin: null
                                  allow_subscription: true
                                  inventory_quantity: 99
                                  variant_country_id: null
                                  customs_information_shipping: null
                                enroll_products: []
                                wholesale_price: '0.0'
                                subscription_price: '17.32'
                                unlimited_inventory: false
                                publish_to_rep_store: true
                                publish_to_share_tab: true
                                price_range_formatted: $17.32
                                display_wholesale_price: $0.00 (USD)
                                publish_to_retail_store: true
                                display_subscription_price: $17.32 (USD)
                                wholesale_subscription_price: '0.0'
                                display_wholesale_subscription_price: $0.00 (USD)
                              quantity: 1
                              ordered_variant: ''
                          phone: null
                          amount: '17.32'
                          rating: 5
                          review: ''
                          status: awaiting_payment
                          contact:
                            id: 20
                            ip: null
                            city: null
                            email: amir@danpheit.com
                            hours: null
                            phone: null
                            state: null
                            token: qgUpmwfwPpCiVmrQTnw6DZQR
                            email2: null
                            income: null
                            invest: null
                            phone2: null
                            reason: null
                            status: new
                            address: null
                            address2: null
                            interest: null
                            phone_id: null
                            best_time: null
                            full_name: a
                            last_name: ''
                            lead_type: null
                            time_zone: null
                            avatar_url: null
                            country_id: null
                            first_name: a
                            language_id: null
                            postal_code: null
                            requested_at: null
                          ship_to:
                            id: 980190974
                            city: a
                            name: a
                            state: Alaska
                            country:
                              id: 214
                              iso: US
                              itn: false
                              iso3: USA
                              name: United States
                              state: true
                              active: true
                              default: true
                              numcode: 840
                              address3: false
                              iso_name: UNITED STATES
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              created_at: '2023-12-26T04:48:23.479Z'
                              updated_at: '2023-12-26T04:48:23.479Z'
                              currency_code: USD
                              geo_entity_id: null
                              currency_symbol: $
                            default: false
                            address1: a
                            address2: a
                            address3: null
                            postal_code: '11111'
                            country_code: null
                          referrer: Maritzaa Gutkowski
                          shipping: '0.0'
                          subtotal: '17.32'
                          tracking: null
                          last_name: ''
                          sale_date: '2023-12-27T12:47:59.832Z'
                          created_at: '2023-12-27T12:47:59.832Z'
                          first_name: a
                          order_type: null
                          refundable: false
                          display_tax: $0.00 (USD)
                          order_number: F53375259023
                          currency_code: USD
                          display_amount: $17.32 (USD)
                          currency_symbol: $
                          display_refunds: (0 CV, 0 QV) -$0.00 (USD)
                          friendly_status: pending
                          order_thumbnail: >-
                            https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                          display_discount: $0.00 (USD)
                          display_shipping: $0.00 (USD)
                          display_subtotal: $17.32 (USD)
                          max_refundable_tax: '0.0'
                          recognized_ship_date: '2024-01-27'
                          max_refundable_amount: '17.32'
                          tracking_informations: []
                          max_refundable_shipping: '0.0'
                          max_refundable_product_price: '17.32'
                      timestamp: '2023-12-28T04:04:18.669Z'
                      identifier: subscriptionorder-170373625853
              example:
                id: 133
                name: subscription_cancelled
                payload:
                  subsctiption_order:
                    cv: 0
                    id: 53
                    qv: 0
                    tax: '0.0'
                    type: SubscriptionOrder
                    email: ram@fluid.com
                    items:
                      - id: 3
                        sku: QDPF7N2XOR
                        price: 17.32
                        product:
                          id: 113
                          sku: QDPF7N2XOR
                          image:
                            full: >-
                              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                            mini: >-
                              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                            detail: >-
                              https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                          leads: 0
                          price: '17.32'
                          title: Aerodynamic Aluminum aaa
                          views: 0
                          active: true
                          images: []
                          public: true
                          vendor: null
                          enrolls: []
                          options: []
                          prompts: []
                          in_stock: true
                          shipping: '0.03'
                          stripped: Optimized clear-thinking access
                          variants:
                            - id: 113
                              title: Default Variant
                              buyable: true
                              image_url: null
                              option_value_ids: []
                              variant_countries:
                                - id: 686
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 214
                                    iso: US
                                    iso3: USA
                                    name: United States
                                    iso_name: UNITED STATES
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: US
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 687
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 65
                                    iso: FO
                                    iso3: FRO
                                    name: Faroe Islands
                                    iso_name: FAROE ISLANDS
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: FO
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 688
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 92
                                    iso: IN
                                    iso3: IND
                                    name: India
                                    iso_name: INDIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: IN
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 689
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 146
                                    iso: NI
                                    iso3: NIC
                                    name: Nicaragua
                                    iso_name: NICARAGUA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: NI
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 690
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 172
                                    iso: LC
                                    iso3: LCA
                                    name: Saint Lucia
                                    iso_name: SAINT LUCIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: LC
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 691
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 66
                                    iso: FJ
                                    iso3: FJI
                                    name: Fiji
                                    iso_name: FIJI
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: FJ
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 692
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 93
                                    iso: ID
                                    iso3: IDN
                                    name: Indonesia
                                    iso_name: INDONESIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: ID
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 693
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 147
                                    iso: NE
                                    iso3: NER
                                    name: Niger
                                    iso_name: NIGER
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: NE
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 694
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 67
                                    iso: FI
                                    iso3: FIN
                                    name: Finland
                                    iso_name: FINLAND
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: FI
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                                - id: 695
                                  tax: '0.0'
                                  price: '17.32'
                                  country:
                                    id: 148
                                    iso: NG
                                    iso3: NGA
                                    name: Nigeria
                                    iso_name: NIGERIA
                                    tax_rate: 0
                                  shipping: '0.0'
                                  country_iso: NG
                                  currency_code: USD
                                  display_price: $17.32 (USD)
                                  currency_symbol: $
                                  wholesale_price: '0.0'
                                  subscription_price: '17.32'
                                  display_wholesale_price: $0.00 (USD)
                                  wholesale_subscription_price: '0.0'
                                  display_wholesale_subscription_price: $0.00 (USD)
                              allow_subscription: true
                          countries:
                            - id: 214
                              iso: US
                              itn: false
                              iso3: USA
                              name: United States
                              state: true
                              active: true
                              numcode: 840
                              address3: false
                              iso_name: UNITED STATES
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: USD
                              currency_symbol: $
                            - id: 65
                              iso: FO
                              itn: false
                              iso3: FRO
                              name: Faroe Islands
                              state: true
                              active: true
                              numcode: 234
                              address3: false
                              iso_name: FAROE ISLANDS
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: DKK
                              currency_symbol: kr.
                            - id: 92
                              iso: IN
                              itn: false
                              iso3: IND
                              name: India
                              state: true
                              active: true
                              numcode: 356
                              address3: false
                              iso_name: INDIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: INR
                              currency_symbol: ₹
                            - id: 146
                              iso: NI
                              itn: false
                              iso3: NIC
                              name: Nicaragua
                              state: true
                              active: true
                              numcode: 558
                              address3: false
                              iso_name: NICARAGUA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: NIO
                              currency_symbol: C$
                            - id: 172
                              iso: LC
                              itn: false
                              iso3: LCA
                              name: Saint Lucia
                              state: true
                              active: true
                              numcode: 662
                              address3: false
                              iso_name: SAINT LUCIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XCD
                              currency_symbol: $
                            - id: 66
                              iso: FJ
                              itn: false
                              iso3: FJI
                              name: Fiji
                              state: true
                              active: true
                              numcode: 242
                              address3: false
                              iso_name: FIJI
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: FJD
                              currency_symbol: $
                            - id: 93
                              iso: ID
                              itn: false
                              iso3: IDN
                              name: Indonesia
                              state: true
                              active: true
                              numcode: 360
                              address3: false
                              iso_name: INDONESIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: IDR
                              currency_symbol: Rp
                            - id: 147
                              iso: NE
                              itn: false
                              iso3: NER
                              name: Niger
                              state: true
                              active: true
                              numcode: 562
                              address3: false
                              iso_name: NIGER
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XOF
                              currency_symbol: Fr
                            - id: 67
                              iso: FI
                              itn: false
                              iso3: FIN
                              name: Finland
                              state: true
                              active: true
                              numcode: 246
                              address3: false
                              iso_name: FINLAND
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 148
                              iso: NG
                              itn: false
                              iso3: NGA
                              name: Nigeria
                              state: true
                              active: true
                              numcode: 566
                              address3: false
                              iso_name: NIGERIA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: NGN
                              currency_symbol: ₦
                            - id: 174
                              iso: VC
                              itn: false
                              iso3: VCT
                              name: Saint Vincent and the Grenadines
                              state: true
                              active: true
                              numcode: 670
                              address3: false
                              iso_name: SAINT VINCENT AND THE GRENADINES
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XCD
                              currency_symbol: $
                            - id: 68
                              iso: FR
                              itn: false
                              iso3: FRA
                              name: France
                              state: true
                              active: true
                              numcode: 250
                              address3: false
                              iso_name: FRANCE
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 94
                              iso: IR
                              itn: false
                              iso3: IRN
                              name: Iran, Islamic Republic of
                              state: true
                              active: true
                              numcode: 364
                              address3: false
                              iso_name: IRAN, ISLAMIC REPUBLIC OF
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: IRR
                              currency_symbol: ﷼
                            - id: 149
                              iso: NU
                              itn: false
                              iso3: NIU
                              name: Niue
                              state: true
                              active: true
                              numcode: 570
                              address3: false
                              iso_name: NIUE
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: NZD
                              currency_symbol: $
                            - id: 175
                              iso: WS
                              itn: false
                              iso3: WSM
                              name: Samoa
                              state: true
                              active: true
                              numcode: 882
                              address3: false
                              iso_name: SAMOA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: WST
                              currency_symbol: T
                            - id: 69
                              iso: GF
                              itn: false
                              iso3: GUF
                              name: French Guiana
                              state: true
                              active: true
                              numcode: 254
                              address3: false
                              iso_name: FRENCH GUIANA
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 95
                              iso: IQ
                              itn: false
                              iso3: IRQ
                              name: Iraq
                              state: true
                              active: true
                              numcode: 368
                              address3: false
                              iso_name: IRAQ
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: IQD
                              currency_symbol: ع.د
                            - id: 176
                              iso: SM
                              itn: false
                              iso3: SMR
                              name: San Marino
                              state: true
                              active: true
                              numcode: 674
                              address3: false
                              iso_name: SAN MARINO
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 96
                              iso: IE
                              itn: false
                              iso3: IRL
                              name: Ireland
                              state: true
                              active: true
                              numcode: 372
                              address3: false
                              iso_name: IRELAND
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                            - id: 177
                              iso: ST
                              itn: false
                              iso3: STP
                              name: Sao Tome and Principe
                              state: true
                              active: true
                              numcode: 678
                              address3: false
                              iso_name: SAO TOME AND PRINCIPE
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: STD
                              currency_symbol: Db
                            - id: 39
                              iso: TD
                              itn: false
                              iso3: TCD
                              name: Chad
                              state: true
                              active: true
                              numcode: 148
                              address3: false
                              iso_name: CHAD
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: XAF
                              currency_symbol: CFA
                            - id: 173
                              iso: PM
                              itn: false
                              iso3: SPM
                              name: Saint Pierre and Miquelon
                              state: true
                              active: true
                              numcode: 666
                              address3: false
                              iso_name: SAINT PIERRE AND MIQUELON
                              passport: false
                              tax_rate: 0
                              delimiter: ','
                              separator: .
                              currency_code: EUR
                              currency_symbol: €
                          image_url: >-
                            https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                          commission: '10.0'
                          country_id: null
                          share_link: null
                          shopify_id: null
                          description:
                            id: 122
                            body: <div>Optimized clear-thinking access</div>
                            name: description
                            record_id: 113
                            created_at: '2023-12-26T04:49:52.800Z'
                            updated_at: '2023-12-26T06:37:59.551Z'
                            record_type: Product
                          price_range:
                            - $17.32
                            - $17.32
                          country_code: td
                          currency_code: USD
                          display_price: $17.32 (USD)
                          option_values: {}
                          average_rating: 0
                          shopify_handle: null
                          currency_symbol: $
                          default_variant:
                            id: 113
                            sku: QDPF7N2XOR
                            size: 4cm
                            price: null
                            title: Default Variant
                            width: null
                            active: true
                            height: null
                            length: null
                            weight: 10 kg
                            hs_code: null
                            taxable: true
                            bar_code: null
                            physical: null
                            position: 1
                            image_url: null
                            is_master: true
                            created_at: '2023-12-26T04:49:52.811Z'
                            image_path: null
                            product_id: 113
                            shopify_id: null
                            updated_at: '2023-12-27T12:48:04.588Z'
                            external_id: null
                            discarded_at: null
                            keep_selling: false
                            option_attrs: []
                            unit_of_size: null
                            track_quantity: true
                            unit_of_weight: null
                            inventory_policy: none
                            country_of_origin: null
                            allow_subscription: true
                            inventory_quantity: 99
                            variant_country_id: null
                            customs_information_shipping: null
                          enroll_products: []
                          wholesale_price: '0.0'
                          subscription_price: '17.32'
                          unlimited_inventory: false
                          publish_to_rep_store: true
                          publish_to_share_tab: true
                          price_range_formatted: $17.32
                          display_wholesale_price: $0.00 (USD)
                          publish_to_retail_store: true
                          display_subscription_price: $17.32 (USD)
                          wholesale_subscription_price: '0.0'
                          display_wholesale_subscription_price: $0.00 (USD)
                        quantity: 1
                        ordered_variant: ''
                    phone: null
                    amount: '17.32'
                    rating: 5
                    review: ''
                    status: awaiting_payment
                    contact:
                      id: 20
                      ip: null
                      city: null
                      email: amir@danpheit.com
                      hours: null
                      phone: null
                      state: null
                      token: qgUpmwfwPpCiVmrQTnw6DZQR
                      email2: null
                      income: null
                      invest: null
                      phone2: null
                      reason: null
                      status: new
                      address: null
                      address2: null
                      interest: null
                      phone_id: null
                      best_time: null
                      full_name: a
                      last_name: ''
                      lead_type: null
                      time_zone: null
                      avatar_url: null
                      country_id: null
                      first_name: a
                      language_id: null
                      postal_code: null
                      requested_at: null
                    ship_to:
                      id: 980190974
                      city: a
                      name: a
                      state: Alaska
                      country:
                        id: 214
                        iso: US
                        itn: false
                        iso3: USA
                        name: United States
                        state: true
                        active: true
                        default: true
                        numcode: 840
                        address3: false
                        iso_name: UNITED STATES
                        passport: false
                        tax_rate: 0
                        delimiter: ','
                        separator: .
                        created_at: '2023-12-26T04:48:23.479Z'
                        updated_at: '2023-12-26T04:48:23.479Z'
                        currency_code: USD
                        geo_entity_id: null
                        currency_symbol: $
                      default: false
                      address1: a
                      address2: a
                      address3: null
                      postal_code: '11111'
                      country_code: null
                    referrer: Maritzaa Gutkowski
                    shipping: '0.0'
                    subtotal: '17.32'
                    tracking: null
                    last_name: ''
                    sale_date: '2023-12-27T12:47:59.832Z'
                    created_at: '2023-12-27T12:47:59.832Z'
                    first_name: a
                    order_type: null
                    refundable: false
                    display_tax: $0.00 (USD)
                    order_number: F53375259023
                    currency_code: USD
                    display_amount: $17.32 (USD)
                    currency_symbol: $
                    display_refunds: (0 CV, 0 QV) -$0.00 (USD)
                    friendly_status: pending
                    order_thumbnail: >-
                      https://d1r16g5m5p3ba7.cloudfront.net/uploads/product/image/298486374/beautyrest.png
                    display_discount: $0.00 (USD)
                    display_shipping: $0.00 (USD)
                    display_subtotal: $17.32 (USD)
                    max_refundable_tax: '0.0'
                    recognized_ship_date: '2024-01-27'
                    max_refundable_amount: '17.32'
                    tracking_informations: []
                    max_refundable_shipping: '0.0'
                    max_refundable_product_price: '17.32'
                timestamp: '2023-12-28T04:04:18.669Z'
                identifier: subscriptionorder-170373625853
      deprecated: false
  /api/company/webhooks/events/user_created:
    get:
      tags:
        - Webhooks
      summary: user_created
      operationId: user_created
      parameters: []
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/user_created'
                  - example:
                      id: 163
                      name: user_created
                      payload:
                        user:
                          id: 124
                          user:
                            bio: null
                            dob: null
                            email: ram@gmailc.om
                            phone: null
                            avatar: null
                            gender: null
                            wechat: null
                            twitter: null
                            youtube: null
                            facebook: null
                            linkedin: null
                            whatsapp: null
                            zip_code: null
                            google_id: null
                            instagram: null
                            last_name: Gm
                            time_zone: null
                            first_name: Ram
                          active: false
                          username: null
                          affiliate:
                            id: 1
                            email: tingeym2@gmail.com
                            username: tobias
                            external_id: '2284189'
                          external_id: null
                      timestamp: '2023-12-28T05:26:09.157Z'
                      identifier: usercompany-1703741169124
              example:
                id: 163
                name: user_created
                payload:
                  user:
                    id: 124
                    user:
                      bio: null
                      dob: null
                      email: ram@gmailc.om
                      phone: null
                      avatar: null
                      gender: null
                      wechat: null
                      twitter: null
                      youtube: null
                      facebook: null
                      linkedin: null
                      whatsapp: null
                      zip_code: null
                      google_id: null
                      instagram: null
                      last_name: Gm
                      time_zone: null
                      first_name: Ram
                    active: false
                    username: null
                    affiliate:
                      id: 1
                      email: tingeym2@gmail.com
                      username: tobias
                      external_id: '2284189'
                    external_id: null
                timestamp: '2023-12-28T05:26:09.157Z'
                identifier: usercompany-1703741169124
      deprecated: false
  /api/company/webhooks/events/user_updated:
    get:
      tags:
        - Webhooks
      summary: user_updated
      operationId: user_updated
      parameters: []
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/user_updated'
                  - example:
                      id: 162
                      name: user_updated
                      payload:
                        user:
                          id: 124
                          user:
                            bio: null
                            dob: null
                            email: ram@gmailc.om
                            phone: null
                            avatar: null
                            gender: null
                            wechat: null
                            twitter: null
                            youtube: null
                            facebook: null
                            linkedin: null
                            whatsapp: null
                            zip_code: null
                            google_id: null
                            instagram: null
                            last_name: Gm
                            time_zone: null
                            first_name: Ram
                          active: false
                          username: null
                          affiliate:
                            id: 1
                            email: tingeym2@gmail.com
                            username: tobias
                            external_id: '2284189'
                          external_id: null
                      timestamp: '2023-12-28T05:25:29.021Z'
                      identifier: usercompany-1703741129124
              example:
                id: 162
                name: user_updated
                payload:
                  user:
                    id: 124
                    user:
                      bio: null
                      dob: null
                      email: ram@gmailc.om
                      phone: null
                      avatar: null
                      gender: null
                      wechat: null
                      twitter: null
                      youtube: null
                      facebook: null
                      linkedin: null
                      whatsapp: null
                      zip_code: null
                      google_id: null
                      instagram: null
                      last_name: Gm
                      time_zone: null
                      first_name: Ram
                    active: false
                    username: null
                    affiliate:
                      id: 1
                      email: tingeym2@gmail.com
                      username: tobias
                      external_id: '2284189'
                    external_id: null
                timestamp: '2023-12-28T05:25:29.021Z'
                identifier: usercompany-1703741129124
      deprecated: false
  /api/company/webhooks/events/user_deactivated:
    get:
      tags:
        - Webhooks
      summary: user_deactivated
      operationId: user_deactivated
      parameters: []
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              $ref: '#/components/headers/ContentType'
            Content-Length:
              $ref: '#/components/headers/ContentLength'
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
          content:
            application/json; charset=utf-8:
              schema:
                allOf:
                  - $ref: '#/components/schemas/user_deactivated'
                  - example:
                      id: 164
                      name: user_deactivated
                      payload:
                        user:
                          id: 124
                          user:
                            bio: null
                            dob: null
                            email: ram@gmailc.om
                            phone: null
                            avatar: null
                            gender: null
                            wechat: null
                            twitter: null
                            youtube: null
                            facebook: null
                            linkedin: null
                            whatsapp: null
                            zip_code: null
                            google_id: null
                            instagram: null
                            last_name: Gm
                            time_zone: null
                            first_name: Ram
                          active: false
                          username: null
                          affiliate:
                            id: 1
                            email: tingeym2@gmail.com
                            username: tobias
                            external_id: '2284189'
                          external_id: null
                      timestamp: '2023-12-28T05:26:57.115Z'
                      identifier: usercompany-1703741217124
              example:
                id: 164
                name: user_deactivated
                payload:
                  user:
                    id: 124
                    user:
                      bio: null
                      dob: null
                      email: ram@gmailc.om
                      phone: null
                      avatar: null
                      gender: null
                      wechat: null
                      twitter: null
                      youtube: null
                      facebook: null
                      linkedin: null
                      whatsapp: null
                      zip_code: null
                      google_id: null
                      instagram: null
                      last_name: Gm
                      time_zone: null
                      first_name: Ram
                    active: false
                    username: null
                    affiliate:
                      id: 1
                      email: tingeym2@gmail.com
                      username: tobias
                      external_id: '2284189'
                    external_id: null
                timestamp: '2023-12-28T05:26:57.115Z'
                identifier: usercompany-1703741217124
      deprecated: false
  /api/company/webhooks/events/{event_name}:
    get:
      summary: Get webhook event payload example
      tags:
        - Webhooks
      operationId: webhook-events
      parameters:
        - name: event_name
          in: path
          required: true
          schema:
            type: string
            example: order
      responses:
        '200':
          description: Event payload example
          content:
            application/json:
              schema:
                type: object
        '404':
          description: Event not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Invalid resource requested
                  status:
                    type: string
                    example: '404'
  /api/company/webhooks/resources:
    get:
      summary: List webhooks resources
      tags:
        - Webhooks Resources
      security:
        - bearer_auth: []
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                required:
                  - resources
                  - meta
                properties:
                  resources:
                    type: object
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: 123e4567-e89b-12d3-a456-426614174000
                      timestamp:
                        type: string
                        example: '2021-01-01T00:00:00Z'
  /api/public/v2025-06/affiliates/lookup:
    post:
      summary: Retrieve affiliate information
      operationId: affiliate-lookup
      tags:
        - affiliate
      parameters: []
      responses:
        '201':
          description: affiliate found
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: number
                    example: 201
                  affiliate:
                    $ref: '#/components/schemas/Affiliate'
                  metadata:
                    $ref: '#/components/schemas/ResponseMetadata'
                required:
                  - status
                  - affiliate
                  - metadata
        '404':
          description: affiliate not found
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 404
                  errors:
                    - message: Affiliate not found
                  metadata:
                    fluid_shop: myshop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 123e4567-e89b-12d3-a456-426614174000
                    timestamp: '2025-01-01T00:00:00Z'
        '422':
          description: invalid request
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 422
                  errors:
                    - message: Unexpected error
                  metadata:
                    fluid_shop: myshop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 123e4567-e89b-12d3-a456-426614174000
                    timestamp: '2025-01-01T00:00:00Z'
        '500':
          description: internal server error
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 500
                  errors:
                    - message: Unexpected error
                  metadata:
                    fluid_shop: myshop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 123e4567-e89b-12d3-a456-426614174000
                    timestamp: '2025-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                metadata:
                  type: object
                  properties:
                    fluid_shop:
                      type: string
                      example: myshop
                    fluid_session:
                      type: string
                      format: /\Afs_[0-9A-Za-z&&[^0OIl]]{22}\z/
                      example: fs_szwdDuRbqEe7AV7sXk7vVq
                    fluid_locale:
                      type: string
                      format: /\A[a-z]{2}_[A-Z]{2}\z/
                      example: en_US
                    fluid_journey:
                      type: string
                    attribution:
                      $ref: '#/components/schemas/Attribution'
                  required:
                    - fluid_shop
                    - fluid_session
                    - attribution
              required:
                - metadata
  /api/public/v2025-06/commerce/carts/{cart_token}/address:
    post:
      summary: Updates cart address
      tags:
        - carts
      operationId: cart_address-update
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: address updated with address id
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    $ref: '#/components/schemas/Cart'
                  meta:
                    $ref: '#/components/schemas/CartCheckoutMetadata'
        '410':
          description: Cart is processed and cannot be modified
        '422':
          description: invalid address type
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Invalid address type
      requestBody:
        content:
          application/json:
            schema:
              type:
                - object
                - 'null'
              properties:
                type:
                  type: string
                  enum:
                    - ship_to
                    - bill_to
                  example: bill_to
                jwt:
                  type:
                    - string
                    - 'null'
                  example: eyJhbGciO1NiJ9.eyJhdXcyNjN9.AZ-4PAgFwVyGp
                address_id:
                  type:
                    - integer
                    - 'null'
                  example: 456
                address:
                  type:
                    - object
                    - 'null'
                  properties:
                    id:
                      type:
                        - integer
                        - 'null'
                      example: 456
                    first_name:
                      type: string
                      example: John
                    last_name:
                      type: string
                      example: Doe
                    address1:
                      type: string
                      example: 123 Main St
                    city:
                      type: string
                      example: Anytown
                    state:
                      type: string
                      example: CA
                    postal_code:
                      type: string
                      example: '12345'
                    country_id:
                      type: integer
                      example: 1
                      description: Takes precedence over country_code if both are provided.
                    country_code:
                      type: string
                      example: US
                      description: >-
                        country_id takes precedence if both country_id and
                        country_code provided.
                metadata:
                  $ref: '#/components/schemas/RequestMetadataOptional'
  /api/public/v2025-06/commerce/carts/{cart_token}/checkout:
    post:
      summary: Completes cart checkout
      tags:
        - carts
      operationId: cart-checkout
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: checkout completed
          content:
            application/json:
              schema:
                type: object
                properties:
                  order:
                    $ref: '#/components/schemas/CheckoutOrder'
                  meta:
                    $ref: '#/components/schemas/CartShopMetadata'
        '202':
          description: enrollment created with pre purchase
          content:
            application/json:
              schema:
                type: object
                properties:
                  enrollment:
                    type: object
                    properties:
                      cart_token:
                        type: string
                        example: CART_TOKEN
                      state:
                        type: string
                        example: incomplete
                      token:
                        type: string
                        example: ENROLLMENT_TOKEN
                  meta:
                    $ref: '#/components/schemas/CartMetadata'
        '422':
          description: checkout declined
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      payment:
                        type: array
                        items:
                          type: string
                          example: >-
                            Payment declined: Unable to process the authorize
                            transaction.
                  meta:
                    $ref: '#/components/schemas/CartMetadata'
  /api/public/v2025-06/commerce/carts/{cart_token}/update_country:
    patch:
      summary: Updates the country of a cart, also updates the currency code
      tags:
        - carts
      operationId: cart-country-update
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: cart's country and currency code changed
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    $ref: '#/components/schemas/Cart'
                  meta:
                    $ref: '#/components/schemas/CartMetadata'
        '404':
          description: country code not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Country not found
                  errors:
                    type: object
                    example:
                      country_code:
                        - not found
                  meta:
                    $ref: '#/components/schemas/CartMetadata'
        '410':
          description: Cart is processed and cannot be modified
      requestBody:
        content:
          application/json:
            schema:
              required:
                - country_code
              type: object
              properties:
                country_code:
                  type: string
                  example: US
                metadata:
                  $ref: '#/components/schemas/RequestMetadataOptional'
        description: ISO country code to update the cart to
  /api/public/v2025-06/commerce/carts/{cart_token}/discount:
    post:
      summary: Applies a discount to the cart
      tags:
        - carts
      operationId: cart-discount-apply
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: discount applied
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    $ref: '#/components/schemas/Cart'
                  meta:
                    $ref: '#/components/schemas/CartCheckoutMetadata'
        '404':
          description: discount code not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
                      example:
                        - not found
                  meta:
                    $ref: '#/components/schemas/CartMetadata'
        '410':
          description: Cart is processed and cannot be modified
        '422':
          description: discount code already applied
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    properties:
                      coupon_code:
                        type: array
                        items:
                          type: string
                          example: already applied
                  meta:
                    $ref: '#/components/schemas/CartMetadata'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                discount_code:
                  type: string
                metadata:
                  $ref: '#/components/schemas/RequestMetadataOptional'
  /api/public/v2025-06/commerce/carts/{cart_token}/enroll:
    get:
      summary: Retrieves enroll for cart
      tags:
        - carts
      operationId: cart-enroll
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
        - name: placement
          in: query
          required: false
          schema:
            type: string
            enum:
              - pre_purchase
              - post_purchase
              - all
        - name: fluid_shop
          in: query
          description: The domain of your Fluid shop (excluding the scheme)
          example: myco.fluid.app
          schema:
            type: string
        - name: fluid_session
          in: query
          description: Session token
          example: fs_szwdDuRbqEe7AV7sXk7vVq
          schema:
            type: string
      responses:
        '200':
          description: enroll fields found
          content:
            application/json:
              schema:
                type: object
                properties:
                  enroll:
                    type: object
                    properties:
                      id:
                        type: integer
                        example: 1
                      active:
                        type: boolean
                        example: true
                      default:
                        type: boolean
                        example: false
                      title:
                        type: string
                        example: Customer Details
                      fields:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type:
                                - number
                                - string
                              example: 1
                            type:
                              type: string
                              example: input
                            title:
                              type: string
                              example: Title
                            metadata:
                              type:
                                - string
                                - 'null'
                              example: >-
                                {"label":"Name","required":true,"targetIndex":2,"element_type":"file_upload","translations":[],"is_form_field":true,"auto_translate":true,"field_data_value":""}
                            position:
                              type: integer
                              example: 0
                  meta:
                    $ref: '#/components/schemas/CartMetadata'
        '404':
          description: enroll not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Enroll not found
                  errors:
                    type: object
                    example:
                      enroll:
                        - not found
                  meta:
                    $ref: '#/components/schemas/CartMetadata'
  /api/public/v2025-06/commerce/carts/{cart_token}/enrollment:
    post:
      summary: Add enrollment to existing cart
      tags:
        - carts
      operationId: cart_enrollment-create
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Enrollment pack added to cart
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    $ref: '#/components/schemas/Cart'
                  meta:
                    $ref: '#/components/schemas/CartMetadata'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Enrollment pack already exists in cart
                  errors:
                    type: object
                  meta:
                    $ref: '#/components/schemas/CartMetadata'
        '404':
          description: Enrollment pack not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Enrollment pack with id 1 not found
                  errors:
                    type: object
                    example:
                      enrollment_pack_id:
                        - not found
                  meta:
                    $ref: '#/components/schemas/CartMetadata'
        '422':
          description: Unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Invalid parameters
                  errors:
                    type: object
                    example:
                      enrollment_pack_id:
                        - is missing
                  meta:
                    $ref: '#/components/schemas/CartMetadata'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                enrollment_pack_id:
                  type: integer
                metadata:
                  $ref: '#/components/schemas/RequestMetadataOptional'
              required:
                - enrollment_pack_id
  /api/public/v2025-06/commerce/carts/{cart_token}/cart_info:
    get:
      summary: Retrieves cart company information
      tags:
        - carts
      operationId: cart_info-get
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
        - name: fluid_shop
          in: query
          description: The domain of your Fluid shop (excluding the scheme)
          example: myco.fluid.app
          schema:
            type: string
        - name: fluid_session
          in: query
          description: Session token
          example: fs_szwdDuRbqEe7AV7sXk7vVq
          schema:
            type: string
      responses:
        '200':
          description: company info found
          content:
            application/json:
              schema:
                type: object
                properties:
                  languages:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 1
                        name:
                          type: string
                          example: English
                        iso:
                          type: string
                          example: en
                  countries:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: integer
                          example: 1
                        name:
                          type: string
                          example: United States
                        iso:
                          type: string
                          example: US
        '410':
          description: Cart is processed and cannot be modified
  /api/public/v2025-06/commerce/carts/{cart_token}/items:
    post:
      summary: Adds items to cart
      tags:
        - carts
      operationId: cart_items-add
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: items added to cart
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    $ref: '#/components/schemas/Cart'
                  meta:
                    $ref: '#/components/schemas/CartCheckoutMetadata'
        '400':
          description: no cart items specified
        '410':
          description: Cart is processed and cannot be modified
        '422':
          description: product not available in country
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - items
              properties:
                items:
                  type: array
                  items:
                    type: object
                    required:
                      - variant_id
                      - quantity
                    properties:
                      variant_id:
                        type: integer
                      quantity:
                        type: integer
                      subscription:
                        type: boolean
                        default: false
                      subscription_plan_id:
                        type:
                          - integer
                          - 'null'
                metadata:
                  $ref: '#/components/schemas/RequestMetadataOptional'
  /api/public/v2025-06/commerce/carts/{cart_token}/items/{item_id}:
    delete:
      summary: Removes item from cart
      tags:
        - carts
      operationId: cart_item-remove
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
        - name: item_id
          in: path
          required: true
          schema:
            type: string
        - name: fluid_shop
          in: query
          description: The domain of your Fluid shop (excluding the scheme)
          example: myco.fluid.app
          schema:
            type: string
        - name: fluid_session
          in: query
          description: Session token
          example: fs_szwdDuRbqEe7AV7sXk7vVq
          schema:
            type: string
      responses:
        '200':
          description: cart item removed from cart
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    $ref: '#/components/schemas/Cart'
                  meta:
                    $ref: '#/components/schemas/CartCheckoutMetadata'
        '404':
          description: cart item id not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Cart item not found
        '410':
          description: Cart is processed and cannot be modified
  /api/public/v2025-06/commerce/carts/{cart_token}/items/{item_id}/subscribe:
    post:
      summary: Adds subscribe:true to cart item
      tags:
        - carts
      operationId: cart_item-subscribe
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
        - name: item_id
          in: path
          required: true
          schema:
            type: string
        - name: subscription_plan_id
          in: query
          description: ID of the subscription plan to use
          example: 123
          schema:
            type: integer
      responses:
        '200':
          description: subscription true updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    $ref: '#/components/schemas/Cart'
                  meta:
                    $ref: '#/components/schemas/CartCheckoutMetadata'
        '410':
          description: Cart is processed and cannot be modified
        '422':
          description: cannot subscribe items
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: unprocessable entity
                  errors:
                    type: object
                    example:
                      subscription:
                        - is not allowed
                  meta:
                    $ref: '#/components/schemas/CartMetadata'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                metadata:
                  $ref: '#/components/schemas/RequestMetadataOptional'
    delete:
      summary: Updates subscribe:false to cart item
      tags:
        - carts
      operationId: cart_item-unsubscribe
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
        - name: item_id
          in: path
          required: true
          schema:
            type: string
        - name: fluid_shop
          in: query
          description: The domain of your Fluid shop (excluding the scheme)
          example: myco.fluid.app
          schema:
            type: string
        - name: fluid_session
          in: query
          description: Session token
          example: fs_szwdDuRbqEe7AV7sXk7vVq
          schema:
            type: string
      responses:
        '200':
          description: subscription false updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    $ref: '#/components/schemas/Cart'
                  meta:
                    $ref: '#/components/schemas/CartCheckoutMetadata'
        '410':
          description: Cart is processed and cannot be modified
        '422':
          description: cannot be unsubscribed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: unprocessable entity
                  errors:
                    type: object
                    example:
                      subscription:
                        - cannot be disabled
                  meta:
                    $ref: '#/components/schemas/CartMetadata'
  /api/public/v2025-06/commerce/carts/{cart_token}/change_language:
    patch:
      summary: Updates the language of a cart
      tags:
        - carts
      operationId: cart_language-update
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: cart's language_iso changed
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    $ref: '#/components/schemas/Cart'
                  meta:
                    $ref: '#/components/schemas/CartCheckoutMetadata'
        '400':
          description: unavailable locale for the company
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Language not supported
        '410':
          description: Cart is processed and cannot be modified
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                language_iso:
                  type: string
                  example: en
                metadata:
                  $ref: '#/components/schemas/RequestMetadataOptional'
              required:
                - language_iso
        required: true
        description: >-
          List of valid iso are at
          `/api/public/v2025-06/commerce/carts/{cart_token}/cart_info`
  /api/public/v2025-06/commerce/carts/{cart_token}/logout:
    delete:
      summary: Removes rep_buyer and customer for the cart
      tags:
        - carts
      operationId: cart-logout
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
        - name: fluid_shop
          in: query
          description: The domain of your Fluid shop (excluding the scheme)
          example: myco.fluid.app
          schema:
            type: string
        - name: fluid_session
          in: query
          description: Session token
          example: fs_szwdDuRbqEe7AV7sXk7vVq
          schema:
            type: string
      responses:
        '200':
          description: Logout successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    $ref: '#/components/schemas/Cart'
                  meta:
                    $ref: '#/components/schemas/CartCheckoutMetadata'
        '404':
          description: cart not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Cart not found
                  errors:
                    type: object
                    example:
                      cart:
                        - not found
                  meta:
                    $ref: '#/components/schemas/CartMetadata'
        '410':
          description: Cart is processed and cannot be modified
  /api/public/v2025-06/commerce/carts/{cart_token}/magic_link:
    post:
      summary: Create magic link for cart
      tags:
        - carts
      operationId: cart_magic_link-create
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
        - name: fluid_shop
          in: query
          description: The domain of your Fluid shop (excluding the scheme)
          example: myco.fluid.app
          schema:
            type: string
        - name: fluid_session
          in: query
          description: Session token
          example: fs_szwdDuRbqEe7AV7sXk7vVq
          schema:
            type: string
      responses:
        '201':
          description: magic link created
          content:
            application/json:
              schema:
                type: object
                properties:
                  multi_factor_authentication:
                    type: object
                    properties:
                      uuid:
                        type: string
                      authenticated:
                        type: boolean
                      verification_channel:
                        type: string
                      verification_code_expires_at:
                        type: string
                        format: date-time
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                      timestamp:
                        type: string
                        format: date-time
        '410':
          description: Cart is processed and cannot be modified
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                email:
                  type: string
                fluid_shop:
                  type: string
              required:
                - email
                - fluid_shop
  /api/public/v2025-06/commerce/carts/{cart_token}/confirm_magic_link:
    post:
      summary: Confirm magic link for cart
      tags:
        - carts
      operationId: cart_magic_link-confirm
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
        - name: fluid_shop
          in: query
          description: The domain of your Fluid shop (excluding the scheme)
          example: myco.fluid.app
          schema:
            type: string
        - name: fluid_session
          in: query
          description: Session token
          example: fs_szwdDuRbqEe7AV7sXk7vVq
          schema:
            type: string
      responses:
        '200':
          description: magic link confirmed
          content:
            application/json:
              schema:
                type: object
                properties:
                  jwt:
                    type: string
                  authenticated:
                    type: boolean
                  auth_type:
                    type: string
                  meta:
                    $ref: '#/components/schemas/CartMetadata'
        '410':
          description: Cart is processed and cannot be modified
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                uuid:
                  type: string
                multi_factor_authentication:
                  type: object
                  properties:
                    verification_code:
                      type: string
                  required:
                    - verification_code
              required:
                - uuid
                - multi_factor_authentication
  /api/public/v2025-06/commerce/carts/{cart_token}/payment_methods/{type}:
    post:
      summary: Sets cart payment method
      tags:
        - carts
      operationId: cart_payment_method-update
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
        - name: type
          in: path
          description: Type of payment method
          required: true
          schema:
            type: string
            enum:
              - credit_card
        - name: jwt
          in: query
          required: false
          description: >-
            JWT token to authenticate (Optional, if payment method id is not
            provided)
          schema:
            type: string
        - name: payment_method_id
          in: query
          required: false
          description: Payment Method id (Optional)
          schema:
            type: integer
      responses:
        '201':
          description: payment method added
          content:
            application/json:
              schema:
                type: object
                properties:
                  card:
                    type: object
                    properties:
                      user_id:
                        type:
                          - string
                          - 'null'
                        example: '123'
                      spreedly_token:
                        type: string
                        example: 01JKFTVM6Z44YFPSS9KK36KMSV
                      full_name:
                        type: string
                        example: John Doe
                      month:
                        type: integer
                        example: 3
                      year:
                        type: integer
                        example: 2032
                      number:
                        type: string
                        example: XXXX-XXXX-XXXX-4444
                      last_four_digits:
                        type: string
                        example: '4444'
                      first_six_digits:
                        type:
                          - string
                          - 'null'
                        example: '555555'
                      card_type:
                        type: string
                        example: master
                      address_id:
                        type:
                          - integer
                          - 'null'
                        example: 123
                      fingerprint:
                        type:
                          - string
                          - 'null'
                        example: 6eb05c4c7fc52fec38ef6e0651e8225be41c
                      default:
                        type: boolean
                        example: false
                      active:
                        type: boolean
                        example: true
                      created_at:
                        type: string
                        format: date-time
                        example: '2021-01-01T00:00:00Z'
                      updated_at:
                        type: string
                        format: date-time
                        example: '2021-01-01T00:00:00Z'
                      fluid:
                        type: boolean
                        example: true
                      test:
                        type:
                          - boolean
                          - 'null'
                        example: true
                      email:
                        type:
                          - string
                          - 'null'
                        example: john@example.com
                      customer_id:
                        type:
                          - string
                          - 'null'
                        example: '123'
                      fluid_pay_account_id:
                        type:
                          - string
                          - 'null'
                        example: '123'
                      token_provider:
                        type:
                          - string
                          - 'null'
                        example: vgs
                      token:
                        type:
                          - string
                          - 'null'
                        example: 01JKFTVM6Z44YFPSS9KK36KMSV
                      cvv_token:
                        type:
                          - string
                          - 'null'
                        example: '411'
                required:
                  - card
        '404':
          description: cart not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
                      example:
                        - not found
                  meta:
                    $ref: '#/components/schemas/CartMetadata'
        '410':
          description: Cart is processed and cannot be modified
        '422':
          description: invalid payment method
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - payment_method
              properties:
                billing_postal_code:
                  type: string
                  description: Billing postal code
                  example: '123'
                payment_method:
                  type: object
                  properties:
                    token:
                      type: string
                      description: Payment method token from Spreedly
                    last_four:
                      type: string
                      description: Last 4 digits of credit card
                    card_type:
                      type: string
                      description: Type of credit card (visa, mastercard, etc)
                    exp_month:
                      type: string
                      description: Expiration month (MM)
                    exp_year:
                      type: string
                      description: Expiration year (YYYY)
                metadata:
                  $ref: '#/components/schemas/RequestMetadataOptional'
  /api/public/v2025-06/commerce/carts/{cart_token}/shipping_method:
    post:
      summary: Sets cart shipping method
      tags:
        - carts
      operationId: cart_shipping_method-update
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: shipping method set
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    $ref: '#/components/schemas/Cart'
                  meta:
                    $ref: '#/components/schemas/CartCheckoutMetadata'
        '410':
          description: Cart is processed and cannot be modified
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - shipping_method_id
              properties:
                shipping_method_id:
                  type: string
                  example: fluid-shipping
                  description: ID of the shipping method to use
                metadata:
                  $ref: '#/components/schemas/RequestMetadataOptional'
  /api/public/v2025-06/commerce/carts/{cart_token}/items/{item_id}/variant:
    patch:
      summary: Updates a cart item's variant
      tags:
        - carts
      description: >
        Updates a cart item to use a different variant.

        If the target variant already exists in another cart item, the
        quantities are consolidated.


        **Consolidation behavior:**

        - If cart already has an item with the target variant_id, the source
        item's quantity is added to the existing item

        - The source item is then removed

        - Otherwise, the cart item's variant is updated directly


        **Optional quantity parameter:**

        - If provided, uses this quantity instead of the current cart item
        quantity when updating to a new variant

        - When consolidating, this quantity is added to the existing item's
        quantity (not replacing it)
      operationId: cart_update-item-variant
      parameters:
        - name: cart_token
          in: path
          required: true
          description: The cart token
          example: abc123def456
          schema:
            type: string
        - name: item_id
          in: path
          required: true
          description: The cart item ID
          example: 123
          schema:
            type: integer
      responses:
        '200':
          description: Variant updated successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    $ref: '#/components/schemas/Cart'
                  meta:
                    $ref: '#/components/schemas/CartCheckoutMetadata'
        '404':
          description: Variant or cart item not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: Variant not found
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
        '410':
          description: Cart is processed and cannot be modified
        '422':
          description: Unprocessable entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
                  meta:
                    type: object
                    properties:
                      request_id:
                        type: string
                        example: f5473a8c-8a86-4e0e-b3e8-95392003921b
                      timestamp:
                        type: string
                        example: '2024-12-10T08:04:10Z'
                required:
                  - error_message
                  - errors
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
                - variant_id
              properties:
                variant_id:
                  type: integer
                  description: The new variant ID to assign to this cart item
                  example: 456
                quantity:
                  type: integer
                  description: 'Optional: Override the quantity (must be >= 1)'
                  example: 2
        required: true
        description: Variant update parameters
  /api/public/v2025-06/commerce/carts:
    post:
      summary: Creates a cart
      tags:
        - carts
      description: >-
        Create a cart. Items, attribution and enrollment_pack_id are optional.
        Buyer rep assignment follows this priority: 1. If JWT is provided,
        extracts user from JWT and assigns as the rep. 2. If session cookie is
        present, extracts user from session and assigns it as the rep. 3. If no
        authentication is provided, cart is created without a rep. When
        authenticated as a rep, the cart will include rep-specific pricing.
      operationId: cart-create
      parameters:
        - name: Cookie
          in: header
          required: false
          description: Session cookie (_fluid_session)
          schema:
            type: string
        - name: jwt
          in: query
          required: false
          description: |-
            JWT token for user authentication. When provided,
                              extracts user and assigns it as the rep to the cart.
          example: >-
            eyJhbGciOiJIUzI1NiJ9.eyJhdXRoX3R5cGUiOiJ1c2VyX2NvbXBhbnkiLCJpZCI6MTIzfQ...
          schema:
            type: string
      responses:
        '200':
          description: cart created with JWT authentication and buyer_rep assignment
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    $ref: '#/components/schemas/Cart'
                  meta:
                    $ref: '#/components/schemas/CartCheckoutMetadata'
        '400':
          description: variant not available in country
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: bad request
                  errors:
                    type: string
                    example: Commerce::CartsService::VariantNotFoundError
                  meta:
                    $ref: '#/components/schemas/CartMetadata'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                country_code:
                  type: string
                  description: ISO 2-letter country code
                  example: US
                fluid_shop:
                  type: string
                  description: The domain of your Fluid shop (excluding the scheme)
                  example: myco.fluid.app
                fluid_session:
                  type: string
                  description: Session token
                  example: fs_szwdDuRbqEe7AV7sXk7vVq
                visitor_token:
                  type: string
                  description: Visitor token
                  example: vt_2a3v3f9s8xRCN
                source:
                  type: string
                  description: The source that created the cart
                  enum:
                    - web
                    - mobile
                    - external
                    - admin
                  example: web
                items:
                  type: array
                  items:
                    type: object
                    properties:
                      variant_id:
                        type: integer
                        description: The ID of the variant to add to the cart
                        example: 90
                      quantity:
                        type: integer
                        description: The quantity of the variant to add to the cart
                        example: 2
                attribution:
                  $ref: '#/components/schemas/Attribution'
                  default:
                    share_guid: james-bond007
                  required: false
              required:
                - country_code
                - fluid_shop
        description: Cart params
  /api/public/v2025-06/commerce/carts/{cart_token}:
    get:
      summary: Retrieves a cart
      tags:
        - carts
      operationId: cart-get
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
        - name: fluid_shop
          in: query
          description: The domain of your Fluid shop (excluding the scheme)
          example: myco.fluid.app
          schema:
            type: string
        - name: fluid_session
          in: query
          description: Session token
          example: fs_szwdDuRbqEe7AV7sXk7vVq
          schema:
            type: string
      responses:
        '200':
          description: cart found
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    $ref: '#/components/schemas/Cart'
                  meta:
                    $ref: '#/components/schemas/CartCheckoutMetadata'
        '404':
          description: cart not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
                      example:
                        - not found
                  meta:
                    $ref: '#/components/schemas/CartMetadata'
        '410':
          description: Cart is processed and cannot be modified
    patch:
      summary: Updates a cart
      tags:
        - carts
      operationId: cart-update
      parameters:
        - name: cart_token
          in: path
          required: true
          schema:
            type: string
        - name: fluid_shop
          in: query
          description: The domain of your Fluid shop (excluding the scheme)
          example: myco.fluid.app
          schema:
            type: string
        - name: fluid_session
          in: query
          description: Session token
          example: fs_szwdDuRbqEe7AV7sXk7vVq
          schema:
            type: string
      responses:
        '200':
          description: cart updated with phone number validation
          content:
            application/json:
              schema:
                type: object
                properties:
                  cart:
                    $ref: '#/components/schemas/Cart'
                  meta:
                    $ref: '#/components/schemas/CartCheckoutMetadata'
        '404':
          description: cart not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                    example: not found
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
                      example:
                        - not found
                  meta:
                    $ref: '#/components/schemas/CartMetadata'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                email:
                  type: string
                  format: email
                phone:
                  type: string
                  example: '4035551212'
  /api/public/v2025-06/events/checkout/started:
    post:
      summary: Record a checkout starting
      operationId: checkout-started
      tags:
        - checkout
      parameters: []
      responses:
        '201':
          description: checkout started
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiResponse'
                example:
                  status: 201
                  metadata:
                    fluid_shop: myshop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 123e4567-e89b-12d3-a456-426614174000
                    timestamp: '2025-01-01T00:00:00Z'
        '404':
          description: unknown shop
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 404
                  errors:
                    - message: Company not found
                  metadata:
                    fluid_shop: myshop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 123e4567-e89b-12d3-a456-426614174000
                    timestamp: '2025-01-01T00:00:00Z'
        '422':
          description: invalid request
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 422
                  errors:
                    - message: Unexpected error
                  metadata:
                    fluid_shop: myshop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 123e4567-e89b-12d3-a456-426614174000
                    timestamp: '2025-01-01T00:00:00Z'
        '500':
          description: internal server error
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 500
                  errors:
                    - message: Unexpected error
                  metadata:
                    fluid_shop: myshop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 123e4567-e89b-12d3-a456-426614174000
                    timestamp: '2025-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                cart_token:
                  type: string
                metadata:
                  $ref: '#/components/schemas/RequestMetadata'
              required:
                - cart_token
                - metadata
  /api/public/v2025-06/enrollment_packs/{slug}:
    post:
      summary: Get enrollment pack by slug
      operationId: enrollment-pack-show
      tags:
        - enrollment-packs
      parameters:
        - name: slug
          in: path
          description: Enrollment pack slug
          example: example-slug
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Enrollment pack retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: number
                    example: 200
                  enrollment_pack:
                    type: object
                    properties:
                      slug:
                        type: string
                      enrollment_pack_id:
                        type: integer
                      title:
                        type: string
                      description:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          body:
                            type: string
                          record_type:
                            type: string
                          record_id:
                            type: integer
                          created_at:
                            type: string
                          updated_at:
                            type: string
                          locale:
                            type: string
                      enrollment_fee:
                        type: string
                      additional_volume:
                        type:
                          - string
                          - 'null'
                      token:
                        type: string
                    required:
                      - slug
                      - title
                      - description
                      - enrollment_fee
                      - token
                  metadata:
                    $ref: '#/components/schemas/ResponseMetadata'
                required:
                  - status
                  - enrollment_pack
                  - metadata
        '404':
          description: Enrollment pack not found
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 404
                  errors:
                    - message: Enrollment pack not found
                  metadata:
                    fluid_shop: myshop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 019524b4-9fce-7934-9429-a51f9c18f363
                    timestamp: '2024-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                metadata:
                  $ref: '#/components/schemas/RequestMetadata'
              required:
                - metadata
  /api/public/v2025-06/events/leads/capture:
    post:
      summary: Save a new lead capture
      operationId: lead-capture
      tags:
        - events
        - lead
      parameters: []
      responses:
        '201':
          description: lead captured
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiResponse'
                example:
                  status: 201
                  metadata:
                    fluid_shop: myshop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 123e4567-e89b-12d3-a456-426614174000
                    timestamp: '2025-01-01T00:00:00Z'
        '404':
          description: unknown shop
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 404
                  errors:
                    - message: Company not found
                  metadata:
                    fluid_shop: myshop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 123e4567-e89b-12d3-a456-426614174000
                    timestamp: '2025-01-01T00:00:00Z'
        '422':
          description: invalid request
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 422
                  errors:
                    - message: Unexpected error
                  metadata:
                    fluid_shop: myshop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 123e4567-e89b-12d3-a456-426614174000
                    timestamp: '2025-01-01T00:00:00Z'
        '500':
          description: internal server error
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 500
                  errors:
                    - message: Unexpected error
                  metadata:
                    fluid_shop: myshop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 123e4567-e89b-12d3-a456-426614174000
                    timestamp: '2025-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                lead:
                  $ref: '#/components/schemas/Lead'
                page:
                  $ref: '#/components/schemas/UrlPage'
                metadata:
                  $ref: '#/components/schemas/RequestMetadata'
              required:
                - lead
                - metadata
  /api/public/v2025-06/events/pages/visit:
    post:
      summary: Save a new page visit
      operationId: page-visit
      tags:
        - events
        - page
      deprecated: true
      parameters: []
      responses:
        '201':
          description: page visited
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiResponse'
                example:
                  status: 201
                  metadata:
                    fluid_shop: myshop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 123e4567-e89b-12d3-a456-426614174000
                    timestamp: '2025-01-01T00:00:00Z'
        '404':
          description: unknown shop
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 404
                  errors:
                    - message: Company not found
                  metadata:
                    fluid_shop: myshop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 123e4567-e89b-12d3-a456-426614174000
                    timestamp: '2025-01-01T00:00:00Z'
        '422':
          description: invalid request
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 422
                  errors:
                    - message: Unexpected error
                  metadata:
                    fluid_shop: myshop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 123e4567-e89b-12d3-a456-426614174000
                    timestamp: '2025-01-01T00:00:00Z'
        '500':
          description: internal server error
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 500
                  errors:
                    - message: Unexpected error
                  metadata:
                    fluid_shop: myshop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 123e4567-e89b-12d3-a456-426614174000
                    timestamp: '2025-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                page:
                  $ref: '#/components/schemas/UrlPage'
                metadata:
                  $ref: '#/components/schemas/RequestMetadata'
              required:
                - page
                - metadata
  /api/public/v2025-06/events/urls/visit:
    post:
      summary: Save a new url visit
      operationId: url-visit
      tags:
        - events
        - url
      parameters: []
      responses:
        '201':
          description: page visited
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiResponse'
                example:
                  status: 201
                  metadata:
                    fluid_shop: myshop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 123e4567-e89b-12d3-a456-426614174000
                    timestamp: '2025-01-01T00:00:00Z'
        '404':
          description: unknown shop
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 404
                  errors:
                    - message: Company not found
                  metadata:
                    fluid_shop: myshop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 123e4567-e89b-12d3-a456-426614174000
                    timestamp: '2025-01-01T00:00:00Z'
        '422':
          description: invalid request
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 422
                  errors:
                    - message: Unexpected error
                  metadata:
                    fluid_shop: myshop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 123e4567-e89b-12d3-a456-426614174000
                    timestamp: '2025-01-01T00:00:00Z'
        '500':
          description: internal server error
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 500
                  errors:
                    - message: Unexpected error
                  metadata:
                    fluid_shop: myshop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 123e4567-e89b-12d3-a456-426614174000
                    timestamp: '2025-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                page:
                  $ref: '#/components/schemas/UrlPage'
                metadata:
                  $ref: '#/components/schemas/RequestMetadata'
              required:
                - page
                - metadata
  /api/public/v2025-06/browser/fingerprint:
    post:
      summary: Start a new fingerprint
      operationId: fingerprint-create
      tags:
        - fingerprint
      deprecated: true
      parameters: []
      responses:
        '201':
          description: fingerprint created
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiResponse'
                example:
                  status: 201
                  metadata:
                    fluid_shop: myshop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 123e4567-e89b-12d3-a456-426614174000
                    timestamp: '2025-01-01T00:00:00Z'
        '404':
          description: unknown shop
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 404
                  errors:
                    - message: Company not found
                  metadata:
                    fluid_shop: myshop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 123e4567-e89b-12d3-a456-426614174000
                    timestamp: '2025-01-01T00:00:00Z'
        '422':
          description: invalid request
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 422
                  errors:
                    - message: Unexpected error
                  metadata:
                    fluid_shop: myshop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 123e4567-e89b-12d3-a456-426614174000
                    timestamp: '2025-01-01T00:00:00Z'
        '500':
          description: internal server error
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 500
                  errors:
                    - message: Unexpected error
                  metadata:
                    fluid_shop: myshop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 123e4567-e89b-12d3-a456-426614174000
                    timestamp: '2025-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                fingerprint:
                  $ref: '#/components/schemas/Fingerprint'
                metadata:
                  $ref: '#/components/schemas/RequestMetadata'
              required:
                - fingerprint
                - metadata
  /api/public/v2025-06/media/{slug}:
    post:
      summary: Get media by slug
      operationId: media-show
      tags:
        - media
      parameters:
        - name: slug
          in: path
          description: Media slug
          example: media-slug
          required: true
          schema:
            type: string
      responses:
        '200':
          description: media retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: number
                    example: 200
                  media:
                    $ref: '#/components/schemas/Media'
                  metadata:
                    $ref: '#/components/schemas/ResponseMetadata'
                required:
                  - status
                  - media
                  - metadata
        '404':
          description: company not found
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 404
                  errors:
                    - message: Company not found
                  metadata:
                    fluid_shop: invalid-shop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 019524b4-9fce-7934-9429-a51f9c18f363
                    timestamp: '2024-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                metadata:
                  $ref: '#/components/schemas/RequestMetadata'
              required:
                - metadata
  /api/public/v2025-06/media:
    post:
      summary: Get media by slug (deprecated)
      operationId: media-show-deprecated
      tags:
        - media
      deprecated: true
      parameters: []
      responses:
        '200':
          description: media retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: number
                    example: 200
                  media:
                    $ref: '#/components/schemas/Media'
                  metadata:
                    $ref: '#/components/schemas/ResponseMetadata'
                required:
                  - status
                  - media
                  - metadata
        '404':
          description: company not found
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 404
                  errors:
                    - message: Company not found
                  metadata:
                    fluid_shop: invalid-shop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 019524b4-9fce-7934-9429-a51f9c18f363
                    timestamp: '2024-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                media:
                  type: object
                  properties:
                    id:
                      type: string
                      description: Media slug
                      example: test-media-slug
                metadata:
                  $ref: '#/components/schemas/RequestMetadata'
              required:
                - media
                - metadata
  /api/public/v2025-06/events/media/video_analytics:
    post:
      summary: Create video analytics event
      operationId: createVideoAnalyticsEvent
      tags:
        - media
      parameters: []
      responses:
        '201':
          description: video analytics event created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  meta:
                    type: object
                    properties:
                      request_id:
                        type:
                          - string
                          - 'null'
                      timestamp:
                        type: string
                    required:
                      - request_id
                      - timestamp
                required:
                  - meta
        '404':
          description: company not found
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 404
                  errors:
                    - message: Company not found
                  metadata:
                    fluid_shop: invalid-shop
                    request_uuid: 019524b4-9fce-7934-9429-a51f9c18f363
                    timestamp: '2024-01-01T00:00:00Z'
        '422':
          description: invalid request parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error_message:
                    type: string
                  errors:
                    type: object
                  meta:
                    type: object
                    properties:
                      request_id:
                        type:
                          - string
                          - 'null'
                      timestamp:
                        type: string
                    required:
                      - request_id
                      - timestamp
                required:
                  - error_message
                  - errors
                  - meta
                example:
                  error_message: Invalid parameters
                  errors:
                    video_analytics:
                      event_type:
                        - >-
                          must be one of: video.started, video.paused,
                          video.resumed, video.completed, video.dismissed
                  meta:
                    request_id: null
                    timestamp: '2024-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VideoAnalyticsCreate'
  /api/public/v2025-06/playlists/{slug}:
    post:
      summary: Get playlist by slug
      operationId: playlist-show
      tags:
        - playlist
      parameters:
        - name: slug
          in: path
          description: Playlist slug
          example: playlist-slug
          required: true
          schema:
            type: string
      responses:
        '200':
          description: playlist retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: number
                    example: 200
                  library:
                    title: Library
                    type: object
                    properties:
                      id:
                        type: integer
                      slug:
                        type:
                          - string
                          - 'null'
                      custom_slug:
                        type: boolean
                        default: false
                      title:
                        type: string
                      library_items:
                        type: array
                        items:
                          title: LibraryItem
                          type: object
                          properties:
                            type:
                              type: string
                            item:
                              type: object
                          required:
                            - type
                            - item
                      products:
                        type: array
                        items:
                          title: Product
                          type: object
                          properties:
                            id:
                              type: integer
                            title:
                              type: string
                            image_url:
                              type:
                                - string
                                - 'null'
                            image_path:
                              type:
                                - string
                                - 'null'
                            cv:
                              type:
                                - integer
                                - 'null'
                              default: 0
                            tax:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                            sku:
                              type:
                                - string
                                - 'null'
                            metadata:
                              type: object
                              default: '{}'
                            external_id:
                              type:
                                - string
                                - 'null'
                            price:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                              minimum: 0
                              maximum: 99999999
                            introduction:
                              type:
                                - string
                                - 'null'
                            price_in_currency:
                              type: string
                            tax_in_currency:
                              type: string
                            cv_in_currency:
                              type: string
                            metafields:
                              type: array
                              items:
                                title: LegacyMetafield
                                type: object
                                properties:
                                  id:
                                    type: integer
                                  namespace:
                                    description: >-
                                      A container for related metafields.
                                      Commonly used to group metafields by app
                                      or functionality.
                                    example: custom
                                    type: string
                                    maxLength: 20
                                    pattern: ^[a-zA-Z0-9_]+$
                                  key:
                                    description: >-
                                      The unique identifier for the metafield
                                      within its namespace. Must be unique per
                                      namespace and owner.
                                    example: material
                                    type: string
                                    maxLength: 30
                                    pattern: ^[a-zA-Z0-9_]+$
                                  value:
                                    description: >-
                                      The actual data stored in the metafield.
                                      Type depends on value_type.
                                    example: cotton
                                    type:
                                      - string
                                      - object
                                  value_type:
                                    description: >-
                                      The data type that defines how the value
                                      should be interpreted and validated.
                                    example: single_line_text_field
                                    type: string
                                  description:
                                    description: >-
                                      Optional human-readable description
                                      explaining the purpose of this metafield.
                                    example: The primary material used in this product
                                    type:
                                      - string
                                      - 'null'
                                  owner_type:
                                    description: >-
                                      The type of resource that this metafield
                                      belongs to (polymorphic association).
                                    example: Product
                                    type: string
                                  owner_id:
                                    description: >-
                                      The ID of the specific resource that this
                                      metafield belongs to.
                                    example: 12345
                                    type: integer
                                  created_at:
                                    description: Timestamp when the metafield was created.
                                    example: '2021-01-01T00:00:00Z'
                                    type: string
                                    format: date-time
                                  updated_at:
                                    description: >-
                                      Timestamp when the metafield was last
                                      updated.
                                    example: '2021-01-01T00:00:00Z'
                                    type: string
                                    format: date-time
                                  metafield_definition:
                                    title: MetafieldDefinition
                                    type:
                                      - object
                                      - 'null'
                                    properties:
                                      id:
                                        type: integer
                                      company_id:
                                        description: >-
                                          The ID of the company that owns this
                                          metafield definition.
                                        example: 1
                                        type: integer
                                      namespace:
                                        description: >-
                                          A container for related metafield
                                          definitions. Used to group definitions
                                          by app or functionality. Must be unique
                                          within company and owner_resource.
                                        example: product_details
                                        type: string
                                        maxLength: 20
                                        pattern: ^[a-zA-Z0-9_]+$
                                      key:
                                        description: >-
                                          The unique identifier for the metafield
                                          definition within its namespace and
                                          owner_resource. Combined with namespace
                                          and owner_resource, this must be unique
                                          per company.
                                        example: material_type
                                        type: string
                                        maxLength: 30
                                        pattern: ^[a-zA-Z0-9_]+$
                                      name:
                                        description: >-
                                          Human-readable display name for the
                                          metafield definition, shown in admin
                                          interfaces and forms.
                                        example: Material Type
                                        type: string
                                        maxLength: 100
                                      description:
                                        description: >-
                                          Detailed explanation of what this
                                          metafield definition represents, how it
                                          should be used, and any special
                                          instructions for content creators.
                                        example: >-
                                          Specify the primary material composition
                                          of the product (e.g., cotton, polyester,
                                          silk). This will be displayed on the
                                          product detail page.
                                        type:
                                          - string
                                          - 'null'
                                      value_type:
                                        description: >-
                                          The data type that defines how metafield
                                          values should be validated, stored, and
                                          displayed. Determines which validation
                                          rules are available.
                                        example: single_line_text_field
                                        type: string
                                      validation_rules:
                                        description: >-
                                          JSON object containing validation
                                          constraints that will be applied to
                                          metafield values. Available rules depend
                                          on the value_type.
                                        example:
                                          choices:
                                            - cotton
                                            - polyester
                                            - silk
                                            - wool
                                            - linen
                                            - bamboo
                                          max: 50
                                          min: 2
                                        type:
                                          - object
                                          - 'null'
                                      owner_resource:
                                        description: >-
                                          The type of resource (model class name)
                                          that metafields using this definition
                                          can be attached to. Must match the
                                          polymorphic owner_type.
                                        example: Product
                                        type: string
                                      pinned:
                                        description: >-
                                          Whether this definition should be
                                          prominently displayed or prioritized in
                                          admin interfaces and forms.
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                        default: false
                                      position:
                                        default: 0
                                        description: >-
                                          Sort order for displaying this
                                          definition relative to others in the
                                          same category and owner_resource. Lower
                                          numbers appear first.
                                        example: 1
                                        type:
                                          - integer
                                          - 'null'
                                      locked:
                                        description: >-
                                          Whether this metafield definition is
                                          locked, preventing direct updates or
                                          deletions of metafields using this
                                          definition.
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                        default: false
                                      created_at:
                                        description: >-
                                          Timestamp when the metafield definition
                                          was created.
                                        example: '2024-01-15T10:30:00Z'
                                        type: string
                                        format: date-time
                                      updated_at:
                                        description: >-
                                          Timestamp when the metafield definition
                                          was last updated.
                                        example: '2024-02-20T14:45:00Z'
                                        type: string
                                        format: date-time
                                      list_type:
                                        description: >-
                                          Whether this definition is for list-type
                                          metafields that store arrays of values.
                                        example: false
                                        type: boolean
                                      reference_type:
                                        description: >-
                                          Whether this definition is for
                                          reference-type metafields that store
                                          references to other resources.
                                        example: false
                                        type: boolean
                                      supported_validations:
                                        description: >-
                                          Array of validation rule names that are
                                          supported for this value_type.
                                        example:
                                          - min
                                          - max
                                          - choices
                                          - regex
                                        type: array
                                      validation_description:
                                        description: >-
                                          Human-readable description of what the
                                          value_type represents and its
                                          constraints.
                                        example: Single line text up to 5000 characters
                                        type: string
                                      category_ids:
                                        description: >-
                                          Array of category IDs that this
                                          metafield definition is associated with
                                          for organizational purposes.
                                        example:
                                          - 1
                                          - 2
                                          - 3
                                        items:
                                          type: integer
                                        type: array
                                    required:
                                      - id
                                      - company_id
                                      - namespace
                                      - key
                                      - name
                                      - value_type
                                      - owner_resource
                                      - created_at
                                      - updated_at
                                      - list_type
                                      - reference_type
                                      - supported_validations
                                      - validation_description
                                      - category_ids
                                required:
                                  - id
                                  - namespace
                                  - key
                                  - value
                                  - value_type
                                  - owner_type
                                  - owner_id
                                  - created_at
                                  - updated_at
                            variants:
                              items:
                                title: Variant
                                properties:
                                  id:
                                    type: integer
                                  title:
                                    example: Variant 1
                                    type:
                                      - string
                                      - 'null'
                                  image_url:
                                    example: https://via.placeholder.com/150
                                    type:
                                      - string
                                      - 'null'
                                  image_path:
                                    example: https://via.placeholder.com/150
                                    type:
                                      - string
                                      - 'null'
                                  sku:
                                    example: SKU-123456
                                    type:
                                      - string
                                      - 'null'
                                  primary_image:
                                    example: https://via.placeholder.com/150
                                    type:
                                      - string
                                      - 'null'
                                  price:
                                    example: 100
                                    type:
                                      - number
                                      - string
                                      - 'null'
                                  price_in_currency:
                                    example: USD 100.00
                                    type: string
                                  options:
                                    items:
                                      type: object
                                      properties:
                                        title:
                                          type: string
                                          example: Size
                                        value:
                                          type: string
                                          example: XL
                                    type: array
                                required:
                                  - id
                                  - price_in_currency
                                  - options
                              type: array
                          required:
                            - id
                            - title
                            - metadata
                            - price_in_currency
                            - tax_in_currency
                            - cv_in_currency
                            - metafields
                            - variants
                      enrollment_packs:
                        type: array
                        items:
                          title: EnrollmentPack
                          type: object
                          properties:
                            id:
                              type: integer
                            title:
                              type: string
                            status:
                              type: string
                            image_url:
                              type: string
                          required:
                            - id
                            - title
                            - status
                            - image_url
                    required:
                      - id
                      - custom_slug
                      - title
                      - library_items
                      - products
                      - enrollment_packs
                  metadata:
                    $ref: '#/components/schemas/ResponseMetadata'
                required:
                  - status
                  - library
                  - metadata
        '404':
          description: company not found
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 404
                  errors:
                    - message: Company not found
                  metadata:
                    fluid_shop: invalid-shop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 019524b4-9fce-7934-9429-a51f9c18f363
                    timestamp: '2024-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                metadata:
                  $ref: '#/components/schemas/RequestMetadata'
              required:
                - metadata
  /api/public/v2025-06/playlists:
    post:
      summary: Get playlist by slug (deprecated)
      operationId: playlist-show-deprecated
      tags:
        - playlist
      deprecated: true
      parameters: []
      responses:
        '200':
          description: playlist retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: number
                    example: 200
                  library:
                    title: Library
                    type: object
                    properties:
                      id:
                        type: integer
                      slug:
                        type:
                          - string
                          - 'null'
                      custom_slug:
                        type: boolean
                        default: false
                      title:
                        type: string
                      library_items:
                        type: array
                        items:
                          title: LibraryItem
                          type: object
                          properties:
                            type:
                              type: string
                            item:
                              type: object
                          required:
                            - type
                            - item
                      products:
                        type: array
                        items:
                          title: Product
                          type: object
                          properties:
                            id:
                              type: integer
                            title:
                              type: string
                            image_url:
                              type:
                                - string
                                - 'null'
                            image_path:
                              type:
                                - string
                                - 'null'
                            cv:
                              type:
                                - integer
                                - 'null'
                              default: 0
                            tax:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                            sku:
                              type:
                                - string
                                - 'null'
                            metadata:
                              type: object
                              default: '{}'
                            external_id:
                              type:
                                - string
                                - 'null'
                            price:
                              type:
                                - number
                                - string
                                - 'null'
                              default: '0.0'
                              minimum: 0
                              maximum: 99999999
                            introduction:
                              type:
                                - string
                                - 'null'
                            price_in_currency:
                              type: string
                            tax_in_currency:
                              type: string
                            cv_in_currency:
                              type: string
                            metafields:
                              type: array
                              items:
                                title: LegacyMetafield
                                type: object
                                properties:
                                  id:
                                    type: integer
                                  namespace:
                                    description: >-
                                      A container for related metafields.
                                      Commonly used to group metafields by app
                                      or functionality.
                                    example: custom
                                    type: string
                                    maxLength: 20
                                    pattern: ^[a-zA-Z0-9_]+$
                                  key:
                                    description: >-
                                      The unique identifier for the metafield
                                      within its namespace. Must be unique per
                                      namespace and owner.
                                    example: material
                                    type: string
                                    maxLength: 30
                                    pattern: ^[a-zA-Z0-9_]+$
                                  value:
                                    description: >-
                                      The actual data stored in the metafield.
                                      Type depends on value_type.
                                    example: cotton
                                    type:
                                      - string
                                      - object
                                  value_type:
                                    description: >-
                                      The data type that defines how the value
                                      should be interpreted and validated.
                                    example: single_line_text_field
                                    type: string
                                  description:
                                    description: >-
                                      Optional human-readable description
                                      explaining the purpose of this metafield.
                                    example: The primary material used in this product
                                    type:
                                      - string
                                      - 'null'
                                  owner_type:
                                    description: >-
                                      The type of resource that this metafield
                                      belongs to (polymorphic association).
                                    example: Product
                                    type: string
                                  owner_id:
                                    description: >-
                                      The ID of the specific resource that this
                                      metafield belongs to.
                                    example: 12345
                                    type: integer
                                  created_at:
                                    description: Timestamp when the metafield was created.
                                    example: '2021-01-01T00:00:00Z'
                                    type: string
                                    format: date-time
                                  updated_at:
                                    description: >-
                                      Timestamp when the metafield was last
                                      updated.
                                    example: '2021-01-01T00:00:00Z'
                                    type: string
                                    format: date-time
                                  metafield_definition:
                                    title: MetafieldDefinition
                                    type:
                                      - object
                                      - 'null'
                                    properties:
                                      id:
                                        type: integer
                                      company_id:
                                        description: >-
                                          The ID of the company that owns this
                                          metafield definition.
                                        example: 1
                                        type: integer
                                      namespace:
                                        description: >-
                                          A container for related metafield
                                          definitions. Used to group definitions
                                          by app or functionality. Must be unique
                                          within company and owner_resource.
                                        example: product_details
                                        type: string
                                        maxLength: 20
                                        pattern: ^[a-zA-Z0-9_]+$
                                      key:
                                        description: >-
                                          The unique identifier for the metafield
                                          definition within its namespace and
                                          owner_resource. Combined with namespace
                                          and owner_resource, this must be unique
                                          per company.
                                        example: material_type
                                        type: string
                                        maxLength: 30
                                        pattern: ^[a-zA-Z0-9_]+$
                                      name:
                                        description: >-
                                          Human-readable display name for the
                                          metafield definition, shown in admin
                                          interfaces and forms.
                                        example: Material Type
                                        type: string
                                        maxLength: 100
                                      description:
                                        description: >-
                                          Detailed explanation of what this
                                          metafield definition represents, how it
                                          should be used, and any special
                                          instructions for content creators.
                                        example: >-
                                          Specify the primary material composition
                                          of the product (e.g., cotton, polyester,
                                          silk). This will be displayed on the
                                          product detail page.
                                        type:
                                          - string
                                          - 'null'
                                      value_type:
                                        description: >-
                                          The data type that defines how metafield
                                          values should be validated, stored, and
                                          displayed. Determines which validation
                                          rules are available.
                                        example: single_line_text_field
                                        type: string
                                      validation_rules:
                                        description: >-
                                          JSON object containing validation
                                          constraints that will be applied to
                                          metafield values. Available rules depend
                                          on the value_type.
                                        example:
                                          choices:
                                            - cotton
                                            - polyester
                                            - silk
                                            - wool
                                            - linen
                                            - bamboo
                                          max: 50
                                          min: 2
                                        type:
                                          - object
                                          - 'null'
                                      owner_resource:
                                        description: >-
                                          The type of resource (model class name)
                                          that metafields using this definition
                                          can be attached to. Must match the
                                          polymorphic owner_type.
                                        example: Product
                                        type: string
                                      pinned:
                                        description: >-
                                          Whether this definition should be
                                          prominently displayed or prioritized in
                                          admin interfaces and forms.
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                        default: false
                                      position:
                                        default: 0
                                        description: >-
                                          Sort order for displaying this
                                          definition relative to others in the
                                          same category and owner_resource. Lower
                                          numbers appear first.
                                        example: 1
                                        type:
                                          - integer
                                          - 'null'
                                      locked:
                                        description: >-
                                          Whether this metafield definition is
                                          locked, preventing direct updates or
                                          deletions of metafields using this
                                          definition.
                                        example: false
                                        type:
                                          - boolean
                                          - 'null'
                                        default: false
                                      created_at:
                                        description: >-
                                          Timestamp when the metafield definition
                                          was created.
                                        example: '2024-01-15T10:30:00Z'
                                        type: string
                                        format: date-time
                                      updated_at:
                                        description: >-
                                          Timestamp when the metafield definition
                                          was last updated.
                                        example: '2024-02-20T14:45:00Z'
                                        type: string
                                        format: date-time
                                      list_type:
                                        description: >-
                                          Whether this definition is for list-type
                                          metafields that store arrays of values.
                                        example: false
                                        type: boolean
                                      reference_type:
                                        description: >-
                                          Whether this definition is for
                                          reference-type metafields that store
                                          references to other resources.
                                        example: false
                                        type: boolean
                                      supported_validations:
                                        description: >-
                                          Array of validation rule names that are
                                          supported for this value_type.
                                        example:
                                          - min
                                          - max
                                          - choices
                                          - regex
                                        type: array
                                      validation_description:
                                        description: >-
                                          Human-readable description of what the
                                          value_type represents and its
                                          constraints.
                                        example: Single line text up to 5000 characters
                                        type: string
                                      category_ids:
                                        description: >-
                                          Array of category IDs that this
                                          metafield definition is associated with
                                          for organizational purposes.
                                        example:
                                          - 1
                                          - 2
                                          - 3
                                        items:
                                          type: integer
                                        type: array
                                    required:
                                      - id
                                      - company_id
                                      - namespace
                                      - key
                                      - name
                                      - value_type
                                      - owner_resource
                                      - created_at
                                      - updated_at
                                      - list_type
                                      - reference_type
                                      - supported_validations
                                      - validation_description
                                      - category_ids
                                required:
                                  - id
                                  - namespace
                                  - key
                                  - value
                                  - value_type
                                  - owner_type
                                  - owner_id
                                  - created_at
                                  - updated_at
                            variants:
                              items:
                                title: Variant
                                properties:
                                  id:
                                    type: integer
                                  title:
                                    example: Variant 1
                                    type:
                                      - string
                                      - 'null'
                                  image_url:
                                    example: https://via.placeholder.com/150
                                    type:
                                      - string
                                      - 'null'
                                  image_path:
                                    example: https://via.placeholder.com/150
                                    type:
                                      - string
                                      - 'null'
                                  sku:
                                    example: SKU-123456
                                    type:
                                      - string
                                      - 'null'
                                  primary_image:
                                    example: https://via.placeholder.com/150
                                    type:
                                      - string
                                      - 'null'
                                  price:
                                    example: 100
                                    type:
                                      - number
                                      - string
                                      - 'null'
                                  price_in_currency:
                                    example: USD 100.00
                                    type: string
                                  options:
                                    items:
                                      type: object
                                      properties:
                                        title:
                                          type: string
                                          example: Size
                                        value:
                                          type: string
                                          example: XL
                                    type: array
                                required:
                                  - id
                                  - price_in_currency
                                  - options
                              type: array
                          required:
                            - id
                            - title
                            - metadata
                            - price_in_currency
                            - tax_in_currency
                            - cv_in_currency
                            - metafields
                            - variants
                      enrollment_packs:
                        type: array
                        items:
                          title: EnrollmentPack
                          type: object
                          properties:
                            id:
                              type: integer
                            title:
                              type: string
                            status:
                              type: string
                            image_url:
                              type: string
                          required:
                            - id
                            - title
                            - status
                            - image_url
                    required:
                      - id
                      - custom_slug
                      - title
                      - library_items
                      - products
                      - enrollment_packs
                  metadata:
                    $ref: '#/components/schemas/ResponseMetadata'
                required:
                  - status
                  - library
                  - metadata
        '404':
          description: company not found
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 404
                  errors:
                    - message: Company not found
                  metadata:
                    fluid_shop: invalid-shop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 019524b4-9fce-7934-9429-a51f9c18f363
                    timestamp: '2024-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                library:
                  type: object
                  properties:
                    id:
                      type: string
                      description: Playlist slug
                      example: test-playlist-slug
                metadata:
                  $ref: '#/components/schemas/RequestMetadata'
              required:
                - library
                - metadata
  /api/public/v2025-06/products/{slug}:
    post:
      summary: Get product by slug in a foreign local includes the correct variants
      operationId: product-show
      tags:
        - product
      parameters:
        - name: slug
          in: path
          description: Product slug
          example: product-slug
          required: true
          schema:
            type: string
      responses:
        '200':
          description: product retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: number
                    example: 200
                  product:
                    title: Product
                    type: object
                    properties:
                      id:
                        type: integer
                      title:
                        type: string
                      image_url:
                        type:
                          - string
                          - 'null'
                      image_path:
                        type:
                          - string
                          - 'null'
                      cv:
                        type:
                          - integer
                          - 'null'
                        default: 0
                      tax:
                        type:
                          - number
                          - string
                          - 'null'
                        default: '0.0'
                      sku:
                        type:
                          - string
                          - 'null'
                      metadata:
                        type: object
                        default: '{}'
                      external_id:
                        type:
                          - string
                          - 'null'
                      price:
                        type:
                          - number
                          - string
                          - 'null'
                        default: '0.0'
                        minimum: 0
                        maximum: 99999999
                      introduction:
                        type:
                          - string
                          - 'null'
                      price_in_currency:
                        type: string
                      tax_in_currency:
                        type: string
                      cv_in_currency:
                        type: string
                      metafields:
                        type: array
                        items:
                          title: LegacyMetafield
                          type: object
                          properties:
                            id:
                              type: integer
                            namespace:
                              description: >-
                                A container for related metafields. Commonly
                                used to group metafields by app or
                                functionality.
                              example: custom
                              type: string
                              maxLength: 20
                              pattern: ^[a-zA-Z0-9_]+$
                            key:
                              description: >-
                                The unique identifier for the metafield within
                                its namespace. Must be unique per namespace and
                                owner.
                              example: material
                              type: string
                              maxLength: 30
                              pattern: ^[a-zA-Z0-9_]+$
                            value:
                              description: >-
                                The actual data stored in the metafield. Type
                                depends on value_type.
                              example: cotton
                              type:
                                - string
                                - object
                            value_type:
                              description: >-
                                The data type that defines how the value should
                                be interpreted and validated.
                              example: single_line_text_field
                              type: string
                            description:
                              description: >-
                                Optional human-readable description explaining
                                the purpose of this metafield.
                              example: The primary material used in this product
                              type:
                                - string
                                - 'null'
                            owner_type:
                              description: >-
                                The type of resource that this metafield belongs
                                to (polymorphic association).
                              example: Product
                              type: string
                            owner_id:
                              description: >-
                                The ID of the specific resource that this
                                metafield belongs to.
                              example: 12345
                              type: integer
                            created_at:
                              description: Timestamp when the metafield was created.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            updated_at:
                              description: Timestamp when the metafield was last updated.
                              example: '2021-01-01T00:00:00Z'
                              type: string
                              format: date-time
                            metafield_definition:
                              title: MetafieldDefinition
                              type:
                                - object
                                - 'null'
                              properties:
                                id:
                                  type: integer
                                company_id:
                                  description: >-
                                    The ID of the company that owns this
                                    metafield definition.
                                  example: 1
                                  type: integer
                                namespace:
                                  description: >-
                                    A container for related metafield
                                    definitions. Used to group definitions by
                                    app or functionality. Must be unique within
                                    company and owner_resource.
                                  example: product_details
                                  type: string
                                  maxLength: 20
                                  pattern: ^[a-zA-Z0-9_]+$
                                key:
                                  description: >-
                                    The unique identifier for the metafield
                                    definition within its namespace and
                                    owner_resource. Combined with namespace and
                                    owner_resource, this must be unique per
                                    company.
                                  example: material_type
                                  type: string
                                  maxLength: 30
                                  pattern: ^[a-zA-Z0-9_]+$
                                name:
                                  description: >-
                                    Human-readable display name for the
                                    metafield definition, shown in admin
                                    interfaces and forms.
                                  example: Material Type
                                  type: string
                                  maxLength: 100
                                description:
                                  description: >-
                                    Detailed explanation of what this metafield
                                    definition represents, how it should be
                                    used, and any special instructions for
                                    content creators.
                                  example: >-
                                    Specify the primary material composition of
                                    the product (e.g., cotton, polyester, silk).
                                    This will be displayed on the product detail
                                    page.
                                  type:
                                    - string
                                    - 'null'
                                value_type:
                                  description: >-
                                    The data type that defines how metafield
                                    values should be validated, stored, and
                                    displayed. Determines which validation rules
                                    are available.
                                  example: single_line_text_field
                                  type: string
                                validation_rules:
                                  description: >-
                                    JSON object containing validation
                                    constraints that will be applied to
                                    metafield values. Available rules depend on
                                    the value_type.
                                  example:
                                    choices:
                                      - cotton
                                      - polyester
                                      - silk
                                      - wool
                                      - linen
                                      - bamboo
                                    max: 50
                                    min: 2
                                  type:
                                    - object
                                    - 'null'
                                owner_resource:
                                  description: >-
                                    The type of resource (model class name) that
                                    metafields using this definition can be
                                    attached to. Must match the polymorphic
                                    owner_type.
                                  example: Product
                                  type: string
                                pinned:
                                  description: >-
                                    Whether this definition should be
                                    prominently displayed or prioritized in
                                    admin interfaces and forms.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                position:
                                  default: 0
                                  description: >-
                                    Sort order for displaying this definition
                                    relative to others in the same category and
                                    owner_resource. Lower numbers appear first.
                                  example: 1
                                  type:
                                    - integer
                                    - 'null'
                                locked:
                                  description: >-
                                    Whether this metafield definition is locked,
                                    preventing direct updates or deletions of
                                    metafields using this definition.
                                  example: false
                                  type:
                                    - boolean
                                    - 'null'
                                  default: false
                                created_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    created.
                                  example: '2024-01-15T10:30:00Z'
                                  type: string
                                  format: date-time
                                updated_at:
                                  description: >-
                                    Timestamp when the metafield definition was
                                    last updated.
                                  example: '2024-02-20T14:45:00Z'
                                  type: string
                                  format: date-time
                                list_type:
                                  description: >-
                                    Whether this definition is for list-type
                                    metafields that store arrays of values.
                                  example: false
                                  type: boolean
                                reference_type:
                                  description: >-
                                    Whether this definition is for
                                    reference-type metafields that store
                                    references to other resources.
                                  example: false
                                  type: boolean
                                supported_validations:
                                  description: >-
                                    Array of validation rule names that are
                                    supported for this value_type.
                                  example:
                                    - min
                                    - max
                                    - choices
                                    - regex
                                  type: array
                                validation_description:
                                  description: >-
                                    Human-readable description of what the
                                    value_type represents and its constraints.
                                  example: Single line text up to 5000 characters
                                  type: string
                                category_ids:
                                  description: >-
                                    Array of category IDs that this metafield
                                    definition is associated with for
                                    organizational purposes.
                                  example:
                                    - 1
                                    - 2
                                    - 3
                                  items:
                                    type: integer
                                  type: array
                              required:
                                - id
                                - company_id
                                - namespace
                                - key
                                - name
                                - value_type
                                - owner_resource
                                - created_at
                                - updated_at
                                - list_type
                                - reference_type
                                - supported_validations
                                - validation_description
                                - category_ids
                          required:
                            - id
                            - namespace
                            - key
                            - value
                            - value_type
                            - owner_type
                            - owner_id
                            - created_at
                            - updated_at
                    required:
                      - id
                      - title
                      - metadata
                      - price_in_currency
                      - tax_in_currency
                      - cv_in_currency
                      - metafields
                  variants:
                    type: array
                    items:
                      title: Variant
                      type: object
                      properties:
                        id:
                          type: integer
                        title:
                          example: Variant 1
                          type:
                            - string
                            - 'null'
                        image_url:
                          example: https://via.placeholder.com/150
                          type:
                            - string
                            - 'null'
                        image_path:
                          example: https://via.placeholder.com/150
                          type:
                            - string
                            - 'null'
                        sku:
                          example: SKU-123456
                          type:
                            - string
                            - 'null'
                        primary_image:
                          example: https://via.placeholder.com/150
                          type:
                            - string
                            - 'null'
                        price:
                          example: 100
                          type:
                            - number
                            - string
                            - 'null'
                        price_in_currency:
                          example: USD 100.00
                          type: string
                        options:
                          items:
                            type: object
                            properties:
                              title:
                                type: string
                                example: Size
                              value:
                                type: string
                                example: XL
                          type: array
                      required:
                        - id
                        - price_in_currency
                        - options
                  subscription_plans:
                    type: array
                    items:
                      title: Commerce::SubscriptionPlan
                      type: object
                      properties:
                        id:
                          type: integer
                        name:
                          example: Test Subscription Plan
                          type: string
                        billing_interval:
                          example: 1
                          type: integer
                          default: 1
                          minimum: 1
                          maximum: 29
                        billing_interval_unit:
                          description: 'Possible values: `day`, `week`, `month`, `year`'
                          example: day
                          type: string
                          default: month
                        billing_frequency_in_words:
                          example: 2 Months
                          type: string
                        shipping_interval:
                          example: 1
                          type: integer
                          default: 1
                          minimum: 1
                          maximum: 29
                        shipping_interval_unit:
                          description: 'Possible values: `day`, `week`, `month`, `year`'
                          example: day
                          type: string
                          default: month
                        volume_interval:
                          example: 1
                          type: integer
                          default: 1
                          minimum: 1
                          maximum: 29
                        volume_interval_unit:
                          description: 'Possible values: `day`, `week`, `month`, `year`'
                          example: day
                          type: string
                          default: month
                        trial_period:
                          example: 1
                          type:
                            - integer
                            - 'null'
                          minimum: 1
                        trial_period_unit:
                          description: 'Possible values: `day`, `week`, `month`, `year`'
                          example: day
                          type:
                            - string
                            - 'null'
                        split_volume:
                          example: true
                          type: boolean
                          default: false
                        allow_skipping:
                          example: true
                          type:
                            - boolean
                            - 'null'
                          default: true
                        max_skips:
                          example: 1
                          type:
                            - integer
                            - 'null'
                          minimum: 1
                        allow_max_billing_cycles:
                          example: true
                          type: boolean
                          default: false
                        max_billing_cycles:
                          example: 3
                          type:
                            - integer
                            - 'null'
                        price_adjustment_type:
                          example: percentage or fixed_amount
                          type:
                            - string
                            - 'null'
                        price_adjustment_amount:
                          example: 10
                          type:
                            - number
                            - 'null'
                        active:
                          example: true
                          type:
                            - boolean
                            - 'null'
                          default: true
                        company_default:
                          example: false
                          type:
                            - boolean
                            - 'null'
                          default: false
                        created_at:
                          example: '2025-03-10T00:00:00Z'
                          type: string
                          format: date-time
                        updated_at:
                          example: '2025-03-10T00:00:00Z'
                          type: string
                          format: date-time
                        products_count:
                          example: 10
                          type:
                            - integer
                            - 'null'
                        subscribers_count:
                          example: 10
                          type:
                            - integer
                            - 'null'
                      required:
                        - id
                        - name
                        - billing_interval
                        - billing_interval_unit
                        - billing_frequency_in_words
                        - shipping_interval
                        - shipping_interval_unit
                        - volume_interval
                        - volume_interval_unit
                        - split_volume
                        - allow_max_billing_cycles
                        - created_at
                        - updated_at
                  metadata:
                    $ref: '#/components/schemas/ResponseMetadata'
                required:
                  - status
                  - product
                  - variants
                  - subscription_plans
                  - metadata
        '404':
          description: company not found
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 404
                  errors:
                    - message: Company not found
                  metadata:
                    fluid_shop: invalid-shop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 019524b4-9fce-7934-9429-a51f9c18f363
                    timestamp: '2024-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                metadata:
                  $ref: '#/components/schemas/RequestMetadata'
              required:
                - metadata
  /api/public/v2025-06/session:
    post:
      summary: Start a new session
      operationId: session-create
      tags:
        - session
      parameters: []
      responses:
        '201':
          description: session created
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    example: 201
                  fluid_session:
                    type: string
                    example: fs_szwdDuRbqEe7AV7sXk7vVq
                required:
                  - status
                  - fluid_session
                example:
                  status: 201
                  fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
        '404':
          description: unknown shop
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    example: 422
                  errors:
                    $ref: '#/components/schemas/ResponseErrors'
                required:
                  - status
                  - errors
                example:
                  status: 404
                  errors:
                    - message: Company not found
        '422':
          description: invalid request
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    example: 422
                  errors:
                    $ref: '#/components/schemas/ResponseErrors'
                required:
                  - status
                  - errors
                example:
                  status: 422
                  errors:
                    - message: Unexpected error
        '500':
          description: internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    example: 422
                  errors:
                    $ref: '#/components/schemas/ResponseErrors'
                required:
                  - status
                  - errors
                example:
                  status: 500
                  errors:
                    - message: Unexpected error
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                fluid_shop:
                  type: string
                  description: Fluid shop identifier
                  example: myshop
              required:
                - fluid_shop
  /api/public/v2025-06/settings:
    post:
      summary: Retrieve page settings
      operationId: settings-retrieve
      tags:
        - settings
      parameters: []
      responses:
        '201':
          description: page loaded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UrlPageSettingsResponse'
        '404':
          description: unknown shop
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 404
                  errors:
                    - message: Company not found
                  metadata:
                    fluid_shop: myshop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 123e4567-e89b-12d3-a456-426614174000
                    timestamp: '2025-01-01T00:00:00Z'
        '422':
          description: invalid request
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 422
                  errors:
                    - message: Unexpected error
                  metadata:
                    fluid_shop: myshop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 123e4567-e89b-12d3-a456-426614174000
                    timestamp: '2025-01-01T00:00:00Z'
        '500':
          description: internal server error
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 500
                  errors:
                    - message: Unexpected error
                  metadata:
                    fluid_shop: myshop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 123e4567-e89b-12d3-a456-426614174000
                    timestamp: '2025-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                page:
                  $ref: '#/components/schemas/UrlPage'
                metadata:
                  $ref: '#/components/schemas/RequestMetadata'
              required:
                - page
                - metadata
  /api/public/v2025-06/widgets/banners:
    post:
      summary: Retrieve banner widget
      operationId: widgets-banners-retrieve
      tags:
        - widgets
      parameters: []
      responses:
        '200':
          description: banner widget found
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: number
                    example: 200
                  banner:
                    oneOf:
                      - $ref: '#/components/schemas/BannerWidget'
                      - type: 'null'
                  metadata:
                    $ref: '#/components/schemas/ResponseMetadata'
                required:
                  - status
                  - banner
                  - metadata
        '404':
          description: unknown shop
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 404
                  errors:
                    - message: Company not found
                  metadata:
                    fluid_shop: invalid-shop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 123e4567-e89b-12d3-a456-426614174000
                    timestamp: '2025-01-01T00:00:00Z'
        '422':
          description: invalid request
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 422
                  errors:
                    - message: Unexpected error
                  metadata:
                    fluid_shop: myshop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 123e4567-e89b-12d3-a456-426614174000
                    timestamp: '2025-01-01T00:00:00Z'
        '500':
          description: internal server error
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 500
                  errors:
                    - message: Internal server error
                  metadata:
                    fluid_shop: myshop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 123e4567-e89b-12d3-a456-426614174000
                    timestamp: '2025-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  example: https://example.com/products/123
                metadata:
                  $ref: '#/components/schemas/RequestMetadata'
              required:
                - url
                - metadata
  /api/public/v2025-06/widgets/carts:
    post:
      summary: Retrieve cart widget
      operationId: widgets-carts-retrieve
      tags:
        - widgets
      parameters: []
      responses:
        '200':
          description: cart widget found
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: number
                    example: 200
                  cart:
                    oneOf:
                      - $ref: '#/components/schemas/CartWidget'
                      - type: 'null'
                  metadata:
                    $ref: '#/components/schemas/ResponseMetadata'
                required:
                  - status
                  - cart
                  - metadata
        '404':
          description: unknown shop
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 404
                  errors:
                    - message: Company not found
                  metadata:
                    fluid_shop: invalid-shop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 123e4567-e89b-12d3-a456-426614174000
                    timestamp: '2025-01-01T00:00:00Z'
        '422':
          description: invalid request
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 422
                  errors:
                    - message: Unexpected error
                  metadata:
                    fluid_shop: myshop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 123e4567-e89b-12d3-a456-426614174000
                    timestamp: '2025-01-01T00:00:00Z'
        '500':
          description: internal server error
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 500
                  errors:
                    - message: Unexpected error
                  metadata:
                    fluid_shop: myshop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 123e4567-e89b-12d3-a456-426614174000
                    timestamp: '2025-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  example: https://example.com/products/123
                metadata:
                  $ref: '#/components/schemas/RequestMetadata'
              required:
                - url
                - metadata
  /api/public/v2025-06/widgets/chats:
    post:
      summary: Retrieve chat widget
      operationId: widgets-chats-retrieve
      tags:
        - widgets
      parameters: []
      responses:
        '200':
          description: chat widget found
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: number
                    example: 200
                  chat:
                    oneOf:
                      - $ref: '#/components/schemas/ChatWidget'
                      - type: 'null'
                  metadata:
                    $ref: '#/components/schemas/ResponseMetadata'
                required:
                  - status
                  - chat
                  - metadata
        '404':
          description: unknown shop
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 404
                  errors:
                    - message: Company not found
                  metadata:
                    fluid_shop: invalid-shop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 123e4567-e89b-12d3-a456-426614174000
                    timestamp: '2025-01-01T00:00:00Z'
        '422':
          description: invalid request
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 422
                  errors:
                    - message: Unexpected error
                  metadata:
                    fluid_shop: myshop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 123e4567-e89b-12d3-a456-426614174000
                    timestamp: '2025-01-01T00:00:00Z'
        '500':
          description: internal server error
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 500
                  errors:
                    - message: Unexpected error
                  metadata:
                    fluid_shop: myshop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 123e4567-e89b-12d3-a456-426614174000
                    timestamp: '2025-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  example: https://example.com/products/123
                metadata:
                  $ref: '#/components/schemas/RequestMetadata'
              required:
                - url
                - metadata
  /api/public/v2025-06/widgets/popups:
    post:
      summary: Retrieve popup widget
      operationId: widgets-popups-retrieve
      tags:
        - widgets
      parameters: []
      responses:
        '200':
          description: popup widget found
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: number
                    example: 200
                  popup:
                    oneOf:
                      - $ref: '#/components/schemas/PopupWidget'
                      - type: 'null'
                  metadata:
                    $ref: '#/components/schemas/ResponseMetadata'
                required:
                  - status
                  - popup
                  - metadata
        '404':
          description: unknown shop
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 404
                  errors:
                    - message: Company not found
                  metadata:
                    fluid_shop: invalid-shop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 123e4567-e89b-12d3-a456-426614174000
                    timestamp: '2025-01-01T00:00:00Z'
        '422':
          description: invalid request
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 422
                  errors:
                    - message: Unexpected error
                  metadata:
                    fluid_shop: myshop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 123e4567-e89b-12d3-a456-426614174000
                    timestamp: '2025-01-01T00:00:00Z'
        '500':
          description: internal server error
          content:
            application/json:
              schema:
                type: object
                $ref: '#/components/schemas/ApiErrorResponse'
                example:
                  status: 500
                  errors:
                    - message: Unexpected error
                  metadata:
                    fluid_shop: myshop
                    fluid_session: fs_szwdDuRbqEe7AV7sXk7vVq
                    request_uuid: 123e4567-e89b-12d3-a456-426614174000
                    timestamp: '2025-01-01T00:00:00Z'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                url:
                  type: string
                  example: https://example.com/products/123
                metadata:
                  $ref: '#/components/schemas/RequestMetadata'
              required:
                - url
                - metadata
  /api/media/{id}:
    get:
      summary: Get a specific media
      operationId: getMedia
      security:
        - bearer_auth: []
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
            example: 1
            description: Media ID
        - name: language_iso
          in: query
          schema:
            type: string
          required: false
          description: Language code for translations (e.g., 'en', 'es', 'de')
      responses:
        '200':
          description: Media retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MediumSerializer'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedError'
  /api/company/settings/social_media:
    get:
      summary: Get Company Social Media Usernames
      description: Returns the social media usernames for the company.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  facebook:
                    type: string
                    example: company_facebook
                  twitter:
                    type: string
                    example: company_twitter
                  instagram:
                    type: string
                    example: company_instagram
                  linkedin:
                    type: string
                    example: company_linkedin
                  youtube:
                    type: string
                    example: company_youtube
                  tiktok:
                    type: string
                    example: company_tiktok
                  pinterest:
                    type: string
                    example: company_pinterest
    put:
      summary: Update Company Social Media Usernames
      description: Updates the social media usernames for the company.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                social_media:
                  type: object
                  properties:
                    facebook:
                      type: string
                      example: updated_facebook
                    twitter:
                      type: string
                      example: updated_twitter
                    instagram:
                      type: string
                      example: updated_instagram
                    linkedin:
                      type: string
                      example: updated_linkedin
                    youtube:
                      type: string
                      example: updated_youtube
                    tiktok:
                      type: string
                      example: updated_tiktok
                    pinterest:
                      type: string
                      example: updated_pinterest
      responses:
        '200':
          description: Successful update
          content:
            application/json:
              schema:
                type: object
                properties:
                  facebook:
                    type: string
                    example: updated_facebook
                  twitter:
                    type: string
                    example: updated_twitter
                  instagram:
                    type: string
                    example: updated_instagram
                  linkedin:
                    type: string
                    example: updated_linkedin
                  youtube:
                    type: string
                    example: updated_youtube
                  tiktok:
                    type: string
                    example: updated_tiktok
                  pinterest:
                    type: string
                    example: updated_pinterest
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  errors:
                    type: array
                    items:
                      type: string
tags:
  - name: Activities
  - name: Admins
  - name: affiliate
  - name: Agreements
  - name: Announcements
  - name: Application Theme Resources
  - name: Application Theme Templates
  - name: Application Themes
  - name: Authentication
  - name: Bank Accounts
  - name: Brand Guidelines
  - name: Business Types
  - name: Callback Definitions
  - name: Callback Registrations
  - name: Callback Schemas
  - name: carts
  - name: Carts
  - name: carts
  - name: Catch Ups
  - name: Categories
  - name: Checkout
  - name: checkout
  - name: Collections
  - name: Companies
  - name: Company Countries
  - name: Compliance
    description: >-
      Content compliance scanning endpoints for products, media, playlists,
      categories, collections, posts, and enrollment packs
  - name: Contacts
  - name: Conversations
  - name: Countries
  - name: Currencies
  - name: Custom Pages
  - name: Customer Notes
  - name: Customer Orders
  - name: Customers
  - name: DAM
    description: Digital Asset Management endpoints
  - name: Default Libraries
  - name: Devices
  - name: Discounts
  - name: Display Settings
  - name: Domains
  - name: Drop Zones
  - name: Droplet Categories
  - name: Droplet Installations
  - name: Droplets
  - name: Enrollment Packs
  - name: enrollment-packs
  - name: Enrollments
  - name: Entities
  - name: Events
  - name: events
  - name: Fantasy Points
  - name: Feature Flags
  - name: File Resources
  - name: fingerprint
  - name: Fluid Pay
  - name: Form Elements
  - name: Forms
  - name: Global Embeds
  - name: Impersonation
  - name: Inventory Levels
  - name: Labels
  - name: Languages
  - name: lead
  - name: Libraries
  - name: Lighthouse
    description: >-
      Lighthouse performance scanning endpoints for products, media, playlists,
      categories, collections, posts, and enrollment packs
  - name: MCC Codes
  - name: media
  - name: Media
  - name: media
  - name: Menus
  - name: Messages
  - name: Metafield Definitions
  - name: Metafields
  - name: Mobile Widgets
  - name: Multi-Factor Authentications
  - name: Notifications
  - name: Onboarding
  - name: Onboarding Info
  - name: Order Fulfillments
  - name: Orders
  - name: Owners
  - name: page
  - name: Pages
  - name: Payment
  - name: Payment Accounts
  - name: Payment Integrations
  - name: Payments
  - name: Paypal
  - name: playlist
  - name: Points
  - name: Points Ledgers
  - name: Points Values
  - name: Posts
  - name: product
  - name: Product Bundles
  - name: Product Images
  - name: Product Redirects
  - name: Product Subscription Plans
  - name: Products
  - name: Prompts
  - name: Public Assets
  - name: Public Companies
  - name: Public Drop Zones
  - name: Ranks
  - name: Recipients
  - name: Redirects
  - name: Refunds
  - name: Reps
  - name: Roles
  - name: Root Themes
  - name: Search
  - name: session
  - name: settings
  - name: Share Statistics
    description: >-
      Share statistics endpoints for media, products, playlists, categories,
      collections, posts, pages, and enrollment packs
  - name: Shares
  - name: Shop
  - name: Sitemap
  - name: Social Media
  - name: Subscription Plans
  - name: Subscriptions
  - name: System Monitoring
  - name: Tags
  - name: Tax Categories
  - name: Theme Region Rules
  - name: Tiles
  - name: Tracking Informations
  - name: Tree Nodes
  - name: Trees
  - name: url
  - name: Users
  - name: Variant Countries
  - name: Variant Images
  - name: Variant Inventory Levels
  - name: Variants
  - name: Warehouses
  - name: Webhook Events
  - name: Webhook Schemas
  - name: Webhooks
  - name: Webhooks Resources
  - name: widgets
x-tagGroups:
  - name: Company APIs
    tags:
      - Activities
      - Admins
      - Agreements
      - Announcements
      - Application Theme Resources
      - Application Theme Templates
      - Application Themes
      - Authentication
      - Bank Accounts
      - Brand Guidelines
      - Business Types
      - Callback Definitions
      - Callback Registrations
      - Callback Schemas
      - Carts
      - Catch Ups
      - Categories
      - Checkout
      - Collections
      - Companies
      - Company Countries
      - Compliance
      - Contacts
      - Conversations
      - Countries
      - Currencies
      - Custom Pages
      - Customer Notes
      - Customer Orders
      - Customers
      - DAM
      - Default Libraries
      - Devices
      - Discounts
      - Display Settings
      - Domains
      - Drop Zones
      - Droplet Categories
      - Droplet Installations
      - Droplets
      - Enrollment Packs
      - Enrollments
      - Entities
      - Events
      - Fantasy Points
      - Feature Flags
      - File Resources
      - Fluid Pay
      - Form Elements
      - Forms
      - Global Embeds
      - Impersonation
      - Inventory Levels
      - Labels
      - Languages
      - Libraries
      - Lighthouse
      - MCC Codes
      - Media
      - Menus
      - Messages
      - Metafield Definitions
      - Metafields
      - Mobile Widgets
      - Multi-Factor Authentications
      - Notifications
      - Onboarding
      - Onboarding Info
      - Order Fulfillments
      - Orders
      - Owners
      - Pages
      - Payment
      - Payment Accounts
      - Payment Integrations
      - Payments
      - Paypal
      - Points
      - Points Ledgers
      - Points Values
      - Posts
      - Product Bundles
      - Product Images
      - Product Redirects
      - Product Subscription Plans
      - Products
      - Prompts
      - Public Assets
      - Public Companies
      - Public Drop Zones
      - Ranks
      - Recipients
      - Redirects
      - Refunds
      - Reps
      - Roles
      - Root Themes
      - Search
      - Share Statistics
      - Shares
      - Shop
      - Sitemap
      - Social Media
      - Subscription Plans
      - Subscriptions
      - System Monitoring
      - Tags
      - Tax Categories
      - Theme Region Rules
      - Tiles
      - Tracking Informations
      - Tree Nodes
      - Trees
      - Users
      - Variant Countries
      - Variant Images
      - Variant Inventory Levels
      - Variants
      - Warehouses
      - Webhook Events
      - Webhook Schemas
      - Webhooks
      - Webhooks Resources
  - name: FairShare SDK (public)
    tags:
      - affiliate
      - carts
      - checkout
      - enrollment-packs
      - events
      - fingerprint
      - lead
      - media
      - page
      - playlist
      - product
      - session
      - settings
      - url
      - widgets
